Sha256: 8a74d6ab928ee100d6106807459a4e6283f1775b7beec79e8641d079b521be75

Contents?: true

Size: 1.7 KB

Versions: 1

Compression:

Stored size: 1.7 KB

Contents

# ActiveRegulation

[![Gem Version](https://badge.fury.io/rb/active_regulation.svg)](http://badge.fury.io/rb/active_regulation)
[![Build Status](https://travis-ci.org/drexed/active_regulation.svg?branch=master)](https://travis-ci.org/drexed/active_regulation)
[![Coverage Status](https://coveralls.io/repos/github/drexed/active_regulation/badge.svg?branch=master)](https://coveralls.io/github/drexed/active_regulation?branch=master)

ActiveRegulation is a library for commonly used record states.

## Installation

Add this line to your application's Gemfile:

```ruby
gem "active_regulation"
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install active_regulation

## Table of Contents

* [Methods](#methods)
* [Usage](#usage)

## Methods

**Modules:**
 * activation
 * containment
 * expiration
 * quarantine
 * suspension
 * visibility

**Attributes:**
 * :inactivated_at
 * :contained_at
 * :expires_at
 * :invisible_at
 * :quarantined_at
 * :suspended_at

```ruby
class User < ActiveRecord::Base

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

  include ActiveRegulation::Containment

end
```

## Usage
```ruby
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

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
active_regulation-3.0.0 README.md