Enumerations
============

Rails plugin for enumerations in ActiveRecord models.

[![Build Status](https://travis-ci.org/infinum/enumerations.svg?branch=master)](https://travis-ci.org/infinum/enumerations)

Installation
============

Inside your `Gemfile` add the following:

```ruby
gem 'enumerations'
```

Usage
=====

Create a model for your enumerations:

```ruby
class Status < Enumeration::Base
  values draft:           { id: 1, name: 'Draft' },
         review_pending:  { id: 2, name: 'Review pending' },
         published:       { id: 3, name: 'Published' }
end
```

Or you can use `value` method for defining your enumerations:

```ruby
class Status < Enumeration::Base
  value :draft,           id: 1, name: 'Draft'
  value :review_pending,  id: 2, name: 'Review pending'
  value :published,       id: 3, name: 'Published'
end
```

Include enumerations for integer fields in other models:

```ruby
class Post < ActiveRecord::Base
  enumeration :status
  validates :status_id, presence: true
end
```

You can pass attributes to specify which enumeratior and which column to use:

```ruby
class Post < ActiveRecord::Base
  enumeration :status,
              foreign_key: :post_status_id, # specifies which column to use
              class_name: Post::Status # specifies the class of the enumerator
  validates :post_status_id, presence: true
end
```

Set enumerations, find enumerations by `symbol`:

```ruby
@post = Post.first
@post.status = Status.find(:draft)
@post.save
```

Or you can set enumerations on this way:

```ruby
@post.status = Status.draft
```

Find enumerations by `id`:

```ruby
@post.status = Status.find(2)               # => Review pending
@post.save
```

Compare enumerations:

```ruby
@post.status == :published                  # => true
@post.status == 3                           # => true
@post.status == Status.find(:published)     # => true
@post.status.published?                     # => true
```

Get all enumerations:

```ruby
Status.all
```

Use in forms:

```ruby
%p
  = f.label :status_id
  %br
  = f.collection_select :status_id, Status.all, :id, :name
```

Advance Usage
=====

Except `id` and `name` you can specify other attributes to your enumerations:

```ruby
class Status < Enumeration::Base
  value :draft,           id: 1, name: 'Draft'
  value :review_pending,  id: 2, name: 'Review pending', description: 'Some description...'
  value :published,       id: 3, name: 'Published'
end
```

Every enumeration has `id`, `name` and `description` methods. If you call method that is not in attribute list for enumeration, it will return `nil`.

```ruby
Status.review_pending.description             # => 'Some description...'
Status.draft.description                      # => nil
```

Author
======

Copyright © 2010 Tomislav Car, Infinum Ltd.