hifsm 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e7c452cb3f0ebfce493c75f0130b191807daae
-  data.tar.gz: 973378be201d7957f7fc22231d0d86e34896825a
+  metadata.gz: 2036f5f0392c1b5556c67030d1f3f4124355b725
+  data.tar.gz: ee74be4931ceb43693bb6e32dae2cb320e6ff848
 SHA512:
-  metadata.gz: 2093aab1fc0253c749fd3b352560ad517a64f4b6a6d14a437197b61e77b7aa8364cf38a269b6455ed2b7eb4c5bb130442ca938fd21a2bfcc86e6d98ae359b30a
-  data.tar.gz: 4730e63e2f71fa653e7c487953da10b0415c00a26a2a005578f92d24178882d9e09b271ac8f1f9715e848ee5078f44ae4428ff99420b84cdf700a92ccf1e0ee9
+  metadata.gz: f48f8b7c4967ad34beb03b74057dc0c876df9a855b3c23194ea6a2a3fd74945884f5ef7f265d42a2c874dcd0b39c270b47d80125e63a0ad801d49c329306f3c7
+  data.tar.gz: 6b49eac8561505a6a7a10d20024abe58c94c677b936e8f5ccf8fdff82f7c2581ca51c4dc49a5a0651e24e1a7485c36ee50781bd290de96dfe34f5d0008ac8249

data/lib/hifsm/fsm.rb

@@ -17,10 +17,10 @@ module Hifsm
     end
 
     def instantiate(target = nil, initial_state = nil)
-      fsm_module = get_fsm_module
+      machine_module = get_machine_module
       machine_name = "#{name}_machine"
       @machine_class ||= Class.new(Hifsm::Machine) do
-        include fsm_module
+        include machine_module
         define_method(machine_name) { self }
       end
       @machine_class.new(self, target, initial_state)
@@ -81,35 +81,51 @@ module Hifsm
     end
 
     private
-      def get_fsm_module
-        @fsm_module ||= begin
-          fsm = self  # capture self
-          machine_var = "@#{name}_machine"
-          machine_name = "#{name}_machine"
-
-          Module.new do
-            define_singleton_method :included do |base|
-              base.send(:define_singleton_method, "#{machine_name}_definition") { fsm }
-            end
+      def get_machine_module
+        fsm = self  # capture self
+        machine_name = "#{name}_machine"
+        @machine_module ||= Module.new do
+          # <event> fires event
+          fsm.all_events.each do |event_name, event|
+            define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
+          end
+        end
+      end
 
-            # <state>_machine returns machine instance
-            define_method(machine_name) do
-              if instance_variable_defined?(machine_var)
-                instance_variable_get(machine_var)
-              else
-                machine = fsm.instantiate(self)
-                instance_variable_set(machine_var, machine)
+      def get_fsm_module
+        fsm = self  # capture self
+        machine_var = "@#{name}_machine"
+        machine_name = "#{name}_machine"
+        machine_module = get_machine_module
+        @fsm_module ||= Module.new do
+          include machine_module
+
+          define_singleton_method :included do |base|
+            base.class_eval do
+              define_singleton_method("#{machine_name}_definition") { fsm }
+
+              # act!
+              define_method "act_with_#{machine_name}!" do |*args|
+                send("act_without_#{machine_name}!", *args) if respond_to?("act_without_#{machine_name}!")
+                send("#{machine_name}").act!(*args)
               end
+              alias_method "act_without_#{machine_name}!", :act! if method_defined?(:act!)
+              alias_method :act!, "act_with_#{machine_name}!"
             end
+          end
 
-            # <state> returns string representation of the current state
-            define_method(fsm.name) { send(machine_name).to_s }
-
-            # <event> fires event
-            fsm.all_events.each do |event_name, event|
-              define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
+          # <state>_machine returns machine instance
+          define_method(machine_name) do
+            if instance_variable_defined?(machine_var)
+              instance_variable_get(machine_var)
+            else
+              machine = fsm.instantiate(self)
+              instance_variable_set(machine_var, machine)
             end
           end
+
+          # <state> returns string representation of the current state
+          define_method(fsm.name) { send(machine_name).to_s }
         end
       end
   end

data/lib/hifsm/machine.rb

@@ -18,7 +18,15 @@ module Hifsm
     end
 
     def state
-      @state.to_s
+      @state
+    end
+
+    def states
+      @fsm.states.keys
+    end
+
+    def all_states
+      @fsm.all_states.reject(&:sub_fsm).collect(&:to_s)
     end
 
     def fire(event, *args)

data/lib/hifsm/state.rb

@@ -2,10 +2,10 @@ module Hifsm
   class State
     CALLBACKS = [:before_enter, :before_exit, :after_enter, :after_exit, :action].freeze
 
-    attr_reader :sub_fsm
+    attr_reader :name, :sub_fsm
 
     def initialize(name, parent = nil, options)
-      @name = name
+      @name = name.to_s
       @parent = parent
       @callbacks = {}
       CALLBACKS.each do |cb|
@@ -34,7 +34,7 @@ module Hifsm
 
     def enter!
       if @sub_fsm
-        @sub_fsm.initial_state!
+        @sub_fsm.initial_state!.enter!
       else
         self
       end
