simplificator-fsm 0.2.0 → 0.2.1

data/README.markdown

@@ -0,0 +1,32 @@
+# fsm
+
+FSM is a simple finite state machine
+
+## Usage
+    class Water
+      include FSM
+      define_fsm do
+        # now define all the states
+        # you can add :enter / :exit callbacks (callback can be a String, Symbol or Proc)
+        # these callbacks are triggered on any transition from/to this state
+        
+        state(:gas)
+        state(:liquid)
+        state(:solid, :enter => :on_enter_solid, :exit => :on_exit_solid)
+        
+        # define all valid transitions (name, from, to)
+        # you can define callbacks which are called only on this transition
+        transition(:heat, :solid, :liquid)
+        transition(:heat, :liquid, :gas)     # look mam.... two transitions with same name
+        transition(:cooldown, :gas, :liquid)
+        transition(:cooldown, :liquid, :solid)
+        
+        # define the attribute which is used to store the state (defaults to :state)
+        state(:state_of_material)
+        
+        # define the initial state (defaults to the first state defined - :gas in this sample)
+        initial(:liquid)
+      end
+    end
+## Copyright
+Copyright (c) 2009 simplificator GmbH. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 0
+:patch: 1

data/lib/fsm/machine.rb

@@ -38,7 +38,7 @@ module FSM
       transition = Transition.new(name, from_state, to_state, options)
       from_state.add_transition(transition)
       
-      define_transition_method(name, to_name)
+      define_transition_method(name)
       
     end
     
@@ -67,21 +67,35 @@ module FSM
     
     private
     
-    def define_transition_method(name, to_name)
+    def define_transition_method(name)
       @target_class.instance_eval do
         define_method(name) do |*args|
           machine = Machine[self.class]
           from_name = Machine.get_current_state_name(self)
           from_state = machine.states[from_name]
-          to_state = machine.states[to_name]
-          transition = from_state.transitions[to_name]
-          raise InvalidStateTransition.new("No transition defined from #{from_name} -> #{to_name}") unless transition
+          
+          entry = from_state.transitions.detect() {|to_name, tr| tr.name == name}
+          transition = entry.last if entry
+          raise InvalidStateTransition.new("No transition with name '#{name}' defined from '#{from_name}'") unless transition
+          to_state = transition.to
           
           from_state.exit(self)
           transition.fire_event(self, args)
           to_state.enter(self)
-          Machine.set_current_state_name(self, to_name)
-          true # at the moment always return true ... as soon as we have guards or thelike this could be false as well 
+          Machine.set_current_state_name(self, to_state.name)
+          true
+          
+          
+          
+          #to_state = machine.states[to_name]
+          #transition = from_state.transitions[to_name]
+          #raise InvalidStateTransition.new("No transition defined from #{from_name} -> #{to_name}") unless transition
+          
+          #from_state.exit(self)
+          #transition.fire_event(self, args)
+          #to_state.enter(self)
+          #Machine.set_current_state_name(self, to_name)
+          #true # at the moment always return true ... as soon as we have guards or thelike this could be false as well 
         end
       end
     end

data/test/invoice_sample_test.rb

@@ -26,7 +26,7 @@ class Invoice
   end
 end
 
-class InvoiceTest < Test::Unit::TestCase
+class InvoiceSampleTest < Test::Unit::TestCase
   context 'Invoice' do
     
     should 'Initial State is the first state defined unless no initial() call was made' do

data/test/water_sample_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class Water
+  attr_accessor(:state_of_material)
+  include FSM
+  define_fsm do
+    # now define all the states
+    # you can add :enter / :exit callbacks (callback can be a String, Symbol or Proc)
+    # these callbacks are triggered on any transition from/to this state and do not receive any arguments
+    state(:gas)
+    state(:liquid)
+    state(:solid, :enter => :on_enter_solid, :exit => :on_exit_solid)
+    
+    # define all valid transitions (name, from, to). This will define a method with the given name.
+    # you can define :event callback which is called only on this transition and receives the arguments passed to the
+    # transition method
+    transition(:heat_up, :solid, :liquid)
+    transition(:heat_up, :liquid, :gas)
+    transition(:cool_down, :gas, :liquid)
+    transition(:cool_down, :liquid, :solid)
+    
+    # define the attribute which is used to store the state (defaults to :state)
+    state_attribute(:state_of_material)
+    
+    # define the initial state (defaults to the first state defined - :gas in this sample)
+    initial(:solid)
+  end
+  private
+  def on_enter_solid()
+  end
+  def on_exit_solid()
+  end
+  
+end
+
+class WaterSampleTest < Test::Unit::TestCase
+  context 'Water' do
+    
+    should 'cycle through material states' do
+      w = Water.new
+      assert_equal(:solid, w.state_of_material)
+      w.heat_up
+      assert_equal(:liquid, w.state_of_material)
+      w.heat_up
+      assert_equal(:gas, w.state_of_material)
+      w.cool_down
+      assert_equal(:liquid, w.state_of_material)
+      w.cool_down
+      assert_equal(:solid, w.state_of_material)
+      
+      assert_raise(FSM::InvalidStateTransition) do
+        w.cool_down
+      end
+    end
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplificator-fsm
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - simplificator
@@ -21,10 +21,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - lib/fsm.rb
@@ -41,6 +41,7 @@ files:
 - test/state_test.rb
 - test/test_helper.rb
 - test/transition_test.rb
+- test/water_sample_test.rb
 has_rdoc: true
 homepage: http://github.com/simplificator/fsm
 post_install_message: 
@@ -74,3 +75,4 @@ test_files:
 - test/state_test.rb
 - test/test_helper.rb
 - test/transition_test.rb
+- test/water_sample_test.rb

data/README.rdoc

@@ -1,7 +0,0 @@
-= fsm
-
-FSM is a simple finite state machine
-
-== Copyright
-
-Copyright (c) 2009 simplificator GmbH. See LICENSE for details.