state_machine 0.6.0 → 0.6.1

data/test/unit/event_test.rb

@@ -264,8 +264,21 @@ end
 
 class EventWithMatchingDisabledTransitionsTest < Test::Unit::TestCase
   def setup
-    @klass = Class.new
-    @machine = StateMachine::Machine.new(@klass)
+    StateMachine::Integrations.const_set('Custom', Module.new do
+      def invalidate(object, event)
+        (object.errors ||= []) << invalid_message(object, event)
+      end
+      
+      def reset(object)
+        object.errors = []
+      end
+    end)
+    
+    @klass = Class.new do
+      attr_accessor :errors
+    end
+    
+    @machine = StateMachine::Machine.new(@klass, :integration => :custom)
     @machine.state :parked, :idling
     
     @event = StateMachine::Event.new(@machine, :ignite)
@@ -291,12 +304,41 @@ class EventWithMatchingDisabledTransitionsTest < Test::Unit::TestCase
     @event.fire(@object)
     assert_equal 'parked', @object.state
   end
+  
+  def test_should_invalidate_the_state
+    @event.fire(@object)
+    assert_equal ['cannot be transitioned via :ignite from :parked'], @object.errors
+  end
+  
+  def test_should_reset_existing_error
+    @object.errors = ['invalid']
+    
+    @event.fire(@object)
+    assert_equal ['cannot be transitioned via :ignite from :parked'], @object.errors
+  end
+  
+  def teardown
+    StateMachine::Integrations.send(:remove_const, 'Custom')
+  end
 end
 
 class EventWithMatchingEnabledTransitionsTest < Test::Unit::TestCase
   def setup
-    @klass = Class.new
-    @machine = StateMachine::Machine.new(@klass)
+    StateMachine::Integrations.const_set('Custom', Module.new do
+      def invalidate(object, event)
+        (object.errors ||= []) << invalid_message(object, event)
+      end
+      
+      def reset(object)
+        object.errors = []
+      end
+    end)
+    
+    @klass = Class.new do
+      attr_accessor :errors
+    end
+    
+    @machine = StateMachine::Machine.new(@klass, :integration => :custom)
     @machine.state :parked, :idling
     
     @event = StateMachine::Event.new(@machine, :ignite)
@@ -326,6 +368,22 @@ class EventWithMatchingEnabledTransitionsTest < Test::Unit::TestCase
     @event.fire(@object)
     assert_equal 'idling', @object.state
   end
+  
+  def test_should_reset_existing_error
+    @object.errors = ['invalid']
+    
+    @event.fire(@object)
+    assert_equal [], @object.errors
+  end
+  
+  def test_should_not_invalidate_the_state
+    @event.fire(@object)
+    assert_equal [], @object.errors
+  end
+  
+  def teardown
+    StateMachine::Integrations.send(:remove_const, 'Custom')
+  end
 end
 
 class EventWithTransitionWithoutToStateTest < Test::Unit::TestCase

data/test/unit/integrations/active_record_test.rb

@@ -3,6 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 begin
   # Load library
   require 'rubygems'
+  
+  gem 'activerecord', ENV['AR_VERSION'] ? "=#{ENV['AR_VERSION']}" : '>=2.1.0'
   require 'active_record'
   
   FIXTURES_ROOT = File.dirname(__FILE__) + '/../../fixtures/'
@@ -160,6 +162,27 @@ begin
         assert_equal 1, @model.count
       end
       
+      def test_should_invalidate_using_errors
+        I18n.backend = I18n::Backend::Simple.new if Object.const_defined?(:I18n)
+        
+        record = @model.new
+        record.state = 'parked'
+        
+        @machine.invalidate(record, StateMachine::Event.new(@machine, :park))
+        
+        assert record.errors.invalid?(:state)
+        assert_equal 'cannot be transitioned via :park from :parked', record.errors.on(:state)
+      end
+      
+      def test_should_clear_errors_on_reset
+        record = @model.new
+        record.state = 'parked'
+        record.errors.add(:state, 'is invalid')
+        
+        @machine.reset(record)
+        assert_nil record.errors.on(:id)
+      end
+      
       def test_should_not_override_the_column_reader
         record = @model.new
         record[:state] = 'parked'
@@ -718,7 +741,75 @@ begin
         assert_equal expected, @notifications
       end
     end
