enumerize 2.0.0 → 2.7.0

data/lib/enumerize/activerecord.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ActiveRecordSupport
     def enumerize(name, options={})
@@ -7,12 +9,32 @@ module Enumerize
         if self < ::ActiveRecord::Base
           include InstanceMethods
 
+          const_get(:ActiveRecord_Relation).include(RelationMethods)
+          const_get(:ActiveRecord_AssociationRelation).include(RelationMethods)
+          const_get(:ActiveRecord_Associations_CollectionProxy).include(RelationMethods)
+
           # Since Rails use `allocate` method on models and initializes them with `init_with` method.
           # This way `initialize` method is not being called, but `after_initialize` callback always gets triggered.
           after_initialize :_set_default_value_for_enumerized_attributes
 
           # 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
@@ -40,17 +62,81 @@ 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
 
-    def update_all(updates)
-      if updates.is_a?(Hash)
-        enumerized_attributes.each do |attr|
-          next if updates[attr.name].blank? || attr.kind_of?(Enumerize::Multiple)
-          updates[attr.name] = attr.find_value(updates[attr.name]).value
+    module RelationMethods
+      def update_all(updates)
+        if updates.is_a?(Hash)
+          enumerized_attributes.each do |attr|
+            next if updates[attr.name].blank? || attr.kind_of?(Enumerize::Multiple)
+            enumerize_value = attr.find_value(updates[attr.name])
+            updates[attr.name] = enumerize_value && enumerize_value.value
+          end
         end
+
+        super(updates)
+      end
+    end
+
+    class Type < ActiveRecord::Type::Value
+      delegate :type, to: :@subtype
+
+      def initialize(attr, subtype)
+        @attr = attr
+        @subtype = subtype
       end
 
-      super(updates)
+      def serialize(value)
+        v = @attr.find_value(value)
+        (v && v.value) || value
+      end
+
+      alias type_cast_for_database serialize
+
+      def cast(value)
+        @attr.find_value(value)
+      end
+
+      alias type_cast_from_database cast
+
+      def as_json(options = nil)
+        {attr: @attr.name}.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]
@@ -10,22 +12,20 @@ module Enumerize
 
       @klass  = klass
       @name   = name.to_sym
+      @i18n_scope = options[:i18n_scope]
 
       value_class = options.fetch(:value_class, Value)
-      @values = Array(options[:in]).map { |v| value_class.new(self, *v) }
+      @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[: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
-
       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 +44,19 @@ module Enumerize
       values.map { |value| find_value(value) }.compact
     end
 
+    def each_value
+      values.each { |value| yield value }
+    end
+
+    def value?(value)
+      values.include?(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)
@@ -47,7 +49,7 @@ module Enumerize
       end
     end
 
-    def initialize(*)
+    def initialize(...)
       super
       _set_default_value_for_enumerized_attributes
     end
@@ -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?
 
@@ -85,27 +90,26 @@ module Enumerize
 
     def _set_default_value_for_enumerized_attributes
       self.class.enumerized_attributes.each do |attr|
-        next if attr.default_value.nil?
-        begin
-          if respond_to?(attr.name)
-            attr_value = public_send(attr.name)
-          else
-            next
-          end
-
-          value_for_validation = _enumerized_values_for_validation[attr.name.to_s]
+        _set_default_value_for_enumerized_attribute(attr)
+      end
+    end
 
-          if (!attr_value || attr_value.empty?) && (!value_for_validation || value_for_validation.empty?)
-            value = attr.default_value
+    def _set_default_value_for_enumerized_attribute(attr)
+      return if attr.default_value.nil?
+      begin
+        if respond_to?(attr.name)
+          attr_value = public_send(attr.name)
+        else
+          return
+        end
 
-            if value.respond_to?(:call)
-              value = value.arity == 0 ? value.call : value.call(self)
-            end
+        value_for_validation = _enumerized_values_for_validation[attr.name.to_s]
 
-            public_send("#{attr.name}=", value)
-          end
-        rescue ActiveModel::MissingAttributeError
+        if (!attr_value || attr_value.empty?) && (!value_for_validation || value_for_validation.empty?)
+          value = Utils.call_if_callable(attr.default_value, self)
+          public_send("#{attr.name}=", value)
         end
+      rescue ActiveModel::MissingAttributeError
       end
     end
   end

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,6 @@
+# frozen_string_literal: true
+
+require 'rspec/matchers'
 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,30 @@ 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
+
+      private
+
+      def _set_default_value_for_enumerized_attribute(attr)
+        super
+      rescue Mongoid::Errors::AttributeNotLoaded
+      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.value?(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
@@ -67,8 +69,22 @@ module Enumerize
       end
 
       def build(klass)
+        warn_on_already_defined_methods
+
         klass.delegate(*names, to: @attr.name, prefix: @options[:prefix], allow_nil: true)
       end
+
+      def warn_on_already_defined_methods
+        names.each do |name|
+          method_name = [@options[:prefix], name].compact.join('_')
+
+          if @attr.klass.respond_to?(method_name)
+            warn(
+              "Predicate method `#{name}` is already defined as #{@attr.klass.name}##{name}. Use enumerize's :prefix option to avoid it"
+            )
+          end
+        end
+      end
     end
   end
 end

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