enumerize 0.8.0 → 2.6.1

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,51 +1,49 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ActiveRecordSupport
     def enumerize(name, options={})
       super
 
       _enumerize_module.dependent_eval do
-        if defined?(::ActiveRecord::Base) && self < ::ActiveRecord::Base
-          if options[:scope]
-            _define_scope_methods!(name, options)
-          end
-
+        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'
-        end
-      end
-    end
-
-    private
-
-    def _define_scope_methods!(name, options)
-      scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
 
-      define_singleton_method scope_name do |*values|
-        values = values.map { |value| enumerized_attributes[name].find_value(value).value }
-        values = values.first if values.size == 1
-
-        where(name => values)
-      end
-
-      if options[:scope] == true
-        define_singleton_method "without_#{name}" do |*values|
-          values = values.map { |value| enumerized_attributes[name].find_value(value).value }
-          where(arel_table[name].not_in(values))
+          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
 
     module InstanceMethods
       # https://github.com/brainspec/enumerize/issues/74
-      def write_attribute(attr_name, value)
+      def write_attribute(attr_name, value, *options)
         if self.class.enumerized_attributes[attr_name]
-          _enumerized_values_for_validation[attr_name] = value
+          _enumerized_values_for_validation[attr_name.to_s] = value
         end
 
         super
@@ -55,13 +53,90 @@ module Enumerize
       def becomes(klass)
         became = super
         klass.enumerized_attributes.each do |attr|
-          if attr.is_a? Multiple
+          # Rescue when column associated to the enum does not exist.
+          begin
             became.send("#{attr.name}=", send(attr.name))
+          rescue ActiveModel::MissingAttributeError
           end
         end
 
         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
+      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
+
+      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}.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,27 +1,35 @@
+# 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]
+      raise ArgumentError, ':scope option does not work with option :multiple' if options[:multiple] && options[:scope]
 
       extend Multiple if options[:multiple]
 
       @klass  = klass
       @name   = name.to_sym
-      @values = Array(options[:in]).map { |v| Value.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)
@@ -36,11 +44,23 @@ module Enumerize
       @value_hash[value.to_s] unless value.nil?
     end
 
+    def find_values(*values)
+      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
@@ -67,6 +87,10 @@ module Enumerize
       values.map { |v| [v.text, v.to_s] }
     end
 
+    def respond_to_missing?(method, include_private=false)
+      @value_hash.include?(method.to_s) || super
+    end
+
     def define_methods!(mod)
       mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{name}
@@ -84,8 +108,6 @@ module Enumerize
         end
 
         def #{name}=(new_value)