@@ -78,9 +78,9 @@ module Hifsm
 
     def to_s
       if @parent
-        "#{@parent.to_s}.#{@name.to_s}"
+        "#{@parent.to_s}.#{@name}"
       else
-        @name.to_s
+        @name
       end
     end
   end

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.4.1"
+  VERSION = "0.4.3"
 end

data/lib/hifsm.rb

@@ -28,14 +28,6 @@ module Hifsm
   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/test_activerecord_adapter.rb

@@ -48,7 +48,7 @@ class TestActiverecrodAdapter < Minitest::Test
 
   def test_new_machines_saved_in_initial_state
     @machine = SodaMachine.create
-    assert_equal 'off', @machine.state_machine.state
+    assert_equal 'off', @machine.state_machine.state.to_s
     assert_equal 'off', @machine.state
   end
 

data/test/test_any_state_event.rb

@@ -16,13 +16,17 @@ class TestAnyStateEvent < Minitest::Test
 
   def test_halt_from_off
     @machine.halt
-    assert_equal 'halt', @machine.state
+    assert_equal 'halt', @machine.state.to_s
   end
 
   def test_halt_from_on
     @machine.toggle
     @machine.halt
-    assert_equal 'halt', @machine.state
+    assert_equal 'halt', @machine.state.to_s
+  end
+
+  def test_event_is_added_to_states
+    assert_equal ['toggle', 'halt'], @machine.state.events
   end
 
 end

data/test/test_basic_fsm.rb

@@ -13,18 +13,18 @@ class TestBasicFSM < Minitest::Test
   end
 
   def test_initial_state_is_off
-    assert_equal 'off', @machine.state
+    assert_equal 'off', @machine.state.to_s
   end
 
   def test_toggle_switches_state_to_on
     @machine.toggle
-    assert_equal 'on', @machine.state
+    assert_equal 'on', @machine.state.to_s
   end
 
   def test_toggle_twice_switches_state_back_to_off
     @machine.toggle
     @machine.toggle
-    assert_equal 'off', @machine.state
+    assert_equal 'off', @machine.state.to_s
   end
 
   def test_instantiating_maching_in_unknown_state_raises_error

data/test/test_hierarchical.rb

@@ -5,7 +5,15 @@ class TestHierarchical < Minitest::Test
     @fsm = Hifsm::FSM.new do
       async = proc do
         state :pending, :initial => true
-        state :sync
+        state :sync do
+          state :third_level, :initial => true
+          state :third_level_two
+
+          event :switch_levels do
+            from :third_level, :to => :third_level_two
+            from :third_level_two, :to => :third_level
+          end
+        end
 
         event :sync, :from => :pending, :to => :sync
       end
@@ -20,12 +28,12 @@ class TestHierarchical < Minitest::Test
 
   def test_initial_state_is_off_pending_by_default
     machine = @fsm.instantiate
-    assert_equal 'off.pending', machine.state
+    assert_equal 'off.pending', machine.state.to_s
   end
 
   def test_explicit_initial_state
     machine2 = @fsm.instantiate(nil, 'on.sync')
-    assert_equal 'on.sync', machine2.state
+    assert_equal 'on.sync.third_level', machine2.state.to_s
     machine2.toggle
     pass # assert_nothing_raised
   end
@@ -40,19 +48,31 @@ class TestHierarchical < Minitest::Test
   def test_sync
     machine = @fsm.instantiate
     machine.sync
-    assert_equal 'off.sync', machine.state
+    assert_equal 'off.sync.third_level', machine.state.to_s
   end
 
   def test_toggle_from_off_sync_to_on_pending
     machine = @fsm.instantiate
     machine.sync
     machine.toggle
-    assert_equal 'on.pending', machine.state
+    assert_equal 'on.pending', machine.state.to_s
   end
 
   def test_toggle_from_on_sync_to_off_sync
     machine2 = @fsm.instantiate(nil, 'on.sync')
     machine2.toggle
-    assert_equal 'off.sync', machine2.state
+    assert_equal 'third_level', machine2.state.name
+    assert_equal 'off.sync.third_level', machine2.state.to_s
+  end
+
+  def test_machine_states
+    machine = @fsm.instantiate
+    assert_equal ["off", "on"], machine.states
+  end
+
+  def test_machine_all_states
+    machine = @fsm.instantiate
+    # note the all_states do not include states from test_machine_states
+    assert_equal ["off.pending", "off.sync.third_level", "off.sync.third_level_two", "on.pending", "on.sync.third_level", "on.sync.third_level_two"], machine.all_states
   end
 end

data/test/test_two_machines.rb

@@ -38,8 +38,9 @@ class TestTwoMachines < Minitest::Test
   end
 
   def test_two_machines_defined
-    assert_equal 'off', @color_printer.working_state_machine.state
-    assert_equal 'red', @color_printer.color_machine.color
+    assert_equal 'off', @color_printer.working_state_machine.state.to_s
+    assert_equal 'red', @color_printer.color_machine.state.to_s
+    assert_equal 'red', @color_printer.color # alias for color_mathine.state.to_s
   end
 
   def test_initial_state_is_off_and_red

metadata

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