enum_ext 0.5.2 → 0.8.0

data/lib/enum_ext.rb

@@ -1,4 +1,9 @@
 require "enum_ext/version"
+require "enum_ext/annotated"
+require "enum_ext/enum_wrapper"
+require "enum_ext/humanize_helpers"
+require "enum_ext/basic_helpers"
+require "enum_ext/superset_helpers"
 
 # Let's assume we have model Request with enum status, and we have model Order with requests like this:
 # class Request
@@ -13,382 +18,66 @@ require "enum_ext/version"
 
 puts <<~DEPRECATION
   ---------------------DEPRECATION WARNING---------------------------
-  There are TWO MAJOR breaking changes coming into the next version :
-  First deprecation: all major DSL moving major class methods to 
+  There are TWO MAJOR breaking changes coming into the next major version :
+  First deprecation: all major DSL moving class methods to 
   enum, just for the sake of clarity:  
 
   Ex for enum named kinds it could look like this: 
 
-    Class.ext_sets_to_kinds         --> Class.kinds.set_to_basic
-    Class.ext_kinds                 --> Class.kinds.sets
+    Class.ext_sets_to_kinds         --> Class.kinds.superset_to_basic
+    Class.ext_kinds                 --> Class.kinds.supersets
     Class.all_kinds_defs            --> Class.kinds.all
+   
+    Class.t_kinds                   --> Class.kinds.t
     Class.t_kinds_options           --> Class.kinds.t_options
     Class.t_named_set_kinds_options --> Class.kinds.t_named_set_options
-  
-  Enum extensions preferable way will be using param to original enum call:
-  Ex:
-    #Instead of three method calls:    
-    enum kind: {}
-    enum_i :kind
-    enum_mass_assign :kind
 
-    #You should go with ext  option instead:
-    enum kinds: {}, ext: [:enum_i, :enum_mass_assign]
 DEPRECATION
 
 module EnumExt
-
-  class << self
-    def define_set_to_enum_method( extended_class, enum_plural)
-      #  ext_sets_to_kinds( :ready_for_shipment, :delivery_set ) --> [:ready_for_shipment, :on_delivery, :delivered]
-      extended_class.define_singleton_method("ext_sets_to_#{enum_plural}") do |*enum_or_sets|
-        return [] if enum_or_sets.blank?
-        enum_or_sets_strs = enum_or_sets.map(&:to_s)
-
-        next_level_deeper = try("ext_#{enum_plural}").slice( *enum_or_sets_strs ).values.flatten
-        (enum_or_sets_strs & send(enum_plural).keys | send("ext_sets_to_#{enum_plural}", *next_level_deeper)).uniq
-      end
-    end
-
-    def define_summary_methods(extended_class, enum_plural)
-      extended_class.define_singleton_method("ext_#{enum_plural}") do
-        @enum_ext_summary ||= ActiveSupport::HashWithIndifferentAccess.new
-      end unless respond_to?("ext_#{enum_plural}")
-
-      extended_class.define_singleton_method("all_#{enum_plural}") do
-        {
-          **send(enum_plural),
-          "ext_#{enum_plural}": {
-            **send("ext_#{enum_plural}")
-          }
-        } unless respond_to?("all_#{enum_plural}")
-      end
-    end
-  end
+  include HumanizeHelpers   # translate and humanize
+  include SupersetHelpers   # enum_supersets
+  include BasicHelpers      # enum_i, mass_assign, multi_enum_scopes
 
   # extending enum with inplace settings
-  # enum status: {}, ext: [:enum_i, :mass_assign_enum, :enum_multi_scopes]
-  # enum_i and mass_assign_enum ara
-  def enum(definitions)
-    extensions = definitions.delete(:ext)
-
-    super(definitions).tap do
-      definitions.each do |name,|
-        [*extensions].each{|ext_method| send(ext_method, name) }
+  # enum status: {}, ext: [:enum_i, :mass_assign_enum, :enum_multi_scopes, enum_supersets: {  }]
+  # and wrapping and replacing original enum with a wrapper object
+  #
+  # I'm using signature of a ActiveRecord 7 here: enum(name = nil, values = nil, **options)
+  # in earlier versions of ActiveRecord signature looks different: enum(definitions),
+  # so calling super should be different based on ActiveRecord major version
+  def enum(name = nil, values = nil, **options)
+    single_enum_definition = name.present?
+    extensions = options.delete(:ext)
+
+    (ActiveRecord::VERSION::MAJOR >= 7 ? super : super(options)).tap do |multiple_enum_definitions|
+      if single_enum_definition
+        enum_ext(name, extensions)
+      else
+        multiple_enum_definitions.each { |enum_name,| enum_ext(enum_name, extensions) }
       end
     end
   end
 
-  # Defines instance method a shortcut for getting integer value of an enum.
-  # for enum named 'status' will generate:
-  #
-  # instance.status_i
-  def enum_i( enum_name )
-    define_method "#{enum_name}_i" do
-      self.class.send("#{enum_name.to_s.pluralize}")[send(enum_name)].to_i
-    end
-  end
-
-  # Defines two scopes for one for an inclusion: `WHERE enum IN( enum1, enum2 )`,
-  # and the second for an exclusion: `WHERE enum NOT IN( enum1, enum2 )`
-  #
-  # Ex:
-  #  Request.with_statuses( :payed, :delivery_set )    # >> :payed and [:ready_for_shipment, :on_delivery, :delivered] requests
-  #  Request.without_statuses( :payed )                # >> scope for all requests with statuses not eq to :payed
-  #  Request.without_statuses( :payed, :in_warehouse ) # >> scope all requests with statuses not eq to :payed or :ready_for_shipment
-  def multi_enum_scopes(enum_name)
-    enum_plural = enum_name.to_s.pluralize
-
-    self.instance_eval do
-      # with_enums scope
-      scope "with_#{enum_plural}", -> (*enum_list) {
-        where( enum_name => send("ext_sets_to_#{enum_plural}", enum_list) )
-      } if !respond_to?("with_#{enum_plural}") && respond_to?(:scope)
-
-      # without_enums scope
-      scope "without_#{enum_plural}", -> (*enum_list) {
-        where.not( enum_name => send("ext_sets_to_#{enum_plural}", enum_list) )
-      } if !respond_to?("without_#{enum_plural}") && respond_to?(:scope)
-
-      EnumExt.define_set_to_enum_method(self, enum_plural)
-      EnumExt.define_summary_methods(self, enum_plural)
-    end
+  # its an extension helper, on the opposite to basic enum method could be called multiple times
+  def enum_ext(enum_name, extensions)
+    replace_enum_with_wrapper(enum_name)
+      # [:enum_i, :enum_multi_scopes, enum_supersets: { valid: [:fresh, :cool], invalid: [:stale] }]
+    #   --> [:enum_i, :enum_multi_scopes, [:enum_supersets, { valid: [:fresh, :cool], invalid: [:stale] }]
+    [*extensions].map { _1.try(:to_a)&.flatten || _1 }
+                 .each { |(ext_method, params)| send(*[ext_method, enum_name, params].compact) }
   end
 