-          _enumerized_values_for_validation[:#{name}] = new_value.nil? ? nil : new_value.to_s
-
           allowed_value_or_nil = self.class.enumerized_attributes[:#{name}].find_value(new_value)
           allowed_value_or_nil = allowed_value_or_nil.value unless allowed_value_or_nil.nil?
 
@@ -96,6 +118,10 @@ module Enumerize
           else
             @#{name} = allowed_value_or_nil
           end
+
+          _enumerized_values_for_validation['#{name}'] = new_value.nil? ? nil : new_value.to_s
+
+          allowed_value_or_nil
         end
 
         def #{name}_text
@@ -107,9 +133,27 @@ module Enumerize
         end
       RUBY
     end
+
+    private
+
+    def method_missing(method)
+      if @value_hash.include?(method.to_s)
+        find_value(method)
+      else
+        super
+      end
+    end
   end
 
   module Multiple
+    def find_default_value(value)
+      if value.respond_to?(:call)
+        value
+      else
+        find_values(*value)
+      end
+    end
+
     def define_methods!(mod)
       mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{name}
@@ -131,20 +175,20 @@ module Enumerize
         end
 
         def #{name}=(values)
-          _enumerized_values_for_validation[:#{name}] = values.respond_to?(:map) ? values.map(&:to_s) : values
-
           @_#{name}_enumerized_set = Enumerize::Set.new(self, self.class.enumerized_attributes[:#{name}], values)
-          string_values = #{name}.values.map(&:to_str)
+          raw_values = self.#{name}.values.map(&:value)
 
           if defined?(super)
-            super string_values
+            super raw_values
           elsif respond_to?(:write_attribute, true)
-            write_attribute '#{name}', string_values
+            write_attribute '#{name}', raw_values
           else
-            @#{name} = string_values
+            @#{name} = raw_values
           end
 
-          #{name}
+          _enumerized_values_for_validation['#{name}'] = values.respond_to?(:map) ? values.reject(&:blank?).map(&:to_s) : values
+
+          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,7 +1,10 @@
+# frozen_string_literal: true
+
 module Enumerize
   module Base
     def self.included(base)
       base.extend ClassMethods
+      base.singleton_class.prepend ClassMethods::Hook
 
       if base.respond_to?(:validate)
         base.validate :_validate_enumerized_attributes
@@ -28,9 +31,11 @@ module Enumerize
         @enumerized_attributes ||= AttributeMap.new
       end
 
-      def inherited(subclass)
-        enumerized_attributes.add_dependant subclass.enumerized_attributes
-        super
+      module Hook
+        def inherited(subclass)
+          enumerized_attributes.add_dependant subclass.enumerized_attributes
+          super subclass
+        end
       end
 
       private
@@ -44,16 +49,20 @@ module Enumerize
       end
     end
 
-    def initialize(*)
+    def initialize(...)
       super
       _set_default_value_for_enumerized_attributes
     end
 
     def read_attribute_for_validation(key)
+      key = key.to_s
+
       if _enumerized_values_for_validation.has_key?(key)
         _enumerized_values_for_validation[key]
-      else
+      elsif defined?(super)
         super
+      else
+        send(key)
       end
     end
 
@@ -65,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?
 
@@ -78,23 +90,26 @@ module Enumerize
 
     def _set_default_value_for_enumerized_attributes
       self.class.enumerized_attributes.each do |attr|
-        # remove after dropping support for Rails 3.x
-        # https://github.com/brainspec/enumerize/issues/101
-        attr_value = begin
-          public_send(attr.name)
-        rescue ActiveModel::MissingAttributeError
-          nil
-        end
+        _set_default_value_for_enumerized_attribute(attr)
+      end
+    end
 
-        if !attr_value && !_enumerized_values_for_validation.key?(attr.name)
-          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]
 
+        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,16 +1,14 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
   module Hooks
     module FormtasticFormBuilderExtension
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method_chain :input, :enumerize
-      end
 
-      def input_with_enumerize(method, options={})
-        klass = object.class
+      def input(method, options={})
+        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
@@ -20,10 +18,10 @@ module Enumerize
           end
         end
 
-        input_without_enumerize(method, options)
+        super(method, options)
       end
     end
   end
 end
 
-::Formtastic::FormBuilder.send :include, Enumerize::Hooks::FormtasticFormBuilderExtension
+::Formtastic::FormBuilder.send :prepend, Enumerize::Hooks::FormtasticFormBuilderExtension

data/lib/enumerize/hooks/sequel_dataset.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Hooks
+    module SequelDataset
+      def literal_append(sql, v)
+        if v.is_a?(Enumerize::Value)
+          super(sql, v.value)
+        else
+          super(sql, v)
+        end
+      end
+    end
+  end
+end
+
+::Sequel::Dataset.send :prepend, Enumerize::Hooks::SequelDataset

data/lib/enumerize/hooks/simple_form.rb

@@ -1,29 +1,26 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
   module Hooks
     module SimpleFormBuilderExtension
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method_chain :input, :enumerize
-        alias_method_chain :input_field, :enumerize
-      end
 
-      def input_with_enumerize(attribute_name, options={}, &block)
+      def input(attribute_name, options={}, &block)
         add_input_options_for_enumerized_attribute(attribute_name, options)
-        input_without_enumerize(attribute_name, options, &block)
+        super(attribute_name, options, &block)
       end
 
-      def input_field_with_enumerize(attribute_name, options={})
+      def input_field(attribute_name, options={})
         add_input_options_for_enumerized_attribute(attribute_name, options)
-        input_field_without_enumerize(attribute_name, options)
+        super(attribute_name, options)
       end
 
       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
@@ -37,4 +34,4 @@ module Enumerize
   end
 end
 
-::SimpleForm::FormBuilder.send :include, Enumerize::Hooks::SimpleFormBuilderExtension
+::SimpleForm::FormBuilder.send :prepend, Enumerize::Hooks::SimpleFormBuilderExtension

data/lib/enumerize/hooks/uniqueness.rb

@@ -1,23 +1,22 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Enumerize
   module Hooks
     module UniquenessValidator
-      extend ActiveSupport::Concern
 
-      included do
-        alias_method_chain :validate_each, :enumerize
-      end
+      def validate_each(record, name, value)
+        klass = record.to_model.class
 
-      def validate_each_with_enumerize(record, name, value)
-        if record.class.respond_to?(:enumerized_attributes) && (attr = record.class.enumerized_attributes[name])
+        if klass.respond_to?(:enumerized_attributes) && (attr = klass.enumerized_attributes[name])
           value = attr.find_value(value).try(:value)
         end
 
-        validate_each_without_enumerize(record, name, value)
+        super(record, name, value)
       end
     end
   end
 end
 
-::ActiveRecord::Validations::UniquenessValidator.send :include, Enumerize::Hooks::UniquenessValidator
+::ActiveRecord::Validations::UniquenessValidator.send :prepend, Enumerize::Hooks::UniquenessValidator

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