enumerations 2.2.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bff6ddbd1cfb803b3463c11796daf3c81f1c741
-  data.tar.gz: 20a258a2ed4129ed92b044f2933fb366d45aba6e
+SHA256:
+  metadata.gz: 662c2ae6e522b2f97a03e6dc0c848b8d6d45d77000f36ca5f08a3b6dc4ce6433
+  data.tar.gz: 8d5a3f9e31fe5f1bf514e0b7deb2c6269a6acce629f14d18078110165994cda2
 SHA512:
-  metadata.gz: 584c186148b1038d4aadbdd1ee4cb230ee32b40332aca1888933a2ac2813ad61dd356eb548701ab52a10a9e426122ba70e6022cc6254001431b3fd2e51c3d198
-  data.tar.gz: 7048a1acf02560a3311d3956d09ce76d25651a631bf7b4a169d7513d28f4f656142ec93a0f44fff6667022d8651f07cdc81104b2eab969c5dabb0468c65bc72e
+  metadata.gz: d9b80ce8946b5614c07d15e7625f366186bfdbb463b807faa4b18458af32ea69c623214ac87b83f165d683e49047d1fdada5222ac299b8d2bb53d3c3ca8d2e3d
+  data.tar.gz: b05ffbd75a2fd6744c71b211aa966c72e74cba905a73cd4efdbb1dde43a3809314d0da4be8626609b9b761fa85f2b96872d8eb01826b6c27a4ce78226999f0cb

data/.rubocop.yml

@@ -0,0 +1,8 @@
+LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: False
+
+Style/SymbolArray:
+  Enabled: False

data/CHANGELOG.md

