simply_fsm 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb54d24c49d69bc4cb382e6c4181a586fe9eef471dd1e44bcef0d95555fb33ae
-  data.tar.gz: 2f336e971e10827c1b731948376b4f2a177e012093c3f66457380df21c0f110c
+  metadata.gz: 0fbbc600cd621a9dc61fe1e27e7f1713ffa51e52719e13975e32aae5963ae5b2
+  data.tar.gz: ad107702004bbb2e877b71a55404c53294dc8cdad83dfecbdacbe5cb5bcf7ab1
 SHA512:
-  metadata.gz: 9afdd28a4281a6d6c4d40abe7d52e5ab674e9bf1e626a9bc2bf47ee678e047f0fd3c4e5ab3f6857a01fc6fd6647a5eab416a6cc1c03f7ebbbdda1a72b6b1d71b
-  data.tar.gz: 21c938cbced1efb61d61c0cc62c4887d1f8084c4b42c6bc2effd0cda358a9cbade73a958250fdb9d81a17a183ed2b092e7d6896ae043fc1dfcc2afa7c9914134
+  metadata.gz: c308a333334a16a02f1d885848c529ef4dc6066367c221cdb93c6ada4eb1fc909557e4376d340df13c34f81ddd03bca7e06f22cac0ca8f71a23c08e18818652a
+  data.tar.gz: b1775decefc14bc483fbe035d8d2b1f65957e07fc8bad9893b3a4c41b5deee0c01f54c67a63cdb32e5f111055bc65619476941981d333f21f520dd9ad8dc79f4

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 - None right now
 
+## [0.2.1] - 2022-03-05
+
+- Fixed bug where named fail handlers were not called properly for multi-transition events.
+
 ## [0.2.0] - 2022-03-01
 
 - *Breaks API* (sorry!)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simply_fsm (0.1.1)
+    simply_fsm (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/simply_fsm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimplyFSM
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/simply_fsm.rb

@@ -113,8 +113,19 @@ module SimplyFSM
       }
     end
 
+    def setup_fail_lambda_for(fail)
+      return unless fail
+
+      if fail.is_a?(String) || fail.is_a?(Symbol)
+        ->(event_name) { send(fail, event_name) }
+      else
+        ->(event_name) { instance_exec(event_name, &fail) }
+      end
+    end
+
     def setup_multi_transition_event_method(event_name, transitions:, guard:, var_name:, fail:)
       state_machine_name = @name
+      fail_lambda = setup_fail_lambda_for(fail)
       make_owner_method event_name, lambda {
         if !guard || instance_exec(&guard)
           current = send(state_machine_name)
@@ -126,7 +137,7 @@ module SimplyFSM
             return true
           end
         end
-        instance_exec(&fail) if fail
+        instance_exec(event_name, &fail_lambda) if fail_lambda
         false
       }
     end
@@ -136,20 +147,14 @@ module SimplyFSM
     end
 
     def setup_event_method(event_name, var_name:, may_event_name:, to:, fail:, &after)
+      fail_lambda = setup_fail_lambda_for(fail)
       method_lambda = lambda {
         if send(may_event_name)
           instance_variable_set(var_name, to)
           instance_exec(&after) if after
           return true
         end
-        # unable to satisfy pre-conditions for the event
-        if fail
-          if fail.is_a?(String) || fail.is_a?(Symbol)
-            send(fail, event_name)
-          else
-            instance_exec(event_name, &fail)
-          end
-        end
+        instance_exec(event_name, &fail_lambda) if fail_lambda
         false
       }
       make_owner_method event_name, method_lambda

data/spec/unit/multi_transition_fail_events_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class MultiTransitionFailHandlingStateMachine
+  class Error < StandardError; end
+  class RunError < StandardError; end
+
+  include SimplyFSM
+
+  state_machine :activity, fail: :on_any_fail do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :run,
+          fail: ->(_event) { raise RunError, "Cannot run" },
+          transitions: [{ from: :sleeping, to: :running }]
+
+    event :clean, transitions: [
+      { from: :running, to: :cleaning }
+    ]
+
+    event :sleep, transitions: [
+      { from: :running, to: :sleeping },
+      { when: -> { cleaning? }, to: :sleeping }
+    ]
+  end
+
+  def on_any_fail(event_name)
+    raise Error, "Cannot do: #{event_name}"
+  end
+end
+
+RSpec.describe MultiTransitionFailHandlingStateMachine do
+  describe "#sleep" do
+    it "error if already sleeping" do
+      expect { subject.sleep }.to raise_error(MultiTransitionFailHandlingStateMachine::Error)
+    end
+  end
+
+  describe "#run" do
+    it "custom error if already running" do
+      subject.run
+      expect { subject.run }.to raise_error(MultiTransitionFailHandlingStateMachine::RunError)
+    end
+
+    it "custom error if cleaning" do
+      subject.run
+      subject.clean
+      expect { subject.run }.to raise_error(MultiTransitionFailHandlingStateMachine::RunError)
+    end
+  end
+
+  describe "#clean" do
+    it "error if sleeping" do
+      expect { subject.clean }.to raise_error(MultiTransitionFailHandlingStateMachine::Error)
+    end
+
+    it "error if already cleaning" do
+      subject.run
+      subject.clean
+      expect { subject.clean }.to raise_error(MultiTransitionFailHandlingStateMachine::Error)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simply_fsm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - nogginly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -65,6 +65,7 @@ files:
 - spec/support/state_machine_examples.rb
 - spec/unit/fail_events_spec.rb
 - spec/unit/guard_events_spec.rb
+- spec/unit/multi_transition_fail_events_spec.rb
 - spec/unit/multi_transition_state_machine_spec.rb
 - spec/unit/one_state_machine_spec.rb
 - spec/unit/simply_fsm_spec.rb
@@ -100,6 +101,7 @@ test_files:
 - spec/support/state_machine_examples.rb
 - spec/unit/fail_events_spec.rb
 - spec/unit/guard_events_spec.rb
+- spec/unit/multi_transition_fail_events_spec.rb
 - spec/unit/multi_transition_state_machine_spec.rb
 - spec/unit/one_state_machine_spec.rb
 - spec/unit/simply_fsm_spec.rb