Contents

# Containment

#### Usage

```ruby
# 1. Add column to table
class AddRegulationTimestampColumn < ActiveRecord::Migration
  def change
    t.datetime :contained_at

    # - or -

    add_column :your_model, :contained_at, :datetime
  end
end

# 2. Include module
class User < ActiveRecord::Base
  include Lite::Regulation::Containment
end
```

#### Methods

```ruby
user = User.first
user.uncontain!
user.uncontained?   #=> true

user.contain!
user.contained?     #=> true

user.to_containment #=> Returns the visibility state locale string (ex: Contained)
```

#### Scopes

```ruby
User.contained    # Returns all contained records
User.uncontained  # Returns all uncontained records
```

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
lite-regulation-1.0.1	docs/CONTAINMENT.md
lite-regulation-1.0.0	docs/CONTAINMENT.md