state_machines-activerecord 0.10.0 → 0.200.0

data/lib/state_machines/integrations/active_record.rb

@@ -1,9 +1,12 @@
+# 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:
+  module Integrations # :nodoc:
     # Adds support for integrating state machines with ActiveRecord models.
     #
     # == Examples
@@ -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
     #
@@ -207,10 +211,10 @@ module StateMachines
     #
     #   class Vehicle < ApplicationRecord
     #     # with_states also aliased to with_state
-    #     scope :with_states, ->(states) { where(state: states) }
+    #     scope :with_states, ->(states) { states.present? ? where(state: states) : all }
     #
     #     # without_states also aliased to without_state
-    #     scope :without_states, ->(states) { where.not(state: states) }
+    #     scope :without_states, ->(states) { states.present? ? where.not(state: states) : all }
     #   end
     #
     # *Note*, however, that the states are converted to their stored values
@@ -226,6 +230,15 @@ module StateMachines
     #
     #   Vehicle.with_state('parked')
     #
+    # === Transparent Scopes
+    #
+    # When `nil` is passed to any of the state scopes, they return `all` records
+    # without applying any filters. This allows for more flexible scope chaining
+    # in search interfaces:
+    #
+    #   Vehicle.with_state(params[:state])  # Returns all vehicles if params[:state] is nil
+    #   Vehicle.where(color: 'red').with_state(nil)  # Returns all red vehicles
+    #
     # == Callbacks
     #
     # All before/after transition callbacks defined for ActiveRecord models
@@ -303,6 +316,12 @@ module StateMachines
     # * (8) *after_transition*
     # * (-) end transaction (if enabled)
     # * (9) after_commit
+    # * (10) *after_transition* callbacks defined with <tt>:after_commit => true</tt>
+    #
+    # An +after_transition+ callback defined with the <tt>:after_commit</tt>
+    # option is deferred until the surrounding database transaction has been
+    # committed (and discarded if it rolls back).  See the documentation for
+    # +after_transition+ in this integration for more details.
     #
     # == Internationalization
     #
@@ -358,8 +377,441 @@ module StateMachines
       include ActiveModel
 
       # The default options to use for state machines using this integration
