https://github.com/drexed/lite-regulations
Collection of mixins to control the state of a database record
https://github.com/drexed/lite-regulations
activation activerecord containment expiration quarantine rails regulate ruby state suspension visibility
Last synced: 24 days ago
JSON representation
Collection of mixins to control the state of a database record
- Host: GitHub
- URL: https://github.com/drexed/lite-regulations
- Owner: drexed
- License: mit
- Created: 2019-07-18T19:56:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T01:39:26.000Z (over 3 years ago)
- Last Synced: 2025-01-10T01:40:16.117Z (over 1 year ago)
- Topics: activation, activerecord, containment, expiration, quarantine, rails, regulate, ruby, state, suspension, visibility
- Language: Ruby
- Homepage: https://drexed.github.io/lite-regulations
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lite::Regulations
[](http://badge.fury.io/rb/lite-regulations)
[](https://travis-ci.org/drexed/lite-regulations)
Lite::Regulations is a collection of mixins to control the state of a database record.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'lite-regulations'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install lite-regulations
## Table of Contents
* [Regulators](#regulators)
## Regulators
* [Activation](https://github.com/drexed/lite-regulations/blob/master/docs/ACTIVATION.md)
* [Containment](https://github.com/drexed/lite-regulations/blob/master/docs/CONTAINMENT.md)
* [Expiration](https://github.com/drexed/lite-regulations/blob/master/docs/EXPIRATION.md)
* [Quarantine](https://github.com/drexed/lite-regulations/blob/master/docs/QUARANTINE.md)
* [Suspension](https://github.com/drexed/lite-regulations/blob/master/docs/SUSPENSION.md)
* [Visibility](https://github.com/drexed/lite-regulations/blob/master/docs/VISIBILITY.md)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/drexed/lite-regulations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Lite::Regulations project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drexed/lite-regulations/blob/master/CODE_OF_CONDUCT.md).