state_machines 0.0.2 → 0.1.0

data/test/unit/transition_collection/transition_collection_with_action_hook_error_test.rb

@@ -0,0 +1,29 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookErrorTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+
+    @superclass.class_eval do
+      remove_method :save
+
+      def save
+        fail ArgumentError
+      end
+    end
+
+    begin
+      ; StateMachines::TransitionCollection.new([@transition]).perform
+    rescue
+    end
+  end
+
+  def test_should_not_write_event
+    assert_nil @object.state_event
+  end
+
+  def test_should_not_write_event_transition
+    assert_nil @object.send(:state_event_transition)
+  end
+end

data/test/unit/transition_collection/transition_collection_with_action_hook_invalid_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookInvalidTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+    @result = StateMachines::TransitionCollection.new([@transition, nil]).perform
+  end
+
+  def test_should_not_succeed
+    assert_equal false, @result
+  end
+
+  def test_should_not_run_action
+    refute @object.saved
+  end
+end

data/test/unit/transition_collection/transition_collection_with_action_hook_multiple_test.rb

@@ -0,0 +1,79 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookMultipleTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+
+    @status_machine = StateMachines::Machine.new(@klass, :status, initial: :first_gear, action: :save)
+    @status_machine.state :second_gear
+    @status_machine.event :shift_up
+
+    @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
+        @state_event_on_save = state_event
+        @state_event_transition_on_save = state_event_transition
+        @status_on_save = status
+        @status_event_on_save = status_event
+        @status_event_transition_on_save = status_event_transition
+        super
+        1
+      end
+    end
+
+    @object = @klass.new
+    @state_transition = StateMachines::Transition.new(@object, @machine, :ignite, :parked, :idling)
+    @status_transition = StateMachines::Transition.new(@object, @status_machine, :shift_up, :first_gear, :second_gear)
+
+    @result = StateMachines::TransitionCollection.new([@state_transition, @status_transition]).perform
+  end
+
+  def test_should_succeed
+    assert_equal 1, @result
+  end
+
+  def test_should_run_action
+    assert @object.saved
+  end
+
+  def test_should_not_have_already_persisted_when_running_action
+    assert_equal 'parked', @object.state_on_save
+    assert_equal 'first_gear', @object.status_on_save
+  end
+
+  def test_should_persist
+    assert_equal 'idling', @object.state
+    assert_equal 'second_gear', @object.status
+  end
+
+  def test_should_not_have_events_during_action
+    assert_nil @object.state_event_on_save
+    assert_nil @object.status_event_on_save
+  end
+
+  def test_should_not_write_events
+    assert_nil @object.state_event
+    assert_nil @object.status_event
+  end
+
+  def test_should_have_event_transitions_during_action
+    assert_equal @state_transition, @object.state_event_transition_on_save
+    assert_equal @status_transition, @object.status_event_transition_on_save
+  end
+
+  def test_should_not_write_event_transitions
+    assert_nil @object.send(:state_event_transition)
+    assert_nil @object.send(:status_event_transition)
+  end
+
+  def test_should_mark_event_transitions_as_transient
+    assert @state_transition.transient?
+    assert @status_transition.transient?
+  end
+end

data/test/unit/transition_collection/transition_collection_with_action_hook_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+    @result = StateMachines::TransitionCollection.new([@transition]).perform
+  end
+
+  def test_should_succeed
+    assert_equal true, @result
+  end
+
+  def test_should_run_action
+    assert @object.saved
+  end
+
+  def test_should_not_have_already_persisted_when_running_action
+    assert_equal 'parked', @object.state_on_save
+  end
+
+  def test_should_persist
+    assert_equal 'idling', @object.state
+  end
+
+  def test_should_not_have_event_during_action
+    assert_nil @object.state_event_on_save
+  end
+
+  def test_should_not_write_event
+    assert_nil @object.state_event
+  end
+
+  def test_should_have_event_transition_during_action
+    assert_equal @transition, @object.state_event_transition_on_save
+  end
+
+  def test_should_not_write_event_transition
+    assert_nil @object.send(:state_event_transition)
+  end
+
+  def test_should_mark_event_transition_as_transient
+    assert @transition.transient?
+  end
+end