+    
+    if Object.const_defined?(:I18n)
+      class MachineWithInternationalizationTest < ActiveRecord::TestCase
+        def setup
+          I18n.backend = I18n::Backend::Simple.new
+          
+          # Initialize the backend
+          I18n.backend.translate(:en, 'activerecord.errors.messages.invalid_transition', :event => 'ignite', :value => 'idling')
+          
+          @model = new_model
+        end
+        
+        def test_should_invalidate_using_i18n_default
+          I18n.backend.store_translations(:en, {
+            :activerecord => {
+              :errors => {
+                :messages => {
+                  :invalid_transition => 'cannot {{event}} when {{value}}'
+                }
+              }
+            }
+          })
+          
+          machine = StateMachine::Machine.new(@model)
+          machine.state :parked, :idling
+          event = StateMachine::Event.new(machine, :ignite)
+          
+          record = @model.new(:state => 'idling')
+          
+          machine.invalidate(record, event)
+          assert_equal 'cannot ignite when idling', record.errors.on(:state)
+        end
+        
+        def test_should_invalidate_using_customized_i18n_key_if_specified
+          I18n.backend.store_translations(:en, {
+            :activerecord => {
+              :errors => {
+                :messages => {
+                  :bad_transition => 'cannot {{event}} when {{value}}'
+                }
+              }
+            }
+          })
+          
+          machine = StateMachine::Machine.new(@model, :invalid_message => :bad_transition)
+          machine.state :parked, :idling
+          event = StateMachine::Event.new(machine, :ignite)
+          
+          record = @model.new(:state => 'idling')
+          
+          machine.invalidate(record, event)
+          assert_equal 'cannot ignite when idling', record.errors.on(:state)
+        end
+      end
+      
+      def test_should_invalidate_using_customized_i18n_string_if_specified
+        machine = StateMachine::Machine.new(@model, :invalid_message => 'cannot {{event}} when {{value}}')
+        machine.state :parked, :idling
+        event = StateMachine::Event.new(machine, :ignite)
+        
+        record = @model.new(:state => 'idling')
+        
+        machine.invalidate(record, event)
+        assert_equal 'cannot ignite when idling', record.errors.on(:state)
+      end
+    else
+      $stderr.puts 'Skipping ActiveRecord I18n tests. `gem install active_record` >= v2.2.0 and try again.'
+    end
   end
 rescue LoadError
-  $stderr.puts 'Skipping ActiveRecord tests. `gem install active_record` and try again.'
+  $stderr.puts "Skipping ActiveRecord tests. `gem install activerecord#{" -v #{ENV['AR_VERSION']}" if ENV['AR_VERSION']}` and try again."
 end

data/test/unit/integrations/data_mapper_test.rb

@@ -3,6 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 begin
   # Load library
   require 'rubygems'
+  
+  gem 'dm-core', ENV['DM_VERSION'] ? "=#{ENV['DM_VERSION']}" : '>=0.9.0'
   require 'dm-core'
   
   # Establish database connection
@@ -141,6 +143,24 @@ begin
         assert_equal 1, @resource.all.size
       end
       
+      def test_should_invalidate_using_errors
+        record = @resource.new
+        record.state = 'parked'
+        
+        @machine.invalidate(record, StateMachine::Event.new(@machine, :park))
+        
+        assert_equal ['cannot be transitioned via :park from :parked'], record.errors.on(:state)
+      end
+      
+      def test_should_clear_errors_on_reset
+        record = @resource.new
+        record.state = 'parked'
+        record.errors.add(:state, 'is invalid')
+        
+        @machine.reset(record)
+        assert_nil record.errors.on(:id)
+      end
+      
       def test_should_not_override_the_column_reader
         record = @resource.new
         record.attribute_set(:state, 'parked')
@@ -323,6 +343,7 @@ begin
     end
     
     begin
+      gem 'dm-observer', ENV['DM_VERSION'] ? "=#{ENV['DM_VERSION']}" : '>=0.9.0'
       require 'dm-observer'
       
       class MachineWithObserversTest < BaseTestCase
@@ -484,10 +505,11 @@ begin
         end
       end
     rescue LoadError
-      $stderr.puts 'Skipping DataMapper Observer tests. `gem install dm-observer` and try again.'
+      $stderr.puts "Skipping DataMapper Observer tests. `gem install dm-observer#{" -v #{ENV['DM_VERSION']}" if ENV['DM_VERSION']}` and try again."
     end
     
     begin
+      gem 'dm-validations', ENV['DM_VERSION'] ? "=#{ENV['DM_VERSION']}" : '>=0.9.0'
       require 'dm-validations'
       
       class MachineWithStateDrivenValidationsTest < BaseTestCase
@@ -519,9 +541,9 @@ begin
         end
       end
     rescue LoadError
-      $stderr.puts 'Skipping DataMapper Validation tests. `gem install dm-validations` and try again.'
+      $stderr.puts "Skipping DataMapper Validation tests. `gem install dm-validations#{" -v #{ENV['DM_VERSION']}" if ENV['DM_VERSION']}` and try again."
     end
   end
 rescue LoadError
