state_machine 1.1.2 → 1.2.0

data/test/unit/integrations/mongo_mapper_test.rb

@@ -11,14 +11,23 @@ module MongoMapperTest
     def default_test
     end
     
+    def teardown
+      if @table_names
+        MongoMapper.database.collections.each {|c| c.drop if @table_names.include?(c.name)}
+      end
+    end
+    
     protected
       # Creates a new MongoMapper model (and the associated table)
-      def new_model(table_name = :foo, &block)
+      def new_model(name = :foo, &block)
+        table_name = "#{name}_#{rand(1000000)}"
+        @table_names ||= []
+        @table_names << table_name
         
         model = Class.new do
           (class << self; self; end).class_eval do
-            define_method(:name) { "MongoMapperTest::#{table_name.to_s.capitalize}" }
-            define_method(:to_s) { name }
+            define_method(:name) { "MongoMapperTest::#{name.to_s.capitalize}" }
+            define_method(:to_s) { self.name }
           end
         end
         
@@ -29,7 +38,6 @@ module MongoMapperTest
           key :state, String
         end
         model.class_eval(&block) if block_given?
-        model.collection.remove
         model
       end
   end
@@ -52,7 +60,7 @@ module MongoMapperTest
     end
     
     def test_should_have_defaults
-      assert_equal e = {:action => :save}, StateMachine::Integrations::MongoMapper.defaults
+      assert_equal({:action => :save}, StateMachine::Integrations::MongoMapper.defaults)
     end
     
     def test_should_have_a_locale_path
@@ -136,7 +144,7 @@ module MongoMapperTest
   
   class MachineWithStaticInitialStateTest < BaseTestCase
     def setup
-      @model = new_model do
+      @model = new_model(:vehicle) do
         attr_accessor :value
       end
       @machine = StateMachine::Machine.new(@model, :initial => :parked)
@@ -159,7 +167,7 @@ module MongoMapperTest
     
     def test_should_not_allow_initialize_blocks
       block_args = nil
-      record = @model.new do |*args|
+      @model.new do |*args|
         block_args = args
       end
       
@@ -170,6 +178,7 @@ module MongoMapperTest
       @model.class_eval do
         attr_accessor :state_during_setter
         
+        remove_method :value=
         define_method(:value=) do |value|
           self.state_during_setter = state
         end
@@ -188,6 +197,20 @@ module MongoMapperTest
       assert_equal 'idling', record.state
     end
     
+    def test_should_persist_initial_state
+      record = @model.new
+      record.save
+      record = @model.find(record.id)
+      assert_equal 'parked', record.state
+    end
+    
+    def test_should_persist_initial_state_on_dup
+      record = @model.create.dup
+      record.save
+      record = @model.find(record.id)
+      assert_equal 'parked', record.state
+    end
+    
     def test_should_use_stored_values_when_loading_from_database
       @machine.state :idling
       
@@ -201,6 +224,65 @@ module MongoMapperTest
       record = @model.find(@model.create(:state => nil).id)
       assert_nil record.state
     end
+    
+    if defined?(MongoMapper::Version) && MongoMapper::Version !~ /^0\.[5-8]\./
+      def test_should_use_stored_values_when_loading_for_many_association
+        @machine.state :idling
+        
+        @model.belongs_to :owner, :class_name => 'MongoMapperTest::Owner'
+        MongoMapperTest.const_set('Vehicle', @model)
+        
+        owner_model = new_model(:owner) do
+          many :vehicles, :class_name => 'MongoMapperTest::Vehicle'
+        end
+        MongoMapperTest.const_set('Owner', owner_model)
+        
+        owner = owner_model.create
+        record = @model.create(:state => 'idling', :owner_id => owner.id)
+        assert_equal 'idling', owner.vehicles[0].state
+      end
+      
+      def test_should_use_stored_values_when_loading_for_one_association
+        @machine.state :idling
+        
+        @model.belongs_to :owner, :class_name => 'MongoMapperTest::Owner'
+        MongoMapperTest.const_set('Vehicle', @model)
+        
+        owner_model = new_model(:owner) do
+          one :vehicle, :class_name => 'MongoMapperTest::Vehicle'
+        end
+        MongoMapperTest.const_set('Owner', owner_model)
+        
+        owner = owner_model.create
+        record = @model.create(:state => 'idling', :owner_id => owner.id)
+        owner.reload
+        assert_equal 'idling', owner.vehicle.state
+      end
+      
+      def test_should_use_stored_values_when_loading_for_belongs_to_association
+        @machine.state :idling
+        
+        MongoMapperTest.const_set('Vehicle', @model)
+        
+        driver_model = new_model(:driver) do
+          belongs_to :vehicle, :class_name => 'MongoMapperTest::Vehicle'
+        end
+        MongoMapperTest.const_set('Driver', driver_model)
+        
+        record = @model.create(:state => 'idling')
+        driver = driver_model.create(:vehicle_id => record.id)
+        assert_equal 'idling', driver.vehicle.state
+      end
+    end
+    
+    def teardown
+      MongoMapperTest.class_eval do
+        remove_const('Vehicle') if defined?(MongoMapperTest::Vehicle)
+        remove_const('Owner') if defined?(MongoMapperTest::Owner)
+        remove_const('Driver') if defined?(MongoMapperTest::Driver)
+      end
+      super
+    end
   end
   
   class MachineWithDynamicInitialStateTest < BaseTestCase
