enum_ext 0.3.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d87b2abcd1fc85e6b40920b0623a190a8b6ae8e
-  data.tar.gz: cfdcb6362c984922ef6047a4ec719363312d8b26
+SHA256:
+  metadata.gz: 31b1c2e892139a6c351a6eceac3680a3f564175e74a590030923866e2ea1e23c
+  data.tar.gz: 43edecda5dbc4f647ab1e405647ae31dbf7c671d9fd16a17a65c6d922bee4dc4
 SHA512:
-  metadata.gz: e921603dd1328763efef7dbd5ac36e335037d4d381e4361c3c5dcf2453503e326876a42935ad679e257e6109e6d74b5aee49782047835eb70f3880c34ef76ff2
-  data.tar.gz: f6ecf63202ba792af34678ecae8f3bc73ca051894e931aebe21b2eb1de4887577f4728e06727a6e814c318a761b2b52bfdb41c8b47226abce5682db4d1676c6f
+  metadata.gz: 86ee6244b2b81a2d70edae5c5675322feac5c9a7e69b7f141c0ce11f9f4a8eacc10f6ae16b6e5e4ed87f4852dd9a59b9120291e7c86456880908e9afbe4b8f32
+  data.tar.gz: 8b2468b334499d88c470b20d397b531ecb39344101c8366faa031ad1e58a70f0cebef70f4479aa67c8c7bd1670cfb8d9dbbf86eb9cdaee6270ea5f0a9f0ad14f

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+  - 2.5.1
+  - 2.3.7

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 0.4.4
+* ext_enum_sets now can be executed without 'scope' definition present on the base class, 
+for instance you can now use with StoreModel's 
+
+# 0.4.3
+* ext_enum_sets now can go without options just to define with and without scopes
+
+# 0.4.2
+* bugfix for localize_enum multiple call
+* test added for 0.4.1 ver funcitonality ( multiple times humanize_enum calls ) 
+* all assert( a == b ) replaced with assert_equal(a,b)
+
+# 0.4.1
+* security dependency issues resolved
+* activerecord version raised 
+* humanize_enum could be called multiple times all definitions will be merged, i.e. there is no need to define all localizations in one place at once 

data/Gemfile.lock

@@ -1,82 +1,87 @@
 PATH
   remote: .
   specs:
-    enum_ext (0.3.0)
-      activerecord (>= 4.1)
+    enum_ext (0.4.4)
+      activerecord (>= 5.2.4.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.0.2)
-      actionview (= 5.0.2)
-      activesupport (= 5.0.2)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.2)
-      activesupport (= 5.0.2)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
+      erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.0.2)
-      activesupport (= 5.0.2)
-    activerecord (5.0.2)
-      activemodel (= 5.0.2)
-      activesupport (= 5.0.2)
-      arel (~> 7.0)
-    activesupport (5.0.2)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    erubis (2.7.0)
-    i18n (0.8.1)
-    loofah (2.0.3)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    erubi (1.10.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.8.2)
-    mini_portile2 (2.1.0)
-    minitest (5.8.3)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    rack (2.0.1)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    rails-i18n (5.0.3)
-      i18n (~> 0.7)
-      railties (~> 5.0)
-    railties (5.0.2)
-      actionpack (= 5.0.2)
-      activesupport (= 5.0.2)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rails-i18n (6.0.0)
+      i18n (>= 0.7, < 2)
+      railties (>= 6.0.0, < 7)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.4.2)
-    sqlite3 (1.3.13)
-    thor (0.19.4)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.3)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.11)
+  bundler (>= 1.11)
+  byebug
   enum_ext!
   minitest
   rails-i18n (>= 4)
-  rake (~> 10.0)
+  rake (>= 10.0)
   sqlite3
 
 BUNDLED WITH
-   1.14.6
+   2.1.4

data/README.md

@@ -1,13 +1,13 @@
 # EnumExt
 
-EnumExt extends rails enum adding localization/translation and it's helpers, mass-assign on scopes with bang, advanced sets logic over existing.
+EnumExt extends rails enum with localization/translation and it's helpers, mass-assign on scopes with bang, advanced sets logic over existing enum.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'enum_ext', '~> 0.2'
+gem 'enum_ext', '~> 0.3'
 ```
 
 And then execute:
@@ -19,7 +19,8 @@ Or install it yourself as:
     $ gem install enum_ext
 
 ## Usage
- To use enum extension extend main model class with EnumExt module, and extend enum the way you need:
+ To use enum extension extend main model class with EnumExt module, 
+ and customize your enums the way you need:
  
     class SomeModel
       extend EnumExt
@@ -64,10 +65,10 @@ Or install it yourself as:
   end
   ```  
    
-  This call adds to instance:
+  This humanize_enum adds to instance:
    - t_in_cart, t_paid, t_ready_for_shipment
   
-  adds to class:
+  and to class:
    - t_statuses - as given or generated values
    - t_statuses_options - translated enum values options for select input
    - t_statuses_options_i - same as above but use int values with translations works for ActiveAdmin filters for instance
@@ -103,6 +104,8 @@ Or install it yourself as:
     request.t_status   # >> "paid 3 dollars"
     Request.t_statuses # >> { in_cart: -> { I18n.t("request.status.in_cart") }, ....  }
   ```  
+
+  Could be called multiple times, all humanization definitions will be merged under the hood.  
     
 ### Translate (translate_enum) 
 
@@ -140,21 +143,23 @@ Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name]
                      in_warehouse: [:ready_for_shipment]  # this 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] ...])
+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_... ):
+        - t_delivery_set_statuses_options (= [['translation or humanization', :ready_for_shipment] ...] ) for select inputs purposes
+        - t_delivery_set_statuses_options_i (= [['translation or humanization', 3] ...]) same as above but with integer as value ( for example to use in Active admin filters )
+```
+
  ```
    Console:
     request.on_delivery!
@@ -189,7 +194,7 @@ Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name]
     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 
- has hundreds and thousands of records to change at once you need update_all
+ have hundreds and thousands of records to change at once you need update_all
 
  ```
     mass_assign_enum( :status )
