enumerize 2.1.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5a43e5546fd78ed42c35abfccc3314e52b7671f
-  data.tar.gz: 727be0571656833f27ee73ff8d65d6455c7511e4
+SHA256:
+  metadata.gz: 15a8427afecf01652e67b4758c05a499ba541254799d8ca61f0146f942647388
+  data.tar.gz: ee769906574712f378ca8dfb8aaadcfcc5993a485531cf520b44c41420e8fa84
 SHA512:
-  metadata.gz: 88cfa3f67475bf8d18279b7f53124051237c3a5bfe302e88860f5c405834cd95ebe9cfca67eb0d721c52ca746a15458cf284d2a376b049ede0b6b69379f667a6
-  data.tar.gz: f57a1bca5a058f2074d834968418865455f4e0ccf3aa2441064f05cb5901a4eb8ec4776cd2e95c938635a41659723679108d873caa338e8487879e91fbcafb25
+  metadata.gz: 46edf9a1fed39c9122247957a64dab6a773f5d0a8d0176204e48bd9d28074019480c1ae3cf16ccc3ad7a185d64fb7cf92d9f1a5ec63a581a388d1dd4620ac651
+  data.tar.gz: 206734dd6819196fbdff49e89626d30e45cd29154a63151f8631c87d13d15c7bd2bae90916b411a7f7d71287fa5be5a742f281392348f3c330401dde9d4b72c2

data/.travis.yml

@@ -1,18 +1,21 @@
+dist: focal
 language: ruby
 sudo: false
 services:
-  - postgresql
   - mongodb
+addons:
+  postgresql: "13"
 gemfile:
   - Gemfile
-  - Gemfile.rails42
-  - Gemfile.rails51
+  - Gemfile.rails60
+  - Gemfile.rails61
   - Gemfile.mongo_mapper
 rvm:
-  - 2.2.7
-  - 2.3.3
-  - 2.4.1
-  - jruby-9.1.8.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+before_install:
+  - gem install bundler
 env:
   global:
     - DB_USER=postgres
@@ -22,8 +25,6 @@ env:
     - DB=postgresql
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: jruby-9.1.8.0
   exclude:
     - gemfile: Gemfile.mongo_mapper
       env: DB=postgresql

data/CHANGELOG.md

@@ -1,9 +1,56 @@
-## 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
+
+* Add ability to skip validations by passing `:skip_validations` option. (by [@chumakoff](https://github.com/chumakoff))
+* Add option `scope: shallow` to extend scopes based on enumerized attribute values (by [@moofkit](https://github.com/moofkit/))
+
+### bug fix
+
+* Fix issue with ActiveRecord and Mongoid `reload` method when enumberized attributes weren't synced from DB. (by [@nashby](https://github.com/nashby) and [@FunkyloverOne](https://github.com/FunkyloverOne))
+* Fix issue with ActiveRecord `reload` method not working for ActiveRecord::Store attributes due to `1b776c`. (by [@rickcsong](https://github.com/rickcsong))
+
+## 2.2.2 (March 6, 2018)
+
+### bug fix
+
+* Support non-ActiveModel objects in SimpleForm/Formtastic integration. (by [@nashby](https://github.com/nashby))
+
+## 2.2.1 (February 15, 2018)
+
 ### bug fix
 
+* Fix issue with SimpleForm/Formtastic forms without object. (by [@nashby](https://github.com/nashby))
+
+## 2.2.0 (February 13, 2018)
+
+### enhancements
+
+* Add integration with active_interaction. (by [@runephilosof](https://github.com/runephilosof))
+* Allow using `plugin :enumerize` with Sequel. (by [@jnylen](https://github.com/jnylen))
+* Support ActiveModel::Attributes from Rails 5.2. (by [@troter](https://github.com/troter))
+* Support Sequel 5.2.0. (by [@troter](https://github.com/troter))
+
+### bug fix
+
+* Fix RailsAdmin integration when enumerated field used on edit form and enumerated value wasn't set. (by [@nashby](https://github.com/nashby))
+* Fallback to a raw passed value instead of nil if AR type can't find value in the attribute. (by [@nashby](https://github.com/nashby))
+
 ## 2.1.2 (May 18, 2017)
 
 ### bug fix
@@ -41,11 +88,11 @@
 * Drop support for Rails 4.0 and 4.1. Support only Rails 4.2 and newer. (by [@lest](https://github.com/lest))
 * Support Rails 5.0. (by [@nashby](https://github.com/nashby) and [@lest](https://github.com/lest))
 * Allow to pass enumerize values to `ActiveRecord#update_all` (by [@DmitryTsepelev](https://github.com/DmitryTsepelev) and [@ianwhite](https://github.com/ianwhite))
-   
+
   ```ruby
   User.update_all(status: :blocked)
   ```
-  
+
 ### bug fix
 
 * Rescue MissingAttributeError on attribute writing. (by [@embs](https://github.com/embs))

data/Gemfile

@@ -1,7 +1,6 @@
 eval_gemfile('Gemfile.global')
 
 gem 'minitest', '~> 5.8'
-gem 'rails',    '5.0.2', require: false
-gem 'activerecord-jdbcsqlite3-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', github: 'jruby/activerecord-jdbc-adapter', branch: 'rails-5', 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', :platform => [:ruby, :mswin, :mingw]
-gem 'pg', :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', platform: :jruby
-gem 'activerecord-jdbcpostgresql-adapter', 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
 
@@ -16,6 +16,10 @@ Or install it yourself as:
 
     $ gem install enumerize
 
+## Supported Versions
+- Ruby 2.5+
+- Rails 5.2+
+
 ## Usage
 
 Basic:
@@ -54,6 +58,18 @@ class User < ActiveRecord::Base
 end
 ```
 
+:warning: By default, `enumerize` adds `inclusion` validation to the model. You can skip validations by passing `skip_validations` option. :warning:
+
+```ruby
+class User < ActiveRecord::Base
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], skip_validations: lambda { |user| user.new_record? }
+
+  enumerize :role, in: [:user, :admin], skip_validations: true
+end
+```
+
 Mongoid:
 
 ```ruby
@@ -252,6 +268,24 @@ User.having_status(:blocked).with_sex(:male, :female)
 # SELECT "users".* FROM "users" WHERE "users"."status" IN (2) AND "users"."sex" IN ('male', 'female')
 ```
 
+Shallow scopes:
+
+Adds named scopes to the class directly
+
+```ruby
+class User < ActiveRecord::Base
+  extend Enumerize
+  enumerize :sex, :in => [:male, :female], scope: :shallow
+  enumerize :status, :in => { active: 1, blocked: 2 }, scope: :shallow
+end
+
+User.male
+# SELECT "users".* FROM "users" WHERE "users"."sex" = 'male'
+
+User.active
+# SELECT "users".* FROM "users" WHERE "users"."status" = 1
+```
+
 :warning: It is not possible to define a scope when using the `:multiple` option. :warning:
 
 Array-like attributes with plain ruby objects:
@@ -315,6 +349,8 @@ and if you want it as radio buttons:
 <% end %>
 ```
 
+Please note that Enumerize overwrites the I18n keys of SimpleForm collections. The enumerized keys are used instead of the SimpleForm ones for inputs concerning enumerized attributes. If you don't want this just pass `:collection` option to the `input` call.
+
 ### Formtastic
 
 If you are using Formtastic gem you also don't need to specify input type (`:select` by default) and collection:

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require 'rake/testtask'

data/lib/enumerize.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
+require 'active_support/core_ext/object/blank'
 require 'enumerize/version'
 
 module Enumerize
@@ -10,8 +13,10 @@ module Enumerize
   autoload :Module,       'enumerize/module'
   autoload :Predicates,   'enumerize/predicates'
   autoload :Predicatable, 'enumerize/predicatable'
+  autoload :Utils,        'enumerize/utils'
   autoload :ModuleAttributes, 'enumerize/module_attributes'
 
+  autoload :ActiveModelAttributesSupport, 'enumerize/activemodel'
   autoload :ActiveRecordSupport, 'enumerize/activerecord'
   autoload :SequelSupport, 'enumerize/sequel'
   autoload :MongoidSupport,      'enumerize/mongoid'
@@ -31,6 +36,10 @@ module Enumerize
     base.send :include, Enumerize::Base
     base.extend Enumerize::Predicates
 
+    if defined?(::ActiveModel::Attributes)
+      base.extend Enumerize::ActiveModelAttributesSupport
+    end
+
     if defined?(::ActiveRecord::Base)
       base.extend Enumerize::ActiveRecordSupport
       base.extend Enumerize::Scope::ActiveRecord

data/lib/enumerize/activemodel.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module ActiveModelAttributesSupport
+    def enumerize(name, options={})
+      super
+
+      _enumerize_module.dependent_eval do
+        if self.included_modules.include? ::ActiveModel::Attributes
+          include InstanceMethods
+
+          attribute name, Enumerize::ActiveModelAttributesSupport::Type.new(enumerized_attributes[name])
+        end
+      end
+    end
+
+    module InstanceMethods
+      # https://github.com/brainspec/enumerize/issues/74
+      def write_attribute(attr_name, value, *options)
+        if self.class.enumerized_attributes[attr_name]
+          _enumerized_values_for_validation[attr_name.to_s] = value
+        end
+
+        super
+      end
+    end
+
+    class Type < ActiveModel::Type::Value
+      def type
+        :enumerize
+      end
+
+      def initialize(attr)
+        @attr = attr
+      end
+
+      def serialize(value)
+        v = @attr.find_value(value)
+        v && v.value
+      end
+
+      def deserialize(value)
+        @attr.find_value(value)
+      end
+    end
+  end
+end

data/lib/enumerize/activerecord.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ActiveRecordSupport
     def enumerize(name, options={})
@@ -19,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
@@ -50,6 +58,28 @@ module Enumerize
 
         became
       end
+
+      def reload(options = nil)
+        reloaded = super
+
+        reloaded.class.enumerized_attributes.each do |attr|
+          begin
+            # Checks first if the enumerized attribute is in ActiveRecord::Store
+            store_attr, _ = reloaded.class.stored_attributes.detect do |store_attr, keys|
+              keys.include?(attr.name)
+            end
+
+            if store_attr.present?
+              reloaded.send("#{attr.name}=", reloaded.send(store_attr).with_indifferent_access[attr.name])
+            else
+              reloaded.send("#{attr.name}=", reloaded[attr.name])
+            end
+          rescue ActiveModel::MissingAttributeError
+          end
+        end
+
+        reloaded
+      end
     end
 
     module RelationMethods
@@ -76,7 +106,7 @@ module Enumerize
 
       def serialize(value)
         v = @attr.find_value(value)
-        v && v.value
+        (v && v.value) || value
       end
 
       alias type_cast_for_database serialize

data/lib/enumerize/attribute.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Enumerize
   class Attribute
-    attr_reader :klass, :name, :values, :default_value, :i18n_scope
+    attr_reader :klass, :name, :values, :default_value, :i18n_scope, :skip_validations_value
 
     def initialize(klass, name, options={})
       raise ArgumentError, ':in option is required' unless options[:in]
@@ -11,21 +13,23 @@ module Enumerize
       @klass  = klass
       @name   = name.to_sym
 
-      value_class = options.fetch(:value_class, Value)
-      @values = Array(options[:in]).map { |v| value_class.new(self, *v) }
-
-      @value_hash = Hash[@values.map { |v| [v.value.to_s, v] }]
-      @value_hash.merge! Hash[@values.map { |v| [v.to_s, v] }]
-
       if options[:i18n_scope]
         raise ArgumentError, ':i18n_scope option accepts only String or Array of strings' unless Array(options[:i18n_scope]).all? { |s| s.is_a?(String) }
         @i18n_scope = options[:i18n_scope]
       end
 
+      value_class = options.fetch(:value_class, Value)
+      @values = Array(options[:in]).map { |v| value_class.new(self, *v).freeze }
+
+      @value_hash = Hash[@values.map { |v| [v.value.to_s, v] }]
+      @value_hash.merge! Hash[@values.map { |v| [v.to_s, v] }]
+
       if options[:default]
         @default_value = find_default_value(options[:default])
         raise ArgumentError, 'invalid default value' unless @default_value
       end
+
+      @skip_validations_value = options.fetch(:skip_validations, false)
     end
 
     def find_default_value(value)
@@ -44,11 +48,15 @@ module Enumerize
       values.map { |value| find_value(value) }.compact
     end
 
+    def each_value
+      values.each { |value| yield value }
+    end
+
     def i18n_scopes
       @i18n_scopes ||= if i18n_scope
-        scopes = Array(i18n_scope)
+        Array(i18n_scope)
       elsif @klass.respond_to?(:model_name)
-        scopes = ["enumerize.#{@klass.model_name.i18n_key}.#{name}"]
+        ["enumerize.#{@klass.model_name.i18n_key}.#{name}"]
       else
         []
       end
@@ -164,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
@@ -176,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