stateful.rb 2.1.0 → 2.2.0

data/test/Sequel/WithColumnName.rb

@@ -0,0 +1,154 @@
+# test/Sequel/WithColumnName.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'
+
+DB.create_table :sequel_machine8s do
+  primary_key :id
+  String :status
+end
+
+class SequelMachine8 < Sequel::Model
+  @stateful_column_name = 'status'
+
+  extend Stateful
+
+  initial_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
+
+describe Stateful::Sequel do
+  let(:machine){SequelMachine8.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 SequelMachine8.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 SequelMachine8.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 SequelMachine8.stateful_state_machine.find(:next_state)
+      _(machine.next_state(:another_event)).must_equal SequelMachine8.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.status.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 SequelMachine8.stateful_state_machine.final_state
+    end
+
+    it "must have a state with name as per the name given" do
+      _(machine.status.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

data/test/Sequel/WithExplicitDeterministicEventOrdering.rb

@@ -0,0 +1,154 @@
+# test/Sequel/WithExplicitDeterministicEventOrdering.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'
+
+DB.create_table :sequel_machine5s do
+  primary_key :id
+  String :current_state
+end
+
+class SequelMachine5 < Sequel::Model
+  extend Stateful
+
+  initial_state :initial_state, deterministic: true 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
+
+describe Stateful::Sequel do
+  let(:machine){SequelMachine5.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 SequelMachine5.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 SequelMachine5.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 SequelMachine5.stateful_state_machine.find(:next_state)
+      _(machine.next_state(:another_event)).must_equal SequelMachine5.stateful_state_machine.find(:final_state)
+    end
+
+    it "must have an intial state which has a collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    end
+
+    it "must have two transitions to other states" do
+      _(machine.transitions.size).must_equal 2
+    end
+
+    it "must know what transitions are available and in what order they are presented" 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 collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    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 SequelMachine5.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

data/test/Sequel/WithExplicitGlobalNonDeterministicEventOrdering.rb

@@ -0,0 +1,160 @@
+# test/Sequel/WithExplicitGlobalNonDeterministicEventOrdering.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'
+
+DB.create_table :sequel_machine9s do
+  primary_key :id
+  String :current_state
+end
+
+class SequelMachine9 < Sequel::Model
+  extend Stateful
+
+  stateful global_non_deterministic_event_ordering: true do
+    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
+end
+
+describe Stateful::Sequel do
+  let(:machine){SequelMachine9.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 SequelMachine9.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 SequelMachine9.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 SequelMachine9.stateful_state_machine.find(:next_state)
+      _(machine.next_state(:another_event)).must_equal SequelMachine9.stateful_state_machine.find(:final_state)
+    end
+
+    it "must have an intial state which has a collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    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
+      transition_pairs = machine.transitions.collect{|t| [t.event_name, t.next_state_name]}
+      _(transition_pairs).must_include [:an_event, :next_state]
+      _(transition_pairs).must_include [: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 collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    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 SequelMachine9.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

data/test/Sequel/WithExplicitGlobalNonDeterministicEventOrderingAndInitialStateBlock.rb

@@ -0,0 +1,158 @@
+# test/Sequel/WithExplicitGlobalNonDeterministicEventOrderingAndInitialStateBlock.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'
+
+DB.create_table :sequel_machine10s do
+  primary_key :id
+  String :current_state
+end
+
+class SequelMachine10 < Sequel::Model
+  extend Stateful
+
+  stateful global_non_deterministic_event_ordering: true do
+    initial_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
+end
+
+describe Stateful::Sequel do
+  let(:machine){SequelMachine10.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 SequelMachine10.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 SequelMachine10.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 SequelMachine10.stateful_state_machine.find(:next_state)
+      _(machine.next_state(:another_event)).must_equal SequelMachine10.stateful_state_machine.find(:final_state)
+    end
+
+    it "must have an intial state which has a collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    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
+      transition_pairs = machine.transitions.collect{|t| [t.event_name, t.next_state_name]}
+      _(transition_pairs).must_include [:an_event, :next_state]
+      _(transition_pairs).must_include [: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 collection of transitions to other states" do
+      _(machine.transitions.class).must_equal Array
+      _(machine.transitions.all?{|transition| transition.is_a?(Stateful::Transition)}).must_equal true
+    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 SequelMachine10.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