enumerations 2.4.0 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a43aa264af10522517e6bfcf47daee1ea28d382d2187ca12690d19f2018781b
-  data.tar.gz: ba01b7f7c44242da5a792839038a3967719e9a2bd6edc9ff8dc73cf66f1d090e
+  metadata.gz: 7415435429c08e2093220592c091dffca83b50fd26f6d71836873594da483778
+  data.tar.gz: 63538f83e93d43926f2401297c213a03c814efb667d96259f8f86cfa241072e3
 SHA512:
-  metadata.gz: 4032983040ac1421779fc12c5433635e572073c6b2da731294de2696dc8074aa4c42677d5831b9e3e02f9ae6deecf0d2a6d91e792d6a1c360ff20cec05a9a41d
-  data.tar.gz: 7dbd89ebab4b368b5971fb011ab386bc5ad25d6670d8f3c9225c0ccf44a5e353d8903ec997e970ef1fafd01b3c5ad7fd03e8d76a5f407e6440fd50cf47e2bba7
+  metadata.gz: dfcb47a129cd32afa78c25897aa681bef271266c878ba9fc077df12ed15543ebdab1f97e71c580adb9e19523bbf3287b3ec0a46a52b247f42030c4f9ade31b1d
+  data.tar.gz: 2dbce2808dcadd1cb3e0b16193b9f66e567846c8d9dca89478d30edc6c1b583e8b8b9e8443e08ec162e7e30dc78423cf7b90edf5de41de2b64722b664785a1d2

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,59 @@
 # Change Log
 
+## [v2.5.3](https://github.com/infinum/enumerations/tree/v2.5.3) (2022-02-02)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.2...v2.5.3)
+
+**Fixed bugs:**
+
+- Prevent `method_missing` instantiates new instance of `Enumerations::Base`; returns `String` instead
+
+**Merged pull requests:**
+
+- Prevent method_missing to instantiates new Enumerations::Base [\#58](https://github.com/infinum/enumerations/pull/58) ([PetarCurkovic](https://github.com/PetarCurkovic))
+
+## [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

@@ -4,7 +4,7 @@ Enumerations
 [![Gem Version](https://badge.fury.io/rb/enumerations.svg)](https://badge.fury.io/rb/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)
+![Build Status](https://github.com/infinum/enumerations/actions/workflows/test.yml/badge.svg)
 
 Rails plugin for Enumerations in ActiveRecord models.
 
@@ -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/base.rb

@@ -126,12 +126,18 @@ module Enumerations
     attr_reader :symbol, :attributes
 
     def initialize(symbol, attributes)
-      super(symbol)
+      super(symbol.to_s)
 
       @symbol = symbol
       @attributes = attributes
 
       create_instance_methods
     end
+
+    private
+
+    def chars(string)
+      string
+    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/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]
@@ -102,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.4.0'.freeze
+  VERSION = '2.5.3'.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/value_test.rb

@@ -82,4 +82,30 @@ 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
+
+  def test_string_methods_on_value
+    enum = Class.new(Enumerations::Base) do
+      value :foobar
+    end
+
+    assert_equal enum.foobar.upcase, 'FOOBAR'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.3
 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
@@ -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: []