enumerations 2.3.1 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce06adb418c77b2cfe89af486bff75362b4183bc
-  data.tar.gz: e65afcbf46c76d46625443de26b52445a7a12a29
+SHA256:
+  metadata.gz: 54447b9967c65df1318cac0ec59daab41b5f41ad118ad0ba32e260b8cbcf36d9
+  data.tar.gz: fa276b02570956e52d22915957154a125585983c5a2923453d3cc0c6146d908f
 SHA512:
-  metadata.gz: 168a363ddbbcf47dbe58f2024d455c6b5aae795360b92ad947d77f396ca25a4714067e4affb7e283d72ba80539d42f573d83cec68e68d2ba3d8334721f1e346e
-  data.tar.gz: d09864e055364e4415870471d0ed16f2f00a7a2afbda0604f4d8dd37c65d165054de7524a5ac62f5173d71bd4c8eca4a626d6993ff06d4d6fa15d7ee1cab125f
+  metadata.gz: 63e002298b8365cc55c296d85963b3bf410bcd02501394666d45efbfffd3f0fd70a276e9413a51b3a7c81571599f9958a98a3d0b9d5c7671cff60cfd77002591
+  data.tar.gz: f7e3d0337b42d668fe78a6ea3037ad59820803db1ae65f1ddbcfaf6fcfc1e5d19e6081c0582fc5a1766e27b2c24747901117d78e9f03f2b5e690b87e79a7bb8f

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-18.04
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
+
+    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

@@ -0,0 +1,140 @@
+# Change Log
+
+## [v2.5.1](https://github.com/infinum/enumerations/tree/v2.5.1) (YYYY-MM-DD)
+[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)
+
+## [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,9 +2,9 @@ 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.
 
@@ -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
 ```
 
@@ -399,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

@@ -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

@@ -52,6 +52,15 @@ 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)
@@ -73,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
 
@@ -87,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
 
@@ -150,15 +163,6 @@ module Enumerations
               where.not(reflection.foreign_key => fetch_foreign_key_values(reflection, symbols))
             end)
     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
   end
 end
 

data/lib/enumerations/base.rb

@@ -4,7 +4,7 @@ require 'enumerations/value'
 require 'enumerations/finder_methods'
 
 module Enumerations
-  class Base
+  class Base < ActiveSupport::Multibyte::Chars
     extend Enumerations::FinderMethods
     include Enumerations::Value
 
@@ -126,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/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)
@@ -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/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.1'.freeze
+  VERSION = '2.5.1'.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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.5.1
 platform: ruby
 authors:
 - Tomislav Car
@@ -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
@@ -123,12 +123,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
-- Migrate.md
+- MIGRATE.md
+- README.md
 - Rakefile
-- Readme.md
 - enumerations.gemspec
 - lib/enumerations.rb
 - lib/enumerations/base.rb
@@ -171,24 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.1
 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: []