statemachine 0.0.2 → 0.0.3

data/CHANGES

@@ -1,5 +1,15 @@
 = StateMachine Changelog
 
+== Version 0.0.3
+
+Bug fix dealing with entry and exit actions.  The state machine's state need to be set to the entered/exited state before calling the 
+exit/entry action.
+* added a couple specs in the exit_entry_spec
+* modified state.entered/exited methods to set the state
+* modifed the StateMachine.state to accept state objects.
+* removed running attribute from StateMachine because it wasn't much use
+* also removed the nil (end state)
+
 == Version 0.0.2
 
 More conventional file structure

data/lib/statemachine/state.rb

@@ -41,15 +41,21 @@ module StateMachine
     
     def exit(args)
       @statemachine.trace("\texiting #{self}")
+      activate
       call_proc(@exit_action, args, "exit action for #{self}") if @exit_action
       @superstate.existing(self) if @superstate
     end
 
     def enter(args)
       @statemachine.trace("\tentering #{self}")
+      activate
       call_proc(@entry_action, args, "entry action for #{self}") if @entry_action
     end
     
+    def activate
+      @statemachine.state = self
+    end
+    
     def is_superstate?
       return false
     end

data/lib/statemachine/state_machine.rb

@@ -15,7 +15,7 @@ module StateMachine
     
     include ProcCalling
   
-    attr_reader :states, :state, :running
+    attr_reader :states, :state
     attr_accessor :start_state, :tracer
   
     def initialize
@@ -34,7 +34,6 @@ module StateMachine
   
     def run
       @state = @start_state
-      @running = true
     end
     alias :reset :run
   
@@ -43,7 +42,9 @@ module StateMachine
     end
     
     def state= value
-      if @states[value]
+      if value.is_a? State
+        @state = value
+      elsif @states[value]
         @state = @states[value]
       elsif value and @states[value.to_sym]
         @state = @states[value.to_sym]
@@ -55,11 +56,10 @@ module StateMachine
       if @state
         transition = @state.transitions[event]
         if transition
-          @state = transition.invoke(@state, args)
+          transition.invoke(@state, args)
         else
           raise MissingTransitionException.new("#{@state} does not respond to the '#{event}' event.")
         end
-        @running = @state != nil
       else
         raise StateMachineException.new("The state machine isn't in any state.  Did you forget to call run?")
       end

data/lib/statemachine/transition.rb

@@ -29,8 +29,6 @@ module StateMachine
         terminal_state = terminal_state.start_state
         terminal_state.enter(args)
       end
-      
-      return terminal_state
     end
     
     def exits_and_entries(origin)

data/lib/statemachine/version.rb

@@ -3,7 +3,7 @@ module StateMachine
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 0
-      TINY   = 2
+      TINY   = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       TAG    = "REL_" + [MAJOR, MINOR, TINY].join('_')

data/spec/sm_entry_exit_actions_spec.rb

@@ -44,6 +44,35 @@ context "State Machine Entry and Exit Actions" do
       @log.join(",").should_equal "exited_off(one),on,entered_on(one,two)"
   end
 
+  specify "current state is set prior to exit and entry actions" do
+    @sm[:off].on_exit Proc.new { @log << @sm.state.id }
+    @sm[:on].on_entry Proc.new { @log << @sm.state.id }
+    
+    @sm.toggle
+    
+    @log.join(",").should_equal "off,on,on"  
+  end
+
+  specify "current state is set prior to exit and entry actions even with super states" do
+    @sm.add(:off_super, :toggle, :on, Proc.new { @log << "super_on" } )
+    @sm.add(:on_super, :toggle, :off, Proc.new { @log << "super_off" } )
+    @sm[:off_super].add_substates(:off)
+    @sm[:on_super].add_substates(:on)
+    @sm[:off_super].on_exit Proc.new { @log << @sm.state.id }
+    @sm[:on_super].on_entry Proc.new { @log << @sm.state.id }
+
+    @sm.toggle
+    @log.join(",").should_equal "off_super,super_on,on_super"  
+  end
+
+  specify "entry actions invokes another event" do
+    @sm[:on].on_entry Proc.new { @sm.toggle }
+    
+    @sm.toggle
+    @log.join(",").should_equal "on,off"
+    @sm.state.id.should_be :off
+  end
+
   
   
 end

data/spec/sm_simple_spec.rb

@@ -25,16 +25,6 @@ context "simple cases:" do
     transition = origin[:flip]
     check_transition(transition, :on, :off, :flip, @proc)
   end
-  
-  specify "end state" do
-    @sm.add(:start, :blah, nil, @proc)
-    
-    @sm.run
-    @sm.running.should.be true
-    @sm.process_event(:blah)
-    @sm.state.should.be nil
-    @sm.running.should.be false;
-  end
 
   specify "reset" do
     @sm.add(:start, :blah, nil, @proc)
@@ -44,7 +34,6 @@ context "simple cases:" do
     @sm.reset
     
     @sm.state.should.be @sm[:start]
-    @sm.running.should.be true
   end
   
   specify "exception when state machine is not running" do

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: statemachine
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-10-25 00:00:00 -05:00
-summary: StateMachine-0.0.2 - State Machine Library for Ruby http://statemachine.rubyforge.org/
+  version: 0.0.3
+date: 2006-10-26 00:00:00 -05:00
+summary: StateMachine-0.0.3 - State Machine Library for Ruby http://statemachine.rubyforge.org/
 require_paths: 
 - lib
 email: statemachine-devel@rubyforge.org