enumerize 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f6c56fc7c04faa02a4b4e4c137d3e3b743426d040e3f58bb79377d2c896d98f
-  data.tar.gz: 1e1842411f2b914b6142d071e84c435f17dfdac0f87a61eb9bf0a45a469a7780
+  metadata.gz: 15a8427afecf01652e67b4758c05a499ba541254799d8ca61f0146f942647388
+  data.tar.gz: ee769906574712f378ca8dfb8aaadcfcc5993a485531cf520b44c41420e8fa84
 SHA512:
-  metadata.gz: b3c9a1fd651070c324e04f26dcf0539ed6d1a8666878106875b78acc00d6219c5525349e0f3557aa43eb6625986322063117f06f8162922b9ae1b91544593d10
-  data.tar.gz: 4f070511d3e8d06e13eef610b73b4e40b5db8bd73c7282aec5cf1203de78b09e323248ce9627b82a8c8ab0a8688a4e0e05ac6d4bf1659c3e5ff69cb86c435745
+  metadata.gz: 46edf9a1fed39c9122247957a64dab6a773f5d0a8d0176204e48bd9d28074019480c1ae3cf16ccc3ad7a185d64fb7cf92d9f1a5ec63a581a388d1dd4620ac651
+  data.tar.gz: 206734dd6819196fbdff49e89626d30e45cd29154a63151f8631c87d13d15c7bd2bae90916b411a7f7d71287fa5be5a742f281392348f3c330401dde9d4b72c2

data/.travis.yml

@@ -1,26 +1,21 @@
+dist: focal
 language: ruby
 sudo: false
 services:
-  - postgresql
   - mongodb
+addons:
+  postgresql: "13"
 gemfile:
   - Gemfile
-  - Gemfile.rails42
-  - Gemfile.rails50
-  - Gemfile.rails52
+  - Gemfile.rails60
+  - Gemfile.rails61
   - Gemfile.mongo_mapper
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-9.1.14.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 before_install:
-  # Rubygems > 3.0.0 no longer supported rubies < 2.3
-  - gem install "rubygems-update:<3.0.0" --no-document && update_rubygems
-  # Bundler 2.0 is not supported by Rails < 5
-  - gem list -i bundler -v '>= 2.0.0' && rvm @global do gem uninstall bundler -x || true
-  - gem install bundler -v '< 2'
+  - gem install bundler
 env:
   global:
     - DB_USER=postgres
@@ -30,8 +25,6 @@ env:
     - DB=postgresql
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: jruby-9.1.14.0
   exclude:
     - gemfile: Gemfile.mongo_mapper
       env: DB=postgresql

data/CHANGELOG.md

@@ -1,9 +1,18 @@
-## master
+## 2.4.0 (December 12, 2020)
 
 ### enhancements
 
