state_machines-activerecord 0.100.0 → 0.103.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8da92c0d0872bf79ae81017dd5d16459e5222d10ee304390ddff3af14f1e1e05
-  data.tar.gz: c7ebd9fbdff4ee5bd2b0cca81b5daad186bb92157eddcb912829685571aa84eb
+  metadata.gz: 571fa09486dd051901ae113941b3ae04e9867da62da325c609f97f44f1272f66
+  data.tar.gz: 22513e4df2238588d70dcff91f79fb00dfc18dac3a7b36a8a971765355939f8a
 SHA512:
-  metadata.gz: 66d176f9efbc9d44ac2d5a5786f078e593d3590a99d855804ff4775649b18abae64264781f4ddc36a60ac253366aea0a9c02d3d1712d680d78fe443fffd437e7
-  data.tar.gz: f5e7a924679499d596439009b9bad2633af5389069959016595d31c44243f7551893cd2e53769e5e1b3a99b979f8d6ad1fa24d86caaa9134f0aa63528739b108
+  metadata.gz: a15cf9abb68277ce52ab35e139b15fa8ce6b28fb68424bcbcf840de0216267f7f58b62483c01b2cbd62df9694ba117dfee3b090e2b64692cfe9114396d64c0f2
+  data.tar.gz: 97cb794b7e45222503e682641e80da05282f3593453979650431f35fa687831e9349dabe46ea7f2969dc2f95e9b3bc181cfc5860af17e3d57aefb72a8144a485

data/README.md

@@ -77,7 +77,108 @@ Vehicle.with_state(params[:state])                 # Returns all vehicles if par
 Vehicle.where(color: 'red').with_state(nil)        # Returns all red vehicles (chainable)
 ```
 
-### State driven validations
+## Rails Enum Integration
+
+When your ActiveRecord model uses Rails enums and defines a state machine on the same attribute, this gem automatically detects the conflict and provides seamless integration. This prevents method name collisions between Rails enum methods and state machine methods.
+
+### Auto-Detection and Conflict Resolution
+
+```ruby
+class Order < ApplicationRecord
+  # Rails enum definition
+  enum :status, { pending: 0, processing: 1, completed: 2, cancelled: 3 }
+  
+  # State machine on the same attribute
+  state_machine :status do
+    state :pending, :processing, :completed, :cancelled
+    
+    event :process do
+      transition pending: :processing
+    end
+    
+    event :complete do
+      transition processing: :completed
+    end
+    
+    event :cancel do
+      transition [:pending, :processing] => :cancelled
+    end
+  end
+end
+```
+
+When enum integration is detected, the gem automatically:
+- Preserves original Rails enum methods (`pending?`, `processing?`, etc.)
+- Generates prefixed state machine methods to avoid conflicts (`status_pending?`, `status_processing?`, etc.)
+- Creates prefixed scope methods (`Order.status_pending`, `Order.status_processing`, etc.)
+
+### Available Methods
+
+**Original Rails enum methods (preserved):**
+```ruby
+order = Order.create(status: :pending)
+order.pending?        # => true (Rails enum method)
+order.processing?     # => false (Rails enum method)
+order.processing!     # Sets status to :processing (Rails enum method)
+
+Order.pending         # Rails enum scope
+Order.processing      # Rails enum scope
+```
+
+**Generated state machine methods (prefixed):**
+```ruby
+# Predicate methods
+order.status_pending?     # => true (state machine method)
+order.status_processing?  # => false (state machine method)
+order.status_completed?   # => false (state machine method)
+
+# Bang methods (for conflict resolution only)
+# These are placeholders and raise runtime errors
+order.status_processing!  # => raises RuntimeError
+
+# Scope methods  
+Order.status_pending      # State machine scope
+Order.status_processing   # State machine scope
+Order.not_status_pending  # Negative state machine scope
+```
+
+### Introspection API
+
+The integration provides a comprehensive introspection API for advanced use cases:
+
+```ruby
+machine = Order.state_machine(:status)
+
+# Check if enum integration is enabled
+machine.enum_integrated?  # => true
+
+# Get the Rails enum mapping
+machine.enum_mapping     # => {"pending"=>0, "processing"=>1, "completed"=>2, "cancelled"=>3}
+
+# Get original Rails enum methods that were preserved
+machine.original_enum_methods
+# => ["pending?", "processing?", "completed?", "cancelled?", "pending!", "processing!", ...]
+
+# Get state machine methods that were generated
+machine.state_machine_methods  
+# => ["status_pending?", "status_processing?", "status_completed?", "status_cancelled?", ...]
+```
+
+
+### Requirements for Enum Integration
+
+- The state machine attribute must match an existing Rails enum attribute
+- Auto-detection is enabled by default when this condition is met
+
+### Configuration Options
+
+The enum integration supports several configuration options:
+
+- `prefix` (default: true) - Adds a prefix to generated methods to avoid conflicts
+- `suffix` (default: false) - Alternative naming strategy using suffixes instead of prefixes
+- `scopes` (default: true) - Controls whether state machine scopes are generated
+
+## State driven validations
 
 As mentioned in `StateMachines::Machine#state`, you can define behaviors,
 like validations, that only execute for certain states. One *important*

data/lib/state_machines/integrations/active_record/type/integer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module StateMachines
+  module Type
+    # Custom ActiveRecord attribute type for state machine attributes backed by
+    # integer columns. Handles bidirectional conversion between state name strings
+    # (used internally by the state machine) and integer values (stored in the DB).
+    #
+    # States without explicit integer values are mapped by their index position
+    # in the states collection (0, 1, 2, …). States with an explicit integer
+    # value (e.g. state :pending, value: 2) use that value directly.
+    class Integer < ::ActiveRecord::Type::Value
+      def initialize(states)
+        @states = states
+        super()
+      end
+
+      # integer from DB → state name string
+      def deserialize(value)
+        return nil if value.nil?
+        int_val = value.to_i
+        state = named_states.detect { |s| state_integer(s) == int_val }
+        state ? state.name.to_s : value
+      end
+
+      # assignment (symbol / string / integer) → state name string (in-memory)
+      def cast(value)
+        return nil if value.nil?
+        state = named_states.detect { |s| s.name.to_s == value.to_s }
+        state ||= named_states.detect { |s| state_integer(s) == value.to_i } if value.respond_to?(:to_i)
+        state ? state.name.to_s : value.to_s
+      end
+
+      # state name string → integer for DB write
+      def serialize(value)
+        return nil if value.nil?
+        state = named_states.detect { |s| s.name.to_s == value.to_s }
+        state ? state_integer(state) : value
+      end
+
+      def type
+        :integer
+      end
+
+      private
+
+      # All non-nil states in definition order — not memoized because states are
+      # added to the collection after the type is instantiated.
+      def named_states
+        @states.reject { |s| s.name.nil? }
+      end
+
+      # Returns the integer to use for storage:
+      # - explicit integer value if set (e.g. state :pending, value: 2)
+      # - otherwise the index position among named states
+      def state_integer(state)
+        state.value.is_a?(::Integer) ? state.value : named_states.index(state)
+      end
+    end
+  end
+end

data/lib/state_machines/integrations/active_record/version.rb

@@ -3,7 +3,7 @@
 module StateMachines
   module Integrations
     module ActiveRecord
-      VERSION = '0.100.0'
+      VERSION = '0.103.0'
     end
   end
 end

data/lib/state_machines/integrations/active_record.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'state_machines-activemodel'
 require 'active_record'
 require 'state_machines/integrations/active_record/version'
+require 'state_machines/integrations/active_record/type/integer'
 
 module StateMachines
   module Integrations # :nodoc:
@@ -194,7 +197,8 @@ module StateMachines
     # example, assuming there's a validation on a field called +name+ on the class:
     #
     #   vehicle = Vehicle.new
-    #   vehicle.ignite!       # => StateMachines::InvalidTransition: Cannot transition state via :ignite from :parked (Reason(s): Name cannot be blank)
+    #   vehicle.ignite!       # => StateMachines::InvalidTransition: Cannot transition state via :ignite from :parked
+    #                              # (Reason(s): Name cannot be blank)
     #
     # == Scopes
     #
