enumerations 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a43aa264af10522517e6bfcf47daee1ea28d382d2187ca12690d19f2018781b
-  data.tar.gz: ba01b7f7c44242da5a792839038a3967719e9a2bd6edc9ff8dc73cf66f1d090e
+  metadata.gz: 662c2ae6e522b2f97a03e6dc0c848b8d6d45d77000f36ca5f08a3b6dc4ce6433
+  data.tar.gz: 8d5a3f9e31fe5f1bf514e0b7deb2c6269a6acce629f14d18078110165994cda2
 SHA512:
-  metadata.gz: 4032983040ac1421779fc12c5433635e572073c6b2da731294de2696dc8074aa4c42677d5831b9e3e02f9ae6deecf0d2a6d91e792d6a1c360ff20cec05a9a41d
-  data.tar.gz: 7dbd89ebab4b368b5971fb011ab386bc5ad25d6670d8f3c9225c0ccf44a5e353d8903ec997e970ef1fafd01b3c5ad7fd03e8d76a5f407e6440fd50cf47e2bba7
+  metadata.gz: d9b80ce8946b5614c07d15e7625f366186bfdbb463b807faa4b18458af32ea69c623214ac87b83f165d683e49047d1fdada5222ac299b8d2bb53d3c3ca8d2e3d
+  data.tar.gz: b05ffbd75a2fd6744c71b211aa966c72e74cba905a73cd4efdbb1dde43a3809314d0da4be8626609b9b761fa85f2b96872d8eb01826b6c27a4ce78226999f0cb

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # 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)
 

data/README.md

@@ -83,7 +83,7 @@ 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.
+> 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:
 
@@ -230,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
 =====
 
@@ -297,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:
@@ -307,9 +333,10 @@ Example of configuration:
 # config/initializers/enumerations.rb
 
 Enumerations.configure do |config|
-  config.primary_key          = :id
-  config.foreign_key_suffix   = :id
-  config.translate_attributes = true
+  config.primary_key               = :id
+  config.foreign_key_suffix        = :id
+  config.translate_attributes      = true
+  config.raise_invalid_value_error = true
 end
 ```
 

data/lib/enumerations.rb

@@ -82,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
 
@@ -96,11 +96,15 @@ module Enumerations
       define_method("#{reflection.name}=") do |other|
         enumeration_value = reflection.enumerator_class.find(other)
 
-        raise Enumerations::InvalidValueError if other.present? && enumeration_value.nil?
+        if other.present? && enumeration_value.nil?
+          raise Enumerations::InvalidValueError if Enumerations.configuration.raise_invalid_value_error
 
-        self[reflection.foreign_key] =
-          enumeration_value &&
-          enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
+          self[reflection.foreign_key] = other
+        else
+          self[reflection.foreign_key] =
+            enumeration_value &&
+            enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
+        end
       end
     end
 

data/lib/enumerations/configuration.rb

@@ -17,11 +17,13 @@ module Enumerations
     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
-      @translate_attributes = true
+      @primary_key               = nil
+      @foreign_key_suffix        = nil
+      @translate_attributes      = true
+      @raise_invalid_value_error = true
     end
   end
 end

data/lib/enumerations/version.rb

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

data/test/enumerations_test.rb

@@ -133,6 +133,20 @@ class EnumerationsTest < Minitest::Test
     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_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
     user = User.new(role: nil)
     assert_nil user.role

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tomislav Car
@@ -9,7 +9,7 @@ authors:
 - Nikola Santić
 - Stjepan Hadjić
 - Petar Ćurković
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2017-09-08 00:00:00.000000000 Z
@@ -157,7 +157,7 @@ files:
 homepage: https://github.com/infinum/enumerations
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files: