enum_ext 0.8.1 → 1.0.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c17ae56d510836b3106e8b1ca84b83f69a6854a0988192e71d7a7a62910dde0
-  data.tar.gz: 870773a5d09b15840695a8ff0ee57823b4bcc4c89753a88840b3daca7a69ae28
+  metadata.gz: 13e0504e5a07f15d1d1308cce427cc3521520d76f8e61298c8c46568e1d3c9d4
+  data.tar.gz: 869bab9d23901292cb977f62cc79e0ab9e760851cb05c8b9596a334457e99977
 SHA512:
-  metadata.gz: dd80dfc1f862eb03fbd9065af6f1eee36a95254ce4dd7e708073683ca4d5483163457cb5a8b96da851943d93246436a0897965d11b0f5478d966a4a590c82276
-  data.tar.gz: f07fd0d4869deba68067d29a0e6ac6a8003ae4df28dea658decd66455f12a5cbcdd622e816042f93de452c7186bb7af885b9b0d549b2fe3c40edfccd6b3fadf1
+  metadata.gz: 27c879c403dcd5d2328bca485426e58063c9ca3a396b6255cd5d3c2bddb96edbb2522f37499084152a6dcea23915c45b64633e78d2284ac769e14a1c5b9cdb00
+  data.tar.gz: 1dcc91a044f65445593cf8be10c29e49e06a99d756233f50d2b41c7c737100eea10061a08ff28915e8564e881f047afc6e3709b7e7d4a49b3fd2d3ccc65d3a6c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.0.0.rc
+* global configuration added
+
+# 0.9.1
+* fix https://github.com/alekseyl/enum_ext/issues/53 
+
+# 0.9
+* supersets works fine and same way with prefixes and suffixes as usual enum does
+
 # 0.8.1
 * Fixes issue https://github.com/alekseyl/enum_ext/issues/50
 * Better describe for supersets.

data/Gemfile_rails_6.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enum_ext (0.8.0)
+    enum_ext (0.9.0)
       activerecord (>= 5.2.4.3)
 
 GEM
@@ -82,6 +82,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (< 7)
   amazing_print
   bundler (>= 1.11)
   byebug

data/README.md