@@ -0,0 +1,126 @@
+# Change Log
+
+## [v2.4.0](https://github.com/infinum/enumerations/tree/v2.4.0) (2019-02-07)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.3.3...v2.4.0)
+
+**Implemented enhancements:**
+
+- Add `translate_attributes` configuration option to disable translation of attributes
+
+## [v2.3.3](https://github.com/infinum/enumerations/tree/v2.3.1) (2019-19-09)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.3.2...v2.3.3)
+
+## [v2.3.2](https://github.com/infinum/enumerations/tree/v2.3.1) (2019-03-27)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.3.1...v2.3.2)
+
+## [v2.3.1](https://github.com/infinum/enumerations/tree/v2.3.1) (2017-09-08)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.3.0...v2.3.1)
+
+## [v2.3.0](https://github.com/infinum/enumerations/tree/v2.3.0) (2017-09-08)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.2.3...v2.3.0)
+
+**Implemented enhancements:**
+
+- Setting attribute to nil if enumeration value is unknown - surprising? [\#35](https://github.com/infinum/enumerations/issues/35)
+- Add `without` methods [\#31](https://github.com/infinum/enumerations/issues/31)
+- Add methods with '?' [\#19](https://github.com/infinum/enumerations/issues/19)
+- Add with\_enumeration\(enumeration\) scope [\#18](https://github.com/infinum/enumerations/issues/18)
+
+**Closed issues:**
+
+- Not assigning the enumeration when tweaking the primary and foreign key [\#32](https://github.com/infinum/enumerations/issues/32)
+- Undocumented feature - can't set attribute if it's not in the enumeration [\#30](https://github.com/infinum/enumerations/issues/30)
+
+**Merged pull requests:**
+
+- Feature/raising error on invalid enumeration value [\#38](https://github.com/infinum/enumerations/pull/38) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Bugfix/config options [\#37](https://github.com/infinum/enumerations/pull/37) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Feature/predicate methods for attributes [\#36](https://github.com/infinum/enumerations/pull/36) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Feature/without scopes [\#34](https://github.com/infinum/enumerations/pull/34) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Feature/with enumeration scope [\#33](https://github.com/infinum/enumerations/pull/33) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v2.2.3](https://github.com/infinum/enumerations/tree/v2.2.3) (2017-03-17)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.2.2...v2.2.3)
+
+## [v2.2.2](https://github.com/infinum/enumerations/tree/v2.2.2) (2017-03-01)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.2.1...v2.2.2)
+
+**Implemented enhancements:**
+
+- Add id and quoted\_id methods [\#20](https://github.com/infinum/enumerations/issues/20)
+
+**Fixed bugs:**
+
+- Error when assiging nil [\#21](https://github.com/infinum/enumerations/issues/21)
+
+**Closed issues:**
+
+- upgrade to new codeclimate reporter [\#25](https://github.com/infinum/enumerations/issues/25)
+- Giving a invalid enum name raises an error [\#23](https://github.com/infinum/enumerations/issues/23)
+- Make second argument to Enumerations.value optional [\#22](https://github.com/infinum/enumerations/issues/22)
+
+**Merged pull requests:**
+
+- Make second argument to Enumerations.value optional [\#28](https://github.com/infinum/enumerations/pull/28) ([domagojnakic](https://github.com/domagojnakic))
+- Fix giving invalid enum name raises error [\#27](https://github.com/infinum/enumerations/pull/27) ([domagojnakic](https://github.com/domagojnakic))
+- Replaced CodeClimate::TestReporter with SimpleCov [\#26](https://github.com/infinum/enumerations/pull/26) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Add migration readme [\#24](https://github.com/infinum/enumerations/pull/24) ([Narayanan170](https://github.com/Narayanan170))
+
+## [v2.2.1](https://github.com/infinum/enumerations/tree/v2.2.1) (2016-09-20)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.2.0...v2.2.1)
+
+**Closed issues:**
+
+- Add option to store foreign\_key as string [\#14](https://github.com/infinum/enumerations/issues/14)
+
+**Merged pull requests:**
+
+- Bugfix/empty initializer [\#17](https://github.com/infinum/enumerations/pull/17) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v2.2.0](https://github.com/infinum/enumerations/tree/v2.2.0) (2016-09-19)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.1.0...v2.2.0)
+
+**Merged pull requests:**
+
+- Feature/remove [\#16](https://github.com/infinum/enumerations/pull/16) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v2.1.0](https://github.com/infinum/enumerations/tree/v2.1.0) (2016-08-19)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.0.0...v2.1.0)
+
+**Closed issues:**
+
+- Moved all back to Base [\#9](https://github.com/infinum/enumerations/issues/9)
+- I18n.locale [\#6](https://github.com/infinum/enumerations/issues/6)
+- Case statement [\#3](https://github.com/infinum/enumerations/issues/3)
+
+**Merged pull requests:**
+
+- Feature/where filtering [\#13](https://github.com/infinum/enumerations/pull/13) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Feature/localized attributes [\#12](https://github.com/infinum/enumerations/pull/12) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v2.0.0](https://github.com/infinum/enumerations/tree/v2.0.0) (2016-08-17)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v1.3.0...v2.0.0)
+
+**Merged pull requests:**
+
+- Update version to 2.0.0 [\#11](https://github.com/infinum/enumerations/pull/11) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Refactor [\#10](https://github.com/infinum/enumerations/pull/10) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v1.3.0](https://github.com/infinum/enumerations/tree/v1.3.0) (2016-08-11)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v1.1.1...v1.3.0)
+
+## [v1.1.1](https://github.com/infinum/enumerations/tree/v1.1.1) (2016-06-07)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v1.1.0...v1.1.1)
+
+**Merged pull requests:**
+
+- Bugfix/value-id [\#8](https://github.com/infinum/enumerations/pull/8) ([nikajukic](https://github.com/nikajukic))
+- Document configuration options [\#7](https://github.com/infinum/enumerations/pull/7) ([stankec](https://github.com/stankec))
+- Refactoring all around [\#5](https://github.com/infinum/enumerations/pull/5) ([janvarljen](https://github.com/janvarljen))
+- Added value method and support for custom attributes [\#4](https://github.com/infinum/enumerations/pull/4) ([PetarCurkovic](https://github.com/PetarCurkovic))
+- Some refactoring and updated README [\#2](https://github.com/infinum/enumerations/pull/2) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [v1.1.0](https://github.com/infinum/enumerations/tree/v1.1.0) (2012-08-19)
+**Merged pull requests:**
+
+- Gemspec. [\#1](https://github.com/infinum/enumerations/pull/1) ([neektza](https://github.com/neektza))

data/{Readme.md → README.md}

@@ -2,11 +2,11 @@ Enumerations
 ============
 
 [![Gem Version](https://badge.fury.io/rb/enumerations.svg)](https://badge.fury.io/rb/enumerations)
-[![Code Climate](https://codeclimate.com/github/infinum/enumerations/badges/gpa.svg)](https://codeclimate.com/github/infinum/enumerations)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c3b96c5afceaa9be2173/maintainability)](https://codeclimate.com/github/infinum/enumerations/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c3b96c5afceaa9be2173/test_coverage)](https://codeclimate.com/github/infinum/enumerations/test_coverage)
 [![Build Status](https://semaphoreci.com/api/v1/infinum/enumerations/branches/master/shields_badge.svg)](https://semaphoreci.com/infinum/enumerations)
-[![Test Coverage](https://codeclimate.com/github/infinum/enumerations/badges/coverage.svg)](https://codeclimate.com/github/infinum/enumerations/coverage)
 
-Rails plugin for enumerations in ActiveRecord models.
+Rails plugin for Enumerations in ActiveRecord models.
 
 Installation
 ============
@@ -83,6 +83,8 @@ Or you can set enumerations by `symbol`:
 @post.status = Status.find(:draft)
 ```
 
+> If you try to set value that is not an Enumeration value (except `nil`), you will get an `Enumerations::InvalidValueError` exception. You can turn this exception off in configuration.
+
 Also, you can set enumeration value like this:
 
 ```ruby
@@ -175,6 +177,14 @@ following format:
 
 ```ruby
 with_#{enumeration_name}_#{enumeration_value_name}
+without_#{enumeration_name}_#{enumeration_value_name}
+```
+
+or you can use the following scope and pass an array of enumerations:
+
+```ruby
+with_#{enumeration_name}(enumeration, ...)
+without_#{enumeration_name}(enumeration, ...)
 ```
 
 Examples:
@@ -185,7 +195,13 @@ class Post < ActiveRecord::Base
 end
 
 Post.with_status_draft                        # => <#ActiveRecord::Relation []>
-Post.with_status_review_pending               # => <#ActiveRecord::Relation []>
+Post.without_status_review_pending            # => <#ActiveRecord::Relation []>
+Post.with_status(:draft)                      # => <#ActiveRecord::Relation []>
+Post.without_status(:draft)                   # => <#ActiveRecord::Relation []>
+Post.with_status(Status.draft)                # => <#ActiveRecord::Relation []>
+Post.with_status(:draft, :review_pending)     # => <#ActiveRecord::Relation []>
+Post.with_status(Status.draft, 'published')   # => <#ActiveRecord::Relation []>
+Post.with_status([:draft, :review_pending])   # => <#ActiveRecord::Relation []>
 ```
 
 ```ruby
@@ -195,6 +211,8 @@ end
 
 Post.with_my_status_draft                      # => <#ActiveRecord::Relation []>
 Post.with_my_status_review_pending             # => <#ActiveRecord::Relation []>
+Post.with_my_status(:draft)                    # => <#ActiveRecord::Relation []>
+Post.without_my_status(:draft)                 # => <#ActiveRecord::Relation []>
 ```
 
 Each scope returns all records with specified enumeration value.
@@ -212,6 +230,32 @@ Use in forms:
   = f.collection_select :status, Status.all, :symbol, :name
 ```
 
+
+
+## Validating input
+
+Enumerations will by default raise an exception if you try to set an invalid value. This prevents usage of validations, which you might want to add if you're developing an API and have to return meaningful errors to API clients.
+
+You can enable validations by first disabling error raising on invalid input (see [configuration](#configuration)). Then, you should add an inclusion validation to enumerated attributes:
+```ruby
+class Post < ActiveRecord::Base
+  enumeration :status
+
+  validates :status, inclusion: { in: Status.all }
+end
+```
+
+You'll now get an appropriate error message when you insert an invalid value:
+```ruby
+> post = Post.new(status: 'invalid')
+> post.valid?
+=> false
+> post.errors.full_messages.to_sentence
+=> "Status is not included in the list"
+> post.status
+=> "invalid"
+```
+
 Advanced Usage
 =====
 
@@ -219,7 +263,7 @@ Except `name` you can specify any other attributes to your enumerations:
 
 ```ruby
 class Status < Enumerations::Base
-  value :draft,           id: 1, name: 'Draft'
+  value :draft,           id: 1, name: 'Draft', published: false
   value :review_pending,  id: 2, name: 'Review pending', description: 'Some description...'
   value :published,       id: 3, name: 'Published', published: true
   value :other                                 # passing no attributes is also allowed
@@ -234,10 +278,20 @@ Status.review_pending.description              # => 'Some description...'
 Status.draft.description                       # => nil
 ```
 
+For each attribute, you have predicate method. Predicate methods are actually calling `present?`
+method on attribute value:
+
+```ruby
+Status.draft.name?                             # => true
+Status.draft.published?                        # => false
+Status.published.published?                    # => true
+Status.other.name?                             # => false
+```
+
 Translations
 =====
 
-**Enumerations** uses power of I18n API to enable you to create a locale file
+**Enumerations** uses power of I18n API (if translate_attributes configuration is set to true) to enable you to create a locale file
 for enumerations like this:
 
 ```yaml
@@ -269,8 +323,8 @@ Configuration
 
 Basically no configuration is needed.
 
-**Enumerations** has two configuration options.
-You can customize primary key and foreign key suffix.
+**Enumerations** has four configuration options.
+You can customize primary key, foreign key suffix, whether to translate attributes and whether to raise `Enumerations::InvalidValueError` exception when setting invalid values.
 Just add initializer file to `config/initializers/enumerations.rb`.
 
 Example of configuration:
@@ -279,8 +333,10 @@ Example of configuration:
 # config/initializers/enumerations.rb
 
 Enumerations.configure do |config|
-  config.primary_key        = :id
-  config.foreign_key_suffix = :id
+  config.primary_key               = :id
+  config.foreign_key_suffix        = :id
+  config.translate_attributes      = true
+  config.raise_invalid_value_error = true
 end
 ```
 
@@ -291,7 +347,7 @@ If you set enumeration as:
 ```ruby
 enumeration :status
 ```
-then model should have `status`column (as `String` type).
+then model should have `status` column (as `String` type).
 If you want save an `ID` to this column, you can set `foreign_key_suffix` to `id`.
 Then model should have `status_id` column.
 
@@ -323,6 +379,17 @@ post = Post.new
 post.status = Status.draft      # => post.status_id = 1
 ```
 
+If you want to configure primary key per enumeration class, you can use `primary_key=` class method:
+
+```ruby
+class Status < Enumerations::Base
+  self.primary_key = :id
+
+  value :draft,           id: 1, name: 'Draft'
+  value :review_pending,  id: 2, name: 'Review pending'
+end
+```
+
 Database Enumerations
 =====================
 
@@ -360,7 +427,7 @@ Credits
 =======
 **Enumerations** is maintained and sponsored by [Infinum](https://infinum.co)
 
-Copyright © 2016 Infinum Ltd.
+Copyright © 2010 - 2018 Infinum Ltd.
 
 License
 =======

data/enumerations.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/enumerations/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'enumerations'
   s.version     = Enumerations::VERSION
-  s.date        = '2016-09-20'
+  s.date        = '2017-09-08'
   s.summary     = 'Enumerations for ActiveRecord!'
   s.description = 'Extends ActiveRecord with enumeration capabilites.'
   s.homepage    = 'https://github.com/infinum/enumerations'
@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'i18n'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
-  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3', '~> 1.4.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/enumerations.rb

@@ -7,7 +7,7 @@ require 'enumerations/configuration'
 require 'enumerations/version'
 require 'enumerations/base'
 require 'enumerations/reflection'
-require 'enumerations/enumerations_error'
+require 'enumerations/errors'
 
 module Enumerations
   extend ActiveSupport::Concern
@@ -52,13 +52,23 @@ module Enumerations
       _enumerations
     end
 
+    def fetch_foreign_key_values(reflection, *symbols)
+      symbols.flatten.map do |symbol|
+        enumeration_value = reflection.enumerator_class.find(symbol)
+
+        enumeration_value &&
+          enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
+      end
+    end
+
     private
 
     def add_enumeration(reflection)
       define_getter_method(reflection)
       define_setter_method(reflection)
       define_bang_methods(reflection)
-      define_scopes(reflection)
+      define_scopes_for_each_enumeration_value(reflection)
+      define_enumeration_scope(reflection)
 
       self._enumerations += [reflection]
     end
@@ -72,7 +82,7 @@ module Enumerations
     #
     def define_getter_method(reflection)
       define_method(reflection.name) do
-        reflection.enumerator_class.find(self[reflection.foreign_key])
+        reflection.enumerator_class.find(self[reflection.foreign_key]) || self[reflection.foreign_key]
       end
     end
 
@@ -86,9 +96,15 @@ module Enumerations
       define_method("#{reflection.name}=") do |other|
         enumeration_value = reflection.enumerator_class.find(other)
 
-        self[reflection.foreign_key] =
-          enumeration_value &&
-          enumeration_value.send(Enumerations.configuration.primary_key || :symbol)
+        if other.present? && enumeration_value.nil?
+          raise Enumerations::InvalidValueError if Enumerations.configuration.raise_invalid_value_error
+
+          self[reflection.foreign_key] = other
+        else
+          self[reflection.foreign_key] =
+            enumeration_value &&
+            enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
+        end
       end
     end
 
@@ -116,14 +132,37 @@ module Enumerations
     #   User.with_role_admin => <#ActiveRecord::Relation []>
     #   User.with_role_editor => <#ActiveRecord::Relation []>
     #
-    def define_scopes(reflection)
+    def define_scopes_for_each_enumeration_value(reflection)
       reflection.enumerator_class.all.each do |enumeration|
-        foreign_key = enumeration.send(Enumerations.configuration.primary_key || :symbol)
+        foreign_key = enumeration.send(reflection.enumerator_class.primary_key || :symbol)
+
+        scope("with_#{reflection.name}_#{enumeration.symbol}",
+              -> { where(reflection.foreign_key => foreign_key) })
 
-        scope "with_#{reflection.name}_#{enumeration.symbol}",
-              -> { where(reflection.foreign_key => foreign_key) }
+        scope("without_#{reflection.name}_#{enumeration.symbol}",
+              -> { where.not(reflection.foreign_key => foreign_key) })
       end
     end
+
+    # Scope for enumerated ActiveRecord model.
+    # Format of scope name is with_#{enumeration_name}(*enumerations).
+    #
+    # Example:
+    #
+    #   User.with_role(:admin) => <#ActiveRecord::Relation []>
+    #   User.with_role(:admin, Role.editor) => <#ActiveRecord::Relation []>
+    #
+    def define_enumeration_scope(reflection)
+      scope("with_#{reflection.name}",
+            lambda do |*symbols|
+              where(reflection.foreign_key => fetch_foreign_key_values(reflection, symbols))
+            end)
+
+      scope("without_#{reflection.name}",
+            lambda do |*symbols|
+              where.not(reflection.foreign_key => fetch_foreign_key_values(reflection, symbols))
+            end)
+    end
   end
 end
 

data/lib/enumerations/base.rb

@@ -4,14 +4,15 @@ require 'enumerations/value'
 require 'enumerations/finder_methods'
 
 module Enumerations
-  class Base
+  class Base < ActiveSupport::Multibyte::Chars
     extend Enumerations::FinderMethods
     include Enumerations::Value
 
-    class_attribute :_values, :_symbol_index
+    class_attribute :_values, :_symbol_index, :_primary_key
 
     self._values = {}
     self._symbol_index = {}
+    self._primary_key = nil
 
     # Adding new value to enumeration
     #
@@ -79,16 +80,45 @@ module Enumerations
       _values.values
     end
 
+    # Sets primary key for enumeration class.
+    #
+    # Example:
+    #
+    #   class Status < Enumeration::Base
+    #     primary_key = :id
+    #   end
+    #
+    def self.primary_key=(key)
+      self._primary_key = key && key.to_sym
+    end
+
+    # Gets primary key for enumeration class.
+    #
+    # Example:
+    #
+    #   Status.primary_key  => # nil
+    #
+    #   class Status < Enumeration::Base
+    #     primary_key = :id
+    #   end
+    #
+    #   Status.primary_key  => # :id
+    #
+    def self.primary_key
+      _primary_key || Enumerations.configuration.primary_key
+    end
+
     def self.validate_symbol_and_primary_key(symbol, attributes)
-      raise EnumerationsError, "Duplicate symbol #{symbol}" if find(symbol)
+      raise Enumerations::DuplicatedSymbolError if find(symbol)
 
-      primary_key = Enumerations.configuration.primary_key
       return if primary_key.nil?
 
-      raise EnumerationsError, 'Enumeration primary key is required' if attributes[primary_key].nil?
-      raise EnumerationsError, "Duplicate primary key #{attributes[primary_key]}" if find(attributes[primary_key])
+      primary_key_value = attributes[primary_key]
 
-      self._symbol_index = _symbol_index.merge(symbol => attributes[primary_key])
+      raise Enumerations::MissingPrimaryKeyError if primary_key_value.nil?
+      raise Enumerations::DuplicatedPrimaryKeyError if find(primary_key_value)
+
+      self._symbol_index = _symbol_index.merge(symbol => primary_key_value)
     end
 
     private_class_method :validate_symbol_and_primary_key
@@ -96,6 +126,8 @@ module Enumerations
     attr_reader :symbol, :attributes
 
     def initialize(symbol, attributes)
+      super(symbol)
+
       @symbol = symbol
       @attributes = attributes
 

data/lib/enumerations/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerations
   def self.configuration
     @configuration ||= Configuration.new
@@ -14,10 +16,14 @@ module Enumerations
   class Configuration
     attr_accessor :primary_key
     attr_accessor :foreign_key_suffix
+    attr_accessor :translate_attributes
+    attr_accessor :raise_invalid_value_error
 
     def initialize
-      @primary_key        = nil
-      @foreign_key_suffix = nil
+      @primary_key               = nil
+      @foreign_key_suffix        = nil
+      @translate_attributes      = true
+      @raise_invalid_value_error = true
     end
   end
 end

data/lib/enumerations/errors.rb

@@ -0,0 +1,7 @@
+module Enumerations
+  class Error < StandardError; end
+  class DuplicatedSymbolError < Error; end
+  class MissingPrimaryKeyError < Error; end
+  class DuplicatedPrimaryKeyError < Error; end
+  class InvalidValueError < Error; end
+end

data/lib/enumerations/finder_methods.rb

@@ -39,7 +39,9 @@ module Enumerations
     end
 
     def find_by_primary_key(primary_key)
-      value_from_symbol_index(primary_key) || value_from_symbol_index(primary_key.to_s.to_i)
+      return value_from_symbol_index(primary_key.to_i) if primary_key.is_a?(String)
+
+      value_from_symbol_index(primary_key)
     end
 
     private

data/lib/enumerations/reflection.rb

@@ -1,6 +1,6 @@
 module Enumerations
   class Reflection
-    attr_reader :name
+    attr_reader :name, :options
 
     def initialize(name, options = {})
       @name = name
@@ -8,11 +8,11 @@ module Enumerations
     end
 
     def class_name
-      @class_name ||= (@options[:class_name] || name).to_s.camelize
+      @class_name ||= (options[:class_name] || name).to_s.camelize
     end
 
     def foreign_key
-      @foreign_key ||= (@options[:foreign_key] || default_foreign_key_name).to_sym
+      @foreign_key ||= (options[:foreign_key] || default_foreign_key_name).to_sym
     end
 
     def enumerator_class

data/lib/enumerations/value.rb

@@ -39,6 +39,7 @@ module Enumerations
     def create_instance_methods
       define_attributes_getters
       define_value_checking_method
+      define_predicate_methods_for_attributes
     end
 
     # Getters for all attributes
@@ -65,6 +66,8 @@ module Enumerations
     end
 
     def translate_attribute(key, locale)
+      return @attributes[key].to_s unless Enumerations.configuration.translate_attributes
+
       I18n.t(key, scope: [:enumerations, self.class.name.demodulize.underscore, symbol],
                   default: @attributes[key].to_s,
                   locale: locale)
@@ -83,5 +86,28 @@ module Enumerations
         __callee__[0..-2].to_sym == symbol
       end
     end
+
+    # Predicate methods for all attributes
+    #
+    # Example:
+    #
+    #   class Role < Enumerations::Base
+    #     value :admin, name: 'Administrator', active: false
+    #   end
+    #
+    #   user.role.name?       => # true
+    #   user.role.admin?      => # false
+    #
+    def define_predicate_methods_for_attributes
+      @attributes.each do |key, _|
+        method_name = "#{key}?"
+
+        next if respond_to?(method_name.to_sym)
+
+        self.class.send :define_method, method_name do
+          @attributes[key].present?
+        end
+      end
+    end
   end
 end

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.2.3'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/test/base_test.rb

@@ -16,7 +16,7 @@ class BaseTest < Minitest::Test
   end
 
   def test_duplicated_symbol
-    assert_raises EnumerationsError, 'Duplicate symbol draft' do
+    assert_raises Enumerations::DuplicatedSymbolError do
       obj = Class.new(Enumerations::Base)
 
       obj.value :draft, id: 1, name: 'Draft'

data/test/configuration/custom_configuration_test.rb

@@ -0,0 +1,27 @@
+module Configuration
+  ::CustomConfigurationEnum = Class.new(Enumerations::Base)
+
+  CustomConfigurationEnum.primary_key = :id
+  CustomConfigurationEnum.value :draft, id: 1
+
+  ::CustomConfigurationModel = Class.new(ActiveRecord::Base)
+  CustomConfigurationModel.table_name = :custom_models
+  CustomConfigurationModel.enumeration :custom_configuration_enum, foreign_key: :custom_enum_id
+
+  class CustomConfigurationTest < Minitest::Test
+    def test_primary_key_value
+      assert_equal :id, CustomConfigurationEnum.primary_key
+    end
+
+    def test_primary_key_value_is_not_set_in_configuration
+      assert_nil Enumerations.configuration.primary_key
+    end
+
+    def test_value_set_for_custom_foreign_key_config
+      model = CustomConfigurationModel.new
+      model.custom_configuration_enum = :draft
+
+      assert_equal :draft, model.custom_configuration_enum.symbol
+    end
+  end
+end

data/test/configuration_test.rb

@@ -37,7 +37,7 @@ class ConfigurationTest < Minitest::Test
   def test_required_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises EnumerationsError, 'Enumeration primary key is required' do
+    assert_raises Enumerations::MissingPrimaryKeyError, 'Enumeration primary key is required' do
       Class.new(Enumerations::Base).value :draft, name: 'Draft'
     end
   end
@@ -45,7 +45,7 @@ class ConfigurationTest < Minitest::Test
   def test_duplicated_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises EnumerationsError, 'Duplicate primary key 1' do
+    assert_raises Enumerations::DuplicatedPrimaryKeyError, 'Duplicate primary key 1' do
       Class.new(Enumerations::Base).values draft: { id: 1, name: 'Draft' },
                                            test:  { id: 1, name: 'Draft' }
     end

data/test/enumerations_test.rb

@@ -1,5 +1,5 @@
 require_relative 'helpers/test_helper'
-require 'enumerations/enumerations_error'
+require 'enumerations/errors'
 
 class EnumerationsTest < Minitest::Test
   def test_reflect_on_all_enumerations
@@ -75,21 +75,76 @@ class EnumerationsTest < Minitest::Test
     assert_equal 'published', u.status.to_s
   end
 
+  def test_enumerated_class_has_enumeration_scope
+    assert_respond_to User, :with_role
+  end
+
   def test_enumerated_class_has_scopes
     Role.all.each do |role|
       assert_respond_to User, ['with_role', role.to_s].join('_').to_sym
     end
   end
 
-  def test_enumerated_class_scope_hash_value
+  def test_enumerated_class_enumeration_scope_hash_value
+    query_hash = User.with_role(:admin).where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: :admin
+  end
+
+  def test_enumerated_class_enumeration_without_scope_results
+    User.create(role: :admin)
+    User.create(role: :editor)
+
+    results = User.without_role(:admin)
+
+    assert_equal results, User.where.not(role: :admin)
+  end
+
+  def test_enumerated_class_enumeration_scope_hash_value_for_multiple_enums
+    query_hash = User.with_role(:admin, Role.author, 'editor').where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: [:admin, :author, :editor]
+  end
+
+  def test_enumerated_class_enumeration_scope_hash_value_for_multiple_enums_as_array
+    query_hash = User.with_role([:admin, Role.author, 'editor']).where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: [:admin, :author, :editor]
+  end
+
+  def test_enumerated_class_without_scope_hash_value
     query_hash = User.with_role_admin.where_values_hash.symbolize_keys
 
     assert_equal query_hash, role: :admin
   end
 
+  def test_enumerated_class_without_scope_results
+    User.create(role: :admin)
+    User.create(role: :editor)
+
+    results = User.without_role_admin
+
+    assert_equal results, User.where.not(role: :admin)
+  end
+
   def test_nonexistent_value_assignment
+    assert_raises Enumerations::InvalidValueError do
+      User.new(role: :nonexistent_value)
+    end
+  end
+
+  def test_nonexistent_value_assignment_with_error_raising_turned_off
+    Enumerations.configuration.raise_invalid_value_error = false
+
     user = User.new(role: :nonexistent_value)
-    assert_nil user.role
+
+    assert_equal user.role, 'nonexistent_value'
+
+    user.role = :other_nonexistent_value
+
+    assert_equal user.role, 'other_nonexistent_value'
+
+    Enumerations.configuration.raise_invalid_value_error = true
   end
 
   def test_on_nil_value_assignment

data/test/translation_test.rb

@@ -91,4 +91,13 @@ class TranslationTest < Minitest::Test
 
     assert_nil status
   end
+
+  def test_turn_of_translate
+    status = Status.find(:draft)
+    Enumerations.configuration.translate_attributes = false
+    name = status.name
+    Enumerations.configuration.translate_attributes = true
+
+    assert_equal name, 'Draft'
+  end
 end

data/test/value_test.rb

@@ -68,4 +68,18 @@ class ValueTest < Minitest::Test
 
     assert_equal role.type, 'croatist'
   end
+
+  def test_enumeration_attribute_predicate_methods
+    status = Status.none
+
+    assert_equal status.name?, true
+    assert_equal status.visible?, true
+    assert_equal status.deleted?, false
+  end
+
+  def test_enumeration_attribute_predicate_method_on_undefined_attribute
+    status = Status.deleted
+
+    assert_equal status.name?, false
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Tomislav Car
@@ -9,10 +9,10 @@ authors:
 - Nikola Santić
 - Stjepan Hadjić
 - Petar Ćurković
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -85,33 +85,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 description: Extends ActiveRecord with enumeration capabilites.
 email:
 - tomislav@infinum.hr
@@ -124,21 +124,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
-- Migrate.md
+- MIGRATE.md
+- README.md
 - Rakefile
-- Readme.md
 - enumerations.gemspec
 - lib/enumerations.rb
 - lib/enumerations/base.rb
 - lib/enumerations/configuration.rb
-- lib/enumerations/enumerations_error.rb
+- lib/enumerations/errors.rb
 - lib/enumerations/finder_methods.rb
 - lib/enumerations/reflection.rb
 - lib/enumerations/value.rb
 - lib/enumerations/version.rb
 - test/base_test.rb
 - test/configuration/configuration.rb
+- test/configuration/custom_configuration_test.rb
 - test/configuration/enumerations_test.rb
 - test/configuration/finder_test.rb
 - test/configuration_test.rb
@@ -154,7 +157,7 @@ files:
 homepage: https://github.com/infinum/enumerations
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,14 +172,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files:
 - test/base_test.rb
 - test/configuration/configuration.rb
+- test/configuration/custom_configuration_test.rb
 - test/configuration/enumerations_test.rb
 - test/configuration/finder_test.rb
 - test/configuration_test.rb

data/lib/enumerations/enumerations_error.rb

@@ -1,2 +0,0 @@
-class EnumerationsError < RuntimeError
-end