enum_ext 0.5.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3be0377b4cba2aee0f9ee1fbb19e5efa6c824b0e5965eefca3ea7de7108df363
-  data.tar.gz: c7a15c944f6598129b29f0ab61f3650a251af242111d90b056f86677fdf51780
+  metadata.gz: 2c17ae56d510836b3106e8b1ca84b83f69a6854a0988192e71d7a7a62910dde0
+  data.tar.gz: 870773a5d09b15840695a8ff0ee57823b4bcc4c89753a88840b3daca7a69ae28
 SHA512:
-  metadata.gz: d920ca2ae630226a778ba83144115f360b97c4e9e52759ecc05aae77fd095fe806912ef81c01fe6750031f700c6e2d9c9511a4c7164897ce6ac3ccf86479a365
-  data.tar.gz: 4433d920ae0ec84e9ad33b6c728a238462f0884b7ce9c693143c06f0a41def984bc25ade651c7c4cdd1d15b32e8229b9deb6a13ba6059885dc9d5d216b591086
+  metadata.gz: dd80dfc1f862eb03fbd9065af6f1eee36a95254ce4dd7e708073683ca4d5483163457cb5a8b96da851943d93246436a0897965d11b0f5478d966a4a590c82276
+  data.tar.gz: f07fd0d4869deba68067d29a0e6ac6a8003ae4df28dea658decd66455f12a5cbcdd622e816042f93de452c7186bb7af885b9b0d549b2fe3c40edfccd6b3fadf1

data/CHANGELOG.md

@@ -1,6 +1,30 @@
+# 0.8.1
+* Fixes issue https://github.com/alekseyl/enum_ext/issues/50
+* Better describe for supersets.
+* Multiple readme and comments fixes
+
+# 0.8.0
+* Methods annotations added:
+  * Full descriptions: Class.enum.describe(short=true) / Class.enum.describe_short / Class.enum.describe_long / Class.enum.describe_basic
+  * Per-methods: Class.enum.describe_enum_i, describe_mass_assign_enum, describe_multi_enum_scopes e.t.c.
+* method Class.enum.supersets_raw added, it will return supersets decompositions to basic enum
+* Class.enum.all method now returns basic enum_values + supersets_raw decomposition to basic enums ( previously was a supersets i.e. high level definition )
+
+# 0.7.0 
+* rails 7 syntax support added
+* massive test process refactoring docker with both rails 7 and earlier support
+* simple translate_enum allowed via `ext: [:translate_enum]`
+
+# 0.6.0 (BREAKING CHANGES)
+* fixed issue with non array superset
+* standard helpers are now private, you should use enum_ext / enum , ext: []  approach to the definitions
+* class.superset_statuses moved to enum_obj -> class.statuses.superset_statuses
+* massive ReadMe refactoring
+
 # 0.5.3
 * refactored tests
 * multi_enum_scopes will be chainable with empty params (i.e. will not change the scope)
+* some development dependencies were added
 
 # 0.5.2
 * removed unused require from the upcoming version 

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:3.0.3-bullseye
+
+WORKDIR /app
+#RUN  apt-get update && apt-get -y install lsb-release
+##
+#RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+#    sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+#    apt-get update && apt-get -y install postgresql postgresql-client-12
+#
+#RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+#    service postgresql start && \
+#    psql -U postgres -c 'CREATE DATABASE "niceql-test"'
+
+RUN  gem install bundler
+
+COPY lib/enum_ext/version.rb /app/lib/enum_ext/version.rb
+COPY enum_ext.gemspec /app/
+COPY Gemfile_rails_6 /app/Gemfile
+COPY Gemfile_rails_6.lock /app/Gemfile.lock
+COPY Rakefile /app/
+#
+RUN bundle install

data/Dockerfile_rails_7

@@ -0,0 +1,25 @@
+FROM ruby:3.0.3-bullseye
+
+WORKDIR /app
+#RUN  apt-get update && apt-get -y install lsb-release
+##
+#RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+#    sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+#    apt-get update && apt-get -y install postgresql postgresql-client-12
+#
+#RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+#    service postgresql start && \
+#    psql -U postgres -c 'CREATE DATABASE "niceql-test"'
+
+RUN  gem install bundler
+
+
+RUN  gem install bundler
+
+COPY lib/enum_ext/version.rb /app/lib/enum_ext/version.rb
+COPY enum_ext.gemspec /app/
+COPY Gemfile_rails_7 /app/Gemfile
+COPY Gemfile_rails_7.lock /app/Gemfile.lock
+COPY Rakefile /app/
+
+RUN bundle install

data/{Gemfile → Gemfile_rails_6}

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in enum_ext.gemspec
 gemspec
 
+gem 'activerecord', "<7"

