state_machine 0.8.1 → 0.9.0

data/lib/tasks/state_machine.rb

@@ -1,9 +1,18 @@
 namespace :state_machine do
   desc 'Draws a set of state machines using GraphViz. Target files to load with FILE=x,y,z; Machine class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
   task :draw do
-    # Load the library
-    $:.unshift(File.dirname(__FILE__) + '/..')
-    require 'state_machine'
+    if defined?(Rails)
+      Rake::Task['environment'].invoke
+    elsif defined?(Merb)
+      Rake::Task['merb_env'].invoke
+      
+      # Fix ruby-graphviz being incompatible with Merb's process title
+      $0 = 'rake'
+    else
+      # Load the library
+      $:.unshift(File.dirname(__FILE__) + '/..')
+      require 'state_machine'
+    end
     
     # Build drawing options
     options = {}
@@ -15,16 +24,4 @@ namespace :state_machine do
     
     StateMachine::Machine.draw(ENV['CLASS'], options)
   end
-  
-  namespace :draw do
-    desc 'Draws a set of state machines using GraphViz for a Ruby on Rails application.  Target class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
-    task :rails => [:environment, 'state_machine:draw']
-    
-    desc 'Draws a set of state machines using GraphViz for a Merb application.  Target class with CLASS=x,y,z; Font name with FONT=x; Image format with FORMAT=x; Orientation with ORIENTATION=x'
-    task :merb => [:merb_env] do
-      # Fix ruby-graphviz being incompatible with Merb's process title
-      $0 = 'rake'
-      Rake::Task['state_machine:draw'].invoke
-    end
-  end
 end

data/test/functional/state_machine_test.rb

@@ -40,7 +40,7 @@ class ModelBase
 end
 
 class Vehicle < ModelBase
-  attr_accessor :auto_shop, :seatbelt_on, :insurance_premium, :force_idle, :callbacks, :saved
+  attr_accessor :auto_shop, :seatbelt_on, :insurance_premium, :force_idle, :callbacks, :saved, :time_elapsed
   
   def initialize(attributes = {})
     attributes = {
@@ -68,6 +68,12 @@ class Vehicle < ModelBase
     after_transition any => :parked, :do => lambda {|vehicle| vehicle.callbacks << 'before_enter_parked'}
     before_transition any => :idling, :do => lambda {|vehicle| vehicle.callbacks << 'before_enter_idling'}
     
+    around_transition do |vehicle, transition, block|
+      time = Time.now
+      block.call
+      vehicle.time_elapsed = Time.now - time
+    end
+    
     event :park do
       transition [:idling, :first_gear] => :parked
     end
@@ -447,6 +453,10 @@ class VehicleIdlingTest < Test::Unit::TestCase
     assert @vehicle.seatbelt_on
   end
   
+  def test_should_track_time_elapsed
+    assert_not_nil @vehicle.time_elapsed
+  end
+  
   def test_should_allow_park
     assert @vehicle.park
   end

data/test/unit/callback_test.rb

@@ -1,25 +1,42 @@
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 class CallbackTest < Test::Unit::TestCase
+  def test_should_raise_exception_if_invalid_type_specified
+    exception = assert_raise(ArgumentError) { StateMachine::Callback.new(:invalid) {} }
+    assert_equal 'Type must be :before, :after, or :around', exception.message
+  end
+  
+  def test_should_not_raise_exception_if_using_before_type
+    assert_nothing_raised { StateMachine::Callback.new(:before) {} }
+  end
+  
+  def test_should_not_raise_exception_if_using_after_type
+    assert_nothing_raised { StateMachine::Callback.new(:after) {} }
+  end
+  
+  def test_should_not_raise_exception_if_using_around_type
+    assert_nothing_raised { StateMachine::Callback.new(:around) {} }
+  end
+  
   def test_should_raise_exception_if_no_methods_specified
-    exception = assert_raise(ArgumentError) { StateMachine::Callback.new }
+    exception = assert_raise(ArgumentError) { StateMachine::Callback.new(:before) }
     assert_equal 'Method(s) for callback must be specified', exception.message
   end
   
   def test_should_not_raise_exception_if_method_specified_in_do_option
-    assert_nothing_raised { StateMachine::Callback.new(:do => :run) }
+    assert_nothing_raised { StateMachine::Callback.new(:before, :do => :run) }
   end
   
   def test_should_not_raise_exception_if_method_specified_as_argument
-    assert_nothing_raised { StateMachine::Callback.new(:run) }
+    assert_nothing_raised { StateMachine::Callback.new(:before, :run) }
   end
   
   def test_should_not_raise_exception_if_method_specified_as_block
-    assert_nothing_raised { StateMachine::Callback.new(:run) {} }
+    assert_nothing_raised { StateMachine::Callback.new(:before, :run) {} }
   end
   
   def test_should_not_raise_exception_if_implicit_option_specified
-    assert_nothing_raised { StateMachine::Callback.new(:do => :run, :invalid => :valid) }
+    assert_nothing_raised { StateMachine::Callback.new(:before, :do => :run, :invalid => :valid) }
   end
   
   def test_should_not_bind_to_objects
@@ -33,7 +50,11 @@ end
 
 class CallbackByDefaultTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:do => lambda {})