-  $stderr.puts 'Skipping DataMapper tests. `gem install dm-core cucumber rspec hoe launchy do_sqlite3` and try again.'
+  $stderr.puts "Skipping DataMapper tests. `gem install dm-core#{" -v #{ENV['DM_VERSION']}" if ENV['DM_VERSION']}`, `gem install cucumber rspec hoe launchy do_sqlite3` and try again."
 end

data/test/unit/integrations/sequel_test.rb

@@ -3,6 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 begin
   # Load library
   require 'rubygems'
+  
+  gem 'sequel', ENV['SEQUEL_VERSION'] ? "=#{ENV['SEQUEL_VERSION']}" : '>=2.8.0'
   require 'sequel'
   require 'logger'
   
@@ -22,6 +24,8 @@ begin
             column :state, :string
           end if auto_migrate
           model = Class.new(Sequel::Model(:foo)) do
+            self.raise_on_save_failure = false
+            
             def self.name; 'SequelTest::Foo'; end
           end
           model.class_eval(&block) if block_given?
@@ -127,6 +131,24 @@ begin
         assert_equal 1, @model.count
       end
       
+      def test_should_invalidate_using_errors
+        record = @model.new
+        record.state = 'parked'
+        
+        @machine.invalidate(record, StateMachine::Event.new(@machine, :park))
+        
+        assert_equal ['cannot be transitioned via :park from :parked'], record.errors.on(:state)
+      end
+      
+      def test_should_clear_errors_on_reset
+        record = @model.new
+        record.state = 'parked'
+        record.errors.add(:state, 'is invalid')
+        
+        @machine.reset(record)
+        assert_nil record.errors.on(:id)
+      end
+      
       def test_should_not_override_the_column_reader
         record = @model.new
         record[:state] = 'parked'
@@ -271,7 +293,7 @@ begin
         @machine.after_transition(lambda {|*args| callback_args = args})
         
         @transition.perform
-        assert_equal [@transition, @record], callback_args
+        assert_equal [@transition, true], callback_args
       end
       
       def test_should_run_after_callbacks_with_the_context_of_the_record
@@ -338,5 +360,5 @@ begin
     end
   end
 rescue LoadError
-  $stderr.puts 'Skipping Sequel tests. `gem install sequel` and try again.'
+  $stderr.puts "Skipping Sequel tests. `gem install sequel#{" -v #{ENV['SEQUEL_VERSION']}" if ENV['SEQUEL_VERSION']}` and try again."
 end

data/test/unit/machine_test.rb

@@ -250,6 +250,14 @@ class MachineWithoutIntegrationTest < Test::Unit::TestCase
     
     assert @yielded
   end
+  
+  def test_invalidation_should_do_nothing
+    assert_nil @machine.invalidate(@object, StateMachine::Event.new(@machine, :park))
+  end
+  
+  def test_reset_should_do_nothing
+    assert_nil @machine.reset(@object)
+  end
 end
 
 class MachineWithCustomIntegrationTest < Test::Unit::TestCase
@@ -328,7 +336,6 @@ class MachineWithCustomPluralTest < Test::Unit::TestCase
   def setup
     @integration = Module.new do
       class << self; attr_accessor :with_scopes, :without_scopes; end
-      @initialized = false
       @with_scopes = []
       @without_scopes = []
       
@@ -360,11 +367,45 @@ class MachineWithCustomPluralTest < Test::Unit::TestCase
   end
 end
 
+class MachineWithCustomInvalidationTest < Test::Unit::TestCase
+  def setup
+    @integration = Module.new do
+      def invalidate(object, event)
+        object.error = invalid_message(object, event)
+      end
+    end
+    StateMachine::Integrations.const_set('Custom', @integration)
+    
+    @klass = Class.new do
+      attr_accessor :error
+    end
+    
+    @machine = StateMachine::Machine.new(@klass, :integration => :custom, :invalid_message => 'cannot %s when %s')
+    @machine.state :parked
+    
+    @object = @klass.new
+    @object.state = 'parked'
+  end
+  
+  def test_use_custom_message
+    @machine.invalidate(@object, StateMachine::Event.new(@machine, :park))
+    assert_equal 'cannot park when parked', @object.error
+  end
+  
+  def teardown
+    StateMachine::Integrations.send(:remove_const, 'Custom')
+  end
+end
+
 class MachineTest < Test::Unit::TestCase
   def test_should_raise_exception_if_invalid_option_specified
     assert_raise(ArgumentError) {StateMachine::Machine.new(Class.new, :invalid => true)}
   end
   
+  def test_should_not_raise_exception_if_custom_invalid_message_specified
+    assert_nothing_raised {StateMachine::Machine.new(Class.new, :invalid_message => 'custom')}
+  end
+  
   def test_should_evaluate_a_block_during_initialization
     called = true
     StateMachine::Machine.new(Class.new) do