data/test/unit/transition_collection/transition_collection_with_action_hook_with_different_actions_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookWithDifferentActionsTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+
+    @klass.class_eval do
+      def save_status
+        true
+      end
+    end
+
+    @machine = StateMachines::Machine.new(@klass, :status, initial: :first_gear, action: :save_status)
+    @machine.state :second_gear
+    @machine.event :shift_up
+
+    @result = StateMachines::TransitionCollection.new([@transition, StateMachines::Transition.new(@object, @machine, :shift_up, :first_gear, :second_gear)]).perform
+  end
+
+  def test_should_succeed
+    assert_equal true, @result
+  end
+
+  def test_should_run_action
+    assert @object.saved
+  end
+
+  def test_should_have_already_persisted_when_running_action
+    assert_equal 'idling', @object.state_on_save
+  end
+
+  def test_should_not_have_event_during_action
+    assert_nil @object.state_event_on_save
+  end
+
+  def test_should_not_write_event
+    assert_nil @object.state_event
+  end
+
+  def test_should_not_have_event_transition_during_save
+    assert_nil @object.state_event_transition_on_save
+  end
+
+  def test_should_not_write_event_attribute
+    assert_nil @object.send(:state_event_transition)
+  end
+end

data/test/unit/transition_collection/transition_collection_with_action_hook_with_nil_action_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../test_helper'
+require_relative 'transition_collection_with_action_hook_base_test.rb'
+
+class TransitionCollectionWithActionHookWithNilActionTest < TransitionCollectionWithActionHookBaseTest
+  def setup
+    super
+
+    @machine = StateMachines::Machine.new(@klass, :status, initial: :first_gear)
+    @machine.state :second_gear
+    @machine.event :shift_up
+
+    @result = StateMachines::TransitionCollection.new([@transition, StateMachines::Transition.new(@object, @machine, :shift_up, :first_gear, :second_gear)]).perform
+  end
+
+  def test_should_succeed
+    assert_equal true, @result
+  end
+
+  def test_should_run_action
+    assert @object.saved
+  end
+
+  def test_should_have_already_persisted_when_running_action
+    assert_equal 'idling', @object.state_on_save
+  end
+
+  def test_should_not_have_event_during_action
+    assert_nil @object.state_event_on_save
+  end
+
+  def test_should_not_write_event
+    assert_nil @object.state_event
+  end
+
+  def test_should_not_have_event_transition_during_save
+    assert_nil @object.state_event_transition_on_save
+  end
+
+  def test_should_not_write_event_attribute
+    assert_nil @object.send(:state_event_transition)
+  end
+end

data/test/unit/transition_collection/transition_collection_with_after_callback_halt_test.rb

@@ -0,0 +1,51 @@
+require_relative '../../test_helper'
+
+class TransitionCollectionWithBeforeCallbackHaltTest < StateMachinesTest
+  def setup
+    @klass = Class.new do
+      attr_reader :saved
+
+      def save
+        @saved = true
+      end
+    end
+    @before_count = 0
+    @after_count = 0
+
+    @machine = StateMachines::Machine.new(@klass, initial: :parked, action: :save)
+    @machine.state :idling
+    @machine.event :ignite
+
+    @machine.before_transition { @before_count += 1; throw :halt }
+    @machine.before_transition { @before_count += 1 }
+    @machine.after_transition { @after_count += 1 }
+    @machine.around_transition { |block| @before_count += 1; block.call; @after_count += 1 }
+
+    @object = @klass.new
+
+    @transitions = StateMachines::TransitionCollection.new([
+      StateMachines::Transition.new(@object, @machine, :ignite, :parked, :idling)
+    ])
+    @result = @transitions.perform
+  end
+
+  def test_should_not_succeed
+    assert_equal false, @result
+  end
+
+  def test_should_not_persist_state
+    assert_equal 'parked', @object.state
+  end
+
+  def test_should_not_run_action
+    refute @object.saved
+  end
+
+  def test_should_not_run_further_before_callbacks
+    assert_equal 1, @before_count
+  end
+
+  def test_should_not_run_after_callbacks
+    assert_equal 0, @after_count
+  end
+end

