enum_machine 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a93f18555b77dbf6370ff79f6e8a541a60f0b65e70a97673dca07c87ab6a83e8
-  data.tar.gz: 4bcf47330cc5492f55fe119d04a814caadfeb47becceb4e5bb9f408976255842
+  metadata.gz: 86f84c741963ae08afc9fc2072a816140b13a8f819fecf2739460cf1118ac10d
+  data.tar.gz: c8eea28785d2845c8ccaf8892f9c63f8e600054b5e8c74998656f1fbda3ced97
 SHA512:
-  metadata.gz: 4cf9904e3c40b0a864ff4fde87a6e0b5c841b92c3279890ee15d18cf7191361f96a96dcf4ba67892b2f541f30072b8c677d8098b77965bb030f07a585ee46193
-  data.tar.gz: c93349f003295b86b1414765d2e844d3d7025c9d6b64da3e5a023eb86765bd627dc47a8c18a0d7ed7e636b9821ac596aee5c3e4d508c676fcdb2b79f406f3f46
+  metadata.gz: db343c2b699f2d00ead6c0ae58a033b3269e4680f55711eb82b136ed0c7092ec3365ce6b5cddd19d28378f2cf1952d67e5e411f6fb97d9a0059ad7ca79a1af5d
+  data.tar.gz: 98e5ad6a7e5ecff10a12c96f2d24a1d19b75b7903bd55fa70aec36d628502ed090d0568d0f5e9ddbd941e08804171d4ad0e09d84dc44b3836d33aca55545c33c

data/.rubocop.yml

@@ -27,3 +27,9 @@ Gp/UnsafeYamlMarshal:
 
 Gp/OptArgParameters:
   Enabled: false
+
+Gp/SpecNestedDuplicatesLetName:
+  Enabled: false
+
+Rails/IndexBy:
+  Enabled: false

data/Gemfile

@@ -10,4 +10,4 @@ gem "pry", "~> 0.12"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.9"
 gem "rubocop-gp", github: "corp-gp/rubocop-gp"
-gem "sqlite3", "~> 1.4"
+gem "sqlite3"

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 
 GIT
   remote: https://github.com/corp-gp/rubocop-gp.git
-  revision: 867f7e1351c3730897cacdc20ce2d727604de245
+  revision: e3d33016bb3b9945ce9d8d22e77825a223de1a5c
   specs:
     rubocop-gp (0.0.4)
       rubocop
@@ -22,7 +22,7 @@ GIT
 PATH
   remote: .
   specs:
-    enum_machine (2.0.1)
+    enum_machine (2.3.0)
       activemodel
       activerecord
       activesupport
@@ -30,125 +30,146 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.2.1)
-      activesupport (= 7.2.1)
-    activerecord (7.2.1)
-      activemodel (= 7.2.1)
-      activesupport (= 7.2.1)
+    activemodel (8.1.2)
+      activesupport (= 8.1.2)
+    activerecord (8.1.2)
+      activemodel (= 8.1.2)
+      activesupport (= 8.1.2)
       timeout (>= 0.4.0)
-    activesupport (7.2.1)
+    activesupport (8.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    dry-core (1.0.1)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    dry-core (1.2.0)
       concurrent-ruby (~> 1.0)
+      logger
       zeitwerk (~> 2.6)
-    dry-inflector (1.1.0)
-    dry-logic (1.5.0)
+    dry-inflector (1.3.0)
+    dry-logic (1.6.0)
+      bigdecimal
       concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0, < 2)
+      dry-core (~> 1.1)
       zeitwerk (~> 2.6)
-    dry-types (1.7.2)
-      bigdecimal (~> 3.0)
+    dry-types (1.9.0)
+      bigdecimal (>= 3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0)
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    i18n (1.14.6)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.9.0)
-    language_server-protocol (3.17.0.3)
-    logger (1.6.1)
+    io-console (0.8.2)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
     method_source (1.1.0)
