stateful.rb 2.1.0 → 2.2.0

data/test/ActiveRecord/WithMultipleStateMachines.rb

@@ -0,0 +1,221 @@
+# test/ActiveRecord/WithMultipleStateMachines.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+require_relative './test_helper'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'Stateful'
+
+class CreateTableMachines < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_record_machine11s do |t|
+      t.string :fulfilment_state
+      t.string :payment_state
+    end
+  end
+end
+
+class ActiveRecordMachine11 < ActiveRecord::Base
+  extend Stateful
+
+  state_machine :fulfilment do
+    initial_state :pending do
+      on :items_collected => :ready
+    end
+
+    state :ready do
+      on :dispatch => :dispatched
+    end
+
+    final_state :dispatched
+  end
+
+  state_machine :payment do
+    initial_state :unpaid do
+      on :pay => :paid
+    end
+
+    state :paid do
+      on :refund => :refunded
+    end
+
+    final_state :refunded
+  end
+end
+
+CreateTableMachines.new.change
+
+describe Stateful::ActiveRecord do
+  let(:machine){ActiveRecordMachine11.create}
+
+  context "initial states" do
+    it "must be in the fulfilment initial state" do
+      _(machine.fulfilment_initial_state?).must_equal true
+    end
+
+    it "must be in the payment initial state" do
+      _(machine.payment_initial_state?).must_equal true
+    end
+
+    it "must have the correct fulfilment state name" do
+      _(machine.fulfilment_state.name).must_equal :pending
+    end
+
+    it "must have the correct payment state name" do
+      _(machine.payment_state.name).must_equal :unpaid
+    end
+
+    it "must have fulfilment transitions" do
+      _(machine.fulfilment_transitions.size).must_equal 1
+      _(machine.fulfilment_transitions.first.event_name).must_equal :items_collected
+    end
+
+    it "must have payment transitions" do
+      _(machine.payment_transitions.size).must_equal 1
+      _(machine.payment_transitions.first.event_name).must_equal :pay
+    end
+
+    it "must not be in a fulfilment final state" do
+      _(machine.fulfilment_final_state?).must_equal false
+    end
+
+    it "must not be in a payment final state" do
+      _(machine.payment_final_state?).must_equal false
+    end
+
+    it "must have domain predicates" do
+      _(machine.pending?).must_equal true
+      _(machine.unpaid?).must_equal true
+    end
+  end
+
+  context "independent state transitions" do
+    before do
+      machine.pay
+    end
+
+    it "must still be in the fulfilment initial state" do
+      _(machine.fulfilment_initial_state?).must_equal true
+      _(machine.pending?).must_equal true
+    end
+
+    it "must have advanced the payment state" do
+      _(machine.payment_state.name).must_equal :paid
+      _(machine.paid?).must_equal true
+    end
+
+    it "must not be in the payment initial state" do
+      _(machine.payment_initial_state?).must_equal false
+    end
+
+    it "must have persisted the payment state" do
+      machine.reload
+      _(machine.payment_state.name).must_equal :paid
+    end
+
+    it "must have persisted the fulfilment state as initial" do
+      machine.reload
+      _(machine.fulfilment_state.name).must_equal :pending
+    end
+  end
+
+  context "both machines advanced" do
+    before do
+      machine.items_collected
+      machine.pay
+    end
+
+    it "must be in the ready fulfilment state" do
+      _(machine.fulfilment_state.name).must_equal :ready
+      _(machine.ready?).must_equal true
+    end
+
+    it "must be in the paid payment state" do
+      _(machine.payment_state.name).must_equal :paid
+      _(machine.paid?).must_equal true
+    end
+
+    it "must have correct fulfilment transitions" do
+      _(machine.fulfilment_transitions.size).must_equal 1
+      _(machine.fulfilment_transitions.first.event_name).must_equal :dispatch
+    end
+
+    it "must have correct payment transitions" do
+      _(machine.payment_transitions.size).must_equal 1
+      _(machine.payment_transitions.first.event_name).must_equal :refund
+    end
+
+    it "must have persisted both states" do
+      machine.reload
+      _(machine.fulfilment_state.name).must_equal :ready
+      _(machine.payment_state.name).must_equal :paid
+    end
+  end
+
+  context "fulfilment final state" do
+    before do
+      machine.items_collected
+      machine.dispatch
+    end
+
+    it "must be in the fulfilment final state" do
+      _(machine.fulfilment_final_state?).must_equal true
+      _(machine.dispatched?).must_equal true
+    end
+
+    it "must have no fulfilment transitions" do
+      _(machine.fulfilment_transitions.empty?).must_equal true
+    end
+  end
+
+  context "payment final state" do
+    before do
+      machine.pay
+      machine.refund
+    end
+
+    it "must be in the payment final state" do
+      _(machine.payment_final_state?).must_equal true
+      _(machine.refunded?).must_equal true
+    end
+
+    it "must have no payment transitions" do
+      _(machine.payment_transitions.empty?).must_equal true
+    end
+  end
+
+  context "active?" do
+    it "must be active when all machines are in initial states" do
+      _(machine.active?).must_equal true
+    end
+
+    it "must be active when one machine has reached final state" do
+      machine.items_collected
+      machine.dispatch
+      _(machine.fulfilment_final_state?).must_equal true
+      _(machine.active?).must_equal true
+    end
+
+    it "must not be active when all machines have reached final states" do
+      machine.items_collected
+      machine.dispatch
+      machine.pay
+      machine.refund
+      _(machine.active?).must_equal false
+    end
+
+    it "must be able to check a specific machine" do
+      machine.items_collected
+      machine.dispatch
+      _(machine.active?(:fulfilment)).must_equal false
+      _(machine.active?(:payment)).must_equal true
+    end
+  end
+end

