state_machine 0.7.1 → 0.7.2

data/test/unit/callback_test.rb

@@ -1,15 +1,23 @@
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 class CallbackTest < Test::Unit::TestCase
-  def test_should_raise_exception_if_do_option_not_specified
+  def test_should_raise_exception_if_no_methods_specified
     exception = assert_raise(ArgumentError) { StateMachine::Callback.new }
-    assert_equal ':do callback must be specified', exception.message
+    assert_equal 'Method(s) for callback must be specified', exception.message
   end
   
-  def test_should_not_raise_exception_if_do_option_specified
+  def test_should_not_raise_exception_if_method_specified_in_do_option
     assert_nothing_raised { StateMachine::Callback.new(:do => :run) }
   end
   
+  def test_should_not_raise_exception_if_method_specified_as_argument
+    assert_nothing_raised { StateMachine::Callback.new(:run) }
+  end
+  
+  def test_should_not_raise_exception_if_method_specified_as_block
+    assert_nothing_raised { StateMachine::Callback.new(:run) {} }
+  end
+  
   def test_should_not_raise_exception_if_implicit_option_specified
     assert_nothing_raised { StateMachine::Callback.new(:do => :run, :invalid => true) }
   end
@@ -25,9 +33,7 @@ end
 
 class CallbackByDefaultTest < Test::Unit::TestCase
   def setup
-    @object = Object.new
-    @method = lambda {|*args| args.unshift(self)}
-    @callback = StateMachine::Callback.new(:do => @method)
+    @callback = StateMachine::Callback.new(:do => lambda {})
   end
   
   def test_should_not_have_a_terminator
@@ -40,30 +46,154 @@ class CallbackByDefaultTest < Test::Unit::TestCase
     assert_equal StateMachine::AllMatcher.instance, @callback.guard.state_requirements.first[:to]
   end
   
-  def test_should_not_bind_to_the_object
-    assert_equal [self, @object], @callback.call(@object)
-  end
-  
   def test_should_not_have_any_known_states
     assert_equal [], @callback.known_states
   end
 end
 
-class CallbackWithOnlyMethodTest < Test::Unit::TestCase
+class CallbackWithMethodArgumentTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(lambda {|*args| @args = args})
+    
+    @object = Object.new
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
+  end
+  
+  def test_should_call_with_empty_context
+    assert_equal [@object], @args
+  end
+end
+
+class CallbackWithMultipleMethodArgumentsTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(:run_1, :run_2)
+    
+    class << @object = Object.new
+      attr_accessor :callbacks
+      
+      def run_1
+        (@callbacks ||= []) << :run_1
+      end
+      
+      def run_2
+        (@callbacks ||= []) << :run_2
+      end
+    end
+    
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
+  end
+  
+  def test_should_call_each_callback_in_order
+    assert_equal [:run_1, :run_2], @object.callbacks
+  end
+end
+
+class CallbackWithDoMethodTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(:do => lambda {|*args| @args = args})
+    
+    @object = Object.new
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
+  end
+  
+  def test_should_call_with_empty_context
+    assert_equal [@object], @args
+  end
+end
+
+class CallbackWithMultipleDoMethodsTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(:do => [:run_1, :run_2])
+    
+    class << @object = Object.new
+      attr_accessor :callbacks
+      
+      def run_1
+        (@callbacks ||= []) << :run_1
+      end
+      
+      def run_2
+        (@callbacks ||= []) << :run_2
+      end
+    end
+    
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
+  end
+  
+  def test_should_call_each_callback_in_order
+    assert_equal [:run_1, :run_2], @object.callbacks
+  end
+end
+
+class CallbackWithBlockTest < Test::Unit::TestCase
   def setup
+    @callback = StateMachine::Callback.new do |*args|
+      @args = args
+    end
+    
     @object = Object.new
-    @callback = StateMachine::Callback.new(lambda {true})
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
   end
   
   def test_should_call_with_empty_context
-    assert @callback.call(@object)
+    assert_equal [@object], @args
+  end
+end
+
+class CallbackWithMixedMethodsTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(:run_argument, :do => :run_do) do |object|
+      object.callbacks << :block
+    end
+    
+    class << @object = Object.new
+      attr_accessor :callbacks
+      
+      def run_argument
+        (@callbacks ||= []) << :argument
+      end
+      
+      def run_do
+        (@callbacks ||= []) << :do
+      end
+    end
+    
+    @result = @callback.call(@object)
+  end
+  
+  def test_should_be_successful
+    assert @result
+  end
+  
+  def test_should_call_each_callback_in_order
+    assert_equal [:argument, :do, :block], @object.callbacks
   end
 end
 
 class CallbackWithExplicitRequirementsTest < Test::Unit::TestCase
   def setup
     @object = Object.new
