@@ -3,9 +3,7 @@ * Things to do: ** Machine#state=(String|Array). -** Trigger State#enter and State#exit on superstates for transitions between Substates with disjoint superstates. ** Add :elapsed_time to history Hash - has performance implication. -** Use UML nomenclature for can_transition?, before_transition!, after_transition!: i.e.: :guard and triggers (enter, exit). ** Support Statemachine#freeze to avoid accidental changes to a running Statemachine. * Jeremy's Comments: TODO @@ -26,7 +26,7 @@ module RedSteak # * guard(machine, trans, *args) # * effect(machine, trans, *args) # - # * enter(machine, state, *args) + # * entry(machine, state, *args) # * exit(machine, state, *args) # * doActivity(machine, state, *args) # @@ -287,7 +287,7 @@ module RedSteak # 1) Transition's effect behavior is performed. # 2) Old State's exit behavior is performed. # 3) transition history is logged. - # 4) New State's enter behavior is performed. + # 4) New State's entry behavior is performed. # 5) New State's doAction behavior is performed. # def execute_transition! trans, *args @@ -337,7 +337,7 @@ module RedSteak # # 1) Performs old State's exit behavior. # 2) If a block is given, yield to it after entering new state. - # 3) Performs new State's enter behavior. + # 3) Performs new State's entry behavior. # def _goto_state! state, args old_state = @state @@ -367,11 +367,11 @@ module RedSteak # Yield to block. yield if block_given? - # Behavior: enter state. + # Behavior: entry state. if old_state != state (to - from).reverse.each do | s | - _log "enter! #{s.inspect}" - s.enter!(self, args) + _log "entry! #{s.inspect}" + s.entry!(self, args) end end lib/red_steak/machine.rb @@ -8,21 +8,21 @@ module RedSteak attr_accessor :state_type # NOT UML AT ALL # The behavior executed upon entry to the transtion. - attr_accessor :enter - - # The behavior executed when it is transitioned into. - attr_accessor :doActivity + attr_accessor :entry # The behavior executed when it is transitioned out of. attr_accessor :exit + # The behavior executed when it is transitioned into. + attr_accessor :doActivity + # This state's submachine, or nil. attr_accessor :submachine # UML def initialize opts = { } @state_type = nil - @enter = nil + @entry = nil @doActivity = nil @exit = nil @submachine = nil @@ -130,8 +130,8 @@ module RedSteak # Called by Machine when State is entered. - def enter! machine, args - _behavior! :enter, machine, args + def entry! machine, args + _behavior! :entry, machine, args end lib/red_steak/state.rb @@ -12,7 +12,7 @@ describe RedSteak do attr_accessor :_transition, :_guard, :_effect # State Behaviors: - attr_accessor :_state, :_enter, :_exit, :_doActivity + attr_accessor :_state, :_entry, :_exit, :_doActivity attr_accessor :_a_to_b @@ -33,7 +33,7 @@ describe RedSteak do @_guard = [ ] @_effect = [ ] @_state = [ ] - @_enter = [ ] + @_entry = [ ] @_exit = [ ] @_doActivity = [ ] end @@ -63,12 +63,12 @@ describe RedSteak do _log end - # Called by State#enter! - def enter(machine, state, *args) + # Called by State#entry! + def entry(machine, state, *args) @_machine = machine @_state = state @_args = args - @_enter << [ state.to_s, *args ] + @_entry << [ state.to_s, *args ] _log end @@ -121,7 +121,7 @@ describe RedSteak do :name => :a_to_b, :guard => :a_to_b? - # state :q, :enter_state => :entering_q + # state :q, :entry_state => :entrying_q state :b transition :c @@ -304,7 +304,7 @@ describe RedSteak do c._transition.should == nil c._guard.should == [ ] c._effect.should == [ ] - c._enter.should == [ [ "a" ] ] + c._entry.should == [ [ "a" ] ] c._exit.should == [ ] c._doActivity.should == [ [ "a" ] ] m.history.size.should == 1 @@ -327,7 +327,7 @@ describe RedSteak do c._a_to_b.should == [ :arg1 ] c._effect.should == [ [ :arg1 ] ] c._state.name.should == :b - c._enter.should == [ [ "b", :arg1 ] ] + c._entry.should == [ [ "b", :arg1 ] ] c._exit.should == [ [ "a", :arg1 ] ] c._doActivity.should == [ [ "b", :arg1 ] ] m.history.size.should == 2 @@ -510,7 +510,7 @@ describe RedSteak do m.state.name.should == :a c._machine.should == m c._state.name.should == :a - c._enter.should == [ [ "a", :foo, :bar ] ] + c._entry.should == [ [ "a", :foo, :bar ] ] c._exit.should == [ ] render_graph m, :show_history => true @@ -609,27 +609,27 @@ describe RedSteak do c.clear! m.start! c._exit.should == [ ] - c._enter.should == [ [ "a" ], [ "a::a" ] ] + c._entry.should == [ [ "a" ], [ "a::a" ] ] c.clear! m.transition_to! "b" c._exit.should == [["a::a"], ["a"]] - c._enter.should == [ [ "b" ], [ "b::a" ] ] + c._entry.should == [ [ "b" ], [ "b::a" ] ] c.clear! m.transition_to! "b::b" c._exit.should == [["b::a"]] - c._enter.should == [["b::b"]] + c._entry.should == [["b::b"]] c.clear! m.transition_to! "a::b" c._exit.should == [["b::b"], ["b"]] - c._enter.should == [["a"], ["a::b"]] + c._entry.should == [["a"], ["a::b"]] c.clear! m.transition_to! "c" c._exit.should == [["a::b"], ["a"]] - c._enter.should == [["c"]] + c._entry.should == [["c"]] render_graph m, :show_history => true test/red_steak.spec 59bdbe3cf423936f5ffb6cf905422ceb9d4d585c Kurt Stephens ks.github@kurtstephens.com http://github.com/kstephens/red_steak/commit/1bdd51a3216fb5cc8e5d3403412d946674cba6b7 1bdd51a3216fb5cc8e5d3403412d946674cba6b7 2008-12-30T23:09:38-08:00 2008-12-30T23:09:38-08:00 UML uses State#entry not State#enter. 483b8d66a357007ce5ee8b1ded1df6e500df5737 Kurt Stephens ks.github@kurtstephens.com