+    @callback = StateMachine::Callback.new(:before) {}
+  end
+  
+  def test_should_have_type
+    assert_equal :before, @callback.type
   end
   
   def test_should_not_have_a_terminator
@@ -53,7 +74,7 @@ end
 
 class CallbackWithMethodArgumentTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(lambda {|*args| @args = args})
+    @callback = StateMachine::Callback.new(:before, lambda {|*args| @args = args})
     
     @object = Object.new
     @result = @callback.call(@object)
@@ -70,7 +91,7 @@ end
 
 class CallbackWithMultipleMethodArgumentsTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:run_1, :run_2)
+    @callback = StateMachine::Callback.new(:before, :run_1, :run_2)
     
     class << @object = Object.new
       attr_accessor :callbacks
@@ -98,7 +119,7 @@ end
 
 class CallbackWithDoMethodTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| @args = args})
+    @callback = StateMachine::Callback.new(:before, :do => lambda {|*args| @args = args})
     
     @object = Object.new
     @result = @callback.call(@object)
@@ -115,7 +136,7 @@ end
 
 class CallbackWithMultipleDoMethodsTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:do => [:run_1, :run_2])
+    @callback = StateMachine::Callback.new(:before, :do => [:run_1, :run_2])
     
     class << @object = Object.new
       attr_accessor :callbacks
@@ -143,7 +164,7 @@ end
 
 class CallbackWithBlockTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new do |*args|
+    @callback = StateMachine::Callback.new(:before) do |*args|
       @args = args
     end
     
@@ -162,7 +183,7 @@ end
 
 class CallbackWithMixedMethodsTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:run_argument, :do => :run_do) do |object|
+    @callback = StateMachine::Callback.new(:before, :run_argument, :do => :run_do) do |object|
       object.callbacks << :block
     end
     
@@ -193,7 +214,7 @@ end
 class CallbackWithExplicitRequirementsTest < Test::Unit::TestCase
   def setup
     @object = Object.new
-    @callback = StateMachine::Callback.new(:from => :parked, :to => :idling, :on => :ignite, :do => lambda {})
+    @callback = StateMachine::Callback.new(:before, :from => :parked, :to => :idling, :on => :ignite, :do => lambda {})
   end
   
   def test_should_call_with_empty_context
@@ -224,7 +245,7 @@ end
 class CallbackWithImplicitRequirementsTest < Test::Unit::TestCase
   def setup
     @object = Object.new
-    @callback = StateMachine::Callback.new(:parked => :idling, :on => :ignite, :do => lambda {})
+    @callback = StateMachine::Callback.new(:before, :parked => :idling, :on => :ignite, :do => lambda {})
   end
   
   def test_should_call_with_empty_context
@@ -258,12 +279,12 @@ class CallbackWithIfConditionTest < Test::Unit::TestCase
   end
   
   def test_should_call_if_true
-    callback = StateMachine::Callback.new(:if => lambda {true}, :do => lambda {})
+    callback = StateMachine::Callback.new(:before, :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 {})
+    callback = StateMachine::Callback.new(:before, :if => lambda {false}, :do => lambda {})
     assert !callback.call(@object)
   end
 end
@@ -274,12 +295,12 @@ class CallbackWithUnlessConditionTest < Test::Unit::TestCase
   end
   
   def test_should_call_if_false
-    callback = StateMachine::Callback.new(:unless => lambda {false}, :do => lambda {})
+    callback = StateMachine::Callback.new(:before, :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 {})
+    callback = StateMachine::Callback.new(:before, :unless => lambda {true}, :do => lambda {})
     assert !callback.call(@object)
   end
 end