-    @callback = StateMachine::Callback.new(:from => :parked, :to => :idling, :on => :ignite, :do => lambda {true})
+    @callback = StateMachine::Callback.new(:from => :parked, :to => :idling, :on => :ignite, :do => lambda {})
   end
   
   def test_should_call_with_empty_context
@@ -94,7 +224,7 @@ end
 class CallbackWithImplicitRequirementsTest < Test::Unit::TestCase
   def setup
     @object = Object.new
-    @callback = StateMachine::Callback.new(:parked => :idling, :on => :ignite, :do => lambda {true})
+    @callback = StateMachine::Callback.new(:parked => :idling, :on => :ignite, :do => lambda {})
   end
   
   def test_should_call_with_empty_context
@@ -128,12 +258,12 @@ class CallbackWithIfConditionTest < Test::Unit::TestCase
   end
   
   def test_should_call_if_true
-    callback = StateMachine::Callback.new(:if => lambda {true}, :do => lambda {true})
+    callback = StateMachine::Callback.new(:if => lambda {true}, :do => lambda {})
     assert callback.call(@object)
   end
   
   def test_should_not_call_if_false
-    callback = StateMachine::Callback.new(:if => lambda {false}, :do => lambda {true})
+    callback = StateMachine::Callback.new(:if => lambda {false}, :do => lambda {})
     assert !callback.call(@object)
   end
 end
@@ -144,12 +274,12 @@ class CallbackWithUnlessConditionTest < Test::Unit::TestCase
   end
   
   def test_should_call_if_false
-    callback = StateMachine::Callback.new(:unless => lambda {false}, :do => lambda {true})
+    callback = StateMachine::Callback.new(:unless => lambda {false}, :do => lambda {})
     assert callback.call(@object)
   end
   
   def test_should_not_call_if_true
-    callback = StateMachine::Callback.new(:unless => lambda {true}, :do => lambda {true})
+    callback = StateMachine::Callback.new(:unless => lambda {true}, :do => lambda {})
     assert !callback.call(@object)
   end
 end
@@ -171,73 +301,111 @@ class CallbackWithTerminatorTest < Test::Unit::TestCase
   end
   
   def test_should_not_halt_if_terminator_does_not_match
-    callback = StateMachine::Callback.new(:do => lambda {false}, :terminator => lambda {|result| false})
+    callback = StateMachine::Callback.new(:do => lambda {false}, :terminator => lambda {|result| result == true})
     assert_nothing_thrown { callback.call(@object) }
   end
   
   def test_should_halt_if_terminator_matches
-    callback = StateMachine::Callback.new(:do => lambda {false}, :terminator => lambda {|result| true})
+    callback = StateMachine::Callback.new(:do => lambda {false}, :terminator => lambda {|result| result == false})
+    assert_throws(:halt) { callback.call(@object) }
+  end
+  
+  def test_should_halt_if_terminator_matches_any_method
+    callback = StateMachine::Callback.new(:do => [lambda {true}, lambda {false}], :terminator => lambda {|result| result == false})
     assert_throws(:halt) { callback.call(@object) }
   end
 end
 
 class CallbackWithoutArgumentsTest < Test::Unit::TestCase
   def setup
+    @callback = StateMachine::Callback.new(:do => lambda {|object| @arg = object})
+    
     @object = Object.new
-    @callback = StateMachine::Callback.new(:do => lambda {|object| object})
+    @callback.call(@object, {}, 1, 2, 3)
   end
   
   def test_should_call_method_with_object_as_argument
-    assert_equal @object, @callback.call(@object, {}, 1, 2, 3)
+    assert_equal @object, @arg
   end
 end
 
 class CallbackWithArgumentsTest < Test::Unit::TestCase
   def setup
+    @callback = StateMachine::Callback.new(:do => lambda {|*args| @args = args})
+    
     @object = Object.new
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| args})
+    @callback.call(@object, {}, 1, 2, 3)
   end
   
   def test_should_call_method_with_all_arguments
-    assert_equal [@object, 1, 2, 3], @callback.call(@object, {}, 1, 2, 3)
+    assert_equal [@object, 1, 2, 3], @args
   end
 end
 
-class CallbackWithUnboundObjectTest < Test::Unit::TestCase
+class CallbackWithUnboundMethodTest < Test::Unit::TestCase
   def setup
+    @callback = StateMachine::Callback.new(:do => lambda {|*args| @context = args.unshift(self)})
+    
     @object = Object.new
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| args.unshift(self)})
+    @callback.call(@object, {}, 1, 2, 3)
   end
   
   def test_should_call_method_outside_the_context_of_the_object