data/test/unit/transition_collection/transition_collection_with_before_callback_halt_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../test_helper'
+
+class TransitionCollectionWithAfterCallbackHaltTest < StateMachinesTest
+  def setup
+    @klass = Class.new do
+      attr_reader :saved
+
+      def save
+        @saved = true
+      end
+    end
+    @before_count = 0
+    @after_count = 0
+
+    @machine = StateMachines::Machine.new(@klass, initial: :parked, action: :save)
+    @machine.state :idling
+    @machine.event :ignite
+
+    @machine.before_transition { @before_count += 1 }
+    @machine.after_transition { @after_count += 1; throw :halt }
+    @machine.after_transition { @after_count += 1 }
+    @machine.around_transition { |block| @before_count += 1; block.call; @after_count += 1 }
+
+    @object = @klass.new
+
+    @transitions = StateMachines::TransitionCollection.new([
+      StateMachines::Transition.new(@object, @machine, :ignite, :parked, :idling)
+    ])
+    @result = @transitions.perform
+  end
+
+  def test_should_succeed
+    assert_equal true, @result
+  end
+
+  def test_should_persist_state
+    assert_equal 'idling', @object.state
+  end
+
+  def test_should_run_before_callbacks
+    assert_equal 2, @before_count
+  end
+
+  def test_should_not_run_further_after_callbacks
+    assert_equal 2, @after_count
+  end
+end

data/test/unit/transition_collection/transition_collection_with_block_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../test_helper'
+
+class TransitionCollectionWithBlockTest < StateMachinesTest
+  def setup
+    @klass = Class.new do
+      attr_reader :actions
+
+      def save
+        (@actions ||= []) << :save
+      end
+    end
+
+    @state = StateMachines::Machine.new(@klass, :state, initial: :parked, action: :save)
+    @state.state :idling
+    @state.event :ignite
+
+    @status = StateMachines::Machine.new(@klass, :status, initial: :first_gear, action: :save)
+    @status.state :second_gear
+    @status.event :shift_up
+
+    @object = @klass.new
+    @transitions = StateMachines::TransitionCollection.new([
+      @state_transition = StateMachines::Transition.new(@object, @state, :ignite, :parked, :idling),
+      @status_transition = StateMachines::Transition.new(@object, @status, :shift_up, :first_gear, :second_gear)
+    ])
+    @result = @transitions.perform { 1 }
+  end
+
+  def test_should_succeed
+    assert_equal 1, @result
+  end
+
+  def test_should_persist_states
+    assert_equal 'idling', @object.state
+    assert_equal 'second_gear', @object.status
+  end
+
+  def test_should_not_run_machine_actions
+    assert_nil @object.actions
+  end
+
+  def test_should_use_result_as_transition_result
+    assert_equal 1, @state_transition.result
+    assert_equal 1, @status_transition.result
+  end
+end

data/test/unit/transition_collection/transition_collection_with_callbacks_test.rb