@@ -368,6 +372,283 @@ module StateMachines
 
       # The default options to use for state machines using this integration
       @defaults = { action: :save, use_transactions: true }
+
+      # Machine-specific methods for enum integration
+      module MachineMethods
+        # Enum integration metadata storage
+        attr_accessor :enum_integration
+
+        # Hook called after machine initialization
+        def after_initialize
+          super
+          initialize_enum_integration
+          register_integer_type if integer_column? && !enum_integrated?
+        end
+
+        # Check if enum integration should be enabled for this machine
+        def detect_enum_integration
+          return nil unless owner_class.defined_enums.key?(attribute.to_s)
+
+          # For now, auto-detect enum and enable basic integration
+          # Later we can add explicit configuration options
+          {
+            enabled: true,
+            prefix: true,
+            suffix: false,
+            scopes: true,
+            enum_values: owner_class.defined_enums[attribute.to_s] || {},
+            original_enum_methods: detect_existing_enum_methods,
+            state_machine_methods: []
+          }
+        end
+
+        # Initialize enum integration if enum is detected
+        def initialize_enum_integration
+          detected_config = detect_enum_integration
+          return unless detected_config
+
+          # Store enum integration metadata
+          self.enum_integration = detected_config
+        end
+
+        # Override state method to trigger method generation after states are defined
+        def state(*, &)
+          result = super
+
+          # Generate methods after each state addition if enum integration is enabled
+          generate_state_machine_methods if enum_integrated?
+
+          result
+        end
+
+        # Check if this machine has enum integration enabled
+        def enum_integrated?
+          enum_integration && enum_integration[:enabled]
+        end
+
+        # Get the enum mapping for this attribute
+        def enum_mapping
+          return {} unless enum_integrated?
+
+          enum_integration[:enum_values] || {}
+        end
+
+        # Get list of original enum methods that were preserved
+        def original_enum_methods
+          return [] unless enum_integrated?
+
+          enum_integration[:original_enum_methods] || []
+        end
+
+        # Get list of state machine methods that were generated
+        def state_machine_methods
+          return [] unless enum_integrated?
+
+          enum_integration[:state_machine_methods] || []
+        end
+
+        def integer_type_registered?
+          !!@integer_type_registered
+        end
+
+        # Machine internals (state matching, validations) call read() to get the
+        # current state value and compare it against state.value.  Only override
+        # when states have explicit integer values (e.g. state :pending, value: 0).
+        # In that case the custom type returns a state name string but machine
+        # internals need the raw integer for value-based lookup.
+        #
+        # For auto-indexed states (no explicit value), state.value is the string
+        # name so super() returns the right thing already.
+        def read(object, attr_sym, ivar = false)
+          return super unless integer_type_registered? && attr_sym == :state
+          return super unless states_with_explicit_integer_values?
+
+          raw = object.read_attribute_before_type_cast(attribute.to_s)
+          if raw.is_a?(::String) || raw.is_a?(::Symbol)
+            matched = states.detect { |s| s.name && s.name.to_s == raw.to_s }
+            return matched ? matched.value : raw
+          end
+          raw
+        end
+
+        private
+
+        # Returns true when at least one named state has an explicit integer value.
+        # Used to decide whether read() needs to return raw integers for machine
+        # internals rather than relying on the custom type's string representation.
+        def states_with_explicit_integer_values?
+          states.any? { |s| s.name && s.value.is_a?(::Integer) }
+        end
+
+        # Returns true when the state machine attribute is backed by an integer column
+        def integer_column?
+          return false unless owner_class.respond_to?(:type_for_attribute)
+          return false unless owner_class.connected? && owner_class.table_exists?
+
+          owner_class.type_for_attribute(attribute.to_s).type == :integer
+        rescue ::ActiveRecord::StatementInvalid, ::ActiveRecord::ConnectionNotEstablished
+          false
+        end
+
+        # Registers a custom AR attribute type so that integer columns transparently
+        # convert between state name strings and stored integers.
+        # Saves the raw column default first so the conflicting-default check
+        # (which fires later, during initial_state=) still compares raw integers.
+        def register_integer_type
+          @raw_integer_column_default = owner_class.column_defaults[attribute.to_s]
+          @integer_type_registered = true
+          owner_class.attribute(attribute.to_s, StateMachines::Type::Integer.new(states))
+        end
+
+        # Detect existing enum methods for this attribute
+        def detect_existing_enum_methods
+          return [] unless owner_class.defined_enums.key?(attribute.to_s)
+
+          enum_values = owner_class.defined_enums[attribute.to_s]
+          methods = []
+
+          enum_values.each_key do |value|
+            # Predicate methods like 'active?'
+            predicate = "#{value}?"
+            methods << predicate if owner_class.method_defined?(predicate)
+
+            # Bang methods like 'active!'
+            bang_method = "#{value}!"
+            methods << bang_method if owner_class.method_defined?(bang_method)
+
+            # Scope methods (class-level)
+            methods << value.to_s if owner_class.respond_to?(value)
+            methods << "not_#{value}" if owner_class.respond_to?("not_#{value}")
+          end
+
+          methods
+        end
+
+        # Generate method name with prefix/suffix based on configuration
+        def generate_state_method_name(state_name, method_type)
+          return state_name unless enum_integrated?
+
+          config = enum_integration
+          base_name = case method_type
+                      when :predicate
+                        "#{state_name}?"
+                      when :bang
+                        "#{state_name}!"
+                      else
+                        state_name.to_s
+                      end
+
+          # Apply prefix
+          if config[:prefix]
+            prefix = config[:prefix] == true ? "#{attribute}_" : "#{config[:prefix]}_"
+            base_name = "#{prefix}#{base_name}"
+          end
+
+          # Apply suffix
+          if config[:suffix]
+            suffix = config[:suffix] == true ? "_#{attribute}" : "_#{config[:suffix]}"
+            base_name = base_name.gsub(/(\?|!)$/, "#{suffix}\\1")
+            base_name = "#{base_name}#{suffix}" unless base_name.end_with?('?', '!')
+          end
+
+          base_name
+        end
+
+        # Generate state machine methods with conflict resolution
+        def generate_state_machine_methods
+          return unless enum_integrated?
+
+          # Initialize tracking if not already done
+          @processed_states ||= Set.new
+          enum_integration[:state_machine_methods] ||= []
+
+          # Get all states for this machine
+          states.each do |state|
+            state_name = state.name.to_s
+            next if state.nil? # Skip nil state
+            next if @processed_states.include?(state_name) # Skip already processed states
+
+            # Generate predicate method (e.g., status_pending?)
+            predicate_method = generate_state_method_name(state_name, :predicate)
+            if predicate_method != "#{state_name}?"
+              define_state_predicate_method(state_name, predicate_method)
+              track_generated_method(predicate_method)
+            end
+
+            # Generate bang method (e.g., status_pending!)
+            bang_method = generate_state_method_name(state_name, :bang)
+            if bang_method != "#{state_name}!"
+              define_state_bang_method(state_name, bang_method)
+              track_generated_method(bang_method)
+            end
+
+            # Generate scope methods (e.g., status_pending) if scopes are enabled
+            if enum_integration[:scopes]
+              scope_method = generate_state_method_name(state_name, :scope)
+              if scope_method != state_name
+                define_state_scope_method(state_name, scope_method)
+                track_generated_method(scope_method)
+              end
+            end
+
+            # Mark this state as processed
+            @processed_states.add(state_name)
+          end
+        end
+
+        # Define a prefixed predicate method for a state
+        def define_state_predicate_method(state_name, method_name)
+          machine_attribute = attribute
+          target_state_name = state_name.to_sym
+          owner_class.define_method(method_name) do
+            machine = self.class.state_machine(machine_attribute)
+            machine.states.matches?(self, target_state_name)
+          end
+        end
+
+        # Define a prefixed bang method for a state
+        def define_state_bang_method(state_name, method_name)
+          owner_class.define_method(method_name) do
+            # Raise an error with actionable guidance
+            raise "#{method_name} is a conflict-resolution placeholder. " \
+                  "Use the original enum method '#{state_name}!' or state machine events instead."
+          end
+        end
+
+        # Define a prefixed scope method for a state
+        def define_state_scope_method(state_name, method_name)
+          machine_attribute = attribute
+          scope_lambda = lambda do |value = true|
+            machine = state_machine(machine_attribute)
+            state_value = machine.states[state_name.to_sym].value
+            if value
+              where(machine_attribute => state_value)
+            else
+              where.not(machine_attribute => state_value)
+            end
+          end
+
+          owner_class.define_singleton_method(method_name, &scope_lambda)
+          owner_class.define_singleton_method("not_#{method_name}") do
+            public_send(method_name, false)
+          end
+        end
+
+        # Track generated state machine methods for introspection
+        def track_generated_method(method_name)
+          return unless enum_integrated?
+
+          # Use a Set to ensure no duplicates
+          enum_integration[:state_machine_methods] ||= []
+          return if enum_integration[:state_machine_methods].include?(method_name)
+
+          enum_integration[:state_machine_methods] << method_name
+        end
+      end
+
+      # Include MachineMethods to make enum integration methods available on machine instances
+      include MachineMethods
+
       class << self
         # Classes that inherit from ActiveRecord::Base will automatically use
         # the ActiveRecord integration.