data/{Gemfile.lock → Gemfile_rails_6.lock}

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enum_ext (0.5.2)
+    enum_ext (0.8.0)
       activerecord (>= 5.2.4.3)
 
 GEM
@@ -94,4 +94,4 @@ DEPENDENCIES
   stubberry
 
 BUNDLED WITH
-   2.1.4
+   2.4.17

data/Gemfile_rails_7

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_ext.gemspec
+gemspec
+
+gem 'activerecord', ">=7"

data/Gemfile_rails_7.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    enum_ext (0.8.0)
+      activerecord (>= 5.2.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.6)
+      actionview (= 7.0.6)
+      activesupport (= 7.0.6)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.6)
+      activesupport (= 7.0.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    amazing_print (1.5.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.18.1)
+    niceql (0.6.1)
+    nokogiri (1.15.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rails-i18n (7.0.7)
+      i18n (>= 0.7, < 2)
+      railties (>= 6.0.0, < 8)
+    rails_sql_prettifier (7.0.4)
+      activerecord (>= 7)
+      niceql (~> 0.6)
+    railties (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    sqlite3 (1.6.3-x86_64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
+    stubberry (0.3.0)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (>= 7)
+  amazing_print
+  bundler (>= 1.11)
+  byebug
+  enum_ext!
+  minitest
+  rails-i18n (>= 4)
+  rails_sql_prettifier
+  rake (>= 10.0)
+  sqlite3
+  stubberry
+
+BUNDLED WITH
+   2.4.17

data/README.md

@@ -7,7 +7,7 @@ EnumExt extends rails enum with localization/translation and it's helpers, mass-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'enum_ext', '~> 0.3'
+gem 'enum_ext', '~> 0.8'
 ```
 
 And then execute:
@@ -26,12 +26,12 @@ Or install it yourself as:
       
    class SomeModel
       extend EnumExt
-    
-      enum kinds: {}, ext: [:enum_i, :enum_mass_assign, ]
-        humanize_enum #...
-        translate_enum #...
-        ext_enum_sets #...
-    end
+        
+      enum status: {}, ext: [:enum_i, :enum_mass_assign, enum_supersets: { superset: [:basic_enum] } ]
+      humanize_enum  #...
+      translate_enum #...
+      ext_enum_sets  # if needed 
+  end
 ```
  
  Let's assume that we have model Request representing some buying requests with enum **status**, and we have model Order with requests, 
@@ -49,11 +49,45 @@ Or install it yourself as:
      end
 ```
 
- Now let's review some examples of possible enum extensions
+## Inline definitions. Starting 0.5.0!! BREAKING CHANGES!
+
+Starting version 0.4.6, for concise and clearer code base, you can activate most of the extensions during enum definition, using `ext: [...]` notation.
+This is a preferable way now, and old helpers are private starting version 0.6!:
+
+```ruby
+    #Instead of three method calls:    
+    enum status: {}
+    enum_i :status # will raise an private method error starting ver 0.6
+    enum_mass_assign :status # will raise an private method error starting ver 0.6!!!
+
+    #You should go with ext  option instead:
+    enum status: {}, ext: [:enum_i, :enum_mass_assign]
+
+    # OR in case of standalone enum definition:
+    enum status: {} # somewhere where you can't or don't want to reach 
+    enum_ext :status, [:enum_i, :enum_mass_assign, enum_supersets: {} ]
+```
+Rem: enum_ext could be called multiple times and merge later definitions, though I can't imagine why would you split it to multiple calls. 
+
+Rem: The only exceptions for the new syntax are full translation/humanization helpers definitions. 
+     Those will not add any clarity to code, and should be used via standalone helpers. 
+     But standard translate_enum without definitions still welcome:
+
+```ruby
+# GOOD: 
+  enum_ext :status, [:enum_i, :enum_mass_assign, :translate_enum, enum_supersets: {}]
+
+# BAD (even if correctly defines internationalization): 
+  enum_ext :status, [:enum_i, :enum_mass_assign, :translate_enum, enum_supersets: {}] do
+    I18n.t("scope.#{kind}")
+  end
+```
+
+## Humanization and localization
 
 ### Humanization (humanize_enum) 
   
-  if app doesn't need internationalization, it may use humanize_enum to make enum user friendly
+  If app doesn't need internationalization, it may use humanize_enum to make enum output user friendly
 
 ```ruby
   humanize_enum :status, {
@@ -69,33 +103,31 @@ Or install it yourself as:
 ```  
    
   This humanize_enum adds to instance:
-   - t_in_cart, t_paid, t_ready_for_shipment
+   - t_status
   
-  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
+  and to enum object:
+   - statuses.t_options - translated enum values options for select input
+   - statuses.t_options_i - same as above but use int values with translations works for ActiveAdmin filters for instance
+   
 
-  
   Example with block:
 
   ```ruby
       humanize_enum :status do
-       I18n.t("scope.#{status}")
+        I18n.t("scope.#{status}")
       end
   ```
   
   Example for select:
   
   ```ruby
-    f.select :status, Request.t_statuses_options
+    f.select :status, Request.statuses.t_options
   ```
   
   in Active Admin filters
   ```ruby
-    filter :status, as: :select, label: 'Status', collection: Request.t_statuses_options_i
+    filter :status, as: :select, label: 'Status', collection: Request.statuses.t_options_i
   ```
- 
   
   **Rem:** select options may break when using lambda() or proc with instance method, but will survive with block
   
@@ -105,7 +137,7 @@ Or install it yourself as:
     request.paid!
     request.status     # >> paid
     request.t_status   # >> "paid 3 dollars"
-    Request.t_statuses # >> { in_cart: -> { I18n.t("request.status.in_cart") }, ....  }
+    Request.statuses.localizations # >> { in_cart: -> { I18n.t("request.status.in_cart") }, ....  }
   ```  
 
   Could be called multiple times, all humanization definitions will be merged under the hood.  
@@ -113,6 +145,7 @@ Or install it yourself as:
 ### Translate (translate_enum) 
 
 Enum is translated using scope 'active_record.attributes.class_name_underscore.enum_plural', or the given one:
+
 ```ruby
    translate_enum :status, 'active_record.request.enum'
 ```
@@ -124,7 +157,12 @@ Or it can be done with block either with translate or humanize:
    end
 ```
 
+All humanization examples also should work same way as expected.
+
+## Enum extended functionality
+
 ### Enum to_i shortcut ( enum_i )
+
 Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name] or enum_name_before_type_cast
 
 **Ex** 
@@ -135,66 +173,79 @@ Defines method enum_name_i shortcut for Model.enum_names[elem.enum_name] or enum
   request.paid_i # 10
 ```
 
-### Enum Sets (ext_enum_sets)
+Rem: whenever underlying enum is not an integer will refuse to define helper and outputs WARNING
+
+### Enum SuperSets (enum_supersets)
  
- **Use-case** whenever you need superset of enums to behave like a enum.
+ **Use-case** whenever you need superset of enums to behave like a super enum.
  
- You can do this with method **ext_enum_sets** it creates: 
+ You can do this with method **enum_supersets** it creates: 
    - scopes for subsets, 
    - instance methods with `?` 
-   - and some class methods helpers
    
    For instance:
 
 ```ruby
-    ext_enum_sets :status, {
-        delivery_set: [:ready_for_shipment, :on_delivery, :delivered], # for shipping department for example
-        in_warehouse: [:ready_for_shipment]  
-    }
+     enum status: [:in_cart, :waiting_for_payment, :paid, :packing, :ready_for_shipment, :on_delivery, :delivered],
+          ext: [enum_supersets: {
+                  around_delivery: [:ready_for_shipment, :on_delivery], # for shipping department for example
+                  in_warehouse: [:packing, :ready_for_shipment],    # this scope is just for superposition example below
+                  sold: [:paid, :around_delivery, :in_warehouse, :delivered] # also you can define any superposition of already defined supersets or enum values
+                }]
+
+     # supersets will be stored inside enum wrapper object, and can be de-referenced to basic enum values 
+     # using wrapper defined methods: "superset_enum_plural", i.e. statuses.sold_statuses -> [:paid, :packing, :ready_for_shipment, :on_delivery, :delivered]
+     # so new supersets could be defined using Array operations against newly defined methods
+     enum_ext :status, enum_supersets: {
+                    outside_warehouse: ( statuses.around_delivery - statuses.in_warehouse ) #... any other array operations like &, + and so can be used
+                  }
 ```
 
 it will generate:
 
 ```
 instance:
-    - methods: delivery_set?, in_warehouse?
+    - methods: around_delivery?, in_warehouse?
 
 class:
-    - named scopes: delivery_set, in_warehouse
-    - parametrized scopes: with_statuses, without_statuses ( available as a standalone extension now, and will not be included by default in a versionafter 0.5.0)
-    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 )
+    - named scopes: around_delivery, in_warehouse
+
+enum methods:    
+    - Class.statuses.supersets -- will output superset definition hash
+    - Class.statuses.supersets_raw -- will output superset decompositions to basic enum types hash 
+    
+    - Class.statuses.around_delivery (=[:ready_for_shipment, :on_delivery, :delivered] ), in_warehouse_statuses
+    - around_delivery_statuses_i (= [3,4,5]), in_warehouse_statuses_i (=[3])
+
+    translation helpers grouped for superset ( started with t_... ):
+    - Class.statuses.t_around_delivery_options (= [['translation or humanization', :ready_for_shipment] ...] ) for select inputs purposes
+    - Class.statuses.t_around_delivery_options_i (= [['translation or humanization', 3] ...]) same as above but with integer as value ( for example to use in Active admin filters )
 ```
 
  ```ruby
     request.on_delivery!
-    request.delivery_set?                    # >> true
+    request.around_delivery?                    # >> true
     
-    Request.delivery_set.exists?(request)    # >> true
+    Request.around_delivery.exists?(request)    # >> true
     Request.in_warehouse.exists?(request)    # >> false
     
-    Request.delivery_set_statuses            # >> ["ready_for_shipment", "on_delivery", "delivered"]
+    Request.statuses.around_delivery            # >> ["ready_for_shipment", "on_delivery", "delivered"]
 ```
 Rem:
-ext_enum_sets can be called multiple times defining a superposition of already defined sets ( considering previous example ):
+supersets creation could be called multiple times defining a superposition of already defined sets ( considering previous example ):
 
 ```ruby
- ext_enum_sets :status, {
-   outside_wharehouse: ( delivery_set_statuses - in_warehouse_statuses )#... any other array operations like &, + and so can be used
+ enum_ext :status, enum_supersets: {
+   outside_wharehouse: ( statuses.around_delivery_superset - statuses.in_warehouse_superset )#... any other array operations like &, + and so can be used
  }
 ```
 
 Rem: you can refer previously defined set as usual kind in the same method call:
     
 ```ruby
-    ext_enum_sets :status, {
-        delivery_set: [:ready_for_shipment, :on_delivery, :delivered],
-        not_in_cart: [:paid, :delivery_set] #
+    enum_ext :status, enum_supersets: {
+        around_delivery: [:ready_for_shipment, :on_delivery, :delivered],
+        not_in_cart: [:paid, :around_delivery] #
     }
 ```
 
@@ -205,7 +256,7 @@ Rem: you can refer previously defined set as usual kind in the same method call:
        ext: [:multi_enum_scopes]
 
 # some place else:
-    Request.with_statuses( :payed, :delivery_set )    # >> status IN (:payed, :ready_for_shipment, :on_delivery, :delivered) 
+    Request.with_statuses( :payed, :around_delivery )    # >> status IN (:payed, :ready_for_shipment, :on_delivery, :delivered) 
     Request.without_statuses( :payed, :in_warehouse ) # >> status NOT IN (:payed, :ready_for_shipment)
 ``` 
 
@@ -215,7 +266,7 @@ Rem: you can refer previously defined set as usual kind in the same method call:
  
  **Use-case:** it's often case when I 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)
+    some_scope.update_all(status: :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 hundreds and thousands of records to change at once you better call update_all
@@ -243,14 +294,50 @@ Rem: you can refer previously defined set as usual kind in the same method call:
     order.requests.delivered.count              # >> N + M
 ```
 
+## Annotations helpers
+Sometimes under irb console you need a quick tip on whats extension available on a enum, so some describe_* helpers added to enum wrapper
+
+General description methods (describe/describe_short/describe_long)
+```
+  Class.enum.describe
+```  
+![img.png](img.png)
+
+```
+  Class.enum.describe_short
+```
+![img_1.png](img_1.png)
+
+```
+  Class.enum.describe_long
+```
+![img_2.png](img_2.png)
+
+And per extension methods (describe_enum_i, e.t.c)
+
+```ruby
+ EnumAnnotated.test_types.describe_mass_assign_enum
+```
+![img_3.png](img_3.png)
+
 ## Tests
-   rake test
- 
+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` 
+to get the idea how they working simultaneously without interference with each other. 
+
+Rem. I'm always freaking googling everytime I need to run single test so I'll just keep here:
+
+```ruby
+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
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/enum_ext or by email: leshchuk@gmail.com
 
 
@@ -258,6 +345,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/alekse
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-### Thanks
 
-Thanks for the star vzamanillo, it inspires me to do mass refactor and gracefully cover code in this gem by tests.
+### Thanks
+Thanks for the first star to vzamanillo, it inspires me to do mass refactor and gracefully cover code in this gem by tests.

data/docker-compose.yml

@@ -0,0 +1,24 @@
+version: "3.7"
+
+services:
+  test:
+    build: .
+    image: enum_ext
+    command: rake test
+    volumes:
+      - './lib:/app/lib'
+      - './test:/app/test'
+      - './Gemfile_rails_6:/app/Gemfile'
+      - './Gemfile_rails_6.lock:/app/Gemfile.lock'
+
+  test_7_0:
+    build:
+      context: .
+      dockerfile: Dockerfile_rails_7
+    image: enum_ext_rails_7
+    command: rake test
+    volumes:
+      - './lib:/app/lib'
+      - './test:/app/test'
+      - './Gemfile_rails_7:/app/Gemfile'
+      - './Gemfile_rails_7.lock:/app/Gemfile.lock'