@@ -0,0 +1,135 @@
+require_relative '../../test_helper'
+
+class TransitionCollectionWithCallbacksTest < StateMachinesTest
+  def setup
+    @klass = Class.new do
+      attr_reader :saved
+
+      def save
+        @saved = true
+      end
+    end
+
+    @before_callbacks = []
+    @after_callbacks = []
+
+    @state = StateMachines::Machine.new(@klass, initial: :parked, action: :save)
+    @state.state :idling
+    @state.event :ignite
+    @state.before_transition { @before_callbacks << :state_before }
+    @state.after_transition { @after_callbacks << :state_after }
+    @state.around_transition { |block| @before_callbacks << :state_around; block.call; @after_callbacks << :state_around }
+
+    @status = StateMachines::Machine.new(@klass, :status, initial: :first_gear, action: :save)
+    @status.state :second_gear
+    @status.event :shift_up
+    @status.before_transition { @before_callbacks << :status_before }
+    @status.after_transition { @after_callbacks << :status_after }
+    @status.around_transition { |block| @before_callbacks << :status_around; block.call; @after_callbacks << :status_around }
+
+    @object = @klass.new
+    @transitions = StateMachines::TransitionCollection.new([
+      StateMachines::Transition.new(@object, @state, :ignite, :parked, :idling),
+      StateMachines::Transition.new(@object, @status, :shift_up, :first_gear, :second_gear)
+    ])
+  end
+
+  def test_should_run_before_callbacks_in_order
+    @transitions.perform
+    assert_equal [:state_before, :state_around, :status_before, :status_around], @before_callbacks
+  end
+
+  def test_should_halt_if_before_callback_halted_for_first_transition
+    @state.before_transition { throw :halt }
+
+    assert_equal false, @transitions.perform
+    assert_equal [:state_before, :state_around], @before_callbacks
+  end
+
+  def test_should_halt_if_before_callback_halted_for_second_transition
+    @status.before_transition { throw :halt }
+
+    assert_equal false, @transitions.perform
+    assert_equal [:state_before, :state_around, :status_before, :status_around], @before_callbacks
+  end
+
+  def test_should_halt_if_around_callback_halted_before_yield_for_first_transition
+    @state.around_transition { throw :halt }
+
+    assert_equal false, @transitions.perform
+    assert_equal [:state_before, :state_around], @before_callbacks
+  end
+
+  def test_should_halt_if_around_callback_halted_before_yield_for_second_transition
+    @status.around_transition { throw :halt }
+
+    assert_equal false, @transitions.perform
+    assert_equal [:state_before, :state_around, :status_before, :status_around], @before_callbacks
+  end
+
+  def test_should_run_after_callbacks_in_reverse_order
+    @transitions.perform
+    assert_equal [:status_around, :status_after, :state_around, :state_after], @after_callbacks
+  end
+
+  def test_should_not_halt_if_after_callback_halted_for_first_transition
+    @state.after_transition { throw :halt }
+
+    assert_equal true, @transitions.perform
+    assert_equal [:status_around, :status_after, :state_around, :state_after], @after_callbacks
+  end
+
+  def test_should_not_halt_if_around_callback_halted_for_second_transition
+    @status.around_transition { |block| block.call; throw :halt }
+
+    assert_equal true, @transitions.perform
+    assert_equal [:state_around, :state_after], @after_callbacks
+  end
+
+  def test_should_run_before_callbacks_before_persisting_the_state
+    @state.before_transition { |object| @before_state = object.state }
+    @state.around_transition { |object, _transition, block| @around_state = object.state; block.call }
+    @transitions.perform
+
+    assert_equal 'parked', @before_state
+    assert_equal 'parked', @around_state
+  end
+
+  def test_should_persist_state_before_running_action
+    @klass.class_eval do
+      attr_reader :saved_on_persist
+
+      def state=(value)
+        @state = value
+        @saved_on_persist = saved
+      end
+    end
+
+    @transitions.perform
+    refute @object.saved_on_persist
+  end
+
+  def test_should_persist_state_before_running_action_block
+    @klass.class_eval do
+      attr_writer :saved
+      attr_reader :saved_on_persist
+
+      def state=(value)
+        @state = value
+        @saved_on_persist = saved
+      end
+    end
+
+    @transitions.perform { @object.saved = true }
+    refute @object.saved_on_persist
+  end
+
+  def test_should_run_after_callbacks_after_running_the_action
+    @state.after_transition { |object| @after_saved = object.saved }
+    @state.around_transition { |object, _transition, block| block.call; @around_saved = object.saved }
+    @transitions.perform
+
+    assert @after_saved
+    assert @around_saved
+  end
+end