@@ -383,8 +664,11 @@ module StateMachines
         action == :save
       end
 
-      # Gets the db default for the machine's attribute
+      # Gets the db default for the machine's attribute.
+      # For integer columns the raw pre-type-registration default is returned so
+      # that check_conflicting_attribute_default can compare integers to integers.
       def owner_class_attribute_default
+        return @raw_integer_column_default if defined?(@raw_integer_column_default)
         return unless owner_class.connected? && owner_class.table_exists?
 
         owner_class.column_defaults[attribute.to_s]
@@ -434,7 +718,7 @@ module StateMachines
 
       # Creates a scope for finding records *with* a particular state or
       # states for the attribute
-      def create_with_scope(name)
+      def create_with_scope(_name)
         attr_name = attribute
         lambda do |klass, values|
           if values.present?
@@ -447,7 +731,7 @@ module StateMachines
 
       # Creates a scope for finding records *without* a particular state or
       # states for the attribute
-      def create_without_scope(name)
+      def create_without_scope(_name)
         attr_name = attribute
         lambda do |klass, values|
           if values.present?
@@ -458,14 +742,13 @@ module StateMachines
         end
       end
 
-
       # Runs a new database transaction, rolling back any changes by raising
       # an ActiveRecord::Rollback exception if the yielded block fails
       # (i.e. returns false).
       def transaction(object)
         result = nil
         object.class.transaction do
-          raise ::ActiveRecord::Rollback unless result = yield
+          raise ::ActiveRecord::Rollback unless (result = yield)
         end
         result
       end
@@ -476,7 +759,6 @@ module StateMachines
 
       private
 
-
       # Generates the results for the given scope based on one or more states to filter by
       def run_scope(scope, machine, klass, states)
         values = states.flatten.compact.map { |state| machine.states.fetch(state).value }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.100.0
+  version: 0.103.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.100.0
+        version: 0.102.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.100.0
+        version: 0.102.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.27.0
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
 description: Adds support for creating state machines for attributes on ActiveRecord
 email:
 - terminale@gmail.com
@@ -121,6 +121,7 @@ files:
 - lib/state_machines-activerecord.rb
 - lib/state_machines/integrations/active_record.rb
 - lib/state_machines/integrations/active_record/locale.rb
+- lib/state_machines/integrations/active_record/type/integer.rb
 - lib/state_machines/integrations/active_record/version.rb
 homepage: https://github.com/state-machines/state_machines-activerecord/
 licenses:
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: State machines Active Record Integration
 test_files: []