@@ -224,7 +306,7 @@ module MongoMapperTest
     
     def test_should_not_allow_initialize_blocks
       block_args = nil
-      record = @model.new do |*args|
+      @model.new do |*args|
         block_args = args
       end
       
@@ -235,6 +317,7 @@ module MongoMapperTest
       @model.class_eval do
         attr_accessor :state_during_setter
         
+        remove_method :value=
         define_method(:value=) do |value|
           self.state_during_setter = state || 'nil'
         end
@@ -253,6 +336,20 @@ module MongoMapperTest
       assert_equal 'idling', record.state
     end
     
+    def test_should_persist_initial_state
+      record = @model.new
+      record.save
+      record = @model.find(record.id)
+      assert_equal 'parked', record.state
+    end
+    
+    def test_should_persist_initial_state_on_dup
+      record = @model.create.dup
+      record.save
+      record = @model.find(record.id)
+      assert_equal 'parked', record.state
+    end
+    
     def test_should_use_stored_values_when_loading_from_database
       @machine.state :idling
       
@@ -280,8 +377,34 @@ module MongoMapperTest
     end
   end
   
-  class MachineWithColumnDefaultTest < BaseTestCase
+  class MachineWithSameColumnDefaultTest < BaseTestCase
     def setup
+      @original_stderr, $stderr = $stderr, StringIO.new
+      
+      @model = new_model do
+        key :status, String, :default => 'parked'
+      end
+      @machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
+      @record = @model.new
+    end
+    
+    def test_should_use_machine_default
+      assert_equal 'parked', @record.status
+    end
+    
+    def test_should_not_generate_a_warning
+      assert_no_match(/have defined a different default/, $stderr.string)
+    end
+    
+    def teardown
+      $stderr = @original_stderr
+    end
+  end
+  
+  class MachineWithDifferentColumnDefaultTest < BaseTestCase
+    def setup
+      @original_stderr, $stderr = $stderr, StringIO.new
+      
       @model = new_model do
         key :status, String, :default => 'idling'
       end
@@ -292,6 +415,39 @@ module MongoMapperTest
     def test_should_use_machine_default
       assert_equal 'parked', @record.status
     end
+    
+    def test_should_generate_a_warning
+      assert_match(/Both MongoMapperTest::Foo and its :status machine have defined a different default for "status". Use only one or the other for defining defaults to avoid unexpected behaviors\./, $stderr.string)
+    end
+    
+    def teardown
+      $stderr = @original_stderr
+    end
+  end
+  
+  class MachineWithDifferentIntegerColumnDefaultTest < BaseTestCase
+    def setup
+      @original_stderr, $stderr = $stderr, StringIO.new
+      
+      @model = new_model do
+        key :status, Integer, :default => 0
+      end
+      @machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
+      @machine.state :parked, :value => 1
+      @record = @model.new
+    end
+    
+    def test_should_use_machine_default
+      assert_equal 1, @record.status
+    end
+    
+    def test_should_generate_a_warning
+      assert_match(/Both MongoMapperTest::Foo and its :status machine have defined a different default for "status". Use only one or the other for defining defaults to avoid unexpected behaviors\./, $stderr.string)
+    end
+    
+    def teardown
+      $stderr = @original_stderr
+    end
   end
   
   class MachineWithConflictingPredicateTest < BaseTestCase
@@ -323,14 +479,14 @@ module MongoMapperTest
       @machine = StateMachine::Machine.new(@model)
       @machine.state :state
       
-      assert_match /^Instance method "state\?" is already defined in .*, use generic helper instead.*\n$/, $stderr.string
+      assert_match(/^Instance method "state\?" is already defined in .*, use generic helper instead.*\n$/, $stderr.string)
     end
     
     def test_should_output_warning_with_same_machine_attribute
       @machine = StateMachine::Machine.new(@model, :public_state, :attribute => :state)
       @machine.state :state
       
-      assert_match /^Instance method "state\?" is already defined in .*, use generic helper instead.*\n$/, $stderr.string
+      assert_match(/^Instance method "state\?" is already defined in .*, use generic helper instead.*\n$/, $stderr.string)
     end
     
     def teardown
