EnumFor

Alternative to ActiveRecord::Enum for API use.

Build

Maintainability

Code Quality

Size

Usage

Activity

Documentation

Security

There are several concerns when using AR Enum with API, when you receive a payload it is hard to handle a proper error message.

class Conversation < ActiveRecord::Base
  enum status: [ :draft, :active, :archived ]
end

curl -X POST \
  {{domain}}/api/v1/conversations \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -d '{
    "conversation": {
      "title": "Relativity theory",
      "status": "unactive"
    }'

conversation = Conversation.new
conversation.status = "unactive"
=> ArgumentError ('unactive' is not a valid status)

instead with EnumFor

class Conversation < ActiveRecord::Base
  extend EnumFor
  enum_for status: { draft: 0, active: 1, archived: 2 }
  validates :status, inclusion: statuses.keys
end

curl -X POST \
  {{domain}}/api/v1/conversations \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -d '{
    "conversation": {
      "title": "Relativity theory",
      "status": "unactive"
    }'

conversation = Conversation.new
conversation.status = "unactive"
conversation.valid?
=> false 
conversation.errors.messages
=> { status: [ 'is not included in the list' ] }

Installation

Add this line to your application's Gemfile:

gem 'enum_for'

And then execute:

$ bundle

Or install it yourself as:

$ gem install enum_for

Usage

You need to extend the AR class you want to use it:

class Conversation < ActiveRecord::Base
  extend EnumFor
  enum_for status: { draft: 0, active: 1, archived: 2 }
  validates :status, inclusion: statuses.keys
end

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]/enum_for. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the EnumFor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.