-    minitest (5.25.2)
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    prism (1.7.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
+      reline (>= 0.6.0)
     racc (1.8.1)
-    rack (3.1.8)
+    rack (3.2.4)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.3)
-    rspec (3.13.0)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.69.2)
+    rspec-support (3.13.6)
+    rubocop (1.82.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.36.2, < 2.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.37.0)
-      parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.1)
-      rubocop (~> 1.61)
-    rubocop-performance (1.23.0)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.27.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.28.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.3)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 1.52.0, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.2.0)
-      rubocop (~> 1.61)
-    rubocop-rspec_rails (2.30.0)
-      rubocop (~> 1.61)
-      rubocop-rspec (~> 3, >= 3.0.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    rubocop-rspec_rails (2.32.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-rspec (~> 3.5)
     ruby-progressbar (1.13.0)
     rumoji (0.5.0)
-    securerandom (0.3.2)
-    sqlite3 (1.7.3-arm64-darwin)
-    sqlite3 (1.7.3-x86_64-darwin)
-    sqlite3 (1.7.3-x86_64-linux)
-    timeout (0.4.2)
+    securerandom (0.4.1)
+    sqlite3 (2.9.0-arm64-darwin)
+    sqlite3 (2.9.0-x86_64-darwin)
+    sqlite3 (2.9.0-x86_64-linux-gnu)
+    timeout (0.6.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.2)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    zeitwerk (2.6.18)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    zeitwerk (2.7.4)
 
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-21
   x86_64-linux
 
@@ -160,7 +181,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.9)
   rubocop-gp!
-  sqlite3 (~> 1.4)
+  sqlite3
 
 BUNDLED WITH
    2.3.15

data/README.md

@@ -4,12 +4,12 @@
 
 You can visualize transitions map with [enum_machine-contrib](https://github.com/corp-gp/enum_machine-contrib)
 
-## Why is `enum_machine` better then [state_machines](https://github.com/state-machines/state_machines) / [aasm](https://github.com/aasm/aasm)?
+## Why is `enum_machine` better than [state_machines](https://github.com/state-machines/state_machines) / [aasm](https://github.com/aasm/aasm)?
 
 - faster [5x](#Benchmarks)
 - code lines: `enum_machine` - 348, `AASM` - 2139
 - namespaced (via attr) by default: `order.state.to_collected`
-- [aliases](Aliases)
+- [aliases](#aliases)
 - guarantees of existing transitions
 - simple run transitions with callbacks `order.update(state: "collected")` or `order.state.to_collected`
 - `aasm` / `state_machines` **event driven**, `enum_machine` **state driven**
@@ -59,7 +59,7 @@ gem "enum_machine"
 ```ruby
 # With ActiveRecord
 class Product < ActiveRecord::Base
-  enum_machine :color, %w[red green]
+  enum_machine :color, %w[red green yellow]
 end
 
 # Or with plain class
@@ -67,13 +67,15 @@ class Product
   # attributes must be defined before including the EnumMachine module
   attr_accessor :color
 
-  include EnumMachine[color: { enum: %w[red green] }]
+  include EnumMachine[color: { enum: %w[red green yellow] }]
   # or reuse from model
   Product::COLOR.enum_decorator
 end
 
-Product::COLOR.values # => ["red", "green"]
+Product::COLOR.values # => ["red", "green", "yellow"]
 Product::COLOR::RED # => "red"
+Product::COLOR::RED.red? # => true
+Product::COLOR::RED.human_name # => "Красный"
 Product::COLOR::RED__GREEN # => ["red", "green"]
 
 Product::COLOR["red"].red? # => true
@@ -83,6 +85,8 @@ product = Product.new
 product.color # => nil
 product.color = "red"
 product.color.red? # => true
+product.color.red__yellow? # => true
+product.color.green__yellow? # => false
 product.color.human_name # => "Красный"
 ```
 
@@ -166,7 +170,7 @@ product = Product.create(state: "created")
 product.state.possible_transitions # => [nil, "approved"]
 product.state.can_activated? # => false
 product.state.to_activated! # => EnumMachine::Error: transition "created" => "activated" not defined in enum_machine
-product.state.to_approved! # => true; equal to `product.update!(state: "approve")`
+product.state.to_approved! # => true; equal to `product.update!(state: "approved")`
 ```
 
 #### Skip transitions
@@ -223,7 +227,7 @@ product.color.human_name # => "Красный"
 I18n scope can be changed with `i18n_scope` option:
 
 ```ruby
-# For AciveRecord
+# For ActiveRecord
 class Product < ActiveRecord::Base
   enum_machine :color, %w[red green], i18n_scope: "users.product"
 end
@@ -234,6 +238,72 @@ class Product
 end
 ```
 
+### Standalone enum
+
+`EnumMachine.enum` builds an enum class without a host attribute: for computed values,
+virtual attributes, permissions, or constants shared across classes.
+
+It provides constants, `values`, lookup `[]`, predicates (including combined `foo__bar?`),
+I18n, and custom decorators:
+
+```ruby
+module ReviewTypeDecorator
+  def bonus_value
+    case self
+    when Comment::REVIEW_TYPE::VIDEO then 100
+    when Comment::REVIEW_TYPE::PHOTO then 50
+    else 10
+    end
+  end
+end
+
+class Comment < ActiveRecord::Base
+  REVIEW_TYPE = EnumMachine.enum(
+    %w[text photo video],
+    i18n_scope: "comment.review_type",
+    value_decorator: ReviewTypeDecorator,
+  )
+
+  # computed, not a database column
+  def review_type
+    if video_ids.any?
+      REVIEW_TYPE::VIDEO
+    elsif photo_ids.any?
+      REVIEW_TYPE::PHOTO
+    else
+      REVIEW_TYPE::TEXT
+    end
+  end
+end
+
+# Constants and listing
+Comment::REVIEW_TYPE.values                 # => ["text", "photo", "video"]
+Comment::REVIEW_TYPE::VIDEO                 # => "video"
+Comment::REVIEW_TYPE::PHOTO__VIDEO          # => ["photo", "video"]
+
+# Lookup by string or symbol
+Comment::REVIEW_TYPE["video"]               # => "video"
+Comment::REVIEW_TYPE[:video]                # => "video"
+Comment::REVIEW_TYPE["unknown"]             # => nil
+
+# Decorator methods
+Comment::REVIEW_TYPE::VIDEO.bonus_value     # => 100
+
+# Predicates on computed values
+comment = Comment.new(video_ids: [1])
+comment.review_type.video?                  # => true
+comment.review_type.photo__video?           # => true
+comment.review_type.bonus_value             # => 100
+
+# Form helpers (when i18n_scope is set)
+Comment::REVIEW_TYPE.values_for_form
+# => [["Text", "text"], ["Photo", "photo"], ["Video", "video"]]
+```
+
+In `ActiveRecord` models, `enum_machine :attribute` relies on a database column for persistence
+and dirty tracking. `EnumMachine.enum` is designed for everything else where you still want
+enum capabilities without an underlying column.
+
 ## Benchmarks
 [test/performance.rb](../master/test/performance.rb)
 

data/enum_machine.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/enum_machine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_machine"
+  spec.version       = EnumMachine::VERSION
+  spec.authors       = ["Ermolaev Andrey"]
+  spec.email         = ["andruhafirst@yandex.ru"]
+
+  spec.summary       = "fast and siple usage state machine in your app"
+  spec.description   = "Enum machine is a library for defining enums and setting state machines for attributes in ActiveRecord models and plain Ruby classes."
+  spec.homepage      = "https://github.com/corp-gp/enum_machine"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/corp-gp/enum_machine"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      end
+    end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/enum_machine/build_enum_class.rb

@@ -36,7 +36,7 @@ module EnumMachine
         end
 
         enum_values.each do |enum_value|
-          const_set enum_value.underscore.upcase, enum_value.to_s.freeze
+          const_set enum_value.underscore.upcase, value_class.new(enum_value).freeze
         end
 
         aliases.each_key do |key|

data/lib/enum_machine/driver_simple_class.rb

@@ -19,8 +19,7 @@ module EnumMachine
               klass.enum_machine(attr, enum_values, i18n_scope: i18n_scope)
             else
               enum_const_name = attr.to_s.upcase
-              value_class = BuildValueClass.call(enum_values: enum_values, i18n_scope: i18n_scope, value_decorator: value_decorator)
-              enum_class = BuildEnumClass.call(enum_values: enum_values, i18n_scope: i18n_scope, value_class: value_class)
+              enum_class = EnumMachine.enum(enum_values, i18n_scope: i18n_scope, value_decorator: value_decorator)
 
               define_methods =
                 Module.new do

data/lib/enum_machine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EnumMachine
-  VERSION = "2.1.0"
+  VERSION = "2.3.0"
 end

data/lib/enum_machine.rb

@@ -29,6 +29,15 @@ module EnumMachine
   def self.[](args)
     DriverSimpleClass.call(args)
   end
+
+  # Enum class without a host class: constants, `values`, `[]`, predicates and decorator
+  #
+  #   COLOR = EnumMachine.enum(%w[red green], i18n_scope: "product.color", value_decorator: ColorDecorator)
+  #   COLOR::RED.red? # => true
+  def self.enum(enum_values, i18n_scope: nil, value_decorator: nil)
+    value_class = BuildValueClass.call(enum_values: enum_values, i18n_scope: i18n_scope, value_decorator: value_decorator)
+    BuildEnumClass.call(enum_values: enum_values, i18n_scope: i18n_scope, value_class: value_class)
+  end
 end
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: enum_machine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ermolaev Andrey
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -70,6 +69,7 @@ files:
 - bin/console
 - bin/setup
 - docs/MIGRATING_FROM_RAILS_STRING_ENUM.ru.md
+- enum_machine.gemspec
 - lib/enum_machine.rb
 - lib/enum_machine/attribute_persistence_methods.rb
 - lib/enum_machine/build_enum_class.rb
@@ -86,7 +86,6 @@ metadata:
   homepage_uri: https://github.com/corp-gp/enum_machine
   source_code_uri: https://github.com/corp-gp/enum_machine
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: fast and siple usage state machine in your app
 test_files: []