+* Show warning when enumerized value name conflicts with existing object's methods. (by [@aki77](https://github.com/aki77))
+* Add RSpec support for shallow scopes. (by [@nashby](https://github.com/nashby))
+* Drop support for Ruby older than 2.5. Support only Ruby 2.5+. (by [@nashby](https://github.com/nashby))
+* Drop support for Rails 4. Support only Rails 5.2+. (by [@nashby](https://github.com/nashby))
+* Add support for Rails 6.1 (by [@y-yagi](https://github.com/y-yagi))
+
 ### bug fix
 
+* Fix exception when using predicate methods on enumerized value transformed into invalid value. (by [@guigs](https://github.com/guigs))
+* Fix issue with RSpec#with_predicates matcher when custom values are used as attribute. (by [@nashby](https://github.com/nashby))
+
 ## 2.3.1 (May 2, 2019)
 
 ### enhancements

data/Gemfile

@@ -1,7 +1,6 @@
 eval_gemfile('Gemfile.global')
 
 gem 'minitest', '~> 5.8'
-gem 'rails',    '5.1.4', require: false
-gem 'activerecord-jdbcsqlite3-adapter', '~> 51.0', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', '~> 51.0', platform: :jruby
+gem 'rails',    '~> 5.2.4', require: false
 gem 'mongoid'
+gem 'sqlite3', '~> 1.3.6', :platform => [:ruby, :mswin, :mingw]

data/Gemfile.global

@@ -5,8 +5,7 @@ gemspec
 gem 'rake'
 gem 'rspec', :require => false
 
-gem 'sqlite3', '~> 1.3.6', :platform => [:ruby, :mswin, :mingw]
-gem 'pg', '~> 0.21.0', :platform => [:ruby, :mswin, :mingw]
+gem 'pg', '~> 1.2.3', :platform => [:ruby, :mswin, :mingw]
 gem 'sequel'
 
 platforms :rbx do

data/Gemfile.mongo_mapper

@@ -1,7 +1,6 @@
 eval_gemfile('Gemfile.global')
 
 gem 'minitest', '~> 5.8'
-gem 'rails',    '4.2.8', :require => false
-gem 'activerecord-jdbcsqlite3-adapter', '~> 1.3.0', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3.0', platform: :jruby
+gem 'rails',    '~> 5.2.4', :require => false
 gem 'mongo_mapper'
+gem 'sqlite3', '~> 1.3.6', :platform => [:ruby, :mswin, :mingw]

data/Gemfile.rails60

@@ -0,0 +1,6 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    '~> 6.0.0', require: false
+gem 'mongoid',  github: 'mongodb/mongoid'
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]

data/Gemfile.rails61

@@ -0,0 +1,6 @@
+eval_gemfile('Gemfile.global')
+
+gem 'minitest', '~> 5.8'
+gem 'rails',    github: 'rails/rails', branch: '6-1-stable', require: false
+gem 'mongoid',  github: 'mongodb/mongoid'
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]

data/README.md

@@ -1,4 +1,4 @@
-# Enumerize [![TravisCI](https://secure.travis-ci.org/brainspec/enumerize.svg?branch=master)](http://travis-ci.org/brainspec/enumerize) [![Gemnasium](https://gemnasium.com/brainspec/enumerize.svg)](https://gemnasium.com/brainspec/enumerize)
+# Enumerize [![TravisCI](https://secure.travis-ci.org/brainspec/enumerize.svg?branch=master)](http://travis-ci.org/brainspec/enumerize)
 
 Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper/Sequel support
 
@@ -17,8 +17,8 @@ Or install it yourself as:
     $ gem install enumerize
 
 ## Supported Versions
-- Ruby 2.2+
-- Rails 4.2+
+- Ruby 2.5+
+- Rails 5.2+
 
 ## Usage
 

data/lib/enumerize.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
+require 'active_support/core_ext/object/blank'
 require 'enumerize/version'
 
 module Enumerize

data/lib/enumerize/activerecord.rb

@@ -21,8 +21,14 @@ module Enumerize
           require 'enumerize/hooks/uniqueness'
 
           unless options[:multiple]
-            decorate_attribute_type(name, :enumerize) do |subtype|
-              Type.new(enumerized_attributes[name], subtype)
+            if ::ActiveRecord.version >= ::Gem::Version.new("6.1.0.alpha")
+              decorate_attribute_type(name.to_s) do |subtype|
+                Type.new(enumerized_attributes[name], subtype)
+              end
+            else
+              decorate_attribute_type(name, :enumerize) do |subtype|
+                Type.new(enumerized_attributes[name], subtype)
+              end
             end
           end
         end

data/lib/enumerize/attribute.rb

@@ -172,7 +172,7 @@ module Enumerize
 
         def #{name}=(values)
           @_#{name}_enumerized_set = Enumerize::Set.new(self, self.class.enumerized_attributes[:#{name}], values)
-          raw_values = #{name}.values.map(&:value)
+          raw_values = self.#{name}.values.map(&:value)
 
           if defined?(super)
             super raw_values
@@ -184,7 +184,7 @@ module Enumerize
 
           _enumerized_values_for_validation['#{name}'] = values.respond_to?(:map) ? values.reject(&:blank?).map(&:to_s) : values
 
-          #{name}
+          self.#{name}
         end
       RUBY
     end

data/lib/enumerize/integrations/rspec/matcher.rb

@@ -110,7 +110,7 @@ module Enumerize
 
         def matches_predicates?
           if expected_predicates.is_a?(TrueClass)
-            subject.respond_to?("#{sorted_values.first}?")
+            subject.respond_to?("#{enumerized_values.first}?")
           else
             subject.respond_to?("#{expected_attr}_#{attributes.values.first}?")
           end
@@ -121,8 +121,11 @@ module Enumerize
         end
 
         def matches_scope?
-          if expected_scope.is_a?(TrueClass)
+          case expected_scope
+          when TrueClass
             subject_class.respond_to?("with_#{expected_attr}")
+          when :shallow
+            enumerized_values.all? { |value| subject_class.respond_to?(value) }
           else
             subject_class.respond_to?(expected_scope[:scope])
           end

data/lib/enumerize/predicatable.rb

@@ -17,7 +17,7 @@ module Enumerize
     end
 
     def predicate_method?(method)
-      method[-1] == '?' && @attr.values.include?(method[0..-2])
+      method[-1] == '?' && @attr && @attr.values.include?(method[0..-2])
     end
   end
 end

data/lib/enumerize/value.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'i18n'
+require 'active_support/inflector'
 
 module Enumerize
   class Value < String
@@ -9,6 +10,10 @@ module Enumerize
     attr_reader :value
 
     def initialize(attr, name, value=nil)
+      if self.class.method_defined?("#{name}?")
+        warn("It's not recommended to use `#{name}` as a field value since `#{name}?` is defined. (#{attr.klass.name}##{attr.name})")
+      end
+
       @attr  = attr
       @value = value.nil? ? name.to_s : value
 
@@ -17,12 +22,12 @@ module Enumerize
       @i18n_keys = @attr.i18n_scopes.map { |s| :"#{s}.#{self}" }
       @i18n_keys << :"enumerize.defaults.#{@attr.name}.#{self}"
       @i18n_keys << :"enumerize.#{@attr.name}.#{self}"
-      @i18n_keys << self.underscore.humanize # humanize value if there are no translations
+      @i18n_keys << ActiveSupport::Inflector.humanize(ActiveSupport::Inflector.underscore(self)) # humanize value if there are no translations
       @i18n_keys
     end
 
     def text
-      I18n.t(@i18n_keys[0], :default => @i18n_keys[1..-1])
+      I18n.t(@i18n_keys[0], :default => @i18n_keys[1..-1]) if @i18n_keys
     end
 
     def ==(other)

data/lib/enumerize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enumerize
-  VERSION = '2.3.1'
+  VERSION = '2.4.0'
 end

data/spec/enumerize/integrations/rspec/matcher_spec.rb

@@ -13,6 +13,7 @@ ActiveRecord::Base.connection.instance_eval do
     t.string :sex
     t.string :role
     t.string :account_type
+    t.string :status
   end
 end
 
@@ -22,6 +23,7 @@ class User < ActiveRecord::Base
   enumerize :sex, :in => [:male, :female], scope: true
   enumerize :role, :in => [:user, :admin], scope: :having_role
   enumerize :account_type, :in => [:basic, :premium]
+  enumerize :status, :in => [:active, :disabled], scope: :shallow
 end
 
 RSpec.describe Enumerize::Integrations::RSpec::Matcher do
@@ -41,7 +43,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe 'without qualifier' do
-
     it 'accepts when has defined a enumerize' do
       model.enumerize(:sex, :in => [:male, :female])
       expect(subject).to enumerize(:sex)
@@ -56,9 +57,7 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#in' do
-
     context 'defined as array' do
-
       before do
         model.enumerize(:sex, :in => [:male, :female])
       end
@@ -91,7 +90,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
     end
 
     context 'defined as hash' do
-
       before do
         model.enumerize(:sex, :in => { male: 0, female: 1 })
       end
@@ -130,7 +128,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#with_default' do
-
     before do
       model.enumerize(:sex, :in => [:male, :female], default: :female)
     end
@@ -161,9 +158,7 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#with_i18n_scope' do
-
     context 'defined as string' do
-
       before do
         model.enumerize(:sex, :in => [:male, :female], i18n_scope: 'sex')
       end
@@ -200,7 +195,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#with_predicates' do
-
     it 'accepts when predicates is defined as a boolean' do
       model.enumerize(:sex, :in => [:male, :female], predicates: true)
       expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(true)
@@ -211,6 +205,11 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
       expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(prefix: true)
     end
 
+    it 'accepts when custom values are used as attribute' do
+      model.enumerize(:sex, :in => { male: 0, female: 1 }, predicates: true)
+      expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(true)
+    end
+
     it 'rejects when predicates is not defined' do
       model.enumerize(:sex, :in => [:male, :female])
       message = 'Expected Model to define enumerize :sex in: "female", "male" predicates: true'
@@ -221,7 +220,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#with_multiple' do
-
     it 'accepts when has defined the multiple' do
       model.enumerize(:sex, :in => [:male, :female], multiple: true)
       expect(subject).to enumerize(:sex).in(:male, :female).with_multiple(true)
@@ -237,7 +235,6 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
   end
 
   describe '#with_scope' do
-
     subject do
       User.new
     end
@@ -250,6 +247,10 @@ RSpec.describe Enumerize::Integrations::RSpec::Matcher do
       expect(subject).to enumerize(:role).in(:user, :admin).with_scope(scope: :having_role)
     end
 
+    it 'accepts shallow scope' do
+      expect(subject).to enumerize(:status).in(:active, :disabled).with_scope(:shallow)
+    end
+
     it 'rejects when scope is not defined' do
       message = 'Expected User to define enumerize :account_type in: "basic", "premium" scope: true'
       expect do

data/test/activerecord_test.rb

@@ -180,7 +180,9 @@ describe Enumerize::ActiveRecordSupport do
     User.delete_all
     User.create!(:sex => :male)
 
-    assert_equal ['id'], User.select(:id).first.attributes.keys
+    user = User.select(:id).first
+    user.attributes['role'].must_equal nil
+    user.attributes['lambda_role'].must_equal nil
   end
 
   it 'has default value with lambda' do
@@ -616,4 +618,30 @@ describe Enumerize::ActiveRecordSupport do
 
     sql.must_include 'LIKE \'%foo%\''
   end
+
+  if Rails::VERSION::MAJOR >= 6
+    it 'supports AR#insert_all' do
+      User.delete_all
+
+      User.insert_all([{ sex: :male }])
+      User.insert_all([{ status: :active }])
+      User.insert_all([{ interests: [:music, :sports] }])
+
+      User.exists?(sex: :male).must_equal true
+      User.exists?(status: :active).must_equal true
+      User.exists?(interests: [:music, :sports]).must_equal true
+    end
+
+    it 'supports AR#upsert_all' do
+      User.delete_all
+
+      User.upsert_all([{ sex: :male }])
+      User.upsert_all([{ status: :active }])
+      User.upsert_all([{ interests: [:music, :sports] }])
+
+      User.exists?(sex: :male).must_equal true
+      User.exists?(status: :active).must_equal true
+      User.exists?(interests: [:music, :sports]).must_equal true
+    end
+  end
 end

data/test/mongo_mapper_test.rb

@@ -8,8 +8,7 @@ silence_warnings do
   require 'mongo_mapper'
 end
 
-MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
-MongoMapper.database   = 'enumerize-test-suite-of-mongomapper'
+MongoMapper.connection = Mongo::Client.new(['localhost:27017'], database: 'enumerize-test-suite-of-mongomapper')
 
 describe Enumerize do
   class MongoMapperUser

data/test/multiple_test.rb

@@ -56,4 +56,10 @@ describe Enumerize::Base do
       kklass.enumerize :foos, in: %w(a b c), multiple: true, scope: true
     end
   end
+
+  it 'assign a name with the first letter capitalized' do
+    kklass.enumerize :Foos, in: %w(a b c), multiple: true
+    object.Foos = %w(a c)
+    object.Foos.must_equal %w(a c)
+  end
 end

data/test/support/view_test_helper.rb

@@ -7,10 +7,21 @@ if defined?(ActionView::RoutingUrlFor)
   ActionView::RoutingUrlFor.send(:include, ActionDispatch::Routing::UrlFor)
 end
 
-module ViewTestHelper
+module SetupAndTeardownHelper
   extend ActiveSupport::Concern
 
   include ActiveSupport::Testing::SetupAndTeardown
+
+  included do
+    include ActiveSupport::Callbacks
+    define_callbacks :setup, :teardown
+  end
+end
+
+module ViewTestHelper
+  extend ActiveSupport::Concern
+
+  include SetupAndTeardownHelper
   include ActionView::TestCase::Behavior
 
   included do

data/test/value_test.rb

@@ -4,10 +4,13 @@ require 'test_helper'
 require 'yaml'
 
 describe Enumerize::Value do
-  class Attr < Struct.new(:values, :name, :i18n_scopes)
+  class Model
   end
 
-  let(:attr) { Attr.new([], "attribute_name", []) }
+  class Attr < Struct.new(:values, :name, :i18n_scopes, :klass)
+  end
+
+  let(:attr) { Attr.new([], "attribute_name", [], Model) }
   let(:val) { Enumerize::Value.new(attr, 'test_value', 1) }
 
   it 'is a string' do
@@ -32,7 +35,6 @@ describe Enumerize::Value do
   end
 
   describe 'translation' do
-
     it 'uses common translation' do
       store_translations(:en, :enumerize => {:attribute_name => {:test_value => "Common translation"}}) do
         val.text.must_be :==, "Common translation"
@@ -82,6 +84,13 @@ describe Enumerize::Value do
         val.text.must_be :==, "Scope specific translation"
       end
     end
+
+    it 'returns nil if value was modified' do
+      store_translations(:en, :enumerize => {:attribute_name => {:test_value => "Common translation"}}) do
+        modified_val = val.upcase
+        modified_val.text.must_be_nil
+      end
+    end
   end
 
   describe 'boolean methods comparison' do
@@ -121,6 +130,14 @@ describe Enumerize::Value do
     it "doesn't respond to a method for not existing value" do
       val.wont_respond_to :some_method?
     end
+
+    it "doesn't respond to methods is value was modified" do
+      modified_value = val.upcase
+
+      modified_value.upcase.wont_respond_to :some_method?
+      modified_value.upcase.wont_respond_to :test_value?
+      modified_value.upcase.wont_respond_to :other_value?
+    end
   end
 
   describe 'serialization' do
@@ -135,4 +152,14 @@ describe Enumerize::Value do
       Marshal.load(dump_value).must_equal 'test_value'
     end
   end
+
+  describe 'initialize' do
+    it 'no output if undefined boolean method' do
+      assert_silent() { Enumerize::Value.new(attr, 'test_value') }
+    end
+
+    it 'error output if defined boolean method' do
+      assert_output(nil, /`empty\?` is defined/) { Enumerize::Value.new(attr, 'empty') }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Sergey Nartimov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,9 +38,8 @@ files:
 - Gemfile
 - Gemfile.global
 - Gemfile.mongo_mapper
-- Gemfile.rails42
-- Gemfile.rails50
-- Gemfile.rails52
+- Gemfile.rails60
+- Gemfile.rails61
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -98,7 +97,7 @@ homepage: https://github.com/brainspec/enumerize
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +112,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.0.8
+signing_key:
 specification_version: 4
 summary: Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support
 test_files:

data/Gemfile.rails42

@@ -1,7 +0,0 @@
-eval_gemfile('Gemfile.global')
-
-gem 'minitest', '~> 5.8'
-gem 'rails',    '4.2.8', :require => false
-gem 'activerecord-jdbcsqlite3-adapter', '~> 1.3.0', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3.0', platform: :jruby
-gem 'mongoid',  '~> 5.0'

data/Gemfile.rails50

@@ -1,7 +0,0 @@
-eval_gemfile('Gemfile.global')
-
-gem 'minitest', '~> 5.8'
-gem 'rails',    '5.0.6', require: false
-gem 'activerecord-jdbcsqlite3-adapter', '~> 51.0', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', '~> 51.0', platform: :jruby
-gem 'mongoid'

data/Gemfile.rails52

@@ -1,7 +0,0 @@
-eval_gemfile('Gemfile.global')
-
-gem 'minitest', '~> 5.8'
-gem 'rails',    '5.2.0.rc1', require: false
-gem 'activerecord-jdbcsqlite3-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'master', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'master', platform: :jruby
-gem 'mongoid',  github: 'mongodb/mongoid'