enumerize 0.3.0 → 2.3.1

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

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Integrations
+    module RSpec
+      class Matcher
+
+        def initialize(expected_attr)
+          self.expected_attr = expected_attr
+        end
+
+        def in(*expected_values)
+          self.expected_values = expected_values.flatten
+          self
+        end
+
+        def with_default(expected_default)
+          self.expected_default = expected_default.to_s
+          self
+        end
+
+        def with_i18n_scope(expected_i18n_scope)
+          self.expected_i18n_scope = expected_i18n_scope
+          self
+        end
+
+        def with_predicates(expected_predicates)
+          self.expected_predicates = expected_predicates
+          self
+        end
+
+        def with_multiple(expected_multiple)
+          self.expected_multiple = expected_multiple
+          self
+        end
+
+        def with_scope(expected_scope)
+          self.expected_scope = expected_scope
+          self
+        end
+
+        def failure_message
+          "Expected #{expectation}"
+        end
+
+        def failure_message_when_negated
+          "Did not expect #{expectation}"
+        end
+
+        def description
+          description  = "define enumerize :#{expected_attr}"
+          description += " in: #{quote_values(expected_values)}" if expected_values
+          description += " with #{expected_default.inspect} as default value" if expected_default
+          description += " i18n_scope: #{expected_i18n_scope.inspect}" if expected_i18n_scope
+          description += " predicates: #{expected_predicates.inspect}" if expected_predicates
+          description += " multiple: #{expected_multiple.inspect}" if expected_multiple
+          description += " scope: #{expected_scope.inspect}" if expected_scope
+
+          description
+        end
+
+        def matches?(subject)
+          self.subject = subject
+          matches      = true
+
+          matches &= matches_attribute?
+          matches &= matches_values? if expected_values
+          matches &= matches_default_value? if expected_default
+          matches &= matches_i18n_scope? if expected_i18n_scope
+          matches &= matches_predicates? if expected_predicates
+          matches &= matches_multiple? if expected_multiple
+          matches &= matches_scope? if expected_scope
+
+          matches
+        end
+
+        private
+        attr_accessor :expected_attr, :expected_values, :subject, :expected_default,
+                      :expected_i18n_scope, :expected_predicates, :expected_multiple,
+                      :expected_scope
+
+        def expectation
+          "#{subject.class.name} to #{description}"
+        end
+
+        def matches_attribute?
+          attributes.present?
+        end
+
+        def matches_values?
+          matches_array_values? || matches_hash_values?
+        end
+
+        def matches_array_values?
+          sorted_values == enumerized_values
+        end
+
+        def matches_hash_values?
+          return unless expected_values.first.is_a?(Hash)
+          expected_values.first.all? { |k, v| enumerized_value_hash[k.to_s] == v; }
+        end
+
+        def matches_default_value?
+          expected_default == enumerized_default
+        end
+
+        def matches_i18n_scope?
+          attributes.i18n_scope == expected_i18n_scope
+        end
+
+        def matches_predicates?
+          if expected_predicates.is_a?(TrueClass)
+            subject.respond_to?("#{sorted_values.first}?")
+          else
+            subject.respond_to?("#{expected_attr}_#{attributes.values.first}?")
+          end
+        end
+
+        def matches_multiple?
+          subject.public_send(expected_attr).is_a?(Enumerize::Set)
+        end
+
+        def matches_scope?
+          if expected_scope.is_a?(TrueClass)
+            subject_class.respond_to?("with_#{expected_attr}")
+          else
+            subject_class.respond_to?(expected_scope[:scope])
+          end
+        end
+
+        def sorted_values
+          @sorted_values ||=expected_values.map(&:to_s).sort
+        end
+
+        def enumerized_values
+          @enumerized_values ||= attributes.values.sort
+        end
+
+        def enumerized_default
+          @enumerized_default ||= attributes.default_value
+        end
+
+        def enumerized_value_hash
+          @enumerized_value_hash ||= attributes.instance_variable_get('@value_hash')
+        end
+
+        def attributes
+          subject_class.enumerized_attributes.attributes[expected_attr.to_s]
+        end
+
+        def subject_class
+          @subject_class ||= subject.class
+        end
+
+        def quote_values(values)
+          sorted_values.map(&:inspect).join(', ')
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/integrations/rspec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'enumerize/integrations/rspec/matcher'
+
+module Enumerize
+  module Integrations
+    module RSpec
+      def enumerize(attr)
+        ::Enumerize::Integrations::RSpec::Matcher.new(attr)
+      end
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    include Enumerize::Integrations::RSpec
+  end
+end

