hifsm 0.4.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e6687ae4f9842846c1053888058f2a900472a2
-  data.tar.gz: b8bd4da00022fca41f541224b09a717189395d58
+  metadata.gz: e8c840d5a3b6429146d55b87579db8d29ca6c6c6
+  data.tar.gz: 2130df37d77e426940c430a7b9a29abc4619838e
 SHA512:
-  metadata.gz: 01b20d9770b5a2623ed3af913de677b28e3de8110580d20781ed601d4d42c8a70ec7178d44c6050a9889cf709fd8737b0f27a234ffaa0aa413f624b58cf03ee8
-  data.tar.gz: 455a85c0392c5e64038f62e8b5025a282ba9657b1b0dec9f082a7e41b1ed2c685c94429ea4ed42d4f258e544f109cac954cc508f8fd52aa6b474af43643d8c47
+  metadata.gz: a182af19cfb5cc12291e395c4041934d9ae5c25997d865ab573807bbf18b27efcc7c131038b0f3bd18f8fae5d5d4440ce4d08bece8ea0b8efd8dd3c3bdb668bb
+  data.tar.gz: b9e9e923ea20dfbf4cb335a65c297b877397559cfc2bc2b12be2a7ea1d34b9837fec772e8c857431a863fd7a1dac48d35601d232741bb6f39f3b8e081e9597d6

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -23,8 +23,6 @@ Or install it yourself as:
 
 Written in Ruby 1.8-style (hashes, lambdas), but few non-essential 1.9 niceties used, tested in 2+.
 
-__This is in early development, so be careful.__
-
 ## Features
 
 * Easy to use
@@ -44,7 +42,7 @@ Here is how to use it to model a monster in a Quake-like game. It covers most Hi
 require 'hifsm'
 
 class Monster
-  include Hifsm
+  extend Hifsm
 
   hifsm do
     state :idle, :initial => true
@@ -58,7 +56,7 @@ class Monster
       state :pursuing do
         before_enter do
           self.roar!
-          true # since roar! returns nil it would stop processing
+          true # since it would stop processing if roar! returns false
         end
         action do
           step_towards target
@@ -162,6 +160,7 @@ ogre.act!               # Acting @attacking.pursuing
                         # step step player2
 ogre.reached
 puts ogre.state         # attacking.fighting
+# ogre.attacking_fighting? = true
 ogre.act!               # Acting @attacking.fighting
                         # 6: Attack!
                         # ~~> player2
@@ -191,7 +190,7 @@ On event:
 * to_state.after_enter
 * event.after
 
-If any of `before...` callbacks returns `false` then no further processing is done, no exceptions raised, machine state is not changed.
+If any of `before...` callbacks returns `false` (literally, `nil` equals to `true` here) then no further processing is done, no exceptions raised, machine state is not changed.
 
 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.
 
@@ -221,6 +220,8 @@ order.start_processing.save   # 'processing.packaging'
 
 # scopes defined automatically. parent scopes looked up via like "processing.%"
 Order.processing.first.start_delivery.save
+Order.first.processing?                         # true
+Order.first.processing_delivering?              # true
 Order.processing_packaging.first                # nil
 Order.processing_delivering.first.cancel!.save  # save is never called inisde hifsm
 

data/lib/hifsm/adapters/active_record_adapter.rb

@@ -41,6 +41,6 @@ module Hifsm
 end
 
 ActiveRecord::Base.class_eval do
-  include Hifsm
+  extend Hifsm
   include Hifsm::Adapters::ActiveRecordAdapter
 end

data/lib/hifsm/callbacks.rb

@@ -1,22 +1,30 @@
-class Callbacks
+module Hifsm
+  module Callbacks
 
-  def initialize(listeners = [])
-    @listeners = listeners
-  end
+    def set_callbacks(key, listeners)
+      @__callbacks ||= {}
+      @__callbacks[key] = listeners
+    end
 
-  def trigger(target, *args)
-    @listeners.map do |cb|
-      if cb.nil?
-        # raise something maybe? :)
-      elsif cb.is_a? Symbol
-        if target.method(cb).arity.zero?
-          target.send(cb)
+    def trigger(key, target, *args)
+      return [] unless @__callbacks[key]
+      @__callbacks[key].map do |cb|
+        if cb.nil?
+          # raise something maybe? :)
+        elsif cb.is_a? Symbol
+          if target.method(cb).arity.zero?
+            target.send(cb)
+          else
+            target.send(cb, *args)
+          end
         else
-          target.send(cb, *args)
+          target.instance_exec(*args, &cb)
         end
-      else
-        target.instance_exec(*args, &cb)
       end
     end
+
+    def trigger?(key, target, *args)
+      !trigger(key, target, *args).any? {|v| v == false }
+    end
   end
 end

data/lib/hifsm/event.rb

@@ -1,5 +1,7 @@
 module Hifsm
   class Event
+    include Hifsm::Callbacks
+
     CALLBACKS = [:before, :after, :guard].freeze
 
     attr_reader :name, :to
@@ -7,18 +9,13 @@ module Hifsm
     def initialize(name, to, callbacks_options)
       @name = name
       @to = to
-      @callbacks = {}
       CALLBACKS.each do |cb|
-        @callbacks[cb] = Callbacks.new(callbacks_options[cb])
+        set_callbacks cb, callbacks_options[cb]
       end
     end
 
-    def trigger(target, cb, *args)
-      @callbacks[cb].trigger(target, *args)
-    end
-
     def guard?(target, *args)
-      trigger(target, :guard, *args).all?
+      trigger?(:guard, target, *args)
     end
   end
 end

data/lib/hifsm/fsm.rb

@@ -94,6 +94,15 @@ module Hifsm
           fsm.all_events.each do |event_name, event|
             define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
           end
+
+          # <state.to_s.underscore>? = is machine currently in state <state>?
+          fsm.all_states.each do |st|
+            query = st.to_s
+            define_method("#{query.gsub('.', '_')}?") do
+              current = send(machine_name).to_s
+              current == query || current.start_with?("#{query}.")
+            end
+          end
         end
       end
 

data/lib/hifsm/state.rb

@@ -1,5 +1,7 @@
 module Hifsm
   class State
+    include Hifsm::Callbacks
+
     CALLBACKS = [:before_enter, :before_exit, :after_enter, :after_exit, :action].freeze
 
     attr_reader :name, :sub_fsm
@@ -7,9 +9,8 @@ module Hifsm
     def initialize(name, parent = nil, options)
       @name = name.to_s
       @parent = parent
-      @callbacks = {}
       CALLBACKS.each do |cb|
-        @callbacks[cb] = Callbacks.new(options[cb])
+        set_callbacks cb, options[cb]
       end
       @transitions = Hash.new {|h, key| h[key] = Array.new }
 
@@ -24,7 +25,7 @@ module Hifsm
 
     def act!(target, *args)
       @parent.act!(target, *args) if @parent
-      trigger(target, :action, *args).last
+      trigger(:action, target, *args).last
     end
 
     def add_transition(ev)
@@ -55,13 +56,13 @@ module Hifsm
         if ev.guard?(target, *args)
           from_state = self
           to_state = ev.to
-          if ev.trigger(target, :before, *args).all? &&
-              to_state.trigger(target, :before_enter, *args).all? &&
-              from_state.trigger(target, :before_exit, *args).all?
+          if ev.trigger?(:before, target, *args) &&
+              to_state.trigger?(:before_enter, target, *args) &&
+              from_state.trigger?(:before_exit, target, *args)
             new_state_callback.call(to_state.enter!)
-            from_state.trigger(target, :after_exit, *args)
-            to_state.trigger(target, :after_enter, *args)
-            ev.trigger(target, :after, *args)
+            from_state.trigger(:after_exit, target, *args)
+            to_state.trigger(:after_enter, target, *args)
+            ev.trigger(:after, target, *args)
           end
           return target
         end
@@ -72,10 +73,6 @@ module Hifsm
       raise Hifsm::MissingTransition.new(to_s, event_name)
     end
 
-    def trigger(target, cb, *args)
-      @callbacks[cb].trigger(target, *args)
-    end
-
     def to_s
       if @parent
         "#{@parent.to_s}.#{@name}"

data/lib/hifsm/version.rb

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

data/lib/hifsm.rb

@@ -22,13 +22,11 @@ module Hifsm
   end
 
   def self.included(base)
-    base.send(:extend, ClassMethods) unless base.respond_to?(:hifsm)
+    raise 'use extend Hifsm instead of include'
   end
 
-  module ClassMethods
-    def hifsm(name = :state, &block)
-      include FSM::new(name, &block).to_module
-    end
+  def hifsm(name = :state, &block)
+    include FSM::new(name, &block).to_module
   end
 end
 

data/test/monster.rb

@@ -1,7 +1,7 @@
 require 'hifsm'
 
 class Monster
-  include Hifsm
+  extend Hifsm
 
   hifsm do
     state :idle, :initial => true
@@ -15,7 +15,7 @@ class Monster
       state :pursuing do
         before_enter do
           self.roar!
-          true # since roar! returns nil it would stop processing
+          true # since it would stop processing if roar! returns false
         end
         action do
           step_towards target
@@ -120,6 +120,7 @@ if $0 == __FILE__
                           # step step player2
   ogre.reached
   puts ogre.state         # attacking.fighting
+  # ogre.attacking_fighting? = true
   ogre.act!               # Acting @attacking.fighting
                           # 6: Attack!
                           # ~~> player2

data/test/test_basic_fsm.rb

@@ -16,6 +16,11 @@ class TestBasicFSM < Minitest::Test
     assert_equal 'off', @machine.state.to_s
   end
 
