state_machines-activerecord 0.103.0 → 0.200.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 571fa09486dd051901ae113941b3ae04e9867da62da325c609f97f44f1272f66
-  data.tar.gz: 22513e4df2238588d70dcff91f79fb00dfc18dac3a7b36a8a971765355939f8a
+  metadata.gz: f022e63c2bfd6af186733c95cbfc19cb7f25dfff128c791e5199b1a3f4e6d760
+  data.tar.gz: '094b3a2befdd974fa1828e9237f75f0a5a38319b7e38b56b8a3dda376a1e797d'
 SHA512:
-  metadata.gz: a15cf9abb68277ce52ab35e139b15fa8ce6b28fb68424bcbcf840de0216267f7f58b62483c01b2cbd62df9694ba117dfee3b090e2b64692cfe9114396d64c0f2
-  data.tar.gz: 97cb794b7e45222503e682641e80da05282f3593453979650431f35fa687831e9349dabe46ea7f2969dc2f95e9b3bc181cfc5860af17e3d57aefb72a8144a485
+  metadata.gz: cfb9f8bca11c37eeaff38ff0a237c2cc241986bba88ee4a8859199ea05ee7d06b4449da73574e0125f678de3082f3ba4e472f491f0efe9100fc2b585cac5e818
+  data.tar.gz: 8fb449a5ead40d4cf43e92208d307bb34f557e9aae068cda123c968ded28aecfa7a97c416426b04f99afd2550a50b54f852bc6e04c5ab6dc4fef62199d5e615d

data/README.md

@@ -164,6 +164,62 @@ machine.state_machine_methods
 # => ["status_pending?", "status_processing?", "status_completed?", "status_cancelled?", ...]
 ```
 
+## Integer-backed state attributes
+
+Integer columns whose states don't declare explicit values are converted
+transparently: application code reads state names while the database stores
+integers (mapped by definition order).
+
+```ruby
+class Order < ApplicationRecord
+  state_machine :status, initial: :pending do
+    state :pending
+    state :approved
+  end
+end
+
+order = Order.create!
+order.status = :approved
+order.status # => "approved"
+# The database stores 1.
+```
+
+Machines where every state declares an explicit integer value keep the classic
+raw-integer behavior automatically: reads return the integer and `status_name`
+returns the state name:
+
+```ruby
+class LegacyOrder < ApplicationRecord
+  self.table_name = "orders"
+
+  state_machine :status, initial: :pending do
+    state :pending, value: 0
+    state :approved, value: 1
+
+    event :approve do
+      transition pending: :approved
+    end
+  end
+end
+
+order = LegacyOrder.create!
+order.approve!
+order.status      # => 1
+order.status_name # => :approved
+# The database stores 1.
+```
+
+Applications that want no type conversion at all can disable it during boot,
+before defining affected state machines:
+
+```ruby
+# config/initializers/state_machines.rb
+
+StateMachines::Integrations::ActiveRecord.auto_convert_integer_state_attributes = false
+```
+
+With this setting disabled, integer-backed state attributes are left entirely
+to ActiveRecord's normal integer handling.
 
 ### Requirements for Enum Integration
 

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

@@ -9,52 +9,113 @@ module StateMachines
     # 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.
+    #
+    # When *every* named state has an explicit integer value, the column already
+    # stores the canonical state values and no name<->integer conversion is
+    # needed. In that case the type delegates to the column's original integer
+    # type, preserving the classic raw-integer behavior
+    # (e.g. record.status # => 1, record.status_name # => :approved).
     class Integer < ::ActiveRecord::Type::Value
-      def initialize(states)
+      # The column's original attribute type, exposed so re-registration
+      # (e.g. for STI subclasses) can reuse it instead of wrapping this type.
+      #
+      # @return [ActiveModel::Type::Value]
+      attr_reader :raw_type
+
+      # @param states [StateMachines::StateCollection] live collection of the
+      #   machine's states; held by reference because states are defined after
+      #   the type is registered
+      # @param raw_type [ActiveModel::Type::Value, nil] the column's original
+      #   attribute type, used verbatim in passthrough mode so adapter-specific
+      #   integer behavior (limits, range checks) is preserved
+      def initialize(states, raw_type: nil)
         @states = states
+        @raw_type = raw_type || ::ActiveModel::Type::Integer.new
         super()
       end
 
-      # integer from DB → state name string
+      # Converts an integer from the database to a state name string.
+      #
+      # @param value [Integer, String, nil] raw database value
+      # @return [String, Integer, nil] state name, or the original type's value
+      #   in passthrough mode, or the raw value when no state matches
       def deserialize(value)
+        states = named_states
+        return @raw_type.deserialize(value) if passthrough?(states)
         return nil if value.nil?
+
         int_val = value.to_i
-        state = named_states.detect { |s| state_integer(s) == int_val }
+        state = states.detect { |s| state_integer(s, states) == int_val }
         state ? state.name.to_s : value
       end
 
-      # assignment (symbol / string / integer) → state name string (in-memory)
+      # Converts an assigned value (symbol, string, or integer) to the in-memory
+      # state name string.
+      #
+      # @param value [Symbol, String, Integer, nil] assigned value
+      # @return [String, Integer, nil] state name, or the original type's cast
+      #   in passthrough mode
       def cast(value)
+        states = named_states
+        return @raw_type.cast(value) if passthrough?(states)
         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 = states.detect { |s| s.name.to_s == value.to_s }
+        state ||= states.detect { |s| state_integer(s, states) == 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
+      # Converts a state name string to its integer for the database write.
+      #
+      # @param value [String, Symbol, Integer, nil] in-memory value
+      # @return [Integer, nil] integer to store
       def serialize(value)
+        states = named_states
+        return @raw_type.serialize(value) if passthrough?(states)
         return nil if value.nil?
-        state = named_states.detect { |s| s.name.to_s == value.to_s }
-        state ? state_integer(state) : value
+
+        state = states.detect { |s| s.name.to_s == value.to_s }
+        state ? state_integer(state, states) : value
       end
 
+      # @return [Symbol] the ActiveModel type identifier
       def type
         :integer
       end
 
       private
 
-      # All non-nil states in definition order — not memoized because states are
+      # All non-nil states in definition order, not memoized because states are
       # added to the collection after the type is instantiated.
+      #
+      # @return [Array<StateMachines::State>]
       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)
+      # Whether the machine was defined for raw integer storage, in which case
+      # conversion would change documented behavior. True when every named state
+      # declares an explicit integer value. Evaluated lazily on every call
+      # because states (and their values) are defined after the type is
+      # registered. Uses value(false) so dynamic (Proc) state values are never
+      # evaluated for this metadata decision.
+      #
+      # @param states [Array<StateMachines::State>] pre-computed named states
+      # @return [Boolean]
+      def passthrough?(states)
+        states.any? && states.all? { |s| s.value(false).is_a?(::Integer) }
+      end
+
+      # The integer to use for storage: the explicit state value if set
+      # (e.g. state :pending, value: 2), otherwise the index position among
+      # named states.
+      #
+      # @param state [StateMachines::State]
+      # @param states [Array<StateMachines::State>] pre-computed named states
+      # @return [Integer]
+      def state_integer(state, states)
+        value = state.value(false)
+        value.is_a?(::Integer) ? value : states.index(state)
       end
     end
   end

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

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

data/lib/state_machines/integrations/active_record.rb

@@ -316,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
     #
@@ -372,6 +378,7 @@ module StateMachines
 
       # The default options to use for state machines using this integration
       @defaults = { action: :save, use_transactions: true }
+      @auto_convert_integer_state_attributes = true
 
       # Machine-specific methods for enum integration
       module MachineMethods
@@ -382,7 +389,24 @@ module StateMachines
         def after_initialize
           super
           initialize_enum_integration
-          register_integer_type if integer_column? && !enum_integrated?
+
+          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
@@ -418,9 +442,39 @@ module StateMachines
           # 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]
@@ -451,33 +505,132 @@ module StateMachines
           !!@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.  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.
+        # 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.
         #
-        # For auto-indexed states (no explicit value), state.value is the string
-        # name so super() returns the right thing already.
+        # @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 states_with_explicit_integer_values?
+          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 ? matched.value : raw
+            return matched.value if matched
           end
-          raw
+
+          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
 
-        # 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) }
+        # 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
@@ -497,7 +650,14 @@ module StateMachines
         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))
+
+          # 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
@@ -650,6 +810,8 @@ module StateMachines
       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
@@ -674,6 +836,22 @@ module StateMachines
         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
           def initialize(attributes = nil, *)
@@ -759,12 +937,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 }
-        scope.call(klass, 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.103.0
+  version: 0.200.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.102.0
+        version: 0.200.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.102.0
+        version: 0.200.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: State machines Active Record Integration
 test_files: []