data/lib/enumerize/module.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Enumerize
+  class Module < ::Module
+    attr_reader :_class_methods
+
+    def initialize
+      super
+
+      @_class_methods   = ::Module.new
+      @_dependents      = []
+      @_dependent_evals = []
+    end
+
+    def included(klass)
+      klass.extend _class_methods
+
+      @_dependent_evals.each do |block|
+        klass.instance_eval(&block)
+      end
+
+      @_dependents << klass
+    end
+
+    def dependent_eval(&block)
+      @_dependents.each do |klass|
+        klass.instance_eval(&block)
+      end
+
+      @_dependent_evals << block
+    end
+  end
+end

data/lib/enumerize/module_attributes.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module Enumerize
   module ModuleAttributes
     def included(base)
-      base.send :include, Enumerize
+      base.extend Enumerize
       base.send :include, _enumerize_module
-      base.extend _enumerize_module._class_methods
       enumerized_attributes.add_dependant base.enumerized_attributes
       super
     end

data/lib/enumerize/mongoid.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module MongoidSupport
+    def enumerize(name, options={})
+      super
+
+      _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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Predicatable
+    def respond_to_missing?(method, include_private=false)
+      predicate_method?(method) || super
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if predicate_method?(method)
+        predicate_call(method[0..-2], *args, &block)
+      else
+        super
+      end
+    end
+
+    def predicate_method?(method)
+      method[-1] == '?' && @attr.values.include?(method[0..-2])
+    end
+  end
+end

data/lib/enumerize/predicates.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module Enumerize
+  # Predicate methods.
+  #
+  # Basic usage:
+  #
+  #     class User
+  #       extend Enumerize
+  #       enumerize :sex, in: %w(male female), predicates: true
+  #     end
+  #
+  #     user = User.new
+  #
+  #     user.male?   # => false
+  #     user.female? # => false
+  #
+  #     user.sex = 'male'
+  #
+  #     user.male?   # => true
+  #     user.female? # => false
+  #
+  # Using prefix:
+  #
+  #     class User
+  #       extend Enumerize
+  #       enumerize :sex, in: %w(male female), predicates: { prefix: true }
+  #     end
+  #
+  #     user = User.new
+  #     user.sex = 'female'
+  #     user.sex_female? # => true
+  #
+  # Use <tt>only</tt> and <tt>except</tt> options to specify what values create
+  # predicate methods for.
+  module Predicates
+    def enumerize(name, options={})
+      super
+
+      if options[:predicates]
+        Builder.new(enumerized_attributes[name], options[:predicates]).build(_enumerize_module)
+      end
+    end
+
+    class Builder
+      def initialize(attr, options)
+        @attr    = attr
+        @options = options.is_a?(Hash) ? options : {}
+      end
+
+      def values
+        values = @attr.values
+
+        if @options[:only]
+          values &= Array(@options[:only]).map(&:to_s)
+        end
+
+        if @options[:except]
+          values -= Array(@options[:except]).map(&:to_s)
+        end
+
+        values
+      end
+
+      def names
+        values.map { |v| "#{v.tr('-', '_')}?" }
+      end
+
+      def build(klass)
+        klass.delegate(*names, to: @attr.name, prefix: @options[:prefix], allow_nil: true)
+      end
+    end
+  end
+end