@@ -290,7 +311,7 @@ class CallbackWithoutTerminatorTest < Test::Unit::TestCase
   end
   
   def test_should_not_halt_if_result_is_false
-    callback = StateMachine::Callback.new(:do => lambda {false}, :terminator => nil)
+    callback = StateMachine::Callback.new(:before, :do => lambda {false}, :terminator => nil)
     assert_nothing_thrown { callback.call(@object) }
   end
 end
@@ -301,24 +322,24 @@ 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| result == true})
+    callback = StateMachine::Callback.new(:before, :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| result == false})
+    callback = StateMachine::Callback.new(:before, :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})
+    callback = StateMachine::Callback.new(:before, :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})
+    @callback = StateMachine::Callback.new(:before, :do => lambda {|object| @arg = object})
     
     @object = Object.new
     @callback.call(@object, {}, 1, 2, 3)
@@ -331,7 +352,7 @@ end
 
 class CallbackWithArgumentsTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| @args = args})
+    @callback = StateMachine::Callback.new(:before, :do => lambda {|*args| @args = args})
     
     @object = Object.new
     @callback.call(@object, {}, 1, 2, 3)
@@ -344,7 +365,7 @@ end
 
 class CallbackWithUnboundMethodTest < Test::Unit::TestCase
   def setup
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| @context = args.unshift(self)})
+    @callback = StateMachine::Callback.new(:before, :do => lambda {|*args| @context = args.unshift(self)})
     
     @object = Object.new
     @callback.call(@object, {}, 1, 2, 3)
@@ -362,7 +383,7 @@ class CallbackWithBoundMethodTest < Test::Unit::TestCase
   
   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 = StateMachine::Callback.new(:before, :do => lambda {|*args| context = [self] + args}, :bind_to_object => true)
     callback.call(@object, {}, 1, 2, 3)
     
     assert_equal [@object, 1, 2, 3], context
@@ -377,14 +398,14 @@ class CallbackWithBoundMethodTest < Test::Unit::TestCase
       end
     end
     
-    callback = StateMachine::Callback.new(:do => :after_ignite, :bind_to_object => true)
+    callback = StateMachine::Callback.new(:before, :do => :after_ignite, :bind_to_object => true)
     callback.call(@object)
     
     assert_equal [], @object.context
   end
   
   def test_should_ignore_option_for_string_methods
-    callback = StateMachine::Callback.new(:do => '[1, 2, 3]', :bind_to_object => true)
+    callback = StateMachine::Callback.new(:before, :do => '[1, 2, 3]', :bind_to_object => true)
     assert callback.call(@object)
   end
 end
@@ -396,7 +417,7 @@ class CallbackWithMultipleBoundMethodsTest < Test::Unit::TestCase
     first_context = nil
     second_context = nil
     
-    @callback = StateMachine::Callback.new(:do => [lambda {first_context = self}, lambda {second_context = self}], :bind_to_object => true)
+    @callback = StateMachine::Callback.new(:before, :do => [lambda {first_context = self}, lambda {second_context = self}], :bind_to_object => true)
     @callback.call(@object)
     
     @first_context = first_context
@@ -415,7 +436,7 @@ class CallbackWithApplicationBoundObjectTest < Test::Unit::TestCase
     StateMachine::Callback.bind_to_object = true
     
     context = nil
-    @callback = StateMachine::Callback.new(:do => lambda {|*args| context = self})
+    @callback = StateMachine::Callback.new(:before, :do => lambda {|*args| context = self})
     
     @object = Object.new
     @callback.call(@object)
@@ -431,6 +452,33 @@ class CallbackWithApplicationBoundObjectTest < Test::Unit::TestCase
   end
 end
 
+class CallbackWithBoundMethodAndArgumentsTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
+  def test_should_include_single_argument_if_specified
+    context = nil
+    callback = StateMachine::Callback.new(:before, :do => lambda {|arg1| context = [arg1]}, :bind_to_object => true)
+    callback.call(@object, {}, 1)
+    assert_equal [1], context
+  end
+  
+  def test_should_include_multiple_arguments_if_specified
+    context = nil
+    callback = StateMachine::Callback.new(:before, :do => lambda {|arg1, arg2, arg3| context = [arg1, arg2, arg3]}, :bind_to_object => true)
+    callback.call(@object, {}, 1, 2, 3)
+    assert_equal [1, 2, 3], context
+  end
+  
+  def test_should_include_arguments_if_splat_used
+    context = nil
+    callback = StateMachine::Callback.new(:before, :do => lambda {|*args| context = args}, :bind_to_object => true)
+    callback.call(@object, {}, 1, 2, 3)
+    assert_equal [1, 2, 3], context
+  end
+end
+
 class CallbackWithApplicationTerminatorTest < Test::Unit::TestCase
   def setup
     @original_terminator = StateMachine::Callback.bind_to_object
