enum_machine 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22866d6d5f37dd78718e7e5eb27dd0066450d8730b821ffb13977888009b6ddd
-  data.tar.gz: fc4c40aa5ea99a6d14143ebec78d2a40b2c8bce58d21ff5507b4d3d2ee67bcf1
+  metadata.gz: 9652b2333de5222d8012acef09006ba1f57f6d5eed4a69afc52aa8e43c930c69
+  data.tar.gz: 3e9929cc5e1f14a78d28321e61c052cc0067d338f219dc70ffa829982a3701f6
 SHA512:
-  metadata.gz: 247ea0d77022905062d7688dd1153037517fa71521c15f51477f66e4f8d368cf008262c0095a1465b068b24da3262ed01334f787504dce9a65265839bffa2726
-  data.tar.gz: 969db73142c57fcf94f82fa6c1eca59c79310a6c6e0399961fbee835c5da8596802039d699657f306f07ac0f0e64ba5692cb4d3dee0f3d02359313cd61b07bc5
+  metadata.gz: 9381ee9e5e0faf50c90becfbea6b1299c50db93e49617735886ccaac987a95f01ee8bd654cd6afa63ad6ff0feb26f8701d79e201ae8f4b8368bfe4a7f2cb7236
+  data.tar.gz: e2d7f9c85b2decd744b4163c31f24597f4785cf4fe4e69d262156d6ecec8538cec437315183682e35236f8436ecdc82c53424535ae143d6bac626b9052b46c6a

data/.rubocop.yml

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

data/Gemfile.lock

@@ -22,7 +22,7 @@ GIT
 PATH
   remote: .
   specs:
-    enum_machine (2.2.0)
+    enum_machine (2.3.1)
       activemodel
       activerecord
       activesupport

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,12 +67,12 @@ 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 # => "Красный"
@@ -85,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 # => "Красный"
 ```
 
@@ -168,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
@@ -225,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
@@ -236,6 +238,78 @@ 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"]]
+
+# Reuse with enum_decorator in other classes or models
+class UserFeedback < ActiveRecord::Base
+  # requires `review_type` database column (or `attr_accessor :review_type` in plain classes)
+  include Comment::REVIEW_TYPE.enum_decorator
+end
+```
+
+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, and can be plugged into classes via `.enum_decorator`.
+
 ## 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

@@ -19,6 +19,10 @@ module EnumMachine
           value_attribute_mapping[key] if value_attribute_mapping.key?(key)
         end
 
+        define_singleton_method(:enum_decorator) do
+          @enum_decorator ||= BuildEnumClass.build_enum_decorator(self, name.demodulize.underscore)
+        end
+
         if i18n_scope
           def self.values_for_form(specific_values = nil)
             (specific_values || values).map { |v| [human_name_for(v), v] }
@@ -59,5 +63,26 @@ module EnumMachine
         end
       end
     end
+
+    def self.build_enum_decorator(enum_class, attr)
+      enum_const_name = attr.to_s.upcase
+
+      define_methods =
+        Module.new do
+          define_method(attr) do
+            enum_value = super()
+            return unless enum_value
+
+            enum_class.value_attribute_mapping.fetch(enum_value)
+          end
+        end
+
+      Module.new do
+        define_singleton_method(:included) do |decorating_class|
+          decorating_class.prepend define_methods
+          decorating_class.const_set enum_const_name, enum_class
+        end
+      end
+    end
   end
 end

data/lib/enum_machine/driver_simple_class.rb

@@ -18,27 +18,8 @@ module EnumMachine
             if defined?(ActiveRecord) && klass <= ActiveRecord::Base
               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)
-
-              define_methods =
-                Module.new do
-                  define_method(attr) do
-                    enum_value = super()
-                    return unless enum_value
-
-                    enum_class.value_attribute_mapping.fetch(enum_value)
-                  end
-                end
-
-              enum_decorator =
-                Module.new do
-                  define_singleton_method(:included) do |decorating_class|
-                    decorating_class.prepend define_methods
-                    decorating_class.const_set enum_const_name, enum_class
-                  end
-                end
+              enum_class = EnumMachine.enum(enum_values, i18n_scope: i18n_scope, value_decorator: value_decorator)
+              enum_decorator = BuildEnumClass.build_enum_decorator(enum_class, attr)
               enum_class.define_singleton_method(:enum_decorator) { enum_decorator }
 
               klass.include(enum_decorator)

data/lib/enum_machine/version.rb

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

data/lib/enum_machine.rb

@@ -7,6 +7,7 @@ require_relative "enum_machine/attribute_persistence_methods"
 require_relative "enum_machine/build_enum_class"
 require_relative "enum_machine/machine"
 require "active_support"
+require "active_support/core_ext/string"
 
 module EnumMachine
   class Error < StandardError; end
@@ -29,6 +30,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_machine
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Ermolaev Andrey
@@ -69,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