data/lib/enumerize/scope/activerecord.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Scope
+    module ActiveRecord
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if self < ::ActiveRecord::Base
+            if options[:scope]
+              _define_activerecord_scope_methods!(name, options)
+            end
+          end
+        end
+      end
+
+      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|
+          values = enumerized_attributes[name].find_values(*values).map(&:value)
+          values = values.first if values.size == 1
+
+          where(name => values)
+        end
+
+        if options[:scope] == true
+          define_singleton_method "without_#{name}" do |*values|
+            values = enumerized_attributes[name].find_values(*values).map(&:value)
+            where(arel_table[name].not_in(values))
+          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
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/scope/mongoid.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Scope
+    module Mongoid
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if self < ::Mongoid::Document
+            if options[:scope]
+              _define_mongoid_scope_methods!(name, options)
+            end
+          end
+        end
+      end
+
+      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|
+          values = enumerized_attributes[name].find_values(*values).map(&:value)
+          self.in(name => values)
+        end
+
+        if options[:scope] == true
+          define_singleton_method "without_#{name}" do |*values|
+            values = enumerized_attributes[name].find_values(*values).map(&:value)
+            not_in(name => values)
+          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
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/scope/sequel.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module Scope
+    module Sequel
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if defined?(::Sequel::Model) && self < ::Sequel::Model
+            if options[:scope]
+              _define_sequel_scope_methods!(name, options)
+            end
+
+            require 'enumerize/hooks/sequel_dataset'
+          end
+        end
+      end
+
+      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]
+
+        def_dataset_method scope_name do |*values|
+          values = values.map { |value| klass.enumerized_attributes[name].find_value(value).value }
+          values = values.first if values.size == 1
+
+          where(name => values)
+        end
+
+        if options[:scope] == true
+          def_dataset_method "without_#{name}" do |*values|
+            values = values.map { |value| klass.enumerized_attributes[name].find_value(value).value }
+            exclude(name => values)
+          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
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/sequel.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Enumerize
+  module SequelSupport
+    def enumerize(name, options={})
+      super
+
+      _enumerize_module.dependent_eval do
+        if defined?(::Sequel::Model) && self < ::Sequel::Model
+          include InstanceMethods
+
+          require 'enumerize/hooks/sequel_dataset'
+        end
+      end
+    end
+
+    private
+
+    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?
+
+          if attr.kind_of? Multiple
+            errors.add attr.name, "is invalid" unless value.respond_to?(:all?) && value.all? { |v| v.blank? || attr.find_value(v) }
+          else
+            errors.add attr.name, "is not included in the list" unless attr.find_value(value)
+          end
+        end
+      end
+
+      def _set_default_value_for_enumerized_attributes
+        _enumerized_values_for_validation.delete_if do |k, v|
+          v.nil?
+        end
+
+        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
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/enumerize/set.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module Enumerize
+  class Set
+    include Enumerable
+    include Predicatable
+
+    attr_reader :values
+
+    def initialize(obj, attr, values)
+      @obj    = obj
+      @attr   = attr
+      @values = []
+
+      if values.respond_to?(:each)
+        values.each do |input|
+          value = @attr.find_value(input)
+
+          if value && !@values.include?(value)
+            @values << value
+          end
+        end
+      end
+    end
+
+    def <<(value)
+      @values << value
+      mutate!
+    end
+
+    alias_method :push, :<<
+
+    delegate :each, :empty?, :size, to: :values
+
+    def to_ary
+      @values.to_a
+    end
+
+    def texts
+      @values.map(&:text)
+    end
+
+    delegate :join, to: :to_ary
+
+    def ==(other)
+      return false unless other.respond_to?(:each)
+      other.size == size && other.all? { |v| @values.include?(@attr.find_value(v)) }
+    end
+
+    alias_method :eql?, :==
+
+    def include?(value)
+      @values.include?(@attr.find_value(value))
+    end
+
+    def delete(value)
+      @values.delete(@attr.find_value(value))
+      mutate!
+    end
+
+    def inspect
+      "#<Enumerize::Set {#{join(', ')}}>"
+    end
+
+    def encode_with(coder)
+      coder.represent_object(Array, @values)
+    end
+
+    private
+
+    def predicate_call(value)
+      include?(value)
+    end
+
+    def mutate!
+      @values = @obj.public_send("#{@attr.name}=", @values).values
+    end
+  end
+end

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