hifsm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e43ef721bec5c9d473610831836bf1531ae5c782
-  data.tar.gz: c6396a4f8ecd0f81c2963a84685bdae93a1dae3c
+  metadata.gz: 25b5e3332cdc03d7cdc7efee6fa52b83a2a85881
+  data.tar.gz: 52f1ffd9779265883292b018ed76ee480032cbf5
 SHA512:
-  metadata.gz: 6c586dba477b583fd85e1bb4eedac0df1610af363d178569645f51a0aa4820c385edd21709149d3dce2a997f95d847ece2a6cbf3a96b864582b01d7f689b8be5
-  data.tar.gz: 90ffecc59fc1bf1a8af8cf54c2a70cf7c48a52a6a37ae84bf3ce92da72a89102449d94688c63ece647c42987d10fafb60ee063feecd6612decdd9d00a01db52c
+  metadata.gz: ecec06c7780e4ab19a6c98fa6191d5a3aeea238ba5c790d0b9a3a02a87b68838ec36c166bbdec15f8d75f9d125d0197f6b79d1833f2e1bcb73f96b110df702e2
+  data.tar.gz: 4e113ea01e29154d6cf2b62a08243a0b7a4054a9c254f59dffc468874f94b843e94c7586de327d0743dfda2c2f98c0e6f775c6168a968011ec3ef62f9d3d20c7

data/README.md

@@ -39,7 +39,7 @@ Here is how to use it to model a monster in a Quake-like game. It covers most Hi
 require 'hifsm'
 
 class Monster
-  @@fsm = Hifsm::FSM.define do
+  @@fsm = Hifsm::FSM.new do
     state :idle, :initial => true
     state :attacking do
       state :acquiring_target, :initial => true do
@@ -97,7 +97,7 @@ class Monster
   def initialize
     @debug = false
     @home = 'home'
-    @state = @@fsm.new(self) # or @@fsm.new(self, 'attacking.pursuing')
+    @state = @@fsm.instantiate(self) # or @@fsm.instantiate(self, 'attacking.pursuing')
     @tick = 1
     @low_hp = false
   end
@@ -155,6 +155,9 @@ ogre.act!               # -> ~~> player2
 ogre.enemy_dead         # -> Woohoo!
 ogre.act!               # -> Acting @coming_back
                         # -> step step home
+ogre.low_hp = true
+ogre.sight 'player3'
+ogre.act!               # -> Acting @runaway
 
 ```
 
@@ -174,10 +177,18 @@ On event:
 * to_state.after_enter
 * event.after
 
-If `before...` callback returns Hifsm.cancel then no further processing is done
+If any of `before...` callbacks returns `false` then no further processing is done, no exceptions raised, machine state is not changed.
 
 On `act!` just calls action block if it was given.
 
+## Testing
+
+Only 'public' API is unit-tested, internal implementation may be freely changed, so don't rely on it.
+
+To run tests use `bundle exec rake test`
+
+Try also `bundle exec ruby test/monster.rb`
+
 ## Contributing
 
 1. Fork it

data/lib/hifsm/callbacks.rb

@@ -4,9 +4,13 @@ class Callbacks
     def invoke(target, cb, *args)
       if cb.nil?
       elsif cb.is_a? Symbol
-        target.send(cb, *args)
+        if target.method(cb).arity > 0
+          target.send(cb, *args)
+        else
+          target.send(cb)
+        end
       else
-        target.instance_exec *args, &cb
+        target.instance_exec(*args, &cb)
       end
     end
   end
@@ -15,12 +19,12 @@ class Callbacks
     @listeners = []
   end
 
-  def add(&callback)
-    @listeners.push callback
+  def add(symbol = nil, &callback)
+    @listeners.push symbol || callback
   end
 
   def trigger(target, *args)
-    @listeners.each do |callback|
+    @listeners.map do |callback|
       Callbacks.invoke target, callback, *args
     end
   end

data/lib/hifsm/event.rb

@@ -1,15 +1,17 @@
 module Hifsm
   class Event
-    CALLBACKS = [:before, :after].freeze
+    CALLBACKS = [:before, :after, :guard].freeze
 
     attr_reader :name, :to
 
-    def initialize(name, to, guard)
+    def initialize(name, to, guards)
       @name = name
-      @guard = guard
       @to = to
-
       @callbacks = Hash.new {|h, key| h[key] = Callbacks.new }
+
+      guards.each do |g|
+        @callbacks[:guard].add g
+      end
     end
 
     CALLBACKS.each do |cb|
@@ -20,8 +22,8 @@ module Hifsm
       @callbacks[cb].trigger(target, *args)
     end
 
-    def guard?(target)
-      !@guard || Callbacks.invoke(target, @guard)
+    def guard?(target, *args)
+      trigger(target, :guard, *args).all?
     end
   end
 end

data/lib/hifsm/fsm.rb

@@ -2,22 +2,16 @@ module Hifsm
   class FSM
     attr_reader :states, :transitions
 
-    class <<self
-      def define(&block)
-        Hifsm::FSM.new(&block)
-      end
-    end
-
     def initialize(parent = nil, &block)
       @parent = parent
       @states = {}
-      @initial_state
+      @initial_state = nil
 
-      instance_eval &block if block
+      instance_eval(&block) if block
     end
 
-    def new(target = nil, initial_state = nil)
-      Hifsm::Machine.new(target, self, initial_state)
+    def instantiate(target = nil, initial_state = nil)
+      Hifsm::Machine.new(self, target, initial_state)
     end
 
     def all_events
@@ -29,24 +23,30 @@ module Hifsm
     end
 
     def get_state!(name)
-      @states[name.to_s] || raise(Hifsm::MissingState.new(name.to_s))
+      top_level_state, rest = name.to_s.split('.', 2)
+      st = @states[top_level_state] || raise(Hifsm::MissingState.new(name.to_s))
+      if rest
+        st.get_substate!(rest)
+      else
+        st
+      end
     end
 
     def event(name, options, &block)
-      ev = Hifsm::Event.new(name, get_state!(options[:to]), options[:guard])
+      ev = Hifsm::Event.new(name, get_state!(options[:to]), array_wrap(options[:guard]))
       from_states = array_wrap(options[:from])
       from_states = @states.keys if from_states.empty?
       from_states.each do |from|
         st = get_state!(from)
         st.add_transition(ev)
       end
-      ev.instance_eval &block if block
+      ev.instance_eval(&block) if block
     end
 
     def state(name, options = {}, &block)
       st = @states[name.to_s] = Hifsm::State.new(name, @parent)
       @initial_state = st if options[:initial]
-      st.instance_eval &block if block
+      st.instance_eval(&block) if block
     end
 
     private

data/lib/hifsm/machine.rb

@@ -1,10 +1,10 @@
 module Hifsm
   class Machine
-    def initialize(target, fsm, initial_state = nil)
+    def initialize(fsm, target, initial_state = nil)
       @target = target || self
       @fsm = fsm
 
-      @state = fsm.states[initial_state] || fsm.initial_state!
+      @state = (initial_state && fsm.get_state!(initial_state) || fsm.initial_state!).enter!
 
       mach = self
       fsm.all_events.each do |event_name, event|

data/lib/hifsm/state.rb

@@ -5,7 +5,8 @@ module Hifsm
     def initialize(name, parent = nil)
       @name = name
       @parent = parent
-      @action
+      @action = nil
+      @sub_fsm = nil
 
       @callbacks = Hash.new {|h, key| h[key] = Callbacks.new }
       @transitions = Hash.new {|h, key| h[key] = Array.new }
@@ -21,11 +22,11 @@ module Hifsm
     end
 
     def state(*args, &block)
-      sub_fsm!.state *args, &block
+      sub_fsm!.state(*args, &block)
     end
 
     def event(*args, &block)
-      sub_fsm!.event *args, &block
+      sub_fsm!.event(*args, &block)
     end
 
     def events
@@ -35,7 +36,7 @@ module Hifsm
     def fire(target, event_name, *args, &new_state_callback)
       event_name = event_name.to_s
       @transitions[event_name].each do |ev|
-        if ev.guard?(target)
+        if ev.guard?(target, *args)
           from_state = self
           to_state = ev.to
           if ev.trigger(target, :before, *args) &&
@@ -46,7 +47,7 @@ module Hifsm
             to_state.trigger(target, :after_enter, *args)
             ev.trigger(target, :after, *args)
           end
-          return
+          return target
         end
       end
       if @parent
@@ -64,9 +65,8 @@ module Hifsm
     end
 
     def act!(target, *args)
+      @parent.act!(target, *args) if @parent
       @action && Callbacks.invoke(target, @action, *args)
-      if @sub_fsm
-      end
     end
 
     def enter!
@@ -77,6 +77,11 @@ module Hifsm
       end
     end
 
+    def get_substate!(name)
+      raise Hifsm::MissingState.new(name.to_s) unless @sub_fsm
+      @sub_fsm.get_state!(name)
+    end
+
     def to_s
       if @parent
         "#{@parent.to_s}.#{@name.to_s}"

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/monster.rb

@@ -1,7 +1,7 @@
 require 'hifsm'
 
 class Monster
-  @@fsm = Hifsm::FSM.define do
+  @@fsm = Hifsm::FSM.new do
     state :idle, :initial => true
     state :attacking do
       state :acquiring_target, :initial => true do
@@ -59,7 +59,7 @@ class Monster
   def initialize
     @debug = false
     @home = 'home'
-    @state = @@fsm.new(self) # or @@fsm.new(self, 'attacking.pursuing')
+    @state = @@fsm.instantiate(self) # or @@fsm.instantiate(self, 'attacking.pursuing')
     @tick = 1
     @low_hp = false
   end
@@ -118,4 +118,7 @@ if $0 == __FILE__
   ogre.enemy_dead         # -> Woohoo!
   ogre.act!               # -> Acting @coming_back
                           # -> step step home
+  ogre.low_hp = true
+  ogre.sight 'player3'
+  ogre.act!               # -> Acting @runaway
 end

data/test/test_any_state_event.rb

@@ -2,7 +2,7 @@ require 'setup_tests'
 
 class TestAnyStateEvent < Minitest::Test
   def setup
-    @fsm = Hifsm::FSM.define do
+    @fsm = Hifsm::FSM.new do
       state :off, :initial => true
       state :on
       state :halt
@@ -11,7 +11,7 @@ class TestAnyStateEvent < Minitest::Test
       event :toggle, :from => :on, :to => :off
       event :halt, :to => :halt
     end
-    @machine = @fsm.new
+    @machine = @fsm.instantiate
   end
 
   def test_halt_from_off

data/test/test_basic_fsm.rb

@@ -2,14 +2,14 @@ require 'setup_tests'
 
 class TestBasicFSM < Minitest::Test
   def setup
-    @fsm = Hifsm::FSM.define do
+    @fsm = Hifsm::FSM.new do
       state :off, :initial => true
       state :on
 
       event :toggle, :from => :off, :to => :on
       event :toggle, :from => :on, :to => :off
     end
-    @machine = @fsm.new
+    @machine = @fsm.instantiate
   end
 
   def test_initial_state_is_off

data/test/test_event_guard.rb

@@ -1,27 +1,30 @@
 require 'setup_tests'
 
 class TestEventGuard < Minitest::Test
-  def setup
-    @wall = Struct.new(:stones).new(10)
+  Wall = Struct.new(:stones)
 
-    @fsm = Hifsm::FSM.define do
+  def build_wall(thickness)
+    fsm = Hifsm::FSM.new do
       state :constructed, :initial => true
       state :broken
 
       event :break, :from => :constructed, :to => :broken, :guard => proc { stones < 5 }
     end
-    @machine = @fsm.new(@wall)
+    wall = Wall.new(thickness)
+    @machine = fsm.instantiate(wall)
+    wall
   end
 
   def test_cant_break_wall_10_stones_thick
+    wall = build_wall 10
     assert_raises(Hifsm::MissingTransition) do
-      @wall.break
+      wall.break
     end
   end
 
   def test_cant_break_thin_wall
-    @wall.stones = 3
-    @wall.break
+    wall = build_wall 3
+    wall.break
     assert_equal 'broken', @machine.state
   end
 

data/test/test_hierarchical.rb

@@ -0,0 +1,58 @@
+require 'setup_tests'
+
+class TestHierarchical < Minitest::Test
+  def setup
+    @fsm = Hifsm::FSM.new do
+      async = proc do
+        state :pending, :initial => true
+        state :sync
+
+        event :sync, :from => :pending, :to => :sync
+      end
+
+      state :off, :initial => true, &async
+      state :on, &async
+
+      event :toggle, :from => 'off.sync', :to => :on
+      event :toggle, :from => 'on.sync', :to => 'off.sync'
+    end
+  end
+
+  def test_initial_state_is_off_pending_by_default
+    machine = @fsm.instantiate
+    assert_equal 'off.pending', machine.state
+  end
+
+  def test_explicit_initial_state
+    machine2 = @fsm.instantiate(nil, 'on.sync')
+    assert_equal 'on.sync', machine2.state
+    machine2.toggle
+    pass # assert_nothing_raised
+  end
+
+  def test_toggle_raises_an_error_in_pending_state
+    machine = @fsm.instantiate
+    assert_raises(Hifsm::MissingTransition) do
+      machine.toggle
+    end
+  end
+
+  def test_sync
+    machine = @fsm.instantiate
+    machine.sync
+    assert_equal 'off.sync', machine.state
+  end
+
+  def test_toggle_from_off_sync_to_on_pending
+    machine = @fsm.instantiate
+    machine.sync
+    machine.toggle
+    assert_equal 'on.pending', machine.state
+  end
+
+  def test_toggle_from_on_sync_to_off_sync
+    machine2 = @fsm.instantiate(nil, 'on.sync')
+    machine2.toggle
+    assert_equal 'off.sync', machine2.state
+  end
+end

data/test/test_ifless_factorial.rb

@@ -0,0 +1,41 @@
+require 'setup_tests'
+
+class TestIflessFactorial < Minitest::Test
+  Value = Struct.new(:value)
+
+  def setup
+    @fsm = Hifsm::FSM.new do
+      state :idle, :initial => true
+      state :counting
+
+      event :count, :to => :idle do
+        guard { |x| x == 0 }
+        after { |x| self.value = 1 }
+      end
+      event :count, :to => :counting do
+        after do |x|
+          count(x - 1)
+          self.value *= x
+        end
+      end
+    end
+  end
+
+  def factorial(n)
+    val = Value.new
+    @fsm.instantiate(val)
+    val.count(n).value
+  end
+
+  def test_factorial_0
+    assert_equal 1, factorial(0)
+  end
+
+  def test_factorial_5
+    assert_equal 120, factorial(5)
+  end
+
+  def test_factorial_100
+    assert_equal 93326215443944152681699238856266700490715968264381621468592963895217599993229915608941463976156518286253697920827223758251185210916864000000000000000000000000, factorial(100)
+  end
+end

data/test/test_many_states.rb

@@ -0,0 +1,34 @@
+require 'setup_tests'
+
+class TestManyStates < Minitest::Test
+  def inefficient_factorial(n)
+    fsm = Hifsm::FSM.new do
+      state :value0 do
+        action { 1 }
+      end
+      (1..n).each do |x|
+        state "value#{x}" do
+          action do
+            x * prev.act!
+          end
+        end
+        event :prev, :from => "value#{x}", :to => "value#{x - 1}"
+      end
+    end
+    machine = fsm.instantiate(nil, "value#{n}")
+    machine.act!
+  end
+
+  def test_factorial_0
+    assert_equal 1, inefficient_factorial(0)
+  end
+
+  def test_factorial_5
+    assert_equal 120, inefficient_factorial(5)
+  end
+
+  def test_factorial_100
+    assert_equal 93326215443944152681699238856266700490715968264381621468592963895217599993229915608941463976156518286253697920827223758251185210916864000000000000000000000000, inefficient_factorial(100)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hifsm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladimir Meremyanin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,9 @@ files:
 - test/test_any_state_event.rb
 - test/test_basic_fsm.rb
 - test/test_event_guard.rb
+- test/test_hierarchical.rb
+- test/test_ifless_factorial.rb
+- test/test_many_states.rb
 - test/test_monster.rb
 homepage: http://github.com/stiff/hifsm
 licenses:
@@ -110,4 +113,7 @@ test_files:
 - test/test_any_state_event.rb
 - test/test_basic_fsm.rb
 - test/test_event_guard.rb
+- test/test_hierarchical.rb
+- test/test_ifless_factorial.rb
+- test/test_many_states.rb
 - test/test_monster.rb