state_machines-activerecord 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570d0e44cce8dade9ceb135c6e24cfcafb7dc0325ee8f40d99658d663072e234
-  data.tar.gz: 2195bc14693c748c3248c3ddd42bc0a26faccbdf78285c6d24f17e54bd3ec0fd
+  metadata.gz: a5e8b447b65a1f99ad367425556a3e726b3f42be5056af03a2a48e741851ff72
+  data.tar.gz: 801a7943d18a71f506acefedb764cb8ed0a9caa1c459893df99f3b21419c78f7
 SHA512:
-  metadata.gz: dde59866fccfe87fbd05658fd0f0b5d92c2129ff3e448c75983722e7a5468cc3201f63dfb319442a60e536e4774ecfd61429d0e979e454abba568e10a1b7cc15
-  data.tar.gz: f78734f5c798ae8f468d69d22e1983b95839dcf724e6b7c1e6563f81a3f1976930b6ff52d275163feaccd0419888a9d754f47d587a112df019a9c9804f21bd31
+  metadata.gz: c6794e0f3d9e6835682f4a541bb8bde8210599749621c262ed164bae482c78f3ec40aa6cc4279db5ed62583bd5d2f30476f43f49f5adc149ac80eb9df20ee487
+  data.tar.gz: 0fc0b42cc6de4c17f4a844634647dd0e0245933c6a713cf51e68655b4354e03801b0a6b63e61c1e27298a1db56ae8559a605972e2a6ef3cc879f32f75691c3b6

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) 2006-2012 Aaron Pfeifer
-Copyright (c) 2014-2023 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
 

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.9.0'
+      VERSION = '0.10.0'
     end
   end
 end

data/lib/state_machines/integrations/active_record.rb

@@ -78,16 +78,14 @@ 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 < ApplicationRecord
-    #     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
     #
@@ -95,8 +93,7 @@ module StateMachines
     # you can build two state machines (one public and one protected) like so:
     #
     #   class Vehicle < ApplicationRecord
-    #     attr_protected :state_event # Prevent access to events in the first machine
-    #
+    #     # 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
@@ -199,27 +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 < 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:
@@ -266,7 +266,7 @@ module StateMachines
     # your callback to roll back.  You can work around this issue like so:
     #
     #   class TransitionLog < ApplicationRecord
-    #     establish_connection Rails.env.to_sym
+    #     connects_to database: { writing: :primary, reading: :primary }
     #   end
     #
     #   class Vehicle < ApplicationRecord
@@ -279,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.
     #
@@ -304,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:
@@ -375,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:
@@ -515,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

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

data/test/machine_with_event_attributes_on_validation_test.rb

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

data/test/machine_with_events_test.rb

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

data/test/machine_with_failed_action_test.rb

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

data/test/machine_with_failed_after_callbacks_test.rb

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

data/test/machine_with_failed_before_callbacks_test.rb

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

data/test/machine_with_initialized_state_test.rb

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

data/test/machine_with_internationalization_test.rb

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

data/test/machine_with_loopback_test.rb

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

data/test/machine_with_non_column_state_attribute_defined_test.rb

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

data/test/machine_with_same_column_default_test.rb

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

data/test/machine_with_same_integer_column_default_test.rb

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

data/test/machine_with_scopes_and_joins_test.rb

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

data/test/machine_with_scopes_and_owner_subclass_test.rb

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

data/test/machine_with_scopes_test.rb

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

data/test/machine_with_state_driven_validations_test.rb

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

data/test/machine_with_states_test.rb

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

data/test/machine_with_static_initial_state_test.rb

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

data/test/machine_with_transactions_test.rb

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

data/test/machine_with_validations_and_custom_attribute_test.rb

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

data/test/machine_with_validations_test.rb

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

data/test/machine_without_database_test.rb

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

data/test/machine_without_transactions_test.rb

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

data/test/model_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require_relative 'files/models/post'
 

data/test/test_helper.rb

@@ -1,7 +1,6 @@
-begin
-  require 'pry-byebug'
-rescue LoadError
-end
+# frozen_string_literal: true
+
+require 'debug' if RUBY_ENGINE == 'ruby'
 require 'minitest/reporters'
 Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
 require 'state_machines-activerecord'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 - Aaron Pfeifer
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines-activemodel
@@ -17,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +178,6 @@ homepage: https://github.com/state-machines/state_machines-activerecord/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -187,15 +185,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: State machines Active Record Integration
 test_files: