hifsm 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313a9e688988c6dac1ee778973a602db61af4ca2
-  data.tar.gz: cf7dc5e882dbf4f8dfaf34f211aa04d136474b01
+  metadata.gz: 4d654a06d28adc762a19f31cacf281568503e4de
+  data.tar.gz: 2d8e83ee31acc329efcce082d33d43d65574e71c
 SHA512:
-  metadata.gz: b585b14728b541d4d2863d71e7ac55a59699f71d33ed48ef8b9a366b8f2f2440b8426fbad9287564748e6acb0fb05308f476b66aa72cd61d70877d9691db30d9
-  data.tar.gz: 53df6c486ca83c6745fca49e9cec581348f5b6919d3efcfd76aa6316682d4d3c6dafb31342777d3530838852a9c0665cebfa3b3bdcfd3f0bc319b8e221854f1a
+  metadata.gz: 5ea67c4a15aaee373a2b672184781e975ba67b2ef2681ce461a66c9c062d7bce9509d5bc01e1d8ce82848391d0a63c1df21e9530bc177251d6fb798f2a5560f5
+  data.tar.gz: 7eb5c56002cc5a98c74a55255e465fa280e91b9ba038b3d99355c23884f960040938b97931d65ea0406c63f84e73afe0e978ed37d490b2f6e3d485a7369bc92a

data/README.md

@@ -36,13 +36,17 @@ __This is in early development, so be careful.__
 
 ## Usage
 