-    assert_equal [self, @object, 1, 2, 3], @callback.call(@object, {}, 1, 2, 3)
+    assert_equal [self, @object, 1, 2, 3], @context
   end
 end
 
-class CallbackWithBoundObjectTest < Test::Unit::TestCase
+class CallbackWithBoundMethodTest < Test::Unit::TestCase
   def setup
     @object = Object.new
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| args.unshift(self)}, :bind_to_object => true)
   end
   
-  def test_should_call_method_within_the_context_of_the_object
-    assert_equal [@object, 1, 2, 3], @callback.call(@object, {}, 1, 2, 3)
+  def test_should_call_method_within_the_context_of_the_object_for_block_methods
+    context = nil
+    callback = StateMachine::Callback.new(:do => lambda {|*args| context = [self] + args}, :bind_to_object => true)
+    callback.call(@object, {}, 1, 2, 3)
+    
+    assert_equal [@object, 1, 2, 3], context
   end
   
-  def test_should_ignore_option_for_symbolic_callbacks
+  def test_should_ignore_option_for_symbolic_methods
     class << @object
+      attr_reader :context
+      
       def after_ignite(*args)
-        args
+        @context = args
       end
     end
     
-    @callback = StateMachine::Callback.new(:do => :after_ignite, :bind_to_object => true)
-    assert_equal [], @callback.call(@object)
+    callback = StateMachine::Callback.new(:do => :after_ignite, :bind_to_object => true)
+    callback.call(@object)
+    
+    assert_equal [], @object.context
   end
   
-  def test_should_ignore_option_for_string_callbacks
-    @callback = StateMachine::Callback.new(:do => '[1, 2, 3]', :bind_to_object => true)
-    assert_equal [1, 2, 3], @callback.call(@object)
+  def test_should_ignore_option_for_string_methods
+    callback = StateMachine::Callback.new(:do => '[1, 2, 3]', :bind_to_object => true)
+    assert callback.call(@object)
+  end
+end
+
+class CallbackWithMultipleBoundMethodsTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    
+    first_context = nil
+    second_context = nil
+    
+    @callback = StateMachine::Callback.new(:do => [lambda {first_context = self}, lambda {second_context = self}], :bind_to_object => true)
+    @callback.call(@object)
+    
+    @first_context = first_context
+    @second_context = second_context
+  end
+  
+  def test_should_call_each_method_within_the_context_of_the_object
+    assert_equal @object, @first_context
+    assert_equal @object, @second_context
   end
 end
 
@@ -246,12 +414,16 @@ class CallbackWithApplicationBoundObjectTest < Test::Unit::TestCase
     @original_bind_to_object = StateMachine::Callback.bind_to_object
     StateMachine::Callback.bind_to_object = true
     
+    context = nil
+    @callback = StateMachine::Callback.new(:do => lambda {|*args| context = self})
+    
     @object = Object.new
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| self})
+    @callback.call(@object)
+    @context = context
   end
   
   def test_should_call_method_within_the_context_of_the_object
-    assert_equal @object, @callback.call(@object)
+    assert_equal @object, @context
   end
   
   def teardown

data/test/unit/machine_collection_test.rb

@@ -319,10 +319,6 @@ class MachineCollectionFireImplicitWithInvalidEventTest < MachineCollectionFireI
   def test_should_not_reset_event_attribute
     assert_equal :invalid, @object.state_event
   end
-  
-  def test_should_not_have_event_transition
-    assert_nil @object.state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitWithoutTransitionTest < MachineCollectionFireImplicitTest
@@ -349,10 +345,6 @@ class MachineCollectionFireImplicitWithoutTransitionTest < MachineCollectionFire
   def test_should_not_reset_event_attribute
     assert_equal :ignite, @object.state_event
   end
-  
-  def test_should_not_have_event_transition
-    assert_nil @object.state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImplicitTest
@@ -360,12 +352,10 @@ class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImp
     super
     
     @state_event = nil
-    @state_event_transition = nil
     
     @object.state_event = 'ignite'
     @result = @machines.fire_attribute_events(@object, :save) do
       @state_event = @object.state_event
-      @state_event_transition = @object.state_event_transition
       @saved = true
     end
   end
@@ -382,10 +372,6 @@ class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImp
     assert_nil @state_event
   end
   
-  def test_should_not_have_event_transition_while_running_action
-    assert_nil @state_event_transition
-  end
-  
   def test_should_transition_state
     assert_equal 'idling', @object.state
   end
@@ -394,8 +380,9 @@ class MachineCollectionFireImplicitWithTransitionTest < MachineCollectionFireImp
     assert_nil @object.state_event
   end
   
