enumerize 2.0.1 → 2.5.0

data/lib/enumerize/activerecord.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ActiveRecordSupport
     def enumerize(name, options={})
@@ -17,6 +19,22 @@ module Enumerize
 
           # https://github.com/brainspec/enumerize/issues/111
           require 'enumerize/hooks/uniqueness'
+
+          unless options[:multiple]
+            if ::ActiveRecord.version >= ::Gem::Version.new("7.0.0.alpha")
+              attribute(name) do |subtype|
+                Type.new(enumerized_attributes[name], subtype)
+              end
+            elsif ::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
       end
     end
@@ -44,6 +62,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
@@ -59,5 +99,44 @@ module Enumerize
         super(updates)
       end
     end
+
+    class Type < ActiveRecord::Type::Value
+      delegate :type, to: :@subtype
+
+      def initialize(attr, subtype)
+        @attr = attr
+        @subtype = subtype
+      end
+
+      def serialize(value)
+        v = @attr.find_value(value)
+        (v && v.value) || value
+      end
+
+      alias type_cast_for_database serialize
+
+      def deserialize(value)
+        @attr.find_value(value)
+      end
+
+      alias type_cast_from_database deserialize
+
+      def as_json(options = nil)
+        {attr: @attr.name, subtype: @subtype}.as_json(options)
+      end
+
+      def encode_with(coder)
+        coder[:class_name] = @attr.klass.name
+        coder[:attr_name] = @attr.name
+        coder[:subtype] = @subtype
+      end
+
+      def init_with(coder)
+        initialize(
+          coder[:class_name].constantize.enumerized_attributes[coder[:attr_name]],
+          coder[:subtype]
+        )
+      end
+    end
   end
 end

data/lib/enumerize/attribute.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Enumerize
   class Attribute
-    attr_reader :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

data/lib/enumerize/attribute_map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   class AttributeMap
     attr_reader :attributes

data/lib/enumerize/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Base
     def self.included(base)
@@ -72,6 +74,9 @@ module Enumerize
 
     def _validate_enumerized_attributes
       self.class.enumerized_attributes.each do |attr|
+        skip_validations = Utils.call_if_callable(attr.skip_validations_value, self)
+        next if skip_validations
+
         value = read_attribute_for_validation(attr.name)
         next if value.blank?
 
@@ -96,12 +101,7 @@ module Enumerize
           value_for_validation = _enumerized_values_for_validation[attr.name.to_s]
 
           if (!attr_value || attr_value.empty?) && (!value_for_validation || value_for_validation.empty?)
-            value = attr.default_value
-
-            if value.respond_to?(:call)
-              value = value.arity == 0 ? value.call : value.call(self)
-            end
-
+            value = Utils.call_if_callable(attr.default_value, self)
             public_send("#{attr.name}=", value)
           end
         rescue ActiveModel::MissingAttributeError

data/lib/enumerize/hooks/formtastic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
@@ -5,7 +7,8 @@ module Enumerize
     module FormtasticFormBuilderExtension
 
       def input(method, options={})
-        klass = object.class
+        enumerized_object = convert_to_model(object)
+        klass = enumerized_object.class
 
         if klass.respond_to?(:enumerized_attributes) && (attr = klass.enumerized_attributes[method])
           options[:collection] ||= attr.options

data/lib/enumerize/hooks/sequel_dataset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Hooks
     module SequelDataset

data/lib/enumerize/hooks/simple_form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
@@ -17,7 +19,8 @@ module Enumerize
       private
 
       def add_input_options_for_enumerized_attribute(attribute_name, options)
-        klass = object.class
+        enumerized_object = convert_to_model(object)
+        klass = enumerized_object.class
 
         if klass.respond_to?(:enumerized_attributes) && (attr = klass.enumerized_attributes[attribute_name])
           options[:collection] ||= attr.options

data/lib/enumerize/hooks/uniqueness.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
@@ -5,7 +7,9 @@ module Enumerize
     module UniquenessValidator
 
       def validate_each(record, name, value)
-        if record.class.respond_to?(:enumerized_attributes) && (attr = record.class.enumerized_attributes[name])
+        klass = record.to_model.class
+
+        if klass.respond_to?(:enumerized_attributes) && (attr = klass.enumerized_attributes[name])
           value = attr.find_value(value).try(:value)
         end
 

data/lib/enumerize/integrations/rails_admin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Integrations
     module RailsAdmin
@@ -7,7 +9,7 @@ module Enumerize
 
         _enumerize_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{name}_enum