-  # ext_enum_sets
-  # This method intend for creating and using some sets of enum values
-  #
-  # it creates: scopes for subsets,
-  #             instance method with ?,
-  #             and some class methods helpers
-  #
-  # For this call:
-  #   ext_enum_sets :status, {
-  #                   delivery_set: [:ready_for_shipment, :on_delivery, :delivered] # for shipping department for example
-  #                   in_warehouse: [:ready_for_shipment]       # this scope is just for superposition example below
-  #                 }
-  #
-  # it will generate:
-  #   instance:
-  #     methods: delivery_set?, in_warehouse?
-  #   class:
-  #     named scopes: delivery_set, in_warehouse
-  #     parametrized scopes: with_statuses, without_statuses
-  #     class helpers:
-  #       - delivery_set_statuses (=[:ready_for_shipment, :on_delivery, :delivered] ), in_warehouse_statuses
-  #       - delivery_set_statuses_i (= [3,4,5]), in_warehouse_statuses_i (=[3])
-  #     class translation helpers ( started with t_... )
-  #       for select inputs purposes:
-  #       - t_delivery_set_statuses_options (= [['translation or humanization', :ready_for_shipment] ...])
-  #       same as above but with integer as value ( for example to use in Active admin filters )
-  #       - t_delivery_set_statuses_options_i (= [['translation or humanization', 3] ...])
-
-  # Console:
-  #  request.on_delivery!
-  #  request.delivery_set?                    # >> true
-
-  #  Request.delivery_set.exists?(request)    # >> true
-  #  Request.in_warehouse.exists?(request)    # >> false
-  #
-  #  Request.delivery_set_statuses            # >> [:ready_for_shipment, :on_delivery, :delivered]
-
-  #Rem:
-  #  ext_enum_sets can be called twice defining a superposition of already defined sets ( considering previous example ):
-  #  ext_enum_sets :status, {
-  #                  outside_warehouse: ( delivery_set_statuses - in_warehouse_statuses )... any other array operations like &, + and so can be used
-  #                }
-  def ext_enum_sets( enum_name, options = {} )
-    enum_plural = enum_name.to_s.pluralize
-
-    self.instance_eval do
-      EnumExt.define_set_to_enum_method(self, enum_plural)
-      EnumExt.define_summary_methods(self, enum_plural)
-
-      puts(<<~DEPRECATION) unless respond_to?("with_#{enum_plural}")
-        ----------------DEPRECATION WARNING----------------
-        - with/without_#{enum_plural} are served now via multi_enum_scopes method, 
-          and will be removed from the ext_enum_sets in the next version!
-      DEPRECATION
-      multi_enum_scopes(enum_name)
-
-      send("ext_#{enum_plural}").merge!( options.transform_values{ _1.map(&:to_s) } )
-
-      options.each do |set_name, enum_vals|
-        # set_name scope
-        scope set_name, -> { where( enum_name => send("#{set_name}_#{enum_plural}") ) } if respond_to?(:scope)
-
-        # class.enum_set_values
-        define_singleton_method( "#{set_name}_#{enum_plural}" ) do
-          send("ext_sets_to_#{enum_plural}", *enum_vals)
-        end
-
-        # instance.set_name?
-        define_method "#{set_name}?" do
-          send(enum_name) && self.class.send( "#{set_name}_#{enum_plural}" ).include?( send(enum_name) )
-        end
-
-        # t_... - are translation dependent methods
-        # This one is a narrow case helpers just a quick subset of t_ enums options for a set
-        # class.t_enums_options
-        define_singleton_method( "t_#{set_name}_#{enum_plural}_options" ) do
-          return [["Enum translations call missed. Did you forget to call translate #{enum_name}"]*2] unless respond_to?( "t_#{enum_plural}_options_raw" )
+  private
+  def replace_enum_with_wrapper(enum_name)
+    enum_name_plural = enum_name.to_s.pluralize
+    return if send(enum_name_plural).is_a?(EnumWrapper)
 
-          send("t_#{enum_plural}_options_raw", send("t_#{set_name}_#{enum_plural}") )
-        end
-
-        # class.t_enums_options_i
-        define_singleton_method( "t_#{set_name}_#{enum_plural}_options_i" ) do
-          return [["Enum translations call missed. Did you forget to call translate #{enum_name}"]*2] unless respond_to?( "t_#{enum_plural}_options_raw_i" )
-
-          send("t_#{enum_plural}_options_raw_i", send("t_#{set_name}_#{enum_plural}") )
-        end
-
-        # protected?
-        # class.t_set_name_enums ( translations or humanizations subset for a given set )
-        define_singleton_method( "t_#{set_name}_#{enum_plural}" ) do
-          return [(["Enum translations call missed. Did you forget to call translate #{enum_name}"]*2)].to_h unless respond_to?( "t_#{enum_plural}" )
-
-          send( "t_#{enum_plural}" ).slice( *send("#{set_name}_#{enum_plural}") )
-        end
-      end
-    end
+    # enum will freeze values so there is no other way to move extended functionality,
+    # than to use wrapper and delegate everything to enum_values
+    enum_wrapper = EnumWrapper.new(send(enum_name_plural), self, enum_name)
+    # "self" here is a base enum class, so we are replacing original enum definition, with a wrapper
+    define_singleton_method(enum_name_plural) { enum_wrapper }
   end
 