-  def test_should_reset_event_transition
-    assert_nil @object.state_event_transition
+  def test_should_not_be_successful_if_fired_again
+    @object.state_event = 'ignite'
+    assert !@machines.fire_attribute_events(@object, :save) { true }
   end
 end
 
@@ -418,10 +405,6 @@ class MachineCollectionFireImplicitWithActionFailureTest < MachineCollectionFire
   def test_should_not_reset_event_attribute
     assert_equal :ignite, @object.state_event
   end
-  
-  def test_should_not_have_event_transition
-    assert_nil @object.state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitWithActionErrorTest < MachineCollectionFireImplicitTest
@@ -439,10 +422,6 @@ class MachineCollectionFireImplicitWithActionErrorTest < MachineCollectionFireIm
   def test_should_not_reset_event_attribute
     assert_equal :ignite, @object.state_event
   end
-  
-  def test_should_not_have_event_transition
-    assert_nil @object.state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTest
@@ -455,12 +434,10 @@ class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTe
     @machine.after_transition { @ran_after_callback = true }
     
     @state_event = nil
-    @state_event_transition = nil
     
     @object.state_event = 'ignite'
     @result = @machines.fire_attribute_events(@object, :save, false) do
       @state_event = @object.state_event
-      @state_event_transition = @object.state_event_transition
       true
     end
   end
@@ -481,10 +458,6 @@ class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTe
     assert_nil @state_event
   end
   
-  def test_should_not_have_event_transition_while_running_action
-    assert_nil @state_event_transition
-  end
-  
   def test_should_transition_state
     assert_equal 'idling', @object.state
   end
@@ -493,29 +466,50 @@ class MachineCollectionFireImplicitPartialTest < MachineCollectionFireImplicitTe
     assert_equal :ignite, @object.state_event
   end
   
-  def test_should_have_event_transition
-    assert_not_nil @object.state_event_transition
-  end
-  
   def test_should_reset_event_attributes_after_next_fire_on_success
     assert @machines.fire_attribute_events(@object, :save) { true }
     assert_equal 'idling', @object.state
     assert_nil @object.state_event
-    assert_nil @object.state_event_transition
+  end
+  
+  def test_should_guard_transition_after_next_fire_on_success
+    @machines.fire_attribute_events(@object, :save) { true }
+    
+    @object.state = 'idling'
+    @object.state_event = 'ignite'
+    assert !@machines.fire_attribute_events(@object, :save) { true }
   end
   
   def test_should_rollback_all_attributes_after_next_fire_on_failure
     assert !@machines.fire_attribute_events(@object, :save) { false }
     assert_equal 'parked', @object.state
     assert_equal :ignite, @object.state_event
-    assert_nil @object.state_event_transition
+    
+    @object.state = 'idling'
+    assert !@machines.fire_attribute_events(@object, :save) { false }
+  end
+  
+  def test_should_guard_transition_after_next_fire_on_failure
+    @machines.fire_attribute_events(@object, :save) { false }
+    
+    @object.state = 'idling'
+    assert !@machines.fire_attribute_events(@object, :save) { true }
   end
   
   def test_should_rollback_all_attributes_after_next_fire_on_error
     assert_raise(ArgumentError) { @machines.fire_attribute_events(@object, :save) { raise ArgumentError } }
     assert_equal 'parked', @object.state
     assert_equal :ignite, @object.state_event
-    assert_nil @object.state_event_transition
+  end
+  
+  def test_should_guard_transition_after_next_fire_on_error
+    begin
+      @machines.fire_attribute_events(@object, :save) { raise ArgumentError }
+    rescue ArgumentError
+    end
+    
+    @object.state = 'idling'
+    assert !@machines.fire_attribute_events(@object, :save) { true }
   end
 end
 
@@ -547,10 +541,6 @@ class MachineCollectionFireImplicitNestedPartialTest < MachineCollectionFireImpl
   def test_should_reset_event_attribute
     assert_nil @object.state_event
   end
-  
-  def test_should_not_have_event_transition
-    assert_nil @object.state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitWithDifferentActionsTest < MachineCollectionFireImplicitTest
@@ -613,11 +603,6 @@ class MachineCollectionFireImplicitWithSameActionsTest < MachineCollectionFireIm
     assert_nil @object.state_event
     assert_nil @object.alarm_state_event
   end
-  
-  def test_should_reset_all_event_transitions_for_action
-    assert_nil @object.state_event_transition
-    assert_nil @object.alarm_state_event_transition
-  end
 end
 
 class MachineCollectionFireImplicitWithValidationsTest < Test::Unit::TestCase