state_machines-activemodel 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8bb31a6d52d73caf948365731b8670f86a57814d839c4606cd12c88b178f48f
-  data.tar.gz: c3f2f12fc7077f4fb230b08908314684fbbe7c59153cd12cc35dbacd767dd386
+  metadata.gz: 8a37766e74933c9b284c1bea7acc586937d437222fb51371a12118cb9c28873c
+  data.tar.gz: 05d7748697762082b5cd5c6a388cfbcdb62d7f54bdaf656587c7cdc9158b78f6
 SHA512:
-  metadata.gz: 8dd82a7786ea47d62fb36e04fd85be1451d1d37666702545bf9db2c0b13601d61ca65c1ab0b28844f64e7cdab82e62a1ea8221706b5d8342b003caa1fb8d9f08
-  data.tar.gz: 944d5c9ce3320e1f46e638c120ee2fcf4bd97f4c98ab3fad8e1598bc2fe2cd0a80ed2db61dc86535b551366c38108c4a007729eaeef4703e5a9e51c874921a2a
+  metadata.gz: 49059888466d7e77da042aa4d3b296d029d3bbaf600ef70cf514322a04c14211460527444d08fd591a8b3e38a3039b1119c3c719d06bdc6363ab03dadf83b7c0
+  data.tar.gz: 787f045227838e8ce24c6b5448d991631ef1a35c90f078582f8f2fff66470760d90d0c05f2bc56c174dcb93f4c4662b137100d06ff27e44aefca98a4d4b7f11e

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Dependencies
 
-Active Model 5.1+
+Active Model 7.1+
 
 ## Usage
 
@@ -36,19 +36,19 @@ class Vehicle
   attr_accessor :state
   define_attribute_methods [:state]
 
-  state_machine :initial => :parked do
-    before_transition :parked => any - :parked, :do => :put_on_seatbelt
-    after_transition any => :parked do |vehicle, transition|
+  state_machine initial: :parked do
+    before_transition parked: any - :parked, do: :put_on_seatbelt
+    after_transition any: :parked do |vehicle, transition|
       vehicle.seatbelt = 'off'
     end
     around_transition :benchmark
 
-    event :ignite do
-      transition :parked => :idling
+    event ignite: do
+      transition parked: :idling
     end
 
     state :first_gear, :second_gear do
-      validates_presence_of :seatbelt_on
+      validates :seatbelt_on, presence: true
     end
   end
 
@@ -62,24 +62,6 @@ class Vehicle
     ...
   end
 end
