Project

enum_for

0.0
No commit activity in last 3 years
No release in over 3 years
ActiveRecord::Enum fire SQL request and bypass ActiveModel::Validations, this let you play with enum and validation
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 10.0
~> 3.0
~> 0.17
~> 1.4
~> 0.9

Runtime

 Project Readme

EnumFor

Alternative to ActiveRecord::Enum for API use.

Build

Travis CI

Maintainability

Maintenance Maintainability

Code Quality

Code Climate coverage Coverage Status Code Climate issues Code Climate maintainability Code Climate maintainability (percentage) Code Climate technical debt

Size

GitHub code size in bytes GitHub repo size in bytes

Usage

Gem Version Gem Gem

Activity

GitHub All Releases GitHub last commit (master) GitHub Release Date

Documentation

Inline docs License Version

Security

Libraries.io dependency status for latest release

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.