hifsm 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c840d5a3b6429146d55b87579db8d29ca6c6c6
-  data.tar.gz: 2130df37d77e426940c430a7b9a29abc4619838e
+  metadata.gz: b1387604547449d9ca598e37da2f65819b7a04af
+  data.tar.gz: e3701a877c217a7a6bafe2c20805a5a30c1f0ef0
 SHA512:
-  metadata.gz: a182af19cfb5cc12291e395c4041934d9ae5c25997d865ab573807bbf18b27efcc7c131038b0f3bd18f8fae5d5d4440ce4d08bece8ea0b8efd8dd3c3bdb668bb
-  data.tar.gz: b9e9e923ea20dfbf4cb335a65c297b877397559cfc2bc2b12be2a7ea1d34b9837fec772e8c857431a863fd7a1dac48d35601d232741bb6f39f3b8e081e9597d6
+  metadata.gz: c9edb501d065c107cefda523991a00b5bd093859f5e46f6403fa1ffab03e2fed90fa5f52bd21e8450aa308d7c62f948ef39c7a7b3caa2c23964220c19e8aa808
+  data.tar.gz: 8851be66fe4d6f2523ef1f949510667c5ab4dd9fc9a330b72f28fdcdbc35d400e753ec073464e7b4911abc92c72922e39efc2531b6d904223d05b7070f4ff063

data/README.md

@@ -227,6 +227,16 @@ Order.processing_delivering.first.cancel!.save  # save is never called inisde hi
 
 ```
 
+## Get possible transitions from current state
+
+The machine instance has `valid_events` method, with accepts arguments, that are passed to all event guards to find out if it is possible to fire the event.
+
+```ruby
+monster.state_machine.valid_events # -> ['reached', 'sight', 'acquire', ...]
+```
+
+The order of events is not guaranteed, events for parent states are included.
+
 ## Testing
 
 Only 'public' API is unit-tested, internal implementation may be freely changed, so don't rely on it.

data/lib/hifsm/machine.rb

@@ -13,6 +13,8 @@ module Hifsm
       @state = initial_state.enter!
     end
 
+    # Public API
+
     def act!(*args)
       @state.act!(@target, *args)
     end
@@ -21,10 +23,19 @@ module Hifsm
       @state
     end
 
+    def valid_events(*args)
+      @state.valid_events(@target, *args)
+    end
+
     def states
       @fsm.states
     end
 
+    def to_s
+      @state.to_s
+    end
+
+    # internals
     def all_states
       @fsm.all_states.reject(&:sub_fsm).collect(&:to_s)
     end
@@ -34,9 +45,5 @@ module Hifsm
         @state = new_state
       end
     end
-
-    def to_s
-      @state.to_s
-    end
   end
 end

data/lib/hifsm/state.rb

@@ -50,6 +50,17 @@ module Hifsm
       @sub_fsm.get_state!(name)
     end
 
+    def valid_events(target, *args)
+      own_events = events.find_all do |event_name|
+        @transitions[event_name].any? {|event| event.guard?(target, *args)}
+      end
+      if @parent
+        (own_events + @parent.valid_events(target, *args)).uniq
+      else
+        own_events.uniq
+      end
+    end
+
     def fire(target, event_name, *args, &new_state_callback)
       event_name = event_name.to_s
       @transitions[event_name].each do |ev|

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/test/test_before_returning_false.rb

@@ -37,4 +37,13 @@ class TestBeforeReturningFalse < Minitest::Test
     # assert nothing raised
   end
 
+  def test_valid_events_include_parent_state_events
+    assert_equal ['lock', 'open'], @door.state_machine.valid_events.sort
+  end
+
+  def test_valid_events_include_parent_state_events
+    @door.lock
+    assert_equal ['open'], @door.state_machine.valid_events.sort
+  end
+
 end

data/test/test_event_guard.rb

@@ -53,4 +53,19 @@ class TestEventGuard < Minitest::Test
     assert_equal '3', wall.last_hit_strength
   end
 
+  def test_valid_events_for_thick_wall_and_low_power
+    wall = Wall.new(10)
+    assert_equal [], wall.state_machine.valid_events
+  end
+
+  def test_valid_events_for_thick_wall_high_power
+    wall = Wall.new(10)
+    assert_equal ['break'], wall.state_machine.valid_events(3)
+  end
+
+  def test_valid_events_for_thin_wall
+    wall = Wall.new(4)
+    assert_equal ['break'], wall.state_machine.valid_events
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hifsm
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Vladimir Meremyanin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler