simply_fsm 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86bd7cca4df06c4ada7a53528e2e0f5853fc9055bf0bb808c4cd029b552ad37
-  data.tar.gz: 6ad8c2cfe781b729316f0df6707be5c10c17e0ed4e865a7042c22504e2039e0c
+  metadata.gz: eb54d24c49d69bc4cb382e6c4181a586fe9eef471dd1e44bcef0d95555fb33ae
+  data.tar.gz: 2f336e971e10827c1b731948376b4f2a177e012093c3f66457380df21c0f110c
 SHA512:
-  metadata.gz: c3dea4db713c9cc75ef314ba8c536d7a0847fa396f12af0e69b951eb78a2bb20c3ed6f620aa1c11cb26f23087c93891ccf6d5cc78fd17abc4e2f0ab130819748
-  data.tar.gz: 659bf78f96bf5bd41cc9cf03c50387d165c04148de5cfc6ea89955f18707f72ab2cfec271d36e2424622a528783b6a13dd88222ee695ce65497d0e930f8df603
+  metadata.gz: 9afdd28a4281a6d6c4d40abe7d52e5ab674e9bf1e626a9bc2bf47ee678e047f0fd3c4e5ab3f6857a01fc6fd6647a5eab416a6cc1c03f7ebbbdda1a72b6b1d71b
+  data.tar.gz: 21c938cbced1efb61d61c0cc62c4887d1f8084c4b42c6bc2effd0cda358a9cbade73a958250fdb9d81a17a183ed2b092e7d6896ae043fc1dfcc2afa7c9914134

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 - None right now
 
+## [0.2.0] - 2022-03-01
+
+- *Breaks API* (sorry!)
+  - When declaring events in a state machine, use `transitions:` (as in "transitions from X to Y") instead of `transition:`
+- Added support for multiple transitions per event
+
 ## [0.1.2] - 2022-02-28
 
 - Cleaned up source with smaller clearer methods

data/README.md

