Project

enum_ish

0.0
A long-lived project that still receives updates
enum_ishkanety/enum_ishHomepageDocumentationSource CodeBug TrackerWiki
A ruby and rails extension to generate enum-like methods
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
32,393
Stars
0
Forks
0
Watchers
3
 Releases
Current version
1.6.3
Total releases
19
First release
2018-02-19
Latest release
2024-10-16
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
3
Pull Request Acceptance Rate
75%
 Development
Primary Language
Ruby
Average date of last 50 commits
2022-03-30
Reverse Dependencies
0

 Dependencies

Development

rspec-rails
>= 0
simplecov
>= 0

Runtime

activesupport
>= 5.0
i18n
>= 0
 Project Readme

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
  include EnumIsh::Base
  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
  include EnumIsh::Base
  attr_accessor :status
  enum_ish :status, ['enable', 'disable'], default: 'enable'
end

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

Use default value with block:

class User
  include EnumIsh::Base
  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
  include EnumIsh::Base
  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

Without prefix:

class User
  include EnumIsh::Base
  attr_accessor :status
  enum_ish :status, ['enable', 'disable'], predicate: { prefix: false }
end

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

Accessor

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

class User
  include EnumIsh::Base
  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
  include EnumIsh::Base
  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
  include EnumIsh::Base
  enum_ish :status, ['enable', 'disable'], scope: true
end

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

Validation

Generate validation:

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

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

Dictionary cache

You can enable dictionary cache using rack middleware:

Rails.application.config.middleware.use EnumIsh::DictionaryCache

This middleware enables dictionary cache for each request. Performance of dictionary lookup will be improved in case one dictionary is used repeatedly in the same request.

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.