ActiveRegulation
ActiveRegulation is a library for commonly used record states.
Installation
Add this line to your application's Gemfile:
gem 'active_regulation'
And then execute:
$ bundle
Or install it yourself as:
$ gem install active_regulation
Table of Contents
Methods
Modules:
- activation
- containment
- expiration
- visibility
Attributes:
- :inactivated_at
- :contained_at
- :expires_at
- :invisible_at
class User < ActiveRecord::Base
# Add one of the datetime attributes
# above to the corresponding table.
include ActiveRegulation::Containment
# A virtual attribute is generated for
# easy use with forms and models
end
Usage
user = User.create!(activation: 1)
user.active? #=> true
user.inactive? #=> false
user.inactive!
user.active? #=> false
user.active!
user.active? #=> true
user.to_activation #=> 'Active'
User.active #=> retrieves all active records
User.inactive #=> retrieves all inactive records
Contributing
- Fork it ( https://github.com/[my-github-username]/active_regulation/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request