@@ -320,6 +320,20 @@ And per extension methods (describe_enum_i, e.t.c)
 ```
 ![img_3.png](img_3.png)
 
+## Configuration
+```ruby
+EnumExt.configure do |config|
+  # the name of class which will have EnumExt extended globally
+  # default: nil
+  config.application_record_class = ApplicationRecord 
+  # default helpers, will be added to every enum ext definitions
+  # default value: [:multi_enum_scopes, :mass_assign_enum]
+  config.default_helpers = [:multi_enum_scopes, :mass_assign_enum]
+end
+
+```
+
+
 ## Tests
 Starting version 0.6 added support for rails 7+ enum definitions, that's making testing a little bit not that easy as running `rake test`.
 Now testings are done via `docker-compose up`. Look closer to Dockerfiles and `docker-compose.yml` 
@@ -334,7 +348,6 @@ rake test TEST=test/test_enum_ext.rb TESTOPTS="--name=/bb/"
 ## Development
 
 ## TODO
-[] better support for suffix/prefix as enum does
 [] add global config and allow global extension
 
 ## Contributing

data/lib/enum_ext/basic_helpers.rb

@@ -8,7 +8,7 @@ module EnumExt::BasicHelpers
   #
   # Rem. Will not define helper when enum values are strings, and will print warning
   def enum_i( enum_name )
-    return puts(<<~NOTINTEGER) if columns_hash[enum_name.to_s].type != :integer
+    return puts(<<~NOTINTEGER) if table_exists? && columns_hash[enum_name.to_s].type != :integer
       ---------------------NOTINTEGER WARNING!---------------------------
       #{enum_name} is not an integer column, so enum_i helper useless and method will not be defined
     NOTINTEGER
@@ -73,11 +73,11 @@ module EnumExt::BasicHelpers
 
   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} : {} ))
+      enum_plural = enum_name.to_s.pluralize
+      self.send(enum_plural).keys.each do |label|
+        method_name = self.send(enum_plural).transform_enum_label(label)
+        define_singleton_method( "#{method_name}!" ) do
+          self.update_all( {enum_name => self.send(enum_plural)[label]}.merge( self.column_names.include?('updated_at') ? {updated_at: Time.now} : {} ))
         end
       end
     end

data/lib/enum_ext/config.rb

@@ -0,0 +1,20 @@
+module EnumExt
+  class EnumExtConfig
+    attr_accessor :default_helpers, :application_record_class
+
+    def initialize
+      self.default_helpers = [:multi_enum_scopes, :mass_assign_enum]
+    end
+  end
+
+  class << self
+    def configure
+      yield(config)
+      config.application_record_class&.extend( EnumExt ) if config.application_record_class.is_a?(Class)
+    end
+
+    def config
+      @config ||= EnumExtConfig.new
+    end
+  end
+end

data/lib/enum_ext/enum_wrapper.rb

@@ -5,12 +5,12 @@ class EnumExt::EnumWrapper
   include EnumExt::Annotated
 
   # supersets is storing exact definitions, if you need a raw mapping use class.statuses.superset_statuses
-  attr_reader :enum_values, :supersets, :supersets_raw, :t_options_raw, :localizations, :base_class, :enum_name
+  attr_reader :enum_values, :supersets, :supersets_raw, :t_options_raw, :localizations, :base_class, :enum_name, :suffix, :prefix
 
   delegate_missing_to :enum_values
   delegate :inspect, to: :enum_values
 
-  def initialize(enum_values, base_class, enum_name)
+  def initialize(enum_values, base_class, enum_name, **options)
     @enum_values = enum_values
     @supersets = ActiveSupport::HashWithIndifferentAccess.new
     @supersets_raw = ActiveSupport::HashWithIndifferentAccess.new
@@ -20,6 +20,8 @@ class EnumExt::EnumWrapper
 
     @base_class = base_class
     @enum_name = enum_name
+    @suffix = options[:suffix] || options[:_suffix]
+    @prefix = options[:prefix] || options[:_prefix]
   end
 
   #  ext_sets_to_kinds( :ready_for_shipment, :delivery_set ) -->
@@ -51,6 +53,18 @@ class EnumExt::EnumWrapper
 
   alias_method :t, :localizations
 
+  def transform_enum_label(label)
+    _prefix = if prefix
+      prefix == true ? "#{enum_name}_" : "#{prefix}_"
+    end
+
+    _suffix = if suffix
+      suffix == true ? "_#{enum_name}" : "_#{suffix}"
+    end
+
+    "#{_prefix}#{label}#{_suffix}"
+  end
+
   private
 
   def evaluate_localizations(t_enum_set)
@@ -75,4 +89,6 @@ class EnumExt::EnumWrapper
     end
   end
 
+
+
 end

data/lib/enum_ext/superset_helpers.rb

@@ -54,6 +54,8 @@ module EnumExt::SupersetHelpers
     enum_plural = enum_name.to_s.pluralize
 
     self.instance_eval do
+      suffix = send(enum_plural).suffix
+      prefix = send(enum_plural).prefix
       send(enum_plural).supersets.merge!( options.transform_values{ _1.try(:map, &:to_s) || _1.to_s } )
 
       options.each do |superset_name, enum_vals|
@@ -64,11 +66,12 @@ module EnumExt::SupersetHelpers
         # class.enum_wrapper.superset
         send(enum_plural).define_singleton_method(superset_name) { base_class.send(enum_plural).superset_to_enum(*enum_vals) }
 
+        superset_method_name = send(enum_plural).transform_enum_label(superset_name)
         # superset_name scope
-        scope superset_name, -> { where( enum_name => send(enum_plural).send(superset_name) ) } if respond_to?(:scope)
+        scope superset_method_name, -> { where( enum_name => send(enum_plural).send(superset_name) ) } if respond_to?(:scope)
 
         # instance.superset_name?
-        define_method "#{superset_name}?" do
+        define_method "#{superset_method_name}?" do
           send(enum_name) && self.class.send(enum_plural).send(superset_name).include?( send(enum_name) )
         end
 

data/lib/enum_ext/version.rb

@@ -1,3 +1,3 @@
 module EnumExt
-  VERSION = "0.8.1"
+  VERSION = "1.0.0.rc"
 end

data/lib/enum_ext.rb

@@ -1,4 +1,5 @@
 require "enum_ext/version"
+require "enum_ext/config"
 require "enum_ext/annotated"
 require "enum_ext/enum_wrapper"
 require "enum_ext/humanize_helpers"
@@ -16,24 +17,6 @@ require "enum_ext/superset_helpers"
 #   has_many :requests
 # end
 
-puts <<~DEPRECATION
-  ---------------------DEPRECATION WARNING---------------------------
-  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.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
-
-DEPRECATION
-
 module EnumExt
   include HumanizeHelpers   # translate and humanize
   include SupersetHelpers   # enum_supersets
@@ -48,34 +31,39 @@ module EnumExt
   # 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)
+    extensions = [*EnumExt.config.default_helpers, *options.delete(:ext)]
+    options_dup = options.dup
 
     (ActiveRecord::VERSION::MAJOR >= 7 ? super : super(options)).tap do |multiple_enum_definitions|
       if single_enum_definition
-        enum_ext(name, extensions)
+        replace_enum_with_wrapper(name, options_dup)
+        enum_ext(name, [*extensions])
       else
-        multiple_enum_definitions.each { |enum_name,| enum_ext(enum_name, extensions) }
+        multiple_enum_definitions.each { |enum_name,|
+          replace_enum_with_wrapper(enum_name, options_dup)
+          enum_ext(enum_name, [*extensions])
+        }
       end
     end
   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] }]
     #   --> [: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
 
   private
-  def replace_enum_with_wrapper(enum_name)
+
+  def replace_enum_with_wrapper(enum_name, options_dup)
     enum_name_plural = enum_name.to_s.pluralize
     return if send(enum_name_plural).is_a?(EnumWrapper)
 
     # 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)
+    enum_wrapper = EnumWrapper.new(send(enum_name_plural), self, enum_name, **options_dup)
     # "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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ext
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0.rc
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -181,6 +181,7 @@ files:
 - lib/enum_ext.rb
 - lib/enum_ext/annotated.rb
 - lib/enum_ext/basic_helpers.rb
+- lib/enum_ext/config.rb
 - lib/enum_ext/enum_wrapper.rb
 - lib/enum_ext/humanize_helpers.rb
 - lib/enum_ext/superset_helpers.rb
@@ -200,9 +201,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.15
 signing_key: