state_machine 1.1.2 → 1.2.0

data/test/unit/node_collection_test.rb

@@ -109,13 +109,13 @@ class NodeCollectionWithoutIndicesTest < Test::Unit::TestCase
   end
   
   def test_should_not_allow_lookup
-    @collection << object = Object.new
+    @collection << Object.new
     exception = assert_raise(ArgumentError) { @collection[0] }
     assert_equal 'No indices configured', exception.message
   end
   
   def test_should_not_allow_fetching
-    @collection << object = Object.new
+    @collection << Object.new
     exception = assert_raise(ArgumentError) { @collection.fetch(0) }
     assert_equal 'No indices configured', exception.message
   end

data/test/unit/path_test.rb

@@ -240,7 +240,7 @@ class PathWithGuardedTransitionsTest < Test::Unit::TestCase
   def test_should_not_walk_transitions_if_guard_enabled
     path = StateMachine::Path.new(@object, @machine)
     path.concat([
-      ignite_transition = StateMachine::Transition.new(@object, @machine, :ignite, :parked, :idling)
+      StateMachine::Transition.new(@object, @machine, :ignite, :parked, :idling)
     ])
     
     paths = []

data/test/unit/state_test.rb

@@ -115,6 +115,10 @@ class StateWithoutNameTest < Test::Unit::TestCase
   def test_should_have_a_description
     assert_equal 'nil', @state.description
   end
+  
+  def test_should_have_a_description_using_human_name
+    assert_equal 'nil', @state.description(:human_name => true)
+  end
 end
 
 class StateWithNameTest < Test::Unit::TestCase
@@ -149,6 +153,11 @@ class StateWithNameTest < Test::Unit::TestCase
     assert_equal 'parked', @state.description
   end
   
+  def test_should_allow_using_human_name_in_description
+    @state.human_name = 'Parked'
+    assert_equal 'Parked', @state.description(:human_name => true)
+  end
+  
   def test_should_define_predicate
     assert @klass.new.respond_to?(:parked?)
   end
@@ -177,6 +186,11 @@ class StateWithNilValueTest < Test::Unit::TestCase
     assert_equal 'parked (nil)', @state.description
   end
   
+  def test_should_have_a_description_with_human_name
+    @state.human_name = 'Parked'
+    assert_equal 'Parked (nil)', @state.description(:human_name => true)
+  end
+  
   def test_should_define_predicate
     object = @klass.new
     assert object.respond_to?(:parked?)
@@ -198,6 +212,11 @@ class StateWithSymbolicValueTest < Test::Unit::TestCase
     assert_equal 'parked', @state.description
   end
   
+  def test_should_allow_human_name_in_description
+    @state.human_name = 'Parked'
+    assert_equal 'Parked', @state.description(:human_name => true)
+  end
+  
   def test_should_match_symbolic_value
     assert @state.matches?(:parked)
     assert !@state.matches?('parked')
@@ -224,6 +243,11 @@ class StateWithIntegerValueTest < Test::Unit::TestCase
     assert_equal 'parked (1)', @state.description
   end
   
+  def test_should_allow_human_name_in_description
+    @state.human_name = 'Parked'
+    assert_equal 'Parked (1)', @state.description(:human_name => true)
+  end
+  
   def test_should_match_integer_value
     assert @state.matches?(1)
     assert !@state.matches?(2)
@@ -843,8 +867,9 @@ begin
         transition :parked => :idling
       end
       
-      graph = GraphViz.new('G')
-      @node = @state.draw(graph)
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph)
+      @node = graph.get_node('parked')
     end
     
     def test_should_use_ellipse_shape
@@ -859,10 +884,6 @@ begin
       assert_equal '1', @node['height'].to_s.gsub('"', '')
     end
     
-    def test_should_use_stringified_name_as_name
-      assert_equal 'parked', Gem::Version.new(Constants::RGV_VERSION) <= Gem::Version.new('0.9.11') ? @node.name : @node.id
-    end
-    
     def test_should_use_description_as_label
       assert_equal 'parked (1)', @node['label'].to_s.gsub('"', '')
     end
@@ -876,8 +897,9 @@ begin
         transition :parked => :idling
       end
       
-      @graph = GraphViz.new('G')
-      @node = @state.draw(@graph)
+      @graph = StateMachine::Graph.new('test')
+      @state.draw(@graph)
+      @node = @graph.get_node('parked')
     end
     
     def test_should_use_ellipse_as_shape
@@ -895,12 +917,13 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       @machine.states << @state = StateMachine::State.new(@machine, nil)
       
-      graph = GraphViz.new('G')
-      @node = @state.draw(graph)
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph)
+      @node = graph.get_node('nil')
     end
     
-    def test_should_use_stringified_nil_as_name
-      assert_equal 'nil', Gem::Version.new(Constants::RGV_VERSION) <= Gem::Version.new('0.9.11') ? @node.name : @node.id
+    def test_should_have_a_node
+      assert_not_nil @node
     end
     
     def test_should_use_description_as_label
@@ -913,12 +936,13 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       @machine.states << @state = StateMachine::State.new(@machine, :parked, :value => lambda {})
       
-      graph = GraphViz.new('G')
-      @node = @state.draw(graph)
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph)
+      @node = graph.get_node('parked')
     end
     
-    def test_should_use_stringified_name_as_name
-      assert_equal 'parked', Gem::Version.new(Constants::RGV_VERSION) <= Gem::Version.new('0.9.11') ? @node.name : @node.id
+    def test_should_have_a_node
+      assert_not_nil @node
     end
     
     def test_should_use_description_as_label
@@ -934,8 +958,9 @@ begin
         transition :parked => :idling
       end
       
-      graph = GraphViz.new('G')
-      @node = @state.draw(graph)
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph)
+      @node = graph.get_node('parked')
     end
     
     def test_should_use_ellipse_as_shape
@@ -948,14 +973,33 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       @machine.states << @state = StateMachine::State.new(@machine, :parked)
       
-      graph = GraphViz.new('G')
-      @node = @state.draw(graph)
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph)
+      @node = graph.get_node('parked')
     end
     
     def test_should_use_doublecircle_as_shape
       assert_equal 'doublecircle', @node['shape'].to_s.gsub('"', '')
     end
   end
+  
+  class StateDrawingWithHumanNameTest < Test::Unit::TestCase
+    def setup
+      @machine = StateMachine::Machine.new(Class.new)
+      @machine.states << @state = StateMachine::State.new(@machine, :parked, :human_name => 'Parked')
+      @machine.event :ignite do
+        transition :parked => :idling
+      end
+      
+      graph = StateMachine::Graph.new('test')
+      @state.draw(graph, :human_name => true)
+      @node = graph.get_node('parked')
+    end
+    
+    def test_should_use_description_with_human_name_as_label
+      assert_equal 'Parked', @node['label'].to_s.gsub('"', '')
+    end
+  end
 rescue LoadError
-  $stderr.puts 'Skipping GraphViz StateMachine::State tests. `gem install ruby-graphviz` >= v0.9.0 and try again.'
+  $stderr.puts 'Skipping GraphViz StateMachine::State tests. `gem install ruby-graphviz` >= v0.9.17 and try again.'
 end unless ENV['TRAVIS']

data/test/unit/transition_collection_test.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 class TransitionCollectionTest < Test::Unit::TestCase
   def test_should_raise_exception_if_invalid_option_specified
     exception = assert_raise(ArgumentError) {StateMachine::TransitionCollection.new([], :invalid => true)}
-    
+    assert_equal 'Invalid key(s): invalid', exception.message
   end
   
   def test_should_raise_exception_if_multiple_transitions_for_same_attribute_specified
@@ -107,12 +107,14 @@ class TransitionCollectionPartialInvalidTest < Test::Unit::TestCase
       attr_accessor :ran_transaction
     end
     
+    @callbacks = []
+    
     @machine = StateMachine::Machine.new(@klass, :initial => :parked)
     @machine.state :idling
     @machine.event :ignite
-    @machine.before_transition {@ran_before = true}
-    @machine.after_transition {@ran_after = true}
-    @machine.around_transition {|block| @ran_around_before = true; block.call; @ran_around_after = true}
+    @machine.before_transition {@callbacks << :before}
+    @machine.after_transition {@callbacks << :after}
+    @machine.around_transition {|block| @callbacks << :around_before; block.call; @callbacks << :around_after}
     
     class << @machine
       def within_transaction(object)
@@ -147,7 +149,7 @@ class TransitionCollectionPartialInvalidTest < Test::Unit::TestCase
   end
   
   def test_should_not_run_before_callbacks
-    assert !@ran_before
+    assert !@callbacks.include?(:before)
   end
   
   def test_should_not_persist_states
@@ -155,15 +157,15 @@ class TransitionCollectionPartialInvalidTest < Test::Unit::TestCase
   end
   
   def test_should_not_run_after_callbacks
-    assert !@ran_after
+    assert !@callbacks.include?(:after)
   end
   
   def test_should_not_run_around_callbacks_before_yield
-    assert !@ran_around_before
+    assert !@callbacks.include?(:around_before)
   end
   
   def test_should_not_run_around_callbacks_after_yield
-    assert !@ran_around_after
+    assert !@callbacks.include?(:around_after)
   end
 end
 
@@ -173,6 +175,7 @@ class TransitionCollectionValidTest < Test::Unit::TestCase
       attr_reader :persisted
       
       def initialize
+        @persisted = nil
         super
         @persisted = []
       end
@@ -557,6 +560,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_not_halt_if_action_fails_for_first_transition
     @klass.class_eval do
+      remove_method :save_state
       def save_state
         (@actions ||= []) << :save_state
         false
@@ -570,6 +574,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_halt_if_action_fails_for_second_transition
     @klass.class_eval do
+      remove_method :save_status
       def save_status
         (@actions ||= []) << :save_status
         false
@@ -582,6 +587,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_rollback_if_action_errors_for_first_transition
     @klass.class_eval do
+      remove_method :save_state
       def save_state
         raise ArgumentError
       end
@@ -594,6 +600,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_rollback_if_action_errors_for_second_transition
     @klass.class_eval do
+      remove_method :save_status
       def save_status
         raise ArgumentError
       end
@@ -606,6 +613,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_not_run_after_callbacks_if_action_fails_for_first_transition
     @klass.class_eval do
+      remove_method :save_state
       def save_state
         false
       end
@@ -623,6 +631,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_not_run_after_callbacks_if_action_fails_for_second_transition
     @klass.class_eval do
+      remove_method :save_status
       def save_status
         false
       end
@@ -640,6 +649,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_run_after_failure_callbacks_if_action_fails_for_first_transition
     @klass.class_eval do
+      remove_method :save_state
       def save_state
         false
       end
@@ -655,6 +665,7 @@ class TransitionCollectionWithDifferentActionsTest < Test::Unit::TestCase
   
   def test_should_run_after_failure_callbacks_if_action_fails_for_second_transition
     @klass.class_eval do
+      remove_method :save_status
       def save_status
         false
       end
@@ -979,7 +990,7 @@ class TransitionCollectionWithCallbacksTest < Test::Unit::TestCase
       
       def state=(value)
         @state = value
-        @saved_on_persist = @saved
+        @saved_on_persist = saved
       end
     end
     
@@ -994,7 +1005,7 @@ class TransitionCollectionWithCallbacksTest < Test::Unit::TestCase
       
       def state=(value)
         @state = value
-        @saved_on_persist = @saved
+        @saved_on_persist = saved
       end
     end
     
@@ -1112,10 +1123,12 @@ class TransitionCollectionWithSkippedAfterCallbacksTest < Test::Unit::TestCase
   def setup
     @klass = Class.new
     
+    @callbacks = []
+    
     @machine = StateMachine::Machine.new(@klass, :initial => :parked)
     @machine.state :idling
     @machine.event :ignite
-    @machine.after_transition {@ran_after = true}
+    @machine.after_transition {@callbacks << :after}
     
     @object = @klass.new
     
@@ -1130,24 +1143,26 @@ class TransitionCollectionWithSkippedAfterCallbacksTest < Test::Unit::TestCase
   end
   
   def test_should_not_run_after_callbacks