data/test/ActiveRecord/WithMultipleStateMachinesAndStatefulBlock.rb

@@ -0,0 +1,223 @@
+# test/ActiveRecord/WithMultipleStateMachinesAndStatefulBlock.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+require_relative './test_helper'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'Stateful'
+
+class CreateTableMachines < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_record_machine12s do |t|
+      t.string :fulfilment_state
+      t.string :payment_state
+    end
+  end
+end
+
+class ActiveRecordMachine12 < ActiveRecord::Base
+  extend Stateful
+
+  stateful do
+    state_machine :fulfilment do
+      initial_state :pending do
+        on :items_collected => :ready
+      end
+
+      state :ready do
+        on :dispatch => :dispatched
+      end
+
+      final_state :dispatched
+    end
+
+    state_machine :payment do
+      initial_state :unpaid do
+        on :pay => :paid
+      end
+
+      state :paid do
+        on :refund => :refunded
+      end
+
+      final_state :refunded
+    end
+  end
+end
+
+CreateTableMachines.new.change
+
+describe Stateful::ActiveRecord do
+  let(:machine){ActiveRecordMachine12.create}
+
+  context "initial states" do
+    it "must be in the fulfilment initial state" do
+      _(machine.fulfilment_initial_state?).must_equal true
+    end
+
+    it "must be in the payment initial state" do
+      _(machine.payment_initial_state?).must_equal true
+    end
+
+    it "must have the correct fulfilment state name" do
+      _(machine.fulfilment_state.name).must_equal :pending
+    end
+
+    it "must have the correct payment state name" do
+      _(machine.payment_state.name).must_equal :unpaid
+    end
+
+    it "must have fulfilment transitions" do
+      _(machine.fulfilment_transitions.size).must_equal 1
+      _(machine.fulfilment_transitions.first.event_name).must_equal :items_collected
+    end
+
+    it "must have payment transitions" do
+      _(machine.payment_transitions.size).must_equal 1
+      _(machine.payment_transitions.first.event_name).must_equal :pay
+    end
+
+    it "must not be in a fulfilment final state" do
+      _(machine.fulfilment_final_state?).must_equal false
+    end
+
+    it "must not be in a payment final state" do
+      _(machine.payment_final_state?).must_equal false
+    end
+
+    it "must have domain predicates" do
+      _(machine.pending?).must_equal true
+      _(machine.unpaid?).must_equal true
+    end
+  end
+
+  context "independent state transitions" do
+    before do
+      machine.pay
+    end
+
+    it "must still be in the fulfilment initial state" do
+      _(machine.fulfilment_initial_state?).must_equal true
+      _(machine.pending?).must_equal true
+    end
+
+    it "must have advanced the payment state" do
+      _(machine.payment_state.name).must_equal :paid
+      _(machine.paid?).must_equal true
+    end
+
+    it "must not be in the payment initial state" do
+      _(machine.payment_initial_state?).must_equal false
+    end
+
+    it "must have persisted the payment state" do
+      machine.reload
+      _(machine.payment_state.name).must_equal :paid
+    end
+
+    it "must have persisted the fulfilment state as initial" do
+      machine.reload
+      _(machine.fulfilment_state.name).must_equal :pending
+    end
+  end
+
+  context "both machines advanced" do
+    before do
+      machine.items_collected
+      machine.pay
+    end
+
+    it "must be in the ready fulfilment state" do
+      _(machine.fulfilment_state.name).must_equal :ready
+      _(machine.ready?).must_equal true
+    end
+
+    it "must be in the paid payment state" do
+      _(machine.payment_state.name).must_equal :paid
+      _(machine.paid?).must_equal true
+    end
+
+    it "must have correct fulfilment transitions" do
+      _(machine.fulfilment_transitions.size).must_equal 1
+      _(machine.fulfilment_transitions.first.event_name).must_equal :dispatch
+    end
+
+    it "must have correct payment transitions" do
+      _(machine.payment_transitions.size).must_equal 1
+      _(machine.payment_transitions.first.event_name).must_equal :refund
+    end
+
+    it "must have persisted both states" do
+      machine.reload
+      _(machine.fulfilment_state.name).must_equal :ready
+      _(machine.payment_state.name).must_equal :paid
+    end
+  end
+
+  context "fulfilment final state" do
+    before do
+      machine.items_collected
+      machine.dispatch
+    end
+
+    it "must be in the fulfilment final state" do
+      _(machine.fulfilment_final_state?).must_equal true
+      _(machine.dispatched?).must_equal true
+    end
+
+    it "must have no fulfilment transitions" do
+      _(machine.fulfilment_transitions.empty?).must_equal true
+    end
+  end
+
+  context "payment final state" do
+    before do
+      machine.pay
+      machine.refund
+    end
+
+    it "must be in the payment final state" do
+      _(machine.payment_final_state?).must_equal true
+      _(machine.refunded?).must_equal true
+    end
+
+    it "must have no payment transitions" do
+      _(machine.payment_transitions.empty?).must_equal true
+    end
+  end
+
+  context "active?" do
+    it "must be active when all machines are in initial states" do
+      _(machine.active?).must_equal true
+    end
+
+    it "must be active when one machine has reached final state" do
+      machine.items_collected
+      machine.dispatch
+      _(machine.fulfilment_final_state?).must_equal true
+      _(machine.active?).must_equal true
+    end
+
+    it "must not be active when all machines have reached final states" do
+      machine.items_collected
+      machine.dispatch
+      machine.pay
+      machine.refund
+      _(machine.active?).must_equal false
+    end
+
+    it "must be able to check a specific machine" do
+      machine.items_collected
+      machine.dispatch
+      _(machine.active?(:fulfilment)).must_equal false
+      _(machine.active?(:payment)).must_equal true
+    end
+  end
+end