@@ -204,8 +209,6 @@ Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name]
     request1.paid?                         # >> true
     request2.paid?                         # >> true
     request1.updated_at                     # >> ~ Time.now
-    defined?(Request::MassAssignEnum) # >> true
-    
     
     order.requests.already_paid.count          # >> N
     order.requests.delivered.count              # >> M
@@ -214,8 +217,6 @@ Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name]
     order.requests.delivered.count              # >> N + M
 ```
 
-
-
 ## Tests
    rake test
  

data/enum_ext.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord', '>=4.1'
+  spec.add_dependency 'activerecord', ">= 5.2.4.3"
 
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.11'
+  spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rails-i18n', '>=4'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'byebug'
 end

data/lib/enum_ext.rb

@@ -14,7 +14,7 @@ require 'enum_ext/version'
 module EnumExt
 
   # defines shortcut for getting integer value of enum.
-  # for enum named status will generate:
+  # for enum named 'status' will generate:
   # instance.status_i
   def enum_i( enum_name )
     define_method "#{enum_name}_i" do
@@ -32,7 +32,7 @@ module EnumExt
   # 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 just for superposition example  below
+  #                   in_warehouse: [:ready_for_shipment]       # this scope is just for superposition example below
   #                 }
   #
   # it will generate:
@@ -69,27 +69,26 @@ module EnumExt
   #  ext_enum_sets :status, {
   #                  outside_wharehouse: ( delivery_set_statuses - in_warehouse_statuses )... any other array operations like &, + and so can be used
   #                }
-  def ext_enum_sets( enum_name, options )
+  def ext_enum_sets( enum_name, options = {} )
     enum_plural = enum_name.to_s.pluralize
 
     self.instance_eval do
-      options.each do |set_name, enum_vals|
-        # set_name scope
-        scope set_name, -> { where( enum_name => self.send( enum_plural ).slice( *enum_vals.map(&:to_s) ).values ) }
+      # with_enums scope
+      scope "with_#{enum_plural}", -> (sets_arr) {
+        where( enum_name => self.send( enum_plural ).slice(
+          *sets_arr.map{|set_name| self.try( "#{set_name}_#{enum_plural}" ) || set_name }.flatten.uniq.map(&:to_s) ).values )
+      } if !respond_to?("with_#{enum_plural}") && respond_to?(:scope)
 
-        # with_enums scope
-        scope "with_#{enum_plural}", -> (sets_arr) {
-          where( enum_name => self.send( enum_plural ).slice(
-                     *sets_arr.map{|set_name| self.try( "#{set_name}_#{enum_plural}" ) || set_name }.flatten.uniq.map(&:to_s) ).values )
-        } unless respond_to?("with_#{enum_plural}")
-
-        # without_enums scope
-        scope "without_#{enum_plural}", -> (sets_arr) {
-          where.not( id: self.send("with_#{enum_plural}", sets_arr) )
-        } unless respond_to?("without_#{enum_plural}")
+      # without_enums scope
+      scope "without_#{enum_plural}", -> (sets_arr) {
+        where.not( id: self.send("with_#{enum_plural}", sets_arr) )
+      } if !respond_to?("without_#{enum_plural}") && respond_to?(:scope)
 
+      options.each do |set_name, enum_vals|
+        # set_name scope
+        scope set_name, -> { where( enum_name => self.send( enum_plural ).slice( *enum_vals.map(&:to_s) ).values ) } if respond_to?(:scope)
 
-        # class.enum_set_values
+          # class.enum_set_values
         define_singleton_method( "#{set_name}_#{enum_plural}" ) do
           enum_vals
         end
@@ -181,13 +180,22 @@ module EnumExt
   #   }
   # 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 select:
+  # in views select:
   #   f.select :status, Request.t_statuses_options
   #
   # in select in Active Admin filter
@@ -208,11 +216,28 @@ module EnumExt
 
     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
-        # if localization is abscent than block must be given
-        localizations.try(:with_indifferent_access) || localizations ||
-            send(enum_plural).keys.map {|en| [en, self.new( {enum_name => en} ).send("t_#{enum_name}")] }.to_h.with_indifferent_access
+        @@localizations
       end
 
       #t_enums_options
@@ -225,16 +250,8 @@ module EnumExt
         send("t_#{enum_plural}_options_raw_i", send("t_#{enum_plural}") )
       end
 
-      #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
+      define_method "t_#{enum_name}=" do |new_val|
+        send("#{enum_name}=", new_val)
       end
 
       #protected?
@@ -258,7 +275,6 @@ module EnumExt
           key_val
         end
       end
-
     end
   end
   alias localize_enum humanize_enum
@@ -278,4 +294,13 @@ module EnumExt
     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

data/lib/enum_ext/version.rb

@@ -1,3 +1,3 @@
 module EnumExt
-  VERSION = "0.3.0"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enum_ext
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.4
 platform: ruby
 authors:
 - alekseyl
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 5.2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -42,28 +42,28 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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, ads enum sets, mass-assign, localization, and some sugar
   helpers.
 email:
@@ -103,6 +117,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -117,7 +133,7 @@ homepage: https://github.com/alekseyl/enum_ext
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Enum extension, ads enum sets, mass-assign, localization, and some sugar
   helpers.