symbolic_enum
symbolic_enum
is an alternate implementation of Rails enums, which changes the following:
- The getters return symbols instead of strings.
- Option to mark the field as an array. This assumes that the underlying database column is an integer array.
- Option to disable scopes and/or setters.
Installation
Add this line to your application's Gemfile:
gem 'symbolic_enum'
And then execute:
$ bundle
Or install it yourself as:
$ gem install symbolic_enum
Usage
symbolic_enum
is used similar to enum
. For example,
class Car < ApplicationRecord
include SymbolicEnum
symbolic_enum category: {
sedan: 0,
hatchback: 1,
suv: 2,
other: 3,
}
end
# Usage
c = Car.create!
c.sedan!
c.sedan? # true
c.hatchback? # false
c.category = :suv
c.category # :suv
c.save!
Car.suv.pluck(:id).include?(c.id) # true
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/symbolic_enum.
License
The gem is available as open source under the terms of the MIT License.