+Start with the [basic example](https://github.com/stiff/hifsm/blob/master/test/test_basic_fsm.rb) and then try [something](https://github.com/stiff/hifsm/blob/master/test/test_hierarchical.rb) [more](https://github.com/stiff/hifsm/blob/master/test/test_many_states.rb) [interesting](https://github.com/stiff/hifsm/blob/master/test/test_dynamic_initial_state.rb).
+
 Here is how to use it to model a monster in a Quake-like game. It covers most Hifsm features:
 
 ```ruby
 require 'hifsm'
 
 class Monster
-  include Hifsm.fsm_module {
+  include Hifsm
+
+  hifsm do
     state :idle, :initial => true
     state :attacking do
       state :acquiring_target, :initial => true do
@@ -92,7 +96,7 @@ class Monster
         self.target = nil
       end
     end
-  }
+  end
 
   attr_accessor :target, :low_hp, :debug
 
@@ -103,11 +107,13 @@ class Monster
     @low_hp = false
   end
 
-  def act!
+  def act_with_tick!
     debug && puts("Acting @#{state}")
-    state_machine.act! @tick
+    act_without_tick! @tick
     @tick = @tick + 1
   end
+  alias_method :act_without_tick!, :act!
+  alias_method :act!, :act_with_tick!
 
   def hit(target)
     debug && puts("~~> #{target}")
@@ -168,11 +174,9 @@ ogre.act!               # Acting @runaway
 
 ```
 
-Note the use of `{..}` construct instead of `do..end` in `include`. `do..end` is treated as block for include itself, instead of `fsm_module`.
-
 ## Guards
 
-Events are tried in order they were defined, if guard callback returns `false` then event is skipped.
+Events are tried in order they were defined, if guard callback returns `false` then event is skipped as if it was not defined at all. See [example of this](https://github.com/stiff/hifsm/blob/master/test/test_event_guard.rb).
 
 ## Callbacks
 
@@ -188,7 +192,7 @@ On event:
 
 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.
+On `act!` state's actions called from top state to nested. If [several FSMs defined]](https://github.com/stiff/hifsm/blob/master/test/test_two_machines.rb), object's `act!` invokes them all in order as they were defined and returns value from last action.
 
 ## ActiveRecord integration
 

data/lib/hifsm/adapters/active_record_adapter.rb

@@ -9,7 +9,8 @@ module Hifsm
 
       module ClassMethods
         def hifsm(column, &block)
-          include Hifsm.fsm_module(column, &block)
+          super
+
           before_save "hifsm_write_#{column}_attribute"
 
           send("#{column}_machine_definition").all_states.each do |st|
@@ -40,5 +41,6 @@ module Hifsm
 end
 
 ActiveRecord::Base.class_eval do
+  include Hifsm
   include Hifsm::Adapters::ActiveRecordAdapter
 end

data/lib/hifsm/callbacks.rb

@@ -4,10 +4,10 @@ class Callbacks
     def invoke(target, cb, *args)
       if cb.nil?
       elsif cb.is_a? Symbol
-        if target.method(cb).arity > 0
-          target.send(cb, *args)
-        else
+        if target.method(cb).arity.zero?
           target.send(cb)
+        else
+          target.send(cb, *args)
         end
       else
         target.instance_exec(*args, &cb)

data/lib/hifsm/fsm.rb

@@ -82,16 +82,9 @@ module Hifsm
         machine_var = "@#{name}_machine"
         machine_name = "#{name}_machine"
 
-        module_class_methods = Module.new do
-          define_method("#{machine_name}_definition") { fsm }
-        end
-
         Module.new do
-          const_set('ClassMethods', module_class_methods)
-          def self.included(base)
-            base.class_exec do
-              extend const_get('ClassMethods')
-            end
+          define_singleton_method :included do |base|
+            base.send(:define_singleton_method, "#{machine_name}_definition") { fsm }
           end
 
           # <state>_machine returns machine instance

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/hifsm.rb

@@ -18,9 +18,21 @@ module Hifsm
     end
   end
 
-  class <<self
-    def fsm_module(name = :state, &block)
-      FSM::new(name, &block).to_module
+  def self.included(base)
+    base.send(:extend, ClassMethods) unless base.respond_to?(:hifsm)
+  end
+
+  module ClassMethods
+    def hifsm(name = :state, &block)
+      include FSM::new(name, &block).to_module
+
+      # act!
+      define_method("act_with_#{name}_machine!") do |*args|
+        send("act_without_#{name}_machine!", *args) if respond_to?("act_without_#{name}_machine!")
+        send("#{name}_machine").act!(*args)
+      end
+      alias_method "act_without_#{name}_machine!", :act! if method_defined?(:act!)
+      alias_method :act!, "act_with_#{name}_machine!"
     end
   end
 end

data/test/monster.rb

@@ -1,7 +1,9 @@
 require 'hifsm'
 
 class Monster
-  include Hifsm.fsm_module {
+  include Hifsm
+
+  hifsm do
     state :idle, :initial => true
     state :attacking do
       state :acquiring_target, :initial => true do
@@ -51,7 +53,7 @@ class Monster
         self.target = nil
       end
     end
-  }
+  end
 
   attr_accessor :target, :low_hp, :debug
 
@@ -62,11 +64,13 @@ class Monster
     @low_hp = false
   end
 
-  def act!
+  def act_with_tick!
     debug && puts("Acting @#{state}")
-    state_machine.act! @tick
+    act_without_tick! @tick
     @tick = @tick + 1
   end
+  alias_method :act_without_tick!, :act!
+  alias_method :act!, :act_with_tick!
 
   def hit(target)
     debug && puts("~~> #{target}")

data/test/test_dynamic_initial_state.rb

@@ -2,7 +2,8 @@ require 'setup_tests'
 
 class TestDynamicInitialState < Minitest::Test
   class Value < Struct.new(:value)
-    include Hifsm.fsm_module(:group) {
+    include Hifsm
+    hifsm :group do
       state :few do
         state :very
         state :almost
@@ -13,7 +14,7 @@ class TestDynamicInitialState < Minitest::Test
       end
       state :throng
       state :swarm
-    }
+    end
 
     def initial_group
       case value

data/test/test_event_guard.rb

@@ -2,7 +2,9 @@ require 'setup_tests'
 
 class TestEventGuard < Minitest::Test
   class Wall < Struct.new(:stones)
-    include Hifsm.fsm_module {
+    include Hifsm
+
+    hifsm do
       state :constructed, :initial => true
       state :broken
 
@@ -10,9 +12,10 @@ class TestEventGuard < Minitest::Test
       event :break, :from => :constructed, :to => :broken, :guard => proc { stones < 5 }
 
       # event parameters are passed to guards only if arity > 0
-      event :shoot, :from => :constructed, :to => :broken, :guard => :breakable?
-    }
-    def breakable?(hits)
+      event :break, :from => :constructed, :to => :broken, :guard => :breakable?
+    end
+
+    def breakable?(hits = 1)
       hits * 5 > stones
     end
   end
@@ -32,7 +35,7 @@ class TestEventGuard < Minitest::Test
 
   def test_can_break_thick_wall_if_hit_3_times
     wall = Wall.new(10)
-    wall.shoot 3
+    wall.break 3
     assert_equal 'broken', wall.state
   end
 

data/test/test_ifless_factorial.rb

@@ -2,7 +2,8 @@ require 'setup_tests'
 
 class TestIflessFactorial < Minitest::Test
   class Value < Struct.new(:value)
-    include Hifsm.fsm_module {
+    include Hifsm
+    hifsm do
       state :idle, :initial => true
       state :computing
 
@@ -16,7 +17,7 @@ class TestIflessFactorial < Minitest::Test
           self.value *= x
         end
       end
-    }
+    end
   end
 
   def factorial(n)

data/test/test_two_machines.rb

@@ -1,27 +1,34 @@
 require 'setup_tests'
 
 class TestTwoMachines < Minitest::Test
-  class ColorPrinter
-    include Hifsm.fsm_module(:working_state) {
+  class ColorPrinter < Struct.new(:log)
+    include Hifsm
+
+    hifsm :color do
+      state :red, :initial => true
+      state :green
+      state :blue do
+        action do
+          self.log = [log, 'blue'].compact.join(' ; ')
+        end
+      end
+
+      event :cycle_color!, :from => :red, :to => :green
+      event :cycle_color!, :from => :green, :to => :blue
+      event :cycle_color!, :from => :blue, :to => :red
+    end
+
+    hifsm :working_state do
       state :off, :initial => true
       state :on do
         action do
-          color_machine.to_s
+          'printing ' + color_machine.to_s
         end
       end
 
       event :toggle, :from => :off, :to => :on
       event :toggle, :from => :on, :to => :off
-    }
-    include Hifsm.fsm_module(:color) {
-      state :red, :initial => true
-      state :green
-      state :blue
-
-      event :cycle_color!, :from => :red, :to => :green
-      event :cycle_color!, :from => :green, :to => :blue
-      event :cycle_color!, :from => :blue, :to => :red
-    }
+    end
   end
 
   def setup
@@ -38,4 +45,24 @@ class TestTwoMachines < Minitest::Test
     assert_equal 'red', @color_printer.color
   end
 
+  def test_color_changes_independently
+    @color_printer.cycle_color!
+    assert_equal 'off', @color_printer.working_state
+    assert_equal 'green', @color_printer.color
+  end
+
+  def test_working_state_changes_independently
+    @color_printer.cycle_color!
+    assert_equal 'off', @color_printer.working_state
+    assert_equal 'green', @color_printer.color
+  end
+
+  def test_both_machines_act
+    @color_printer.cycle_color!
+    @color_printer.toggle
+    @color_printer.cycle_color!
+    assert_equal 'printing blue', @color_printer.act!
+    assert_equal 'blue', @color_printer.log
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hifsm
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Meremyanin