state_machines-activerecord 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4d6c3db18b13bbece06c33f047109e49d17eb1b97e8d26d8e001ed02a554b7a
-  data.tar.gz: ebd085709c837eb3c76994e23780b884136a338f92b63eb77c8c64620bd1980e
+  metadata.gz: a5e8b447b65a1f99ad367425556a3e726b3f42be5056af03a2a48e741851ff72
+  data.tar.gz: 801a7943d18a71f506acefedb764cb8ed0a9caa1c459893df99f3b21419c78f7
 SHA512:
-  metadata.gz: febb1df5b304114be86875716fb620b7c1b7fe1d0d44bea3c52c92451345e2cf2fb57e11cbd87d9b277079a52ebb9f82734d4174ea6722e8c6d933d274f88f6d
-  data.tar.gz: 3ee22472203164647a9d65ef4a5df8edfeda3874144b57281b9dce79ae210006f171bc02fdcdd24d44afd08ed4b9dff409b61d443a61052a1baeee27d8f3ed16
+  metadata.gz: c6794e0f3d9e6835682f4a541bb8bde8210599749621c262ed164bae482c78f3ec40aa6cc4279db5ed62583bd5d2f30476f43f49f5adc149ac80eb9df20ee487
+  data.tar.gz: 0fc0b42cc6de4c17f4a844634647dd0e0245933c6a713cf51e68655b4354e03801b0a6b63e61c1e27298a1db56ae8559a605972e2a6ef3cc879f32f75691c3b6

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) 2006-2012 Aaron Pfeifer
-Copyright (c) 2014-2021 Abdelkader Boudih
+Copyright (c) 2014-2025 Abdelkader Boudih
 
 MIT License
 

data/README.md

