ActiveRegulation

Gem Version Build Status Coverage Status

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
  • quarantine
  • suspension
  • visibility

Attributes:

  • :inactivated_at
  • :contained_at
  • :expires_at
  • :invisible_at
  • :quarantined_at
  • :suspended_at
class User < ActiveRecord::Base

  # Add one of the datetime attributes
  # above to the corresponding table.

  include ActiveRegulation::Containment

end

Usage

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

Your contribution is welcome.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request