-
-class VehicleObserver < ActiveModel::Observer
-  # Callback for :ignite event *before* the transition is performed
-  def before_ignite(vehicle, transition)
-    # log message
-  end
-
-  # Generic transition callback *after* the transition is performed
-  def after_transition(vehicle, transition)
-    Audit.log(vehicle, transition)
-  end
-
-  # Generic callback after the transition fails to perform
-  def after_failure_to_transition(vehicle, transition)
-    Audit.error(vehicle, transition)
-  end
-end
-
 ```
 
 ## Contributing

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

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

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

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

data/lib/state_machines/integrations/active_model.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/module/attribute_accessors.rb'
+require 'active_support/core_ext/module/attribute_accessors'
 require 'state_machines'
 require 'state_machines/integrations/base'
 require 'state_machines/integrations/active_model/version'
@@ -25,9 +27,9 @@ module StateMachines
     #     attr_accessor :state
     #     define_attribute_methods [:state]
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       event :ignite do
-    #         transition :parked => :idling
+    #         transition parked: :idling
     #       end
     #     end
     #   end
@@ -45,7 +47,7 @@ module StateMachines
     #     include ActiveModel::Validations
     #     attr_accessor :state
     #
-    #     state_machine :action => :save do
+    #     state_machine action: :save do
     #       ...
     #     end
     #
@@ -83,7 +85,7 @@ module StateMachines
     #     state_machine do
     #       ...
     #       state :first_gear, :second_gear do
-    #         validate {|vehicle| vehicle.speed_is_legal}
+    #         validate { |vehicle| vehicle.speed_is_legal }
     #       end
     #     end
     #   end
@@ -115,38 +117,44 @@ module StateMachines
     # 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:
+    # should be protected using Strong Parameters in your controllers:
     #
     #   class Vehicle
-    #     include ActiveModel::MassAssignmentSecurity
     #     attr_accessor :state
     #
-    #     attr_protected :state_event
-    #     # attr_accessible ... # Alternative technique
-    #
     #     state_machine do
     #       ...
     #     end
     #   end
     #
+    #   # In your controller
+    #   def vehicle_params
+    #     params.require(:vehicle).permit(:attribute1, :attribute2) # Exclude :state_event
+    #   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:
+    # you can build two state machines (one private and one public) like so:
     #
     #   class Vehicle
     #     attr_accessor :state
     #
-    #     attr_protected :state_event # Prevent access to events in the first machine
-    #
     #     state_machine do
     #       # Define private events here
     #     end
     #
     #     # Public machine targets the same state as the private machine
-    #     state_machine :public_state, :attribute => :state do
+    #     state_machine :public_state, attribute: :state do
     #       # Define public events here
     #     end
     #   end
     #
+    #   # In your controller
+    #   def vehicle_params
+    #     # Only permit events from the public state machine
+    #     params.require(:vehicle).permit(:attribute1, :attribute2, :public_state_event)
+    #     # The private state_event is not permitted
+    #   end
+    #
     # == Callbacks
     #
     # All before/after transition callbacks defined for ActiveModel models
@@ -159,7 +167,7 @@ module StateMachines
     #     include ActiveModel::Validations
     #     attr_accessor :state
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       before_transition any => :idling do |vehicle|
     #         vehicle.put_on_seatbelt
     #       end
@@ -169,7 +177,7 @@ module StateMachines
     #       end
     #
     #       event :ignite do
-    #         transition :parked => :idling
+    #         transition parked: :idling
     #       end
     #     end
     #
@@ -181,64 +189,6 @@ module StateMachines
     # Note, also, that the transition can be accessed by simply defining
     # additional arguments in the callback block.
     #
-    # == Observers
-    #
-    # In order to hook in observer support for your application, the
-    # ActiveModel::Observing feature must be included.  This can be added by including the
-    # https://github.com/state-machines/state_machines-activemodel-observers gem in your 
-    # Gemfile. Because of the way
-    # ActiveModel 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 object'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 < ActiveModel::Observer
-    #     # 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
-    #
-    #     def after_failure_to_transition(vehicle, transition)
-    #       Audit.error(vehicle, transition)
-    #     end
-    #   end
-    #
-    # More flexible transition callbacks can be defined directly within the
-    # model as described in StateMachine::Machine#before_transition
-    # and StateMachine::Machine#after_transition.
-    #
-    # To define a single observer for multiple state machines:
-    #
-    #   class StateMachineObserver < ActiveModel::Observer
-    #     observe Vehicle, Switch, Project
-    #
-    #     def after_transition(object, transition)
-    #       Audit.log(object, transition)
-    #     end
-    #   end
-    #
     # == Internationalization
     #
     # Any error message that is generated from performing invalid transitions
@@ -308,9 +258,9 @@ module StateMachines
     #     include ActiveModel::Dirty
     #     attr_accessor :state
     #
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       event :park do
-    #         transition :parked => :parked, ...
+    #         transition parked: :parked, ...
     #       end
     #     end
     #   end
@@ -322,7 +272,7 @@ module StateMachines
     #
     #   class Vehicle
     #     ...
-    #     state_machine :initial => :parked do
+    #     state_machine initial: :parked do
     #       before_transition all => same do |vehicle|
     #         vehicle.state_will_change!
     #
@@ -344,7 +294,7 @@ module StateMachines
     #   module StateMachine::Integrations::MyORM
     #     include ActiveModel
     #
-    #     mattr_accessor(:defaults) { :action => :persist }
+    #     mattr_accessor(:defaults) { { action: :persist } }
     #
     #     def self.matches?(klass)
     #       defined?(::MyORM::Base) && klass <= ::MyORM::Base
@@ -376,10 +326,7 @@ module StateMachines
       def invalidate(object, attribute, message, values = [])
         if supports_validations?
           attribute = self.attribute(attribute)
-          options = values.reduce({}) do |h, (key, value)|
-            h[key] = value
-            h
-          end
+          options = values.to_h { |key, value| [key, value] }
 
           default_options = default_error_message_options(object, attribute, message)
           object.errors.add(attribute, message, **options, **default_options)
@@ -389,7 +336,7 @@ module StateMachines
       # Describes the current validation errors on the given object.  If none
       # are specific, then the default error is interpeted as a "halt".
       def errors_for(object)
-        object.errors.empty? ? 'Transition halted' : object.errors.full_messages * ', '
+        object.errors.empty? ? 'Transition halted' : object.errors.full_messages.join(', ')
       end
 
       # Resets any errors previously added when invalidating the given object

data/lib/state_machines-activemodel.rb

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

data/test/integration_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class IntegrationTest < BaseTestCase
   def test_should_be_registered

data/test/machine_by_default_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineByDefaultTest < BaseTestCase
   def setup

data/test/machine_errors_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineErrorsTest < BaseTestCase
   def setup

data/test/machine_multiple_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineMultipleTest < BaseTestCase
   def setup

data/test/machine_with_callbacks_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithCallbacksTest < BaseTestCase
   def setup

data/test/machine_with_dirty_attribute_and_custom_attributes_during_loopback_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDirtyAttributeAndCustomAttributesDuringLoopbackTest < BaseTestCase
   def setup

data/test/machine_with_dirty_attribute_and_state_events_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDirtyAttributeAndStateEventsTest < BaseTestCase
   def setup

data/test/machine_with_dirty_attributes_and_custom_attribute_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDirtyAttributesAndCustomAttributeTest < BaseTestCase
   def setup

data/test/machine_with_dirty_attributes_during_loopback_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDirtyAttributesDuringLoopbackTest < BaseTestCase
   def setup

data/test/machine_with_dirty_attributes_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDirtyAttributesTest < BaseTestCase
   def setup

data/test/machine_with_dynamic_initial_state_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithDynamicInitialStateTest < BaseTestCase
   def setup

data/test/machine_with_events_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithEventsTest < BaseTestCase
   def setup

data/test/machine_with_failed_after_callbacks_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithFailedAfterCallbacksTest < BaseTestCase
   def setup

data/test/machine_with_failed_before_callbacks_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithFailedBeforeCallbacksTest < BaseTestCase
   def setup

data/test/machine_with_initialized_aliased_attribute_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithInitializedAliasedAttributeTest < BaseTestCase
   def test_should_match_original_attribute_value_with_attribute_methods

data/test/machine_with_initialized_state_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithInitializedStateTest < BaseTestCase
   def setup

data/test/machine_with_internationalization_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 require 'i18n'
 
 class MachineWithInternationalizationTest < BaseTestCase

data/test/machine_with_model_state_attribute_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithModelStateAttributeTest < BaseTestCase
   def setup

data/test/machine_with_non_model_state_attribute_undefined_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithNonModelStateAttributeUndefinedTest < BaseTestCase
   def setup

data/test/machine_with_state_driven_validations_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithStateDrivenValidationsTest < BaseTestCase
   def setup
@@ -9,7 +11,7 @@ class MachineWithStateDrivenValidationsTest < BaseTestCase
 
     @machine = StateMachines::Machine.new(@model)
     @machine.state :first_gear, :second_gear do
-      validates_presence_of :seatbelt
+      validates :seatbelt, presence: true
     end
     @machine.other_states :parked
   end

data/test/machine_with_states_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithStatesTest < BaseTestCase
   def setup

data/test/machine_with_static_initial_state_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithStaticInitialStateTest < BaseTestCase
   def setup

data/test/machine_with_validations_and_custom_attribute_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithValidationsAndCustomAttributeTest < BaseTestCase
   def setup

data/test/machine_with_validations_test.rb

@@ -1,4 +1,6 @@
-require_relative 'test_helper'
+# frozen_string_literal: true
+
+require 'test_helper'
 
 class MachineWithValidationsTest < BaseTestCase
   def setup

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'debug'
+
+require 'state_machines-activemodel'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'active_support/all'
+Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new]
+I18n.enforce_available_locales = true
+
+class BaseTestCase < ActiveSupport::TestCase
+  protected
+  # Creates a new ActiveModel model (and the associated table)
+  def new_model(&block)
+    # Simple ActiveModel superclass
+    parent = Class.new do
+      def self.model_attribute(name)
+        define_method(name) { instance_variable_defined?(:"@#{name}") ? instance_variable_get(:"@#{name}") : nil }
+        define_method("#{name}=") do |value|
+          send(:"#{name}_will_change!") if self.class <= ActiveModel::Dirty && value != send(name)
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      def self.create
+        object = new
+        object.save
+        object
+      end
+
+      def initialize(attrs = {})
+        attrs.each { |attr, value| send("#{attr}=", value) }
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def save
+        true
+      end
+    end
+
+    model = Class.new(parent) do
+      def self.name
+        'Foo'
+      end
+
+      model_attribute :state
+    end
+    model.class_eval(&block) if block_given?
+    model
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activemodel
 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
@@ -17,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -147,11 +146,11 @@ files:
 - test/machine_with_static_initial_state_test.rb
 - test/machine_with_validations_and_custom_attribute_test.rb
 - test/machine_with_validations_test.rb
+- test/test_helper.rb
 homepage: https://github.com/state-machines/state_machines-activemodel
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +158,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 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: ActiveModel integration for State Machines
 test_files:
@@ -195,3 +193,4 @@ test_files:
 - test/machine_with_static_initial_state_test.rb
 - test/machine_with_validations_and_custom_attribute_test.rb
 - test/machine_with_validations_test.rb
+- test/test_helper.rb