-  # Ex mass_assign_enum
-  #
-  # Used for mass assigning for collection without callbacks it creates bang methods for collections using update_all.
-  # it's often case when you need bulk update without callbacks, so it's gets frustrating to repeat:
-  # some_scope.update_all(status: Request.statuses[:new_status], update_at: Time.now)
-  #
-  # If you need callbacks you can do like this: some_scope.each(&:new_stat!) but if you don't need callbacks
-  # and you have lots of records to change at once you need update_all
-  #
-  #  mass_assign_enum( :status )
-  #
-  #  class methods:
-  #    in_cart! paid! in_warehouse! and so
-  #
-  # Console:
-  # request1.in_cart!
-  # request2.waiting_for_payment!
-  # Request.with_statuses( :in_cart, :waiting_for_payment ).payed!
-  # request1.paid?                          # >> true
-  # request2.paid?                          # >> true
-  # request1.updated_at                     # >> Time.now
-  #
-  # order.requests.paid.all?(&:paid?)       # >> true
-  # order.requests.paid.delivered!
-  # order.requests.map(&:status).uniq       #>> [:delivered]
-
-  def mass_assign_enum( *enums_names )
-    enums_names.each do |enum_name|
-      enum_vals = self.send( enum_name.to_s.pluralize )
-
-      enum_vals.keys.each do |enum_el|
-        define_singleton_method( "#{enum_el}!" ) do
-          self.update_all( {enum_name => enum_vals[enum_el]}.merge( self.column_names.include?('updated_at') ? {updated_at: Time.now} : {} ))
-        end
-      end
-    end
-  end
-  alias_method :enum_mass_assign, :mass_assign_enum
-
-  # if app doesn't need internationalization, it may use humanize_enum to make enum user friendly
-  #
-  # class Request
-  #   humanize_enum :status, {
-  #     #locale dependent example with pluralization and lambda:
-  #     payed: -> (t_self) { I18n.t("request.status.payed", count: t_self.sum ) }
-  #
-  #     #locale dependent example with pluralization and proc:
-  #     payed: Proc.new{ I18n.t("request.status.payed", count: self.sum ) }
-  #
-  #     #locale independent:
-  #     ready_for_shipment: "Ready to go!"
-  #   }
-  # end
-  #
-  # Could be called multiple times, all humanization definitions will be merged under the hood:
-  #  humanize_enum :status, {
-  #     payed: I18n.t("scope.#{status}")
-  # }
-  # humanize_enum :status, {
-  #   billed: I18n.t("scope.#{status}")
-  # }
-  #
-  #
-  # Example with block:
-  #
-  # humanize_enum :status do
-  #  I18n.t("scope.#{status}")
-  # end
-  #
-  # in views select:
-  #   f.select :status, Request.t_statuses_options
-  #
-  # in select in Active Admin filter
-  #   collection: Request.t_statuses_options_i
-  #
-  # Rem: select options breaks when using lambda() with params
-  #
-  # Console:
-  #   request.sum = 3
-  #   request.payed!
-  #   request.status     # >> payed
-  #   request.t_status   # >> "Payed 3 dollars"
-  #   Request.t_statuses # >> { in_cart: -> { I18n.t("request.status.in_cart") }, ....  }
-  def humanize_enum( *args, &block )
-    enum_name = args.shift
-    localizations = args.pop
-    enum_plural = enum_name.to_s.pluralize
-
-    self.instance_eval do
-
-      #t_enum
-      define_method "t_#{enum_name}" do
-        t = block || @@localizations.try(:with_indifferent_access)[send(enum_name)]
-        if t.try(:lambda?)
-          t.try(:arity) == 1 && t.call( self ) || t.try(:call)
-        elsif t.is_a?(Proc)
-          instance_eval(&t)
-        else
-          t
-        end.to_s
-      end
-
-      @@localizations ||= {}.with_indifferent_access
-      # if localization is abscent than block must be given
-      @@localizations.merge!(
-        localizations.try(:with_indifferent_access) ||
-          localizations ||
-          send(enum_plural).keys.map{|en| [en, Proc.new{ self.new({ enum_name => en }).send("t_#{enum_name}") }] }.to_h.with_indifferent_access
-      )
-      #t_enums
-      define_singleton_method( "t_#{enum_plural}" ) do
-        @@localizations
-      end
-
-      #t_enums_options
-      define_singleton_method( "t_#{enum_plural}_options" ) do
-        send("t_#{enum_plural}_options_raw", send("t_#{enum_plural}") )
-      end
-
-      #t_enums_options_i
-      define_singleton_method( "t_#{enum_plural}_options_i" ) do
-        send("t_#{enum_plural}_options_raw_i", send("t_#{enum_plural}") )
-      end
-
-      define_method "t_#{enum_name}=" do |new_val|
-        send("#{enum_name}=", new_val)
-      end
-
-      #protected?
-      define_singleton_method( "t_#{enum_plural}_options_raw_i" ) do |t_enum_set|
-        send("t_#{enum_plural}_options_raw", t_enum_set ).map do | key_val |
-          key_val[1] = send(enum_plural)[key_val[1]]
-          key_val
-        end
-      end
-
-      define_singleton_method( "t_#{enum_plural}_options_raw" ) do |t_enum_set|
-        t_enum_set.invert.to_a.map do | key_val |
-          # since all procs in t_enum are evaluated in context of a record than it's not always possible to create select options
-          if key_val[0].respond_to?(:call)
-            if key_val[0].try(:arity) < 1
-              key_val[0] = key_val[0].try(:call) rescue "Cannot create option for #{key_val[1]} ( proc fails to evaluate )"
-            else
-              key_val[0] = "Cannot create option for #{key_val[1]} because of a lambda"
-            end
-          end
-          key_val
-        end
-      end
-    end
-  end
-  alias localize_enum humanize_enum
-
-  # Simple way to translate enum.
-  # It use either given scope as second argument, or generated activerecord.attributes.model_name_underscore.enum_name
-  # If block is given than no scopes are taken in consider
-  def translate_enum( *args, &block )
-    enum_name = args.shift
-    enum_plural = enum_name.to_s.pluralize
-    t_scope = args.pop || "activerecord.attributes.#{self.name.underscore}.#{enum_plural}"
-
-    if block_given?
-      humanize_enum( enum_name, &block )
-    else
-      humanize_enum( enum_name, send(enum_plural).keys.map{|en| [ en, Proc.new{ I18n.t("#{t_scope}.#{en}") }] }.to_h )
-    end
-  end
-
-  # human_attribute_name is redefined for automation like this:
-  # p #{object.class.human_attribute_name( attr_name )}:
-  # p object.send(attr_name)
-  def human_attribute_name( name, options = {} )
-    # if name starts from t_ and there is a column with the last part then ...
-    name[0..1] == 't_' && column_names.include?(name[2..-1]) ? super( name[2..-1], options ) : super( name, options )
-  end
-
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ext
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.8.0
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-01 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails_sql_prettifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Enum extension introduces: enum supersets, enum mass-assign, easy localization,
   and more sweetness to Active Record enums.'
 email:
@@ -133,15 +161,29 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- Dockerfile
+- Dockerfile_rails_7
+- Gemfile_rails_6
+- Gemfile_rails_6.lock
+- Gemfile_rails_7
+- Gemfile_rails_7.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - enum_ext.gemspec
+- img.png
+- img_1.png
+- img_2.png
+- img_3.png
 - lib/enum_ext.rb
+- lib/enum_ext/annotated.rb
+- lib/enum_ext/basic_helpers.rb
+- lib/enum_ext/enum_wrapper.rb
+- lib/enum_ext/humanize_helpers.rb
+- lib/enum_ext/superset_helpers.rb
 - lib/enum_ext/version.rb
 homepage: https://github.com/alekseyl/enum_ext
 licenses:
@@ -162,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: 'Enum extension introduces: enum supersets, enum mass-assign, easy localization,