enumerations 2.3.3 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3236e6559134898d597bcdd10d713f1e8b0221ebc86c40c51b99ee99b9a902f
-  data.tar.gz: a16037b68fca739949c3952260e44cde3ad904de8072ea4f9fe9216870bba39b
+  metadata.gz: 34bf65bbe1b914b7d56e3b2ef93b0379deccc09709e37900ea4d6ed8ea97fa3d
+  data.tar.gz: da852c0b54ab6c0013564f2b30b0d6df7ccdb1ddd6017c551d078994874f3691
 SHA512:
-  metadata.gz: 375ca1a05df8bf65c6ecf4086fd9bb0a4db797398079a9b414aea37851f7ed1bcf56f88b2acfeb2e509a9b4f674b9ce45b2c807377acb8ed5253d981625f5134
-  data.tar.gz: 4e02e59780bc7321acf18233b784dfc0b3f1d45e9b8d97e7b43c2a3c99e8c9b688adb6a5a15d884b4d2d0def1b9918bd824c7936f84a55eb38de55d5779f46d4
+  metadata.gz: ee7e94705e02796314e0f494d6c55231173b76697d34c691e38bc511f7448216306af75fa016558247903210b965a19316fa358210dd83c00ea42e589f05d211
+  data.tar.gz: 485c5e53c7dd4b3b5a85c5725f321354e822907fddb64f76c14abeed130c084cd11ea77469376519e08897e594d75b3a5445b7fcc9c7f10c64160f1af344b8df

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test suite
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, '3.0', 3.1]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Change Log
 
+## [v2.5.2](https://github.com/infinum/enumerations/tree/v2.5.2) (2022-01-27)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.1...v2.5.2)
+
+**Implemented enhancements:**
+
+- Adds Ruby 3.1 to test suite. Changes the runner to ubuntu-latest.
+
+**Closed issues:**
+
+- Ruby 3.0, `respond_to? :name` always returns true [\#55](https://github.com/infinum/enumerations/issues/55)
+
+**Merged pull requests:**
+
+- Initialize `ActiveSupport::Multibyte::Chars` with a String [\#56](https://github.com/infinum/enumerations/pull/56) ([lovro-bikic](https://github.com/lovro-bikic))
+- Test against Ruby 3.1 [\#57](https://github.com/infinum/enumerations/pull/57) ([lovro-bikic](https://github.com/lovro-bikic))
+
+## [v2.5.1](https://github.com/infinum/enumerations/tree/v2.5.1) (2021-05-24)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.0...v2.5.1)
+
+**Implemented enhancements:**
+
+- Add support for Ruby 3 [\#52](https://github.com/infinum/enumerations/issues/52)
+
+## [v2.5.0](https://github.com/infinum/enumerations/tree/v2.5.0) (2021-03-03)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.4.0...v2.5.0)
+
+**Implemented enhancements:**
+
+- Add `raise_invalid_value_error` configuration option to disable raising errors on invalid values
+
+## [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
 =====
 
@@ -265,7 +291,7 @@ 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
@@ -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,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
 ```
 

data/enumerations.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  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/base.rb

@@ -126,7 +126,7 @@ module Enumerations
     attr_reader :symbol, :attributes
 
     def initialize(symbol, attributes)
-      super(symbol)
+      super(symbol.to_s)
 
       @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/finder_methods.rb

@@ -31,7 +31,7 @@ module Enumerations
     #   Role.find_by(name: 'Admin') => #<Enumerations::Value: @base=Role, @symbol=:admin...>
     #
     def find_by(**args)
-      where(args).first
+      where(**args).first
     end
 
     def find_by_key(key)

data/lib/enumerations/value.rb

@@ -54,7 +54,7 @@ module Enumerations
     #
     def define_attributes_getters
       @attributes.each do |key, _|
-        next if respond_to?(key)
+        next if self.class.method_defined?(key)
 
         self.class.send :define_method, key do |locale: I18n.locale|
           case @attributes[key]
@@ -66,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)
@@ -100,7 +102,7 @@ module Enumerations
       @attributes.each do |key, _|
         method_name = "#{key}?"
 
-        next if respond_to?(method_name.to_sym)
+        next if self.class.method_defined?(method_name.to_sym)
 
         self.class.send :define_method, method_name do
           @attributes[key].present?

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.3.3'.freeze
+  VERSION = '2.5.2'.freeze
 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/test/enumerations_test.rb

@@ -26,6 +26,12 @@ class EnumerationsTest < Minitest::Test
     assert_equal 'draft', p.status.to_s
   end
 
+  def test_model_uniqueness_validation
+    p = Post.new(status: :draft)
+
+    assert_equal true, p.valid?
+  end
+
   def test_model_bang_assignment_with_custom_name
     p = Post.new
     p.different_status_draft!
@@ -133,6 +139,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

data/test/helpers/test_helper.rb

@@ -32,6 +32,8 @@ end
 class Post < ActiveRecord::Base
   enumeration :status
   enumeration :different_status, foreign_key: :some_other_status, class_name: 'Status'
+
+  validates :status, uniqueness: true
 end
 
 class User < ActiveRecord::Base

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

@@ -82,4 +82,22 @@ class ValueTest < Minitest::Test
 
     assert_equal status.name?, false
   end
+
+  def test_enumeration_raises_error_for_nonexistent_attribute
+    enum = Class.new(Enumerations::Base) do
+      value :foobar
+    end
+
+    assert_raises NoMethodError do
+      enum.foobar.name
+    end
+  end
+
+  def test_enumeration_does_not_respond_to_nonexistent_attribute
+    enum = Class.new(Enumerations::Base) do
+      value :foobar
+    end
+
+    assert_equal enum.foobar.respond_to?(:name), false
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.5.2
 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
@@ -104,14 +104,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.0
 description: Extends ActiveRecord with enumeration capabilites.
 email:
 - tomislav@infinum.hr
@@ -123,6 +123,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -157,7 +158,7 @@ files:
 homepage: https://github.com/infinum/enumerations
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,24 +173,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.3.3
+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
-- test/enumerations_test.rb
-- test/finder_test.rb
-- test/helpers/database_helper.rb
-- test/helpers/locale_helper.rb
-- test/helpers/test_helper.rb
-- test/locales/hr.yml
-- test/reflection_test.rb
-- test/translation_test.rb
-- test/value_test.rb
+test_files: []