data/test/ActiveRecord/WithPersistenceNonSpecificExtend.rb

@@ -0,0 +1,159 @@
+# test/ActiveRecord/WithPersistenceNonSpecificExtend.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+require_relative './test_helper'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'Stateful'
+
+class CreateTableMachines < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_record_machine0s do |t|
+      t.string :current_state
+    end
+  end
+end
+
+class ActiveRecordMachine0 < ActiveRecord::Base
+  extend Stateful
+
+  initial_state :initial_state
+
+  state :initial_state do
+    on :an_event => :next_state
+    on :another_event => :final_state
+  end
+
+  state :next_state do
+    on :yet_another_event => :final_state
+  end
+
+  final_state :final_state
+end
+
+CreateTableMachines.new.change
+
+describe Stateful::ActiveRecord do
+  let(:machine){ActiveRecordMachine0.create}
+
+  it "must have an initial state" do
+    _(machine.initial_state).wont_be_nil
+  end
+
+  it "must have a final state (if one has been specified)" do
+    if ActiveRecordMachine0.final_state?
+      _(machine.final_state).wont_be_nil
+    end
+  end
+
+  context "initial_state" do
+    it "must have an initial state before any events occur" do
+      _(machine.initial_state?).must_equal true
+    end
+
+    it "must have an initial state consistent with what is given" do
+      _(machine.initial_state).must_equal ActiveRecordMachine0.stateful_state_machine.initial_state
+    end
+
+    it "must have an initial state with name as per the name given" do
+      _(machine.initial_state.name).must_equal :initial_state
+    end
+
+    it "must not be in the final state (assuming that initial and final are different states)" do
+      _(machine.final_state?).must_equal false
+    end
+
+    it "must know what it's next state is given an event name" do
+      _(machine.next_state(:an_event)).must_equal ActiveRecordMachine0.stateful_state_machine.find(:next_state)
+      _(machine.next_state(:another_event)).must_equal ActiveRecordMachine0.stateful_state_machine.find(:final_state)
+    end
+
+    it "must have an intial state which has as set of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+    end
+
+    it "must have two transitions to other states" do
+      _(machine.transitions.size).must_equal 2
+    end
+
+    it "must know what transitions are available" do
+      _(machine.transitions.collect{|t| [t.event_name, t.next_state_name]}).must_equal [[:an_event, :next_state], [:another_event, :final_state]]
+    end
+
+    it "must be active" do
+      _(machine.active?).must_equal true
+    end
+  end
+
+  context "next_state" do
+    before do
+      machine.an_event
+    end
+
+    it "must not be in the initial state" do
+      _(machine.initial_state?).must_equal false
+    end
+
+    it "must not be in the final state" do
+      _(machine.final_state?).must_equal false
+    end
+
+    it "must be in the next_state state" do
+      _(machine.current_state.name).must_equal :next_state
+      _(machine.next_state?).must_equal true
+    end
+
+    it "must have a set of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+    end
+
+    it "must have one transition to other states" do
+      _(machine.transitions.size).must_equal 1
+    end
+
+    it "must know what transitions are available" do
+      _(machine.transitions.collect{|t| [t.event_name, t.next_state_name]}).must_equal [[:yet_another_event, :final_state]]
+    end
+
+    it "must be active" do
+      _(machine.active?).must_equal true
+    end
+  end
+
+  context "final_state" do
+    before do
+      machine.another_event
+    end
+
+    it "must have a final state" do
+      _(machine.final_state?).must_equal true
+    end
+
+    it "must have a final state consistent with what is given" do
+      _(machine.final_state).must_equal ActiveRecordMachine0.stateful_state_machine.final_state
+    end
+
+    it "must have a state with name as per the name given" do
+      _(machine.current_state.name).must_equal :final_state
+    end
+
+    it "must not be in the initial state (assuming that initial and final are different states)" do
+      _(machine.initial_state?).must_equal false
+    end
+
+    it "must have no transitions" do
+      _(machine.transitions.empty?).must_equal true
+    end
+
+    it "must not be active" do
+      _(machine.active?).must_equal false
+    end
+  end
+end