state_machines-activemodel 0.200.0 → 0.300.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d7c29b2ded4a4dd3f035c36ecc1166a5924f0e26a5ff19b79ea6f30dabd963
-  data.tar.gz: ea20010149781f3d4454a7da0990e49042a9ad15026601c7e51378f692c70dd5
+  metadata.gz: e9bcbb7b130697e27194b008c66a4726b5bd9023fd81b74b36eacbe863c7863d
+  data.tar.gz: a6417bddb1b03bc3e93c1ac5e060ac05f0f8a4439cd0feb5cdb7585b473f34a4
 SHA512:
-  metadata.gz: 6984e416bb81801cc845d626e79bd884e98c012ace964bf066b6ec416fd8e636c97cda7407bb9dfd1afcb66987bac2788cb204891f49f6688e1ba581641fe746
-  data.tar.gz: 8717de95a50444d3f23fac8d3471705f53a4255535e93bb8708f7d31e7abbf499c212fd1d09f4f132a75e370e6426c1fe8f781c75f09e66f7b6bf2f112542753
+  metadata.gz: 366e48ee43687f70332bad18f99e4366b261c03fdfda013455ff01f1b4f986289877782aef9379dc952695568273867e9e9a2c371a266da0fab3277112e6e77c
+  data.tar.gz: 165ffdfc7019e95ae43182c67967c78beadbf9512054c0da4205de99e67efd1d14bd0e33d78b64121998bbfc444c0edbbf108762945b54c23de3f8ec504bed8b

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Dependencies
 
-Active Model 7.1+
+Active Model 8.0+
 
 ## Usage
 