+  def test_state_question_methods
+    refute @machine.on?, "Machine .on? should be false"
+    assert @machine.off?, "Machine .off? should be true"
+  end
+
   def test_toggle_switches_state_to_on
     @machine.toggle
     assert_equal 'on', @machine.state.to_s

data/test/test_before_returning_false.rb

@@ -2,13 +2,17 @@ require 'setup_tests'
 
 class TestBeforeReturningFalse < Minitest::Test
   class Door
-    include Hifsm
+    extend Hifsm
 
     hifsm do
       state :open
       state :closed, :initial => true do
         state :unlocked, :initial => true
-        state :locked
+        state :locked do
+          before_enter do
+            nil # nil equals true in this case, like in Rails
+          end
+        end
 
         event :lock, :from => :unlocked, :to => :locked
       end

data/test/test_dynamic_initial_state.rb

@@ -2,7 +2,7 @@ require 'setup_tests'
 
 class TestDynamicInitialState < Minitest::Test
   class Value < Struct.new(:value)
-    include Hifsm
+    extend Hifsm
     hifsm :group do
       state :few do
         state :very

data/test/test_event_guard.rb

@@ -2,19 +2,27 @@ require 'setup_tests'
 
 class TestEventGuard < Minitest::Test
   class Wall < Struct.new(:stones)
-    include Hifsm
+    extend Hifsm
 
     hifsm do
       state :constructed, :initial => true
       state :broken
 
-      # guards can be inline proc, or symbols
-      event :break, :from => :constructed, :to => :broken, :guard => proc { stones < 5 }
+      event :break do
+        # guards can be inline proc, or symbols
+        from :constructed, :to => :broken, :guard => proc { stones < 5 }
 
-      # event parameters are passed to guards only if arity > 0
-      event :break, :from => :constructed, :to => :broken, :guard => :breakable?
+        # event parameters are passed to guards only if arity > 0
+        from :constructed, :to => :broken, :guard => :breakable?
+
+        before do |strength|
+          @last_hit_strength = strength.to_s
+        end
+      end
     end
 
+    attr_reader :last_hit_strength
+
     def breakable?(hits = 1)
       hits * 5 > stones
     end
@@ -24,6 +32,8 @@ class TestEventGuard < Minitest::Test
     wall = Wall.new(3)
     wall.break
     assert_equal 'broken', wall.state
+    # before callback invoked
+    assert_equal '', wall.last_hit_strength
   end
 
   def test_cant_break_wall_10_stones_thick
@@ -31,12 +41,16 @@ class TestEventGuard < Minitest::Test
     assert_raises(Hifsm::MissingTransition) do
       wall.break
     end
+    # before callback not called
+    assert_equal nil, wall.last_hit_strength
   end
 
   def test_can_break_thick_wall_if_hit_3_times
     wall = Wall.new(10)
     wall.break 3
     assert_equal 'broken', wall.state
+    # before callback invoked
+    assert_equal '3', wall.last_hit_strength
   end
 
 end

data/test/test_groupped_transitions.rb

@@ -2,7 +2,7 @@ require 'setup_tests'
 
 class TestGrouppedTransitions < Minitest::Test
   class Button
-    include Hifsm
+    extend Hifsm
 
     hifsm do
       state :active, :initial => true
@@ -25,6 +25,7 @@ class TestGrouppedTransitions < Minitest::Test
     attr_accessor :disable_on_click, :log
 
     def initialize
+      self.disable_on_click = false # nil = true, same as for callbacks
       self.log = []
     end
   end

data/test/test_hierarchical.rb

@@ -51,6 +51,14 @@ class TestHierarchical < Minitest::Test
     assert_equal 'off.sync.third_level', machine.state.to_s
   end
 
+  def test_state_question_methods
+    machine = @fsm.instantiate
+    refute machine.on?, "Machine .on? should be false"
+    assert machine.off?, "Machine .off? should be true"
+    refute machine.off_sync?, "Machine .off_sync? should be false"
+    assert machine.off_pending?, "Machine .off_pending? should be true"
+  end
+
   def test_toggle_from_off_sync_to_on_pending
     machine = @fsm.instantiate
     machine.sync

data/test/test_ifless_factorial.rb

@@ -2,7 +2,7 @@ require 'setup_tests'
 
 class TestIflessFactorial < Minitest::Test
   class Value < Struct.new(:value)
-    include Hifsm
+    extend Hifsm
     hifsm do
       state :idle, :initial => true
       state :computing

data/test/test_two_machines.rb

@@ -2,7 +2,7 @@ require 'setup_tests'
 
 class TestTwoMachines < Minitest::Test
   class ColorPrinter < Struct.new(:log)
-    include Hifsm
+    extend Hifsm
 
     hifsm :color do
       state :red, :initial => true

metadata

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