-            self.class.enumerized_attributes[:#{name}].values.map{|v| [v.text, v.value]}
+            self.class.enumerized_attributes[:#{name}].options
           end
         RUBY
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Integrations
     module RSpec
@@ -108,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
@@ -119,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/integrations/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'enumerize/integrations/rspec/matcher'
 
 module Enumerize

data/lib/enumerize/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   class Module < ::Module
     attr_reader :_class_methods

data/lib/enumerize/module_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ModuleAttributes
     def included(base)

data/lib/enumerize/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module MongoidSupport
     def enumerize(name, options={})
@@ -5,9 +7,23 @@ module Enumerize
 
       _enumerize_module.dependent_eval do
         if self < ::Mongoid::Document
+          include InstanceMethods
+
           after_initialize :_set_default_value_for_enumerized_attributes
         end
       end
     end
+
+    module InstanceMethods
+      def reload
+        reloaded = super
+
+        reloaded.class.enumerized_attributes.each do |attr|
+          reloaded.send("#{attr.name}=", reloaded[attr.name])
+        end
+
+        reloaded
+      end
+    end
   end
 end

data/lib/enumerize/predicatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Predicatable
     def respond_to_missing?(method, include_private=false)
@@ -15,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/predicates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/module/delegation'
 
 module Enumerize

data/lib/enumerize/scope/activerecord.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Scope
     module ActiveRecord
@@ -16,6 +18,8 @@ module Enumerize
       private
 
       def _define_activerecord_scope_methods!(name, options)
+        return _define_activerecord_shallow_scopes!(name) if options[:scope] == :shallow
+
         scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
 
         define_singleton_method scope_name do |*values|
@@ -32,6 +36,18 @@ module Enumerize
           end
         end
       end
+
+      def _define_activerecord_shallow_scopes!(attribute_name)
+        enumerized_attributes[attribute_name].each_value do |value_obj|
+          define_singleton_method(value_obj) do
+            where(attribute_name => value_obj.value)
+          end
+
+          define_singleton_method("not_#{value_obj}") do
+            where.not(attribute_name => value_obj.value)
+          end
+        end
+      end
     end
   end
 end

data/lib/enumerize/scope/mongoid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Scope
     module Mongoid
@@ -16,6 +18,7 @@ module Enumerize
       private
 
       def _define_mongoid_scope_methods!(name, options)
+        return _define_mongoid_shallow_scopes!(name) if options[:scope] == :shallow
         scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
 
         define_singleton_method scope_name do |*values|
@@ -30,6 +33,18 @@ module Enumerize
           end
         end
       end
+
+      def _define_mongoid_shallow_scopes!(attribute_name)
+        enumerized_attributes[attribute_name].each_value do |value_obj|
+          define_singleton_method(value_obj) do
+            self.in(attribute_name => value_obj.value)
+          end
+
+          define_singleton_method("not_#{value_obj}") do
+            self.not_in(attribute_name => value_obj.value)
+          end
+        end
+      end
     end
   end
 end

data/lib/enumerize/scope/sequel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Scope
     module Sequel
@@ -18,6 +20,8 @@ module Enumerize
       private
 
       def _define_sequel_scope_methods!(name, options)
+        return _define_sequel_shallow_scopes!(name) if options[:scope] == :shallow
+
         klass = self
         scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
 
@@ -35,6 +39,18 @@ module Enumerize
           end
         end
       end
+
+      def _define_sequel_shallow_scopes!(attribute_name)
+        enumerized_attributes[attribute_name].each_value do |value_obj|
+          def_dataset_method(value_obj) do
+            where(attribute_name => value_obj.value.to_s)
+          end
+
+          def_dataset_method("not_#{value_obj}") do
+            exclude(attribute_name => value_obj.value.to_s)
+          end
+        end
+      end
     end
   end
 end

data/lib/enumerize/sequel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module SequelSupport
     def enumerize(name, options={})
@@ -17,8 +19,11 @@ module Enumerize
     module InstanceMethods
       def validate
         super
-        
+
         self.class.enumerized_attributes.each do |attr|
+          skip_validations = Utils.call_if_callable(attr.skip_validations_value, self)
+          next if skip_validations
+
           value = read_attribute_for_validation(attr.name)
           next if value.blank?
 
@@ -38,13 +43,13 @@ module Enumerize
         if defined?(Sequel::Plugins::Serialization::InstanceMethods)
           modules = self.class.ancestors
           plugin_idx = modules.index(Sequel::Plugins::Serialization::InstanceMethods)
-          
+
           if plugin_idx && plugin_idx < modules.index(Enumerize::SequelSupport::InstanceMethods)
             abort "ERROR: You need to enable the Sequel serialization plugin before calling any enumerize methods on a model."
           end
-          
+
           plugin_idx = modules.index(Sequel::Plugins::ValidationHelpers::InstanceMethods)
-          
+
           if plugin_idx && plugin_idx < modules.index(Enumerize::SequelSupport::InstanceMethods)
             abort "ERROR: You need to enable the Sequel validation_helpers plugin before calling any enumerize methods on a model."
           end

data/lib/enumerize/set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/module/delegation'
 
 module Enumerize

data/lib/enumerize/utils.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Utils
+    class << self
+      def call_if_callable(value, param = nil)
+        return value unless value.respond_to?(:call)
+        value.arity == 0 ? value.call : value.call(param)
+      end
+    end
+  end
+end

data/lib/enumerize/value.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'i18n'
+require 'active_support/inflector'
 
 module Enumerize
   class Value < String
@@ -7,14 +10,24 @@ 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
 
       super(name.to_s)
+
+      @i18n_keys = @attr.i18n_scopes.map { |s| :"#{s}.#{self}" }
+      @i18n_keys << :"enumerize.defaults.#{@attr.name}.#{self}"
+      @i18n_keys << :"enumerize.#{@attr.name}.#{self}"
+      @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)
@@ -30,19 +43,5 @@ module Enumerize
     def predicate_call(value)
       value == self
     end
-
-    def i18n_keys
-      @i18n_keys ||= begin
-        i18n_keys = i18n_scopes
-        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
-      end
-    end
-
-    def i18n_scopes
-      @attr.i18n_scopes.map { |s| :"#{s}.#{self}" }
-    end
   end
 end

data/lib/enumerize/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
-  VERSION = "2.0.1"
+  VERSION = '2.5.0'
 end

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/sequel/plugins/enumerize.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sequel
+  module Plugins
+    module Enumerize
+      # Depend on the def_dataset_method plugin
+      def self.apply(model)
+        model.plugin(:def_dataset_method) unless model.respond_to?(:def_dataset_method)
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.extend ::Enumerize
+        end
+      end
+    end
+  end
+end