@@ -63,6 +63,32 @@ class Vehicle
 end
 ```
 
+### Why an event was refused
+
+An event method still returns `false` when it is refused, and `errors` is filled
+as before. The `<event>_refusal` reader from state_machines tells the reasons
+apart (`nil` after a success):
+
+```ruby
+vehicle.park                 # => false
+vehicle.park_refusal         # => :no_transition (errors: State cannot transition via "park")
+
+vehicle.ignite               # => false, a before_transition returned false
+vehicle.ignite_refusal       # => :halted
+
+# With `action: :save`, a save that returns false (e.g. failed validations)
+vehicle.shift_up             # => false
+vehicle.shift_up_refusal     # => :action_failed
+vehicle.errors.full_messages # => ["Seatbelt on can't be blank"]
+
+vehicle.shift_up!            # => StateMachines::InvalidTransition, #reason => :action_failed
+```
+
+The reasons are `:no_transition`, `:guard`, `:halted`, `:action_failed` (and
+`:contended` in async mode). They are also recorded for event attributes
+(`vehicle.state_event = 'park'; vehicle.save`). See the state_machines README
+for parallel events.
+
 ## Contributing
 
 1. Fork it ( https://github.com/state-machines/state_machines-activemodel/fork )

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

@@ -3,7 +3,7 @@
 module StateMachines
   module Integrations
     module ActiveModel
-      VERSION = '0.200.0'
+      VERSION = '0.300.0'
     end
   end
 end

data/test/machine_with_refusal_reasons_test.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class MachineWithRefusalReasonsTest < BaseTestCase
+  def setup
+    @model = new_model do
+      include ActiveModel::Validations
+
+      attribute :alarm_state, :string
+      attr_accessor :fuelled, :abort_ignite, :jam_alarm, :saved
+
+      validates :state, exclusion: { in: %w[blocked] }
+
+      # Defined on an ancestor so the machine hooks it for event attributes
+      include(Module.new do
+        def save
+          valid? && (self.saved = true)
+        end
+      end)
+    end
+
+    @machine = StateMachines::Machine.new(@model, action: :save, initial: :parked)
+    @machine.state :blocked
+    @machine.before_transition(on: :ignite) { |record| !record.abort_ignite }
+    @machine.event(:ignite) { transition parked: :idling, if: ->(record) { record.fuelled != false } }
+    @machine.event(:park) { transition idling: :parked }
+    @machine.event(:block) { transition parked: :blocked }
+
+    @alarm = StateMachines::Machine.new(@model, :alarm_state, action: :save, initial: :active, namespace: :alarm)
+    @alarm.around_transition(on: :disable) do |record, _transition, block|
+      block.call unless record.jam_alarm
+    end
+    @alarm.event(:disable) { transition active: :off }
+
+    @record = @model.new
+  end
+
+  def test_should_report_no_transition
+    assert_same false, @record.park
+    assert_equal :no_transition, @record.park_refusal
+  end
+
+  def test_should_keep_the_invalid_transition_error
+    @record.park
+
+    assert_equal ['State cannot transition via "park"'], @record.errors.full_messages
+  end
+
+  def test_should_report_guard
+    @record.fuelled = false
+
+    refute @record.ignite
+    assert_equal :guard, @record.ignite_refusal
+  end
+
+  def test_should_report_halted_by_a_before_transition_returning_false
+    @record.abort_ignite = true
+
+    refute @record.ignite
+    assert_equal :halted, @record.ignite_refusal
+    assert_equal 'parked', @record.state
+  end
+
+  def test_should_report_halted_by_an_around_transition_that_does_not_yield
+    @record.jam_alarm = true
+
+    refute @record.disable_alarm
+    assert_equal :halted, @record.disable_alarm_refusal
+  end
+
+  def test_should_report_action_failed_when_validation_fails
+    refute @record.block
+    assert_equal :action_failed, @record.block_refusal
+    assert_equal 'parked', @record.state
+    refute @record.saved
+  end
+
+  def test_should_keep_validation_errors_when_the_action_fails
+    @record.block
+
+    assert_equal ['State is reserved'], @record.errors.full_messages
+  end
+
+  def test_should_clear_the_refusal_after_success
+    @record.abort_ignite = true
+    @record.ignite
+    @record.abort_ignite = false
+
+    assert @record.ignite
+    assert_nil @record.ignite_refusal
+    assert @record.saved
+  end
+
+  def test_should_carry_the_reason_on_bang
+    error = assert_raises(StateMachines::InvalidTransition) { @record.block! }
+
+    assert_equal :action_failed, error.reason
+    assert_includes error.message, 'State is reserved'
+  end
+
+  def test_should_carry_halted_on_bang
+    @record.abort_ignite = true
+    error = assert_raises(StateMachines::InvalidTransition) { @record.ignite! }
+
+    assert_equal :halted, error.reason
+    assert_includes error.message, 'Transition halted'
+  end
+
+  def test_should_report_no_transition_for_an_event_attribute
+    @record.state_event = 'park'
+
+    refute @record.save
+    assert_equal :no_transition, @record.park_refusal
+  end
+
+  def test_should_report_action_failed_for_an_event_attribute
+    @record.state_event = 'block'
+
+    refute @record.save
+    assert_equal :action_failed, @record.block_refusal
+  end
+
+  def test_should_report_action_failed_for_every_event_in_parallel
+    @record.fuelled = true
+    @record.define_singleton_method(:save) { false }
+
+    refute @record.fire_events(:ignite, :disable_alarm)
+    assert_equal :action_failed, @record.ignite_refusal
+    assert_equal :action_failed, @record.disable_alarm_refusal
+  end
+
+  def test_should_report_only_the_halting_event_in_parallel
+    @record.jam_alarm = true
+
+    refute @record.fire_events(:ignite, :disable_alarm)
+    assert_nil @record.ignite_refusal
+    assert_equal :halted, @record.disable_alarm_refusal
+  end
+
+  def test_should_carry_parallel_reasons_on_bang
+    error = assert_raises(StateMachines::InvalidParallelTransition) { @record.fire_events!(:park, :disable_alarm) }
+
+    assert_equal({ park: :no_transition }, error.reasons)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activemodel
 version: !ruby/object:Gem::Version
-  version: 0.200.0
+  version: 0.300.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.200.0
+        version: 0.300.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.200.0
+        version: 0.300.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.27.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.27.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +144,7 @@ files:
 - test/machine_with_internationalization_test.rb
 - test/machine_with_model_state_attribute_test.rb
 - test/machine_with_non_model_state_attribute_undefined_test.rb
+- test/machine_with_refusal_reasons_test.rb
 - test/machine_with_state_driven_validations_test.rb
 - test/machine_with_states_test.rb
 - test/machine_with_static_initial_state_test.rb
@@ -162,14 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: ActiveModel integration for State Machines
 test_files:
@@ -195,6 +196,7 @@ test_files:
 - test/machine_with_internationalization_test.rb
 - test/machine_with_model_state_attribute_test.rb
 - test/machine_with_non_model_state_attribute_undefined_test.rb
+- test/machine_with_refusal_reasons_test.rb
 - test/machine_with_state_driven_validations_test.rb
 - test/machine_with_states_test.rb
 - test/machine_with_static_initial_state_test.rb