@@ -1,5 +1,4 @@
-[![Build Status](https://travis-ci.com/state-machines/state_machines-activerecord.svg?branch=master)](https://travis-ci.com/state-machines/state_machines-activerecord)
-[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-activerecord.svg)](https://codeclimate.com/github/state-machines/state_machines-activerecord)
+[![Build Status](https://github.com/state-machines/state_machines-activerecord/actions/workflows/ruby.yml/badge.svg)](https://github.com/state-machines/state_machines-activerecord/actions/workflows/ruby.yml)
 
 # StateMachines Active Record Integration
 
@@ -27,7 +26,7 @@ For the complete usage guide, see http://www.rubydoc.info/github/state-machines/
 ### Example
 
 ```ruby
-class Vehicle < ActiveRecord::Base
+class Vehicle < ApplicationRecord
   state_machine :initial => :parked do
     before_transition :parked => any - :parked, :do => :put_on_seatbelt
     after_transition any => :parked do |vehicle, transition|
@@ -40,7 +39,7 @@ class Vehicle < ActiveRecord::Base
     end
 
     state :first_gear, :second_gear do
-      validates_presence_of :seatbelt_on
+      validates :seatbelt_on, presence: true
     end
   end
 
@@ -73,7 +72,7 @@ framework, custom validators will not work as expected when defined to run
 in multiple states. For example:
 
 ```ruby
-class Vehicle < ActiveRecord::Base
+class Vehicle < ApplicationRecord
   state_machine do
     state :first_gear, :second_gear do
       validate :speed_is_legal
@@ -87,7 +86,7 @@ for the <tt>:second_gear</tt> state.  To avoid this, you can define your
 custom validation like so:
 
 ```ruby
-class Vehicle < ActiveRecord::Base
+class Vehicle < ApplicationRecord
   state_machine do
     state :first_gear, :second_gear do
       validate {|vehicle| vehicle.speed_is_legal}

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 { en: {
     activerecord: {
         errors: {

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module StateMachines
   module Integrations
     module ActiveRecord
-      VERSION = '0.8.0'
+      VERSION = '0.10.0'
     end
   end
 end

data/lib/state_machines/integrations/active_record.rb

@@ -11,7 +11,7 @@ module StateMachines
     # Below is an example of a simple state machine defined within an
     # ActiveRecord model:
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine :initial => :parked do
     #       event :ignite do
     #         transition :parked => :idling
@@ -78,25 +78,22 @@ module StateMachines
     # === Security implications
     #
     # Beware that public event attributes mean that events can be fired
-    # whenever mass-assignment is being used.  If you want to prevent malicious
-    # users from tampering with events through URLs / forms, the attribute
-    # should be protected like so:
-    #
-    #   class Vehicle < ActiveRecord::Base
-    #     attr_protected :state_event
-    #     # attr_accessible ... # Alternative technique
-    #
-    #     state_machine do
-    #       ...
+    # whenever mass-assignment is being used. If you want to prevent malicious
+    # users from tampering with events through URLs / forms, you should use
+    # Rails' strong parameters to control which attributes are permitted:
+    #
+    #   class VehiclesController < ApplicationController
+    #     def vehicle_params
+    #       params.require(:vehicle).permit(:color, :make, :model)
+    #       # Exclude state_event to prevent tampering
     #     end
     #   end
     #
     # If you want to only have *some* events be able to fire via mass-assignment,
     # you can build two state machines (one public and one protected) like so:
     #
-    #   class Vehicle < ActiveRecord::Base
-    #     attr_protected :state_event # Prevent access to events in the first machine
-    #
+    #   class Vehicle < ApplicationRecord
+    #     # Define private machine
     #     state_machine do
     #       # Define private events here
     #     end
@@ -105,6 +102,8 @@ module StateMachines
     #     state_machine :public_state, :attribute => :state do
     #       # Define public events here
     #     end
+    #
+    #     # Control access via strong parameters in your controller
     #   end
     #
     # == Transactions
@@ -115,7 +114,7 @@ module StateMachines
     #
     # For example,
     #
-    #   class Message < ActiveRecord::Base
+    #   class Message < ApplicationRecord
     #   end
     #
     #   Vehicle.state_machine do
@@ -136,7 +135,7 @@ module StateMachines
     #
     # To turn off transactions:
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine :initial => :parked, :use_transactions => false do
     #       ...
     #     end
@@ -150,7 +149,7 @@ module StateMachines
     # framework, custom validators will not work as expected when defined to run
     # in multiple states.  For example:
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine do
     #       ...
     #       state :first_gear, :second_gear do
@@ -163,7 +162,7 @@ module StateMachines
     # for the <tt>:second_gear</tt> state.  To avoid this, you can define your
     # custom validation like so:
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine do
     #       ...
     #       state :first_gear, :second_gear do
@@ -199,28 +198,28 @@ module StateMachines
     #
     # == Scopes
     #
-    # To assist in filtering models with specific states, a series of named
-    # scopes are defined on the model for finding records with or without a
+    # To assist in filtering models with specific states, a series of scopes
+    # are defined on the model for finding records with or without a
     # particular set of states.
     #
-    # These named scopes are essentially the functional equivalent of the
+    # These scopes are essentially the functional equivalent of the
     # following definitions:
     #
-    #   class Vehicle < ActiveRecord::Base
-    #     named_scope :with_states, lambda {|*states| {:conditions => {:state => states}}}
+    #   class Vehicle < ApplicationRecord
     #     # with_states also aliased to with_state
+    #     scope :with_states, ->(states) { where(state: states) }
     #
-    #     named_scope :without_states, lambda {|*states| {:conditions => ['state NOT IN (?)', states]}}
     #     # without_states also aliased to without_state
+    #     scope :without_states, ->(states) { where.not(state: states) }
     #   end
     #
     # *Note*, however, that the states are converted to their stored values
     # before being passed into the query.
     #
-    # Because of the way named scopes work in ActiveRecord, they can be
+    # Because of the way scopes work in ActiveRecord, they can be
     # chained like so:
     #
-    #   Vehicle.with_state(:parked).all(:order => 'id DESC')
+    #   Vehicle.with_state(:parked).order(id: :desc)
     #
     # Note that states can also be referenced by the string version of their
     # name:
@@ -235,7 +234,7 @@ module StateMachines
     #
     # For example,
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine :initial => :parked do
     #       before_transition any => :idling do |vehicle|
     #         vehicle.put_on_seatbelt
@@ -266,11 +265,11 @@ module StateMachines
     # ActiveRecord, a save failure will cause any records that get created in
     # your callback to roll back.  You can work around this issue like so:
     #
-    #   class TransitionLog < ActiveRecord::Base
-    #     establish_connection Rails.env.to_sym
+    #   class TransitionLog < ApplicationRecord
+    #     connects_to database: { writing: :primary, reading: :primary }
     #   end
     #
-    #   class Vehicle < ActiveRecord::Base
+    #   class Vehicle < ApplicationRecord
     #     state_machine do
     #       after_failure do |vehicle, transition|
     #         TransitionLog.create(:vehicle => vehicle, :transition => transition)
@@ -280,7 +279,7 @@ module StateMachines
     #     end
     #   end
     #
-    # The +TransitionLog+ model establishes a second connection to the database
+    # The +TransitionLog+ model establishes a separate connection to the database
     # that allows new records to be saved without being affected by rollbacks
     # in the +Vehicle+ model's transaction.
     #
@@ -305,65 +304,9 @@ module StateMachines
     # * (-) end transaction (if enabled)
     # * (9) after_commit
     #
-    # == Observers
-    #
-    # In addition to support for ActiveRecord-like hooks, there is additional
-    # support for ActiveRecord observers.  Because of the way ActiveRecord
-    # observers are designed, there is less flexibility around the specific
-    # transitions that can be hooked in.  However, a large number of hooks
-    # *are* supported.  For example, if a transition for a record's +state+
-    # attribute changes the state from +parked+ to +idling+ via the +ignite+
-    # event, the following observer methods are supported:
-    # * before/after/after_failure_to-_ignite_from_parked_to_idling
-    # * before/after/after_failure_to-_ignite_from_parked
-    # * before/after/after_failure_to-_ignite_to_idling
-    # * before/after/after_failure_to-_ignite
-    # * before/after/after_failure_to-_transition_state_from_parked_to_idling
-    # * before/after/after_failure_to-_transition_state_from_parked
-    # * before/after/after_failure_to-_transition_state_to_idling
-    # * before/after/after_failure_to-_transition_state
-    # * before/after/after_failure_to-_transition
-    #
-    # The following class shows an example of some of these hooks:
-    #
-    #   class VehicleObserver < ActiveRecord::Observer
-    #     def before_save(vehicle)
-    #       # log message
-    #     end
-    #
-    #     # Callback for :ignite event *before* the transition is performed
-    #     def before_ignite(vehicle, transition)
-    #       # log message
-    #     end
-    #
-    #     # Callback for :ignite event *after* the transition has been performed
-    #     def after_ignite(vehicle, transition)
-    #       # put on seatbelt
-    #     end
-    #
-    #     # Generic transition callback *before* the transition is performed
-    #     def after_transition(vehicle, transition)
-    #       Audit.log(vehicle, transition)
-    #     end
-    #   end
-    #
-    # More flexible transition callbacks can be defined directly within the
-    # model as described in StateMachines::Machine#before_transition
-    # and StateMachines::Machine#after_transition.
-    #
-    # To define a single observer for multiple state machines:
-    #
-    #   class StateMachineObserver < ActiveRecord::Observer
-    #     observe Vehicle, Switch, Project
-    #
-    #     def after_transition(record, transition)
-    #       Audit.log(record, transition)
-    #     end
-    #   end
-    #
     # == Internationalization
     #
-    # In Rails 2.2+, any error message that is generated from performing invalid
+    # Any error message that is generated from performing invalid
     # transitions can be localized.  The following default translations are used:
     #
     #   en:
@@ -376,9 +319,6 @@ module StateMachines
     #           # %{value} = attribute value, %{event} = Human event name, %{state} = Human current state name
     #           invalid_transition: "cannot transition via %{event}"
     #
-    # Notice that the interpolation syntax is %{key} in Rails 3+.  In Rails 2.x,
-    # the appropriate syntax is {{key}}.
-    #
     # You can override these for a specific model like so:
     #
     #   en:
@@ -435,72 +375,23 @@ module StateMachines
       end
 
       # Gets the db default for the machine's attribute
-      if ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0')
-        def owner_class_attribute_default
-          if owner_class.connected? && owner_class.table_exists?
-            owner_class.column_defaults[attribute.to_s]
-          end
-        end
-      else
-        def owner_class_attribute_default
-          if owner_class.connected? && owner_class.table_exists?
-            if column = owner_class.columns_hash[attribute.to_s]
-              column.default
-            end
-          end
+      def owner_class_attribute_default
+        if owner_class.connected? && owner_class.table_exists?
+          owner_class.column_defaults[attribute.to_s]
         end
       end
 
       def define_state_initializer
-        if ::ActiveRecord.gem_version >= Gem::Version.new('5.0.0.alpha')
-          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
-            def initialize(attributes = nil, *)
-              super(attributes) do |*args|
-                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
-        elsif ::ActiveRecord.gem_version >= Gem::Version.new('4.2')
-          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
-            def initialize(attributes = nil, options = {})
+        define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+          def initialize(attributes = nil, *)
+            super(attributes) do |*args|
               scoped_attributes = (attributes || {}).merge(self.class.scope_attributes)
 
-              super(attributes, options) do |*args|
-                self.class.state_machines.initialize_states(self, {}, scoped_attributes)
-                yield(*args) if block_given?
-              end
+              self.class.state_machines.initialize_states(self, {}, scoped_attributes)
+              yield(*args) if block_given?
             end
-          end_eval
-        else
-          # Initializes static states
-          #
-          # This is the only available hook where the default set of attributes
-          # can be overridden for a new object *prior* to the processing of the
-          # attributes passed into #initialize
-          define_helper :class, <<-end_eval, __FILE__, __LINE__ + 1
-            def column_defaults(*) #:nodoc:
-              result = super
-              # No need to pass in an object, since the overrides will be forced
-              self.state_machines.initialize_states(nil, :static => :force, :dynamic => false, :to => result)
-              result
-            end
-          end_eval
-
-          # Initializes dynamic states
-          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
-            def initialize(attributes = nil, options = {})
-              scoped_attributes = (attributes || {}).merge(self.class.scope_attributes)
-
-              super(attributes, options) do |*args|
-                self.class.state_machines.initialize_states(self, {}, scoped_attributes)
-                yield(*args) if block_given?
-              end
-            end
-          end_eval
-        end
+          end
+        end_eval
       end
 
       # Uses around callbacks to run state events if using the :save hook
@@ -565,7 +456,7 @@ module StateMachines
 
       private
 
-        # Defines a new named scope with the given name
+        # Defines a new scope with the given name
         def create_scope(name, scope)
           lambda { |model, values| model.where(scope.call(values)) }
         end

data/lib/state_machines-activerecord.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'state_machines/integrations/active_record'
 

data/test/files/models/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ActiveRecord::Base.connection.create_table(:posts, :force => true) do |t|
   t.string :title
   t.string :content

data/test/integration_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class IntegrationTest < BaseTestCase

data/test/machine_by_default_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineByDefaultTest < BaseTestCase

data/test/machine_errors_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineErrorsTest < BaseTestCase

data/test/machine_multiple_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineMultipleTest < BaseTestCase

data/test/machine_nested_action_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineNestedActionTest < BaseTestCase

data/test/machine_unmigrated_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineUnmigratedTest < BaseTestCase

data/test/machine_with_aliased_attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithAliasedAttributeTest < BaseTestCase

data/test/machine_with_callbacks_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithCallbacksTest < BaseTestCase

data/test/machine_with_column_state_attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithColumnStateAttributeTest < BaseTestCase

data/test/machine_with_complex_pluralization_scopes_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithComplexPluralizationScopesTest < BaseTestCase

data/test/machine_with_conflicting_predicate_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithConflictingPredicateTest < BaseTestCase

data/test/machine_with_conflicting_state_name_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'stringio'
 
@@ -12,14 +14,14 @@ class MachineWithConflictingStateNameTest < BaseTestCase
     @machine = StateMachines::Machine.new(@model)
     @machine.state :state
 
-    assert_match(/^Instance method "state\?" is already defined in Foo, use generic helper instead.*\n$/, $stderr.string)
+    assert_match(/^Instance method "state\?" is already defined in .+, use generic helper instead.*\n$/, $stderr.string)
   end
 
   def test_should_output_warning_with_same_machine_attribute
     @machine = StateMachines::Machine.new(@model, :public_state, :attribute => :state)
     @machine.state :state
 
-    assert_match(/^Instance method "state\?" is already defined in Foo, use generic helper instead.*\n$/, $stderr.string)
+    assert_match(/^Instance method "state\?" is already defined in .+, use generic helper instead.*\n$/, $stderr.string)
   end
 
   def teardown

data/test/machine_with_custom_attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'stringio'
 

data/test/machine_with_default_scope_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDefaultScopeTest < BaseTestCase

data/test/machine_with_different_column_default_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'stringio'
 

data/test/machine_with_different_integer_column_default_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'stringio'
 

data/test/machine_with_dirty_attribute_and_custom_attributes_during_loopback_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDirtyAttributeAndCustomAttributesDuringLoopbackTest < BaseTestCase

data/test/machine_with_dirty_attribute_and_state_events_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDirtyAttributeAndStateEventsTest < BaseTestCase

data/test/machine_with_dirty_attributes_and_custom_attribute_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDirtyAttributesAndCustomAttributeTest < BaseTestCase

data/test/machine_with_dirty_attributes_during_loopback_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDirtyAttributesDuringLoopbackTest < BaseTestCase

data/test/machine_with_dirty_attributes_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDirtyAttributesTest < BaseTestCase

data/test/machine_with_dynamic_initial_state_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithDynamicInitialStateTest < BaseTestCase

data/test/machine_with_event_attributes_on_autosave_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithEventAttributesOnAutosaveTest < BaseTestCase
@@ -42,7 +44,7 @@ class MachineWithEventAttributesOnAutosaveTest < BaseTestCase
       remove_const('Vehicle')
       remove_const('Owner')
     end
-    ActiveSupport::Dependencies.clear if defined?(ActiveSupport::Dependencies)
+    clear_active_support_dependencies
     super
   end
 end

data/test/machine_with_event_attributes_on_custom_action_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithEventAttributesOnCustomActionTest < BaseTestCase

data/test/machine_with_event_attributes_on_save_bang_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithEventAttributesOnSaveBangTest < BaseTestCase

data/test/machine_with_event_attributes_on_save_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 
 class MachineWithEventAttributesOnSaveTest < BaseTestCase