@@ -969,8 +1010,8 @@ class MachineWithEventsWithTransitionsTest < Test::Unit::TestCase
     @klass = Class.new
     @machine = StateMachine::Machine.new(@klass, :initial => :parked)
     @event = @machine.event(:ignite) do
-      transition :to => :idling, :from => :parked
-      transition :to => :idling, :from => :stalled
+      transition :parked => :idling
+      transition :stalled => :idling
     end
   end
   
@@ -984,7 +1025,7 @@ class MachineWithEventsWithTransitionsTest < Test::Unit::TestCase
   
   def test_should_not_duplicate_states_defined_in_multiple_event_transitions
     @machine.event :park do
-      transition :to => :parked, :from => :idling
+      transition :idling => :parked
     end
     
     assert_equal [:parked, :idling, :stalled], @machine.states.map {|state| state.name}
@@ -992,7 +1033,7 @@ class MachineWithEventsWithTransitionsTest < Test::Unit::TestCase
   
   def test_should_track_state_from_new_events
     @machine.event :shift_up do
-      transition :to => :first_gear, :from => :idling
+      transition :idling => :first_gear
     end
     
     assert_equal [:parked, :idling, :stalled, :first_gear], @machine.states.map {|state| state.name}
@@ -1004,7 +1045,7 @@ class MachineWithMultipleEventsTest < Test::Unit::TestCase
     @klass = Class.new
     @machine = StateMachine::Machine.new(@klass, :initial => :parked)
     @park, @shift_down = @machine.event(:park, :shift_down) do
-      transition :to => :parked, :from => :first_gear
+      transition :first_gear => :parked
     end
   end
   
@@ -1037,7 +1078,7 @@ class MachineWithTransitionCallbacksTest < Test::Unit::TestCase
     
     @machine = StateMachine::Machine.new(@klass, :initial => :parked)
     @event = @machine.event :ignite do
-      transition :to => :idling, :from => :parked
+      transition :parked => :idling
     end
     
     @object = @klass.new
@@ -1118,16 +1159,16 @@ class MachineWithTransitionCallbacksTest < Test::Unit::TestCase
   end
   
   def test_should_track_states_defined_in_transition_callbacks
-    @machine.before_transition :from => :parked, :to => :idling, :do => lambda {}
-    @machine.after_transition :from => :first_gear, :to => :second_gear, :do => lambda {}
+    @machine.before_transition :parked => :idling, :do => lambda {}
+    @machine.after_transition :first_gear => :second_gear, :do => lambda {}
     
     assert_equal [:parked, :idling, :first_gear, :second_gear], @machine.states.map {|state| state.name}
   end
   
   def test_should_not_duplicate_states_defined_in_multiple_event_transitions
-    @machine.before_transition :from => :parked, :to => :idling, :do => lambda {}
-    @machine.after_transition :from => :first_gear, :to => :second_gear, :do => lambda {}
-    @machine.after_transition :from => :parked, :to => :idling, :do => lambda {}
+    @machine.before_transition :parked => :idling, :do => lambda {}
+    @machine.after_transition :first_gear => :second_gear, :do => lambda {}
+    @machine.after_transition :parked => :idling, :do => lambda {}
     
     assert_equal [:parked, :idling, :first_gear, :second_gear], @machine.states.map {|state| state.name}
   end
@@ -1177,11 +1218,11 @@ class MachineWithNamespaceTest < Test::Unit::TestCase
     @klass = Class.new
     @machine = StateMachine::Machine.new(@klass, :namespace => 'car', :initial => :parked) do
       event :ignite do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
       
       event :park do
-        transition :to => :parked, :from => :idling
+        transition :idling => :parked
       end
     end
     @object = @klass.new
@@ -1354,7 +1395,7 @@ begin
       end
       @machine = StateMachine::Machine.new(@klass, :initial => :parked)
       @machine.event :ignite do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
     end
     
@@ -1398,7 +1439,7 @@ begin
       end
       @machine = StateMachine::Machine.new(@klass, :state_id, :initial => :parked)
       @machine.event :ignite do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
       @machine.state :parked, :value => 1
       @machine.state :idling, :value => 2
@@ -1419,7 +1460,7 @@ begin
       end
       @machine = StateMachine::Machine.new(@klass, :initial => :parked)
       @machine.event :ignite do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
       @machine.state :parked, :value => nil
       @machine.draw
@@ -1439,7 +1480,7 @@ begin
       end
       @machine = StateMachine::Machine.new(@klass, :initial => :parked)
       @machine.event :activate do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
       @machine.state :idling, :value => lambda {Time.now}
       @machine.draw
@@ -1459,7 +1500,7 @@ begin
       end
       @machine = StateMachine::Machine.new(@klass)
       @machine.event :ignite do
-        transition :to => :idling, :from => :parked
+        transition :parked => :idling
       end
     end