@@ -440,12 +488,12 @@ class CallbackWithApplicationTerminatorTest < Test::Unit::TestCase
   end
   
   def test_should_not_halt_if_terminator_does_not_match
-    callback = StateMachine::Callback.new(:do => lambda {true})
+    callback = StateMachine::Callback.new(:before, :do => lambda {true})
     assert_nothing_thrown { callback.call(@object) }
   end
   
   def test_should_halt_if_terminator_matches
-    callback = StateMachine::Callback.new(:do => lambda {false})
+    callback = StateMachine::Callback.new(:before, :do => lambda {false})
     assert_throws(:halt) { callback.call(@object) }
   end
   
@@ -453,3 +501,228 @@ class CallbackWithApplicationTerminatorTest < Test::Unit::TestCase
     StateMachine::Callback.bind_to_object = @original_bind_to_object
   end
 end
+
+class CallbackWithAroundTypeAndBlockTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    @callbacks = []
+  end
+  
+  def test_should_evaluate_before_without_after
+    callback = StateMachine::Callback.new(:around, lambda {|*args| block = args.pop; @args = args; block.call})
+    assert callback.call(@object)
+    assert_equal [@object], @args
+  end
+  
+  def test_should_evaluate_after_without_before
+    callback = StateMachine::Callback.new(:around, lambda {|*args| block = args.pop; block.call; @args = args})
+    assert callback.call(@object)
+    assert_equal [@object], @args
+  end
+  
+  def test_should_halt_if_not_yielded
+    callback = StateMachine::Callback.new(:around, lambda {|block|})
+    assert_throws(:halt) { callback.call(@object) }
+  end
+  
+  def test_should_call_block_after_before
+    callback = StateMachine::Callback.new(:around, lambda {|block| @callbacks << :before; block.call})
+    assert callback.call(@object) { @callbacks << :block }
+    assert_equal [:before, :block], @callbacks
+  end
+  
+  def test_should_call_block_before_after
+    @callbacks = []
+    callback = StateMachine::Callback.new(:around, lambda {|block| block.call; @callbacks << :after})
+    assert callback.call(@object) { @callbacks << :block }
+    assert_equal [:block, :after], @callbacks
+  end
+  
+  def test_should_halt_if_block_halts
+    callback = StateMachine::Callback.new(:around, lambda {|block| block.call; @callbacks << :after})
+    assert_throws(:halt) { callback.call(@object) { throw :halt }  }
+    assert_equal [], @callbacks
+  end
+end
+
+class CallbackWithAroundTypeAndMultipleMethodsTest < Test::Unit::TestCase
+  def setup
+    @callback = StateMachine::Callback.new(:around, :run_1, :run_2)
+    
+    class << @object = Object.new
+      attr_accessor :before_callbacks
+      attr_accessor :after_callbacks
+      
+      def run_1
+        (@before_callbacks ||= []) << :run_1
+        yield
+        (@after_callbacks ||= []) << :run_1
+      end
+      
+      def run_2
+        (@before_callbacks ||= []) << :run_2
+        yield
+        (@after_callbacks ||= []) << :run_2
+      end
+    end
+  end
+  
+  def test_should_succeed
+    assert @callback.call(@object)
+  end
+  
+  def test_should_evaluate_before_callbacks_in_order
+    @callback.call(@object)
+    assert_equal [:run_1, :run_2], @object.before_callbacks
+  end
+  
+  def test_should_evaluate_after_callbacks_in_reverse_order
+    @callback.call(@object)
+    assert_equal [:run_2, :run_1], @object.after_callbacks
+  end
+  
+  def test_should_call_block_after_before_callbacks
+    @callback.call(@object) { (@object.before_callbacks ||= []) << :block }
+    assert_equal [:run_1, :run_2, :block], @object.before_callbacks
+  end
+  
+  def test_should_call_block_before_after_callbacks
+    @callback.call(@object) { (@object.after_callbacks ||= []) << :block }
+    assert_equal [:block, :run_2, :run_1], @object.after_callbacks
+  end
+  
+  def test_should_halt_if_first_doesnt_yield
+    class << @object
+      def run_1
+        (@before_callbacks ||= []) << :run_1
+      end
+    end
+    
+    catch(:halt) do
+      @callback.call(@object) { (@object.before_callbacks ||= []) << :block }
+    end
+    
+    assert_equal [:run_1], @object.before_callbacks
+    assert_nil @object.after_callbacks
+  end
+  
+  def test_should_halt_if_last_doesnt_yield
+    class << @object
+      def run_2
+        (@before_callbacks ||= []) << :run_2
+      end
+    end
+    
+    catch(:halt) { @callback.call(@object) }
+    assert_equal [:run_1, :run_2], @object.before_callbacks
+    assert_nil @object.after_callbacks
+  end
+  
+  def test_should_not_evaluate_further_methods_if_after_halts
+    class << @object
+      def run_2
+        (@before_callbacks ||= []) << :run_2
+        yield
+        (@after_callbacks ||= []) << :run_2
+        throw :halt
+      end
+    end
+    
+    catch(:halt) { @callback.call(@object) }
+    assert_equal [:run_1, :run_2], @object.before_callbacks
+    assert_equal [:run_2], @object.after_callbacks
+  end
+end
+
+class CallbackWithAroundTypeAndArgumentsTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
+  def test_should_include_object_if_specified
+    callback = StateMachine::Callback.new(:around, lambda {|object, block| @args = [object]; block.call})
+    callback.call(@object)
+    assert_equal [@object], @args
+  end
+  
+  def test_should_include_arguments_if_specified
+    callback = StateMachine::Callback.new(:around, lambda {|object, arg1, arg2, arg3, block| @args = [object, arg1, arg2, arg3]; block.call})
+    callback.call(@object, {}, 1, 2, 3)
+    assert_equal [@object, 1, 2, 3], @args
+  end
+  
+  def test_should_include_arguments_if_splat_used
+    callback = StateMachine::Callback.new(:around, lambda {|*args| block = args.pop; @args = args; block.call})
+    callback.call(@object, {}, 1, 2, 3)
+    assert_equal [@object, 1, 2, 3], @args
+  end
+end
+
+class CallbackWithAroundTypeAndTerminatorTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
+  def test_should_not_halt_if_terminator_does_not_match
+    callback = StateMachine::Callback.new(:around, :do => lambda {|block| block.call(false); false}, :terminator => lambda {|result| result == true})
+    assert_nothing_thrown { callback.call(@object) }
+  end
+  
+  def test_should_not_halt_if_terminator_matches
+    callback = StateMachine::Callback.new(:around, :do => lambda {|block| block.call(false); false}, :terminator => lambda {|result| result == false})
+    assert_nothing_thrown { callback.call(@object) }
+  end
+end
+
+class CallbackWithAroundTypeAndBoundMethodTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
+  def test_should_call_method_within_the_context_of_the_object
+    context = nil
+    callback = StateMachine::Callback.new(:around, :do => lambda {|block| context = self; block.call}, :bind_to_object => true)
+    callback.call(@object, {}, 1, 2, 3)
+    
+    assert_equal @object, context
+  end
+  
+  def test_should_include_arguments_if_specified
+    context = nil
+    callback = StateMachine::Callback.new(:around, :do => lambda {|*args| block = args.pop; context = args; block.call}, :bind_to_object => true)
+    callback.call(@object, {}, 1, 2, 3)
+    
+    assert_equal [1, 2, 3], context
+  end
+end
+
+class CallbackSuccessMatcherTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
+  def test_should_match_if_not_specified
+    callback = StateMachine::Callback.new(:before) {}
+    assert callback.matches_success?(true)
+  end
+  
+  def test_should_match_if_true_and_not_including_failures
+    callback = StateMachine::Callback.new(:before, :include_failures => false) {}
+    assert callback.matches_success?(true)
+  end
+  
+  def test_should_match_if_true_and_including_failures
+    callback = StateMachine::Callback.new(:before, :include_failures => true) {}
+    assert callback.matches_success?(true)
+  end
+  
+  def test_should_not_match_if_false_and_not_including_failures
+    callback = StateMachine::Callback.new(:before, :include_failures => false) {}
+    assert !callback.matches_success?(false)
+  end
+  
+  def test_Should_match_if_false_and_including_failures
+    callback = StateMachine::Callback.new(:before, :include_failures => true) {}
+    assert callback.matches_success?(false)
+  end
+end