@@ -441,24 +597,26 @@ module MongoMapperTest
     end
   end
   
-  class MachineWithAliasedAttributeTest < BaseTestCase
-    def setup
-      @model = new_model do
-        alias_attribute :vehicle_status, :state
+  if !defined?(MongoMapper::Version) || MongoMapper::Version =~ /^0\.[5-8]\./
+    class MachineWithAliasedAttributeTest < BaseTestCase
+      def setup
+        @model = new_model do
+          alias_attribute :vehicle_status, :state
+        end
+        
+        @machine = StateMachine::Machine.new(@model, :status, :attribute => :vehicle_status)
+        @machine.state :parked
+        
+        @record = @model.new
       end
       
-      @machine = StateMachine::Machine.new(@model, :status, :attribute => :vehicle_status)
-      @machine.state :parked
-      
-      @record = @model.new
-    end
-    
-    def test_should_check_custom_attribute_for_predicate
-      @record.vehicle_status = nil
-      assert !@record.status?(:parked)
-      
-      @record.vehicle_status = 'parked'
-      assert @record.status?(:parked)
+      def test_should_check_custom_attribute_for_predicate
+        @record.vehicle_status = nil
+        assert !@record.status?(:parked)
+        
+        @record.vehicle_status = 'parked'
+        assert @record.status?(:parked)
+      end
     end
   end
   
@@ -529,7 +687,7 @@ module MongoMapperTest
   class MachineMultipleTest < BaseTestCase
     def setup
       @model = new_model do
-        key :status, String, :default => 'idling'
+        key :status, String
       end
       @state_machine = StateMachine::Machine.new(@model, :initial => :parked)
       @status_machine = StateMachine::Machine.new(@model, :status, :initial => :idling)
@@ -625,7 +783,7 @@ module MongoMapperTest
   class MachineWithDirtyAttributesAndCustomAttributeTest < BaseTestCase
     def setup
       @model = new_model do
-        key :status, String, :default => 'idling'
+        key :status, String
       end
       @machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
       @machine.event :ignite
@@ -656,7 +814,7 @@ module MongoMapperTest
   class MachineWithDirtyAttributeAndCustomAttributesDuringLoopbackTest < BaseTestCase
     def setup
       @model = new_model do
-        key :status, String, :default => 'idling'
+        key :status, String
       end
       @machine = StateMachine::Machine.new(@model, :status, :initial => :parked)
       @machine.event :park
@@ -789,11 +947,21 @@ module MongoMapperTest
     def test_should_run_around_callbacks
       before_called = false
       after_called = false
-      @machine.around_transition {|block| before_called = true; block.call; after_called = true}
+      ensure_called = 0
+      @machine.around_transition do |block|
+        before_called = true
+        begin
+          block.call
+        ensure
+          ensure_called += 1
+        end
+        after_called = true
+      end
       
       @transition.perform
       assert before_called
       assert after_called
+      assert_equal ensure_called, 1
     end
     
     def test_should_include_transition_states_in_known_states
@@ -826,6 +994,29 @@ module MongoMapperTest
       
       assert_equal [1, 2, 3], @record.callback_result
     end
+    
+    def test_should_run_in_expected_order
+      expected = [
+        :before_transition, :before_validation, :after_validation,
+        :before_save, :before_create, :after_create, :after_save,
+        :after_transition
+      ]
+      
+      callbacks = []
+      @model.before_validation { callbacks << :before_validation }
+      @model.after_validation { callbacks << :after_validation }
+      @model.before_save { callbacks << :before_save }
+      @model.before_create { callbacks << :before_create }
+      @model.after_create { callbacks << :after_create }
+      @model.after_save { callbacks << :after_save }
+      
+      @machine.before_transition { callbacks << :before_transition }
+      @machine.after_transition { callbacks << :after_transition }
+      
+      @transition.perform
+      
+      assert_equal expected, callbacks
+    end
   end
   
   class MachineWithFailedBeforeCallbacksTest < BaseTestCase
@@ -881,6 +1072,42 @@ module MongoMapperTest
     end
   end
   
+  class MachineNestedActionTest < BaseTestCase
+    def setup
+      @callbacks = []
+      
+      @model = new_model
+      @machine = StateMachine::Machine.new(@model)
+      @machine.event :ignite do
+        transition :parked => :idling
+      end
+      
+      @record = @model.new(:state => 'parked')
+    end
+    
+    def test_should_allow_transition_prior_to_creation_if_skipping_action
+      record = @record
+      @model.before_create { record.ignite(false) }
+      result = @record.save
+      
+      assert_equal true, result
+      assert_equal "idling", @record.state
+      @record = @model.find(@record.id)
+      assert_equal "idling", @record.state
+    end
+    
+    def test_should_allow_transition_after_creation
+      record = @record
+      @model.after_create { record.ignite }
+      result = @record.save
+      
+      assert_equal true, result
+      assert_equal "idling", @record.state
+      @record = @model.find(@record.id)
+      assert_equal "idling", @record.state
+    end
+  end
+  
   class MachineWithFailedActionTest < BaseTestCase
     def setup
       @model = new_model do