@@ -13,6 +13,7 @@ If you need storage/persistence/Rails/etc support, I recommend [AASM](https://gi
   - [Multiple state machines](#multiple-state-machines)
   - [Handle failed events](#handle-failed-events)
   - [Guarding events](#guarding-events)
+  - [Multiple transitions for an event](#multiple-transitions-for-an-event)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -49,15 +50,15 @@ class Job
     state :running
     state :cleaning
 
-    event :run, transition: { from: :sleeping, to: :running } do
+    event :run, transitions: { from: :sleeping, to: :running } do
       # executed when transition succeeds
     end
 
-    event :clean, transition: { from: :running, to: :cleaning } do
+    event :clean, transitions: { from: :running, to: :cleaning } do
       # do the cleaning since transition succeeded
     end
 
-    event :sleep, transition: { from: [:running, :cleaning], to: :sleeping }
+    event :sleep, transitions: { from: [:running, :cleaning], to: :sleeping }
   end
 end
 ```
@@ -88,16 +89,16 @@ class Player
     state :idling, initial: true
     state :walking
 
-    event :idle, transition: { from: :any, to: :idling }
-    event :walk, transition: { from: :idling, to: :walking }
+    event :idle, transitions: { from: :any, to: :idling }
+    event :walk, transitions: { from: :idling, to: :walking }
   end
 
   state_machine :action do
     state :ready, initial: true
     state :blocking
 
-    event :hold, transition: { from: :any, to: :ready }
-    event :block, transition: { from: :any, to: :blocking }
+    event :hold, transitions: { from: :any, to: :ready }
+    event :block, transitions: { from: :any, to: :blocking }
   end
 end
 ```
@@ -126,11 +127,11 @@ class JobWithErrors
     state :running
     state :cleaning
 
-    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
-    event :clean, transition: { from: :running, to: :cleaning }
+    event :sleep, transitions: { from: %i[running cleaning], to: :sleeping }
+    event :clean, transitions: { from: :running, to: :cleaning }
     event :run,
           fail: ->(_event) { raise RunError, "Cannot run" },
-          transition: { from: :sleeping, to: :running }
+          transitions: { from: :sleeping, to: :running }
   end
 
   def on_any_fail(event_name)
@@ -154,9 +155,9 @@ class AgilePlayer
     state :walking
     state :running
 
-    event :idle, transition: { from: :any, to: :idling }
-    event :walk, transition: { from: :any, to: :walking }
-    event :run, transition: { from: :any, to: :running }
+    event :idle, transitions: { from: :any, to: :idling }
+    event :walk, transitions: { from: :any, to: :walking }
+    event :run, transitions: { from: :any, to: :running }
   end
 
   state_machine :action do
@@ -164,14 +165,45 @@ class AgilePlayer
     state :jumping
     state :leaping
 
-    event :hold, transition: { from: :any, to: :ready }
+    event :hold, transitions: { from: :any, to: :ready }
     event :jump,
           guard: -> { !running? },
-          transition: { from: :ready, to: :jumping }
+          transitions: { from: :ready, to: :jumping }
     event :leap,
           guard: -> { running? },
           fail: ->(_event) { raise LeapError, "Cannot leap" },
-          transition: { from: :ready, to: :leaping }
+          transitions: { from: :ready, to: :leaping }
+  end
+end
+```
+### Multiple transitions for an event
+
+Sometimes a single event can transition to different end states based on different input states. In those situations you can specify an array of transitions. Consider the following example where the `hunt` event transitions to `walking` or `running` depending on some condition outside the state machine.
+
+```ruby
+class Critter
+  include SimplyFSM
+
+  def tired?
+    @ate_at <= 12.hours.ago || @slept_at <= 24.hours.ago
+  end
+
+  state_machine :activity do
+    state :sleeping, initial: true
+    state :running
+    state :walking
+    state :eating
+
+    event :eat, transitions: { to: :eating } do
+      @ate_at = DateTime.new
+    end
+    event :sleep, transitions: { from: :eating, to: :sleeping } do
+      @slept_at = DateTime.new
+    end
+    event :hunt, transitions: [
+      { when: -> { tired? }, to: :walking },
+      { to: :running }
+    ]
   end
 end
 ```

data/lib/simply_fsm/version.rb

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

data/lib/simply_fsm.rb

@@ -9,6 +9,17 @@ module SimplyFSM
     base.extend(ClassMethods)
   end
 
+  def state_match?(from, current)
+    return true if from == :any
+    return from.include?(current) if from.is_a?(Array)
+
+    from == current
+  end
+
+  def cannot_transition?(from, cond, current)
+    (from && !state_match?(from, current)) || (cond && !instance_exec(&cond))
+  end
+
   ##
   # Defines the constructor for defining a state machine
   module ClassMethods
@@ -55,19 +66,29 @@ module SimplyFSM
     end
 
     ##
-    # Define an event by +event_name+ and
-    # - its +transition+ as a hash with a +from+ state or array of states and the +to+ state,
+    # Define an event by +event_name+
+    #
+    # - which +transitions+ as a hash with a +from+ state or array of states and the +to+ state,
     # - an optional +guard+ lambda which must return true for the transition to occur,
     # - an optional +fail+ lambda that is called when the transition fails (overrides top-level fail handler), and
     # - an optional do block that is called +after+ the transition succeeds
-    def event(event_name, transition:, guard: nil, fail: nil, &after)
-      return unless event_exists?(event_name) && transition
+    def event(event_name, transitions:, guard: nil, fail: nil, &after)
+      return unless event_exists?(event_name) && transitions
 
       @events << event_name
-      to = transition[:to]
       may_event_name = "may_#{event_name}?"
 
-      setup_may_event_method may_event_name, transition[:from], to, guard
+      if transitions.is_a?(Array)
+        setup_multi_transition_may_event_method transitions: transitions, guard: guard,
+                                                may_event_name: may_event_name
+        setup_multi_transition_event_method event_name,
+                                            transitions: transitions, guard: guard,
+                                            var_name: "@#{@name}", fail: fail || @fail_handler
+        return
+      end
+
+      to = transitions[:to]
+      setup_may_event_method may_event_name, transitions[:from] || :any, transitions[:when], guard
       setup_event_method event_name, var_name: "@#{@name}",
                                      may_event_name: may_event_name, to: to,
                                      fail: fail || @fail_handler, &after
@@ -75,6 +96,41 @@ module SimplyFSM
 
     private
 
+    def setup_multi_transition_may_event_method(transitions:, guard:, may_event_name:)
+      state_machine_name = @name
+
+      make_owner_method may_event_name, lambda {
+        if !guard || instance_exec(&guard)
+          current = send(state_machine_name)
+          # Check each transition, and first one that succeeds ends the scan
+          transitions.each do |t|
+            next if cannot_transition?(t[:from], t[:when], current)
+
+            return true
+          end
+        end
+        false
+      }
+    end
+
+    def setup_multi_transition_event_method(event_name, transitions:, guard:, var_name:, fail:)
+      state_machine_name = @name
+      make_owner_method event_name, lambda {
+        if !guard || instance_exec(&guard)
+          current = send(state_machine_name)
+          # Check each transition, and first one that succeeds ends the scan
+          transitions.each do |t|
+            next if cannot_transition?(t[:from], t[:when], current)
+
+            instance_variable_set(var_name, t[:to])
+            return true
+          end
+        end
+        instance_exec(&fail) if fail
+        false
+      }
+    end
+
     def event_exists?(event_name)
       event_name && !@events.include?(event_name)
     end
@@ -99,23 +155,43 @@ module SimplyFSM
       make_owner_method event_name, method_lambda
     end
 
-    def setup_may_event_method(may_event_name, from, _to, guard)
+    def setup_may_event_method(may_event_name, from, cond, guard)
       state_machine_name = @name
       #
       # Instead of one "may_event?" method that checks all variations every time it's called, here we check
       # the event definition and define the most optimal lambda to ensure the check is as fast as possible
-      method_lambda = if from == :any && !guard
-                        -> { true } # unguarded transition from any state
-                      elsif from == :any
-                        guard # guarded transition from any state
-                      elsif !guard
-                        guardless_may_event_lambda(from, state_machine_name)
+      method_lambda = if from == :any
+                        from_any_may_event_lambda(guard, cond, state_machine_name)
                       else
-                        guarded_may_event_lambda(from, guard, state_machine_name)
+                        guarded_or_conditional_may_event_lambda(from, guard, cond, state_machine_name)
                       end
       make_owner_method may_event_name, method_lambda
     end
 
+    def from_any_may_event_lambda(guard, cond, _state_machine_name)
+      if !guard && !cond
+        -> { true } # unguarded transition from any state
+      elsif !cond
+        guard # guarded transition from any state
+      elsif !guard
+        cond # conditional unguarded transition from any state
+      else
+        -> { instance_exec(&guard) && instance_exec(&cond) }
+      end
+    end
+
+    def guarded_or_conditional_may_event_lambda(from, guard, cond, state_machine_name)
+      if !guard && !cond
+        guardless_may_event_lambda(from, state_machine_name)
+      elsif !cond
+        guarded_may_event_lambda(from, guard, state_machine_name)
+      elsif !guard
+        guarded_may_event_lambda(from, cond, state_machine_name)
+      else
+        guarded_and_conditional_may_event_lambda(from, guard, cond, state_machine_name)
+      end
+    end
+
     def guarded_may_event_lambda(from, guard, state_machine_name)
       if from.is_a?(Array)
         lambda { # guarded transition from choice of states
@@ -130,6 +206,20 @@ module SimplyFSM
       end
     end
 
+    def guarded_and_conditional_may_event_lambda(from, guard, cond, state_machine_name)
+      if from.is_a?(Array)
+        lambda { # guarded transition from choice of states
+          current = send(state_machine_name)
+          from.include?(current) && instance_exec(&guard) && instance_exec(&cond)
+        }
+      else
+        lambda { # guarded transition from one state
+          current = send(state_machine_name)
+          from == current && instance_exec(&guard) && instance_exec(&cond)
+        }
+      end
+    end
+
     def guardless_may_event_lambda(from, state_machine_name)
       if from.is_a?(Array)
         lambda {    # unguarded transition from choice of states

data/spec/unit/fail_events_spec.rb

@@ -11,11 +11,11 @@ class FailHandlingStateMachine
     state :running
     state :cleaning
 
-    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
-    event :clean, transition: { from: :running, to: :cleaning }
+    event :sleep, transitions: { from: %i[running cleaning], to: :sleeping }
+    event :clean, transitions: { from: :running, to: :cleaning }
     event :run,
           fail: ->(_event) { raise RunError, "Cannot run" },
-          transition: { from: :sleeping, to: :running }
+          transitions: { from: :sleeping, to: :running }
   end
 
   def on_any_fail(event_name)

data/spec/unit/guard_events_spec.rb

@@ -10,9 +10,9 @@ class GuardingEvents
     state :walking
     state :running
 
-    event :idle, transition: { from: :any, to: :idling }
-    event :walk, transition: { from: :any, to: :walking }
-    event :run, transition: { from: :any, to: :running }
+    event :idle, transitions: { to: :idling }
+    event :walk, transitions: { from: :any, to: :walking }
+    event :run, transitions: { from: :any, to: :running }
   end
 
   state_machine :action do
@@ -20,14 +20,14 @@ class GuardingEvents
     state :jumping
     state :leaping
 
-    event :hold, transition: { from: :any, to: :ready }
+    event :hold, transitions: { to: :ready }
     event :jump,
           guard: -> { !running? },
-          transition: { from: :ready, to: :jumping }
+          transitions: { from: :ready, to: :jumping }
     event :leap,
           guard: -> { running? },
           fail: ->(_event) { raise LeapError, "Cannot leap" },
-          transition: { from: :ready, to: :leaping }
+          transitions: { when: -> { ready? }, to: :leaping }
   end
 end
 

data/spec/unit/multi_transition_state_machine_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+class MultiTransitionStateMachine
+  include SimplyFSM
+
+  state_machine :activity do
+    state :sleeping, initial: true
+    state :running
+    state :cleaning
+
+    event :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
+end
+
+RSpec.describe MultiTransitionStateMachine do
+  include_examples "state machine basics", :activity,
+                   initial_state: :sleeping,
+                   states: %i[sleeping running cleaning],
+                   events: %i[run clean sleep]
+
+  describe "#sleep" do
+    it "fails if already sleeping" do
+      expect(subject.may_sleep?).to be false
+      expect(subject.sleep).to be false
+    end
+    it "succeeds if running" do
+      subject.run
+      expect(subject.may_sleep?).to be true
+      expect(subject.sleep).to be true
+    end
+    it "succeeds if cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_sleep?).to be true
+      expect(subject.sleep).to be true
+    end
+  end
+
+  describe "#run" do
+    it "succeeds if sleeping" do
+      expect(subject.may_run?).to be true
+      expect(subject.run).to be true
+    end
+
+    it "fails if already running" do
+      subject.run
+      expect(subject.may_run?).to be false
+      expect(subject.run).to be false
+    end
+
+    it "fails if cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_run?).to be false
+      expect(subject.run).to be false
+    end
+  end
+
+  describe "#clean" do
+    it "succeeds if running" do
+      subject.run
+      expect(subject.may_clean?).to be true
+      expect(subject.clean).to be true
+    end
+
+    it "fails if sleeping" do
+      expect(subject.may_clean?).to be false
+      expect(subject.clean).to be false
+    end
+
+    it "fails if already cleaning" do
+      subject.run
+      subject.clean
+      expect(subject.may_clean?).to be false
+      expect(subject.clean).to be false
+    end
+  end
+end

data/spec/unit/one_state_machine_spec.rb

@@ -8,9 +8,9 @@ class OneStateMachine
     state :running
     state :cleaning
 
-    event :run, transition: { from: :sleeping, to: :running }
-    event :clean, transition: { from: :running, to: :cleaning }
-    event :sleep, transition: { from: %i[running cleaning], to: :sleeping }
+    event :run, transitions: { from: :sleeping, to: :running }
+    event :clean, transitions: { from: :running, to: :cleaning }
+    event :sleep, transitions: { from: %i[running cleaning], to: :sleeping }
   end
 end
 

data/spec/unit/two_state_machines_spec.rb

@@ -7,16 +7,16 @@ class TwoStateMachines
     state :idling, initial: true
     state :walking
 
-    event :idle, transition: { from: :any, to: :idling }
-    event :walk, transition: { from: :idling, to: :walking }
+    event :idle, transitions: { from: :any, to: :idling }
+    event :walk, transitions: { from: :idling, to: :walking }
   end
 
   state_machine :action do
     state :ready, initial: true
     state :blocking
 
-    event :hold, transition: { from: :any, to: :ready }
-    event :block, transition: { from: :any, to: :blocking }
+    event :hold, transitions: { from: :any, to: :ready }
+    event :block, transitions: { from: :any, to: :blocking }
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simply_fsm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - nogginly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-01 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_state_machine_spec.rb
 - spec/unit/one_state_machine_spec.rb
 - spec/unit/simply_fsm_spec.rb
 - spec/unit/two_state_machines_spec.rb
@@ -99,6 +100,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_state_machine_spec.rb
 - spec/unit/one_state_machine_spec.rb
 - spec/unit/simply_fsm_spec.rb
 - spec/unit/two_state_machines_spec.rb