-      @defaults = {:action => :save, use_transactions: true}
+      @defaults = { action: :save, use_transactions: true }
+      @auto_convert_integer_state_attributes = 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 register_integer_type?
+        end
+
+        # Hook called when a machine is assigned to a class, including when an
+        # inherited machine is cloned for an STI subclass. The cloned machine
+        # carries the parent's @integer_type_registered flag while the subclass
+        # still inherits the parent's attribute type, which references the
+        # parent machine's state collection. Re-register so the subclass type
+        # sees this machine's (cloned) states, picking up subclass-added states
+        # as they are defined.
+        #
+        # @param klass [Class] the new owner class
+        # @return [Class] the assigned owner class
+        def owner_class=(klass)
+          super.tap do
+            register_integer_type if integer_type_registered?
+          end
+        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?
+
+          # States defined after initialization (e.g. adding an explicit value
+          # to the initial state) can change how the column default maps to
+          # states, so re-evaluate the conflicting-default warning
+          recheck_conflicting_attribute_default if integer_type_registered?
+
+          result
+        end
+
+        # Warns at most once when the column default conflicts with the
+        # machine's initial state. The conflict is re-evaluated as states are
+        # defined, so remember when the warning has been issued.
+        def check_conflicting_attribute_default
+          return if @attribute_default_conflict_warned
+
+          initial_state = states.detect(&:initial)
+          conflict = !owner_class_attribute_default.nil? && (
+            dynamic_initial_state? || !owner_class_attribute_default_matches?(initial_state)
+          )
+          return unless conflict
+
+          @attribute_default_conflict_warned = true
+          super
+        end
+
+        # Returns true when this machine should use the custom integer attribute type
+        # to convert between Ruby state names and integer database values. This only
+        # applies to non-enum integer columns when automatic conversion is enabled.
+        def register_integer_type?
+          StateMachines::Integrations::ActiveRecord.auto_convert_integer_state_attributes &&
+            integer_column? &&
+            !enum_integrated?
+        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
+
+        # Creates a callback that will be invoked *after* a transition is
+        # performed, so long as the given requirements match the transition.
+        #
+        # In addition to the configuration options supported by the core
+        # +after_transition+ (see StateMachines::Machine#after_transition), the
+        # ActiveRecord integration supports:
+        # * <tt>:after_commit</tt> - Defer execution of the callback until the
+        #   database transaction wrapping the transition has been committed.
+        #   When no transaction is open at that point, the callback runs
+        #   immediately.  When the transaction (or an outer transaction wrapping
+        #   it) is rolled back, the callback is discarded.
+        #
+        # This is the safe place to enqueue background jobs that reference the
+        # record (e.g. via GlobalID), since a regular +after_transition+ runs
+        # inside the transaction, before the record's changes are visible to
+        # other connections:
+        #
+        #   class Vehicle < ApplicationRecord
+        #     state_machine do
+        #       after_transition on: :ignite, after_commit: true do |vehicle|
+        #         EngineWarmupJob.perform_later(vehicle)
+        #       end
+        #
+        #       ...
+        #     end
+        #   end
+        #
+        # Note that a deferred callback cannot halt the callback chain or
+        # affect the result of the transition: by the time it runs, the
+        # transition has already been committed.  For the same reason, an
+        # exception raised by a deferred callback is not propagated (doing so
+        # would revert the record's in-memory state even though the database
+        # was already updated); it is reported to +ActiveSupport.error_reporter+
+        # (+Rails.error+) instead.  Conditions (<tt>:if</tt>/<tt>:unless</tt>)
+        # and state requirements are evaluated when the transition is
+        # performed, not at commit time.
+        #
+        # Like ActiveRecord's own +after_commit+, a surrounding
+        # <tt>transaction(joinable: false)</tt> wrapper is transparent: the
+        # callback fires at the inner commit.  This is what makes it fire
+        # under transactional test fixtures.
+        def after_transition(*args, **options, &block)
+          # The flag may hide in a legacy trailing positional options hash
+          positional_options = args.last.is_a?(Hash) ? args.pop.dup : {}
+          options = positional_options.merge(options)
+
+          # Only a boolean is the flag — a non-boolean value is the implicit
+          # state-requirement form for a state named :after_commit
+          flag = options[:after_commit]
+          return super unless flag == true || flag == false
+
+          options.delete(:after_commit)
+          return super unless flag
+
+          # Method handling goes to a real Callback (reusing core's binding,
+          # arity and :do semantics); branch matching stays on the wrapper so
+          # conditions are evaluated at transition time
+          parsed = parse_callback_arguments(args, options)
+          method_options = parsed.slice(:do, :bind_to_object)
+          method_options[:terminator] = callback_terminator
+          branch_options = parsed.except(:do, :bind_to_object, :terminator)
+
+          deferred = Callback.new(:after, method_options, &block)
+
+          super(**branch_options, bind_to_object: false) do |object, transition|
+            object.class.current_transaction.after_commit do
+              # The transition's catch(:halt) is gone at commit time
+              catch(:halt) { deferred.call(object, {}, transition) }
+            rescue StandardError => e
+              # Raising would roll back in-memory state already committed; report instead
+              ActiveSupport.error_reporter.report(e, handled: false, source: 'state_machines-activerecord')
+            end
+          end
+        end
+
+        # Machine internals (state matching, validations) call read() to get the
+        # current state value and compare it against state.value. The custom
+        # integer type already returns the canonical value when state values are
+        # uniform: raw integers when every named state has an explicit integer
+        # value (passthrough), name strings when none do (state.value is the
+        # name). Only machines mixing explicit and auto-indexed values need an
+        # override, because the type returns name strings while the explicit
+        # states match on integers; map the stored value back to the matched
+        # state's canonical state.value.
+        #
+        # @param object [ActiveRecord::Base] record being read
+        # @param attr_sym [Symbol] attribute kind (:state, :event, ...)
+        # @param ivar [Boolean] whether to read from an instance variable
+        # @return [Object] a value machine internals can match on state.value
+        def read(object, attr_sym, ivar = false)
+          return super unless integer_type_registered? && attr_sym == :state
+          return super unless mixed_integer_state_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.value if matched
+          end
+
+          name = owner_class.type_for_attribute(attribute.to_s).deserialize(raw)
+          matched = states.detect { |s| s.name && s.name.to_s == name.to_s }
+          matched ? matched.value : raw
+        end
+
+        private
+
+        # Re-runs the conflicting-default check for states defined after
+        # initialization. Skipped until an initial state exists (the DSL block
+        # evaluates before initial_state= during Machine.new).
+        #
+        # @return [void]
+        def recheck_conflicting_attribute_default
+          return unless states.detect(&:initial)
+
+          check_conflicting_attribute_default
+        end
+
+        # Returns true when named states mix explicit integer values with
+        # auto-indexed (name-valued) states. Uses value(false) so dynamic
+        # (Proc) state values are never evaluated for this metadata decision.
+        #
+        # @return [Boolean]
+        def mixed_integer_state_values?
+          named = states.select(&:name)
+          explicit = named.count { |s| s.value(false).is_a?(::Integer) }
+          explicit.positive? && explicit < named.size
+        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
+
+          # When re-registering (e.g. for an STI subclass that inherited the
+          # parent's custom type), unwrap it to keep the column's original type
+          # as the passthrough delegate.
+          current_type = owner_class.type_for_attribute(attribute.to_s)
+          raw_type = current_type.is_a?(StateMachines::Type::Integer) ? current_type.raw_type : current_type
+
+          owner_class.attribute(attribute.to_s, StateMachines::Type::Integer.new(states, raw_type: raw_type))
+        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
+        attr_accessor :auto_convert_integer_state_attributes
+
         # Classes that inherit from ActiveRecord::Base will automatically use
         # the ActiveRecord integration.
         def matching_ancestors
@@ -374,30 +826,50 @@ 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
-        if owner_class.connected? && owner_class.table_exists?
-          owner_class.column_defaults[attribute.to_s]
-        end
+        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]
+      end
+
+      # Checks whether the given state matches the column default. When the
+      # custom integer type is registered, auto-indexed states match on their
+      # name string while the column default is a raw integer, so the default
+      # is also compared through the type's mapping (e.g. 0 matches the first
+      # auto-indexed state).
+      #
+      # @param state [StateMachines::State] the state to compare (the initial state)
+      # @return [Boolean] whether the column default represents this state
+      def owner_class_attribute_default_matches?(state)
+        matches = super
+        return matches if matches || !integer_type_registered?
+
+        default = owner_class_attribute_default
+        state.matches?(owner_class.type_for_attribute(attribute.to_s).deserialize(default))
       end
 
       def define_state_initializer
-        define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+        define_helper :instance, <<-END_EVAL, __FILE__, __LINE__ + 1
           def initialize(attributes = nil, *)
             super(attributes) do |*args|
-              scoped_attributes = (attributes || {}).merge(self.class.scope_attributes)
+              attributes = (attributes || {}).transform_keys { |key| self.class.attribute_aliases[key.to_s] || key }
+              scoped_attributes = attributes.merge(self.class.scope_attributes)
 
               self.class.state_machines.initialize_states(self, {}, scoped_attributes)
               yield(*args) if block_given?
             end
           end
-        end_eval
+        END_EVAL
       end
 
       # Uses around callbacks to run state events if using the :save hook
       def define_action_hook
         if action_hook == :save
-          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+          define_helper :instance, <<-END_EVAL, __FILE__, __LINE__ + 1
               def save(*, **)
                 self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
               end
@@ -410,33 +882,42 @@ module StateMachines
               def changed_for_autosave?
                 super || self.class.state_machines.any? {|name, machine| machine.action == :save && machine.read(self, :event)}
               end
-          end_eval
+          END_EVAL
         else
           super
         end
       end
 
       # Runs state events around the machine's :save action
-      def around_save(object)
-        object.class.state_machines.transitions(object, action).perform { yield }
+      def around_save(object, &)
+        # Pass fiber: false to avoid deadlocks with ActiveRecord's LoadInterlockAwareMonitor
+        object.class.state_machines.transitions(object, action, fiber: false).perform(&)
       end
 
       # Creates a scope for finding records *with* a particular state or
       # states for the attribute
-      def create_with_scope(name)
-        create_scope(name, ->(values) { ["#{attribute_column} IN (?)", values] })
+      def create_with_scope(_name)
+        attr_name = attribute
+        lambda do |klass, values|
+          if values.present?
+            klass.where(attr_name => values)
+          else
+            klass.all
+          end
+        end
       end
 
       # Creates a scope for finding records *without* a particular state or
       # states for the attribute
-      def create_without_scope(name)
-        create_scope(name, ->(values) { ["#{attribute_column} NOT IN (?)", values] })
-      end
-
-      # Generates the fully-qualifed column name for this machine's attribute
-      def attribute_column
-        connection = owner_class.connection
-        "#{connection.quote_table_name(owner_class.table_name)}.#{connection.quote_column_name(attribute)}"
+      def create_without_scope(_name)
+        attr_name = attribute
+        lambda do |klass, values|
+          if values.present?
+            klass.where.not(attr_name => values)
+          else
+            klass.all
+          end
+        end
       end
 
       # Runs a new database transaction, rolling back any changes by raising
@@ -445,7 +926,7 @@ module StateMachines
       def transaction(object)
         result = nil
         object.class.transaction do
-          raise ::ActiveRecord::Rollback unless result = yield
+          raise ::ActiveRecord::Rollback unless (result = yield)
         end
         result
       end
@@ -456,17 +937,12 @@ module StateMachines
 
       private
 
-        # Defines a new scope with the given name
-        def create_scope(name, scope)
-          lambda { |model, values| model.where(scope.call(values)) }
-        end
-
-        # ActiveModel's use of method_missing / respond_to for attribute methods
-        # breaks both ancestor lookups and defined?(super).  Need to special-case
-        # the existence of query attribute methods.
-        def owner_class_ancestor_has_method?(scope, method)
-          scope == :instance && method == "#{attribute}?" ? owner_class : super
-        end
+      # ActiveModel's use of method_missing / respond_to for attribute methods
+      # breaks both ancestor lookups and defined?(super).  Need to special-case
+      # the existence of query attribute methods.
+      def owner_class_ancestor_has_method?(scope, method)
+        scope == :instance && method == "#{attribute}?" ? owner_class : super
+      end
     end
     register(ActiveRecord)
   end