@@ -920,7 +1147,7 @@ module MongoMapperTest
   end
   
   class MachineWithFailedAfterCallbacksTest < BaseTestCase
-     def setup
+    def setup
       @callbacks = []
       
       @model = new_model
@@ -1006,10 +1233,7 @@ module MongoMapperTest
   
   class MachineWithValidationsAndCustomAttributeTest < BaseTestCase
     def setup
-      @model = new_model do
-        alias_attribute :status, :state
-      end
-      
+      @model = new_model
       @machine = StateMachine::Machine.new(@model, :status, :attribute => :state)
       @machine.state :parked
       
@@ -1118,7 +1342,11 @@ module MongoMapperTest
       ran_callback = false
       @machine.around_transition {|block| ran_callback = true; block.call }
       
-      @record.valid?
+      begin
+        @record.valid?
+      rescue ArgumentError
+        raise if StateMachine::Transition.pause_supported?
+      end
       assert ran_callback
     end
     
@@ -1152,7 +1380,11 @@ module MongoMapperTest
       ran_callback = false
       @machine.around_transition {|block| block.call; ran_callback = true }
       
-      @record.valid?
+      begin
+        @record.valid?
+      rescue ArgumentError
+        raise if StateMachine::Transition.pause_supported?
+      end
       assert !ran_callback
     end
     
@@ -1298,6 +1530,73 @@ module MongoMapperTest
       @record.save
       assert ran_callback
     end
+    
+    def test_should_allow_additional_transitions_to_new_state_in_after_transitions
+      @machine.event :park do
+        transition :idling => :parked
+      end
+      
+      @machine.after_transition(:on => :ignite) { @record.park }
+      
+      @record.save
+      assert_equal 'parked', @record.state
+      
+      @record = @model.find(@record.id)
+      assert_equal 'parked', @record.state
+    end
+    
+    def test_should_allow_additional_transitions_to_previous_state_in_after_transitions
+      @machine.event :shift_up do
+        transition :idling => :first_gear
+      end
+      
+      @machine.after_transition(:on => :ignite) { @record.shift_up }
+      
+      @record.save
+      assert_equal 'first_gear', @record.state
+      
+      @record = @model.find(@record.id)
+      assert_equal 'first_gear', @record.state
+    end
+  end
+  
+  if defined?(MongoMapper::Version) && MongoMapper::Version !~ /^0\.[5-8]\./
+    class MachineWithEventAttributesOnAutosaveTest < BaseTestCase
+      def setup
+        @vehicle_model = new_model(:vehicle) do
+          belongs_to :owner, :class_name => 'MongoMapperTest::Owner'
+        end
+        MongoMapperTest.const_set('Vehicle', @vehicle_model)
+        
+        @owner_model = new_model(:owner)
+        MongoMapperTest.const_set('Owner', @owner_model)
+        
+        machine = StateMachine::Machine.new(@vehicle_model)
+        machine.event :ignite do
+          transition :parked => :idling
+        end
+        
+        @owner = @owner_model.create
+        @vehicle = @vehicle_model.create(:state => 'parked', :owner_id => @owner.id)
+      end
+      
+      def test_should_persist_many_association
+        @owner_model.many :vehicles, :class_name => 'MongoMapperTest::Vehicle', :autosave => true
+        @owner.vehicles[0].state_event = 'ignite'
+        @owner.save
+        
+        @vehicle.reload
+        assert_equal 'idling', @vehicle.state
+      end
+      
+      def teardown
+        MongoMapperTest.class_eval do
+          remove_const('Vehicle')
+          remove_const('Owner')
+        end
+        super
+      end
+    end
   end
   
   class MachineWithEventAttributesOnSaveBangTest < BaseTestCase
@@ -1364,11 +1663,6 @@ module MongoMapperTest
       assert_equal 'idling', @record.state
     end
     
-    def test_should_persist_new_state
-      @record.save!
-      assert_equal 'idling', @record.state
-    end
-    
     def test_should_run_after_callbacks
       ran_callback = false
       @machine.after_transition { ran_callback = true }
@@ -1439,7 +1733,7 @@ module MongoMapperTest
     
     def test_should_only_include_records_with_state_in_singular_with_scope
       parked = @model.create :state => 'parked'
-      idling = @model.create :state => 'idling'
+      @model.create :state => 'idling'
       
       assert_equal [parked], @model.with_state(:parked).to_a
     end