Contents

# Quarantine

#### Usage

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

    # - or -

    add_column :your_model, :quarantined_at, :datetime
  end
end

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

#### Methods

```ruby
user = User.first
user.unquarantine!
user.unquarantined? #=> true

user.quarantine!
user.quarantined?   #=> true

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

#### Scopes

```ruby
User.unquarantined  # Returns all unquarantined records
User.quarantined    # Returns all quarantined records
```

Version data entries

2 entries across 2 versions & 1 rubygems

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