-    assert !@ran_after
+    assert !@callbacks.include?(:after)
   end
   
   def test_should_run_after_callbacks_on_subsequent_perform
     StateMachine::TransitionCollection.new([@transition]).perform
-    assert @ran_after
+    assert @callbacks.include?(:after)
   end
 end
 
-if RUBY_PLATFORM != 'java'
+if StateMachine::Transition.pause_supported?
   class TransitionCollectionWithSkippedAfterCallbacksAndAroundCallbacksTest < Test::Unit::TestCase
     def setup
       @klass = Class.new
       
+      @callbacks = []
+      
       @machine = StateMachine::Machine.new(@klass, :initial => :parked)
       @machine.state :idling
       @machine.event :ignite
-      @machine.around_transition {|block| @ran_around_before = true; block.call; @ran_around_after = true}
+      @machine.around_transition {|block| @callbacks << :around_before; block.call; @callbacks << :around_after}
       
       @object = @klass.new
       
@@ -1162,19 +1177,19 @@ if RUBY_PLATFORM != 'java'
     end
     
     def test_should_not_run_around_callbacks_after_yield
-      assert !@ran_around_after
+      assert !@callbacks.include?(:around_after)
     end
     
     def test_should_run_around_callbacks_after_yield_on_subsequent_perform
       StateMachine::TransitionCollection.new([@transition]).perform
-      assert @ran_around_after
+      assert @callbacks.include?(:around_after)
     end
     
     def test_should_not_rerun_around_callbacks_before_yield_on_subsequent_perform
-      @ran_around_before = false
+      @callbacks = []
       StateMachine::TransitionCollection.new([@transition]).perform
       
-      assert !@ran_around_before
+      assert !@callbacks.include?(:around_before)
     end
   end
 else
@@ -1182,10 +1197,12 @@ else
     def setup
       @klass = Class.new
       
+      @callbacks = []
+      
       @machine = StateMachine::Machine.new(@klass, :initial => :parked)
       @machine.state :idling
       @machine.event :ignite
-      @machine.around_transition {|block| @ran_around_before = true; block.call; @ran_around_after = true}
+      @machine.around_transition {|block| @callbacks << :around_before; block.call; @callbacks << :around_after}
       
       @object = @klass.new
       
@@ -1453,6 +1470,7 @@ class TransitionCollectionWithActionHookMultipleTest < TransitionCollectionWithA
     @klass.class_eval do
       attr_reader :status_on_save, :status_event_on_save, :status_event_transition_on_save
       
+      remove_method :save
       def save
         @saved = true
         @state_on_save = state
@@ -1522,6 +1540,7 @@ class TransitionCollectionWithActionHookErrorTest < TransitionCollectionWithActi
     super
     
     @superclass.class_eval do
+      remove_method :save
       def save
         raise ArgumentError
       end
@@ -1767,7 +1786,8 @@ class AttributeTransitionCollectionWithCallbacksTest < Test::Unit::TestCase
     @state.around_transition {|object, transition, block| block.call; @around_state_event = object.state_event }
     @transitions.perform
     
-    assert_nil @state_event
+    assert_nil @after_state_event
+    assert_nil @around_state_event
   end
   
   def test_should_not_have_event_transitions_during_before_callbacks
@@ -2046,7 +2066,7 @@ class AttributeTransitionCollectionWithAroundCallbackAfterYieldHaltTest < Test::
   end
 end
 
-class AttributeTransitionCollectionWithAfterCallbackErrorTest < Test::Unit::TestCase
+class AttributeTransitionCollectionWithAroundCallbackAfterYieldErrorTest < Test::Unit::TestCase
   def setup
     @klass = Class.new
     
@@ -2117,7 +2137,7 @@ class AttributeTransitionCollectionMarshallingTest < Test::Unit::TestCase
     end
   end
   
-  if RUBY_PLATFORM != 'java'
+  if StateMachine::Transition.pause_supported?
     def test_should_marshal_during_around_callbacks_before_yield
       @machine.around_transition {|object, transition, block| Marshal.dump(object); block.call}
       assert_nothing_raised do