EnumIsh

A ruby and rails extension to generate enum-like methods.

Dependencies

• ruby 2.3+
• activerecord 5.0+
• activesupport 5.0+

Installation

Add this line to your application's Gemfile:

gem 'enum_ish'

Then execute:

$ bundle

Usage

Extend your class using EnumIsh and define an enum-like field:

class User
  extend EnumIsh
  attr_accessor :status                    # status is a string field
  enum_ish :status, ['enable', 'disable']  # status has 'enable' or 'disable'
end

Then define i18n translations (example below shows japanese translations):

ja:
  enum_ish:
    user:
      enable: 有効
      disable: 無効

Enum-like methods are generated as follows:

user = User.new
user.status = 'enable'
user.status_text     #=> "有効"
User.status_options  #=> [["有効", "enable"], ["無効", "disable"]]
User.status_options(only: 'enable')  #=> [["有効", "enable"]]
User.status_options(except: 'enable')  #=> [["無効", "disable"]]

Additional translations

Define additional translations:

ja:
  enum_ish:
    user:
      status:
        enable: 有効
        disable: 無効
      status/short:
        enable: 有
        disable: 無

user = User.new
user.status = 'enable'
user.status_text(format: :short)     #=> "有"
User.status_options(format: :short)  #=> [["有", "enable"], ["無", "disable"]]

Default value

Set default value:

class User
  extend EnumIsh
  attr_accessor :status
  enum_ish :status, ['enable', 'disable'], default: 'enable'
end

user = User.new
user.status  #=> "enable"

Use default value with block:

class User
  extend EnumIsh
  attr_accessor :status, :flag
  enum_ish :status, ['enable', 'disable'], default: -> { flag ? 'enable' : 'disable' }
end

user = User.new
user.status  #=> "disable"

Predicates

Generate predicate methods:

class User
  extend EnumIsh
  attr_accessor :status
  enum_ish :status, ['enable', 'disable'], predicate: true
end

user = User.new
user.status = 'enable'
user.status_enable?   #=> true
user.status_disable?  #=> false

Accessor

Generate getter and setter for aliased symbols instead of raw values:

class User
  extend EnumIsh
  attr_accessor :status
  enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
end

user = User.new
user.status = :_enable
user.status              #=> :_enable
user.status_raw          #=> "enable"

ActiveRecord features

Accessor

Generate accessor:

class User < ActiveRecord::Base
  extend EnumIsh
  enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
end

User.where(status: :_enable)  #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"

Scope

Generate scope:

class User < ActiveRecord::Base
  extend EnumIsh
  enum_ish :status, ['enable', 'disable'], scope: true
end

User.with_status(:enable)  #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"

Validation

Generate validation:

class User < ActiveRecord::Base
  extend EnumIsh
  enum_ish :status, ['enable', 'disable'], validate: true
end

user = User.new
user.status = 'INVALID'
user.valid?  #=> false

Contributing

Bug reports and pull requests are welcome at https://github.com/kanety/enum_ish.

License

The gem is available as open source under the terms of the MIT License.