ardm-is-state_machine 1.2.0

data/spec/integration/slot_machine_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'examples/slot_machine'
+
+describe SlotMachine do
+
+  before(:each) do
+    @sm = SlotMachine.new
+  end
+
+  it "should have a 'mode' column" do
+    @sm.attributes.should have_key(:mode)
+  end
+
+  it "should have a 'power_on' column" do
+    @sm.attributes.should have_key(:power_on)
+  end
+
+  it "should not have a 'state' column" do
+    @sm.attributes.should_not have_key(:state)
+  end
+
+  it "should start in the off state" do
+    @sm.mode.should == "off"
+  end
+
+  it "should start with power_on == false" do
+    @sm.power_on.should == false
+  end
+
+  describe "in :off mode" do
+
+    before(:each) do
+      @sm.mode = :off
+      @sm.power_on = false
+    end
+
+    it "should allow the mode to be set" do
+      @sm.mode = :idle
+      @sm.save
+      @sm.mode.should == "idle"
+    end
+
+    it "turn_on! should work from off mode" do
+      @sm.turn_on!
+      @sm.mode.should == "idle"
+      @sm.power_on.should == true
+    end
+
+    it "turn_on! should not work twice in a row" do
+      @sm.turn_on!
+      lambda {
+        @sm.turn_on!
+      }.should raise_error(DataMapper::Is::StateMachine::InvalidEvent)
+    end
+
+  end
+
+  describe "in :idle mode" do
+
+    before(:each) do
+      @sm.mode = :idle
+      @sm.power_on = true
+    end
+
+    it "turn_on! should raise error" do
+      lambda {
+        @sm.turn_on!
+      }.should raise_error(DataMapper::Is::StateMachine::InvalidEvent)
+    end
+
+    it "turn_off! should work" do
+      @sm.turn_off!
+      @sm.mode.should == "off"
+      @sm.power_on.should == false
+    end
+
+    it "turn_off! should not work twice in a row" do
+      @sm.turn_off!
+      lambda {
+        @sm.turn_off!
+      }.should raise_error(DataMapper::Is::StateMachine::InvalidEvent)
+    end
+
+  end
+
+end

data/spec/integration/traffic_light_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require 'examples/traffic_light'
+
+describe TrafficLight do
+
+  before(:each) do
+    @t = TrafficLight.new
+  end
+
+  it "should have a 'color' column" do
+    @t.attributes.should have_key(:color)
+  end
+
+  it "should not have a 'state' column" do
+    @t.attributes.should_not have_key(:state)
+  end
+
+  it "should start off in the green state" do
+    @t.color.should == "green"
+  end
+
+  it "should allow the color to be set" do
+    @t.color = :yellow
+    @t.save
+    @t.color.should == "yellow"
+  end
+
+  it "should have called the :enter Proc" do
+    @t.log.should == %w(G)
+  end
+
+  it "should call the original initialize method" do
+    @t.init.should == [:init]
+  end
+
+  describe 'forward!' do
+
+    it "should respond to :forward!" do
+      @t.respond_to?(:forward!).should == true
+    end
+
+    it "should transition to :yellow, :red, :green" do
+      @t.color.should == "green"
+      @t.forward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G Y)
+      @t.forward!
+      @t.color.should == "red"
+      @t.log.should == %w(G Y R)
+      @t.forward!
+      @t.color.should == "green"
+      @t.log.should == %w(G Y R G)
+      @t.should be_new
+    end
+
+    it "should skip to :yellow then transition to :red, :green, :yellow" do
+      @t.color = :yellow
+      @t.color.should == "yellow"
+      @t.log.should == %w(G)
+      @t.forward!
+      @t.color.should == "red"
+      @t.log.should == %w(G R)
+      @t.forward!
+      @t.color.should == "green"
+      @t.log.should == %w(G R G)
+      @t.forward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G R G Y)
+      @t.should be_new
+    end
+
+    it "should skip to :red then transition to :green, :yellow, :red" do
+      @t.color = :red
+      @t.color.should == "red"
+      @t.log.should == %w(G)
+      @t.forward!
+      @t.color.should == "green"
+      @t.log.should == %w(G G)
+      @t.forward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G G Y)
+      @t.forward!
+      @t.color.should == "red"
+      @t.log.should == %w(G G Y R)
+      @t.should be_new
+    end
+
+  end
+
+  describe 'backward!' do
+
+    it "should respond to 'backward!'" do
+      @t.respond_to?(:backward!).should == true
+    end
+
+    it "should transition to :red, :yellow, :green" do
+      @t.color.should == "green"
+      @t.log.should == %w(G)
+      @t.backward!
+      @t.color.should == "red"
+      @t.log.should == %w(G R)
+      @t.backward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G R Y)
+      @t.backward!
+      @t.color.should == "green"
+      @t.log.should == %w(G R Y G)
+      @t.should be_new
+    end
+
+    it "should skip to :yellow then transition to :green, :red, :yellow" do
+      @t.color = :yellow
+      @t.color.should == "yellow"
+      @t.log.should == %w(G)
+      @t.backward!
+      @t.color.should == "green"
+      @t.log.should == %w(G G)
+      @t.backward!
+      @t.color.should == "red"
+      @t.log.should == %w(G G R)
+      @t.backward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G G R Y)
+      @t.should be_new
+    end
+
+    it "should skip to :red then transition to :yellow, :green, :red" do
+      @t.color = :red
+      @t.color.should == "red"
+      @t.log.should == %w(G)
+      @t.backward!
+      @t.color.should == "yellow"
+      @t.log.should == %w(G Y)
+      @t.backward!
+      @t.color.should == "green"
+      @t.log.should == %w(G Y G)
+      @t.backward!
+      @t.color.should == "red"
+      @t.log.should == %w(G Y G R)
+      @t.should be_new
+    end
+
+  end
+
+  describe "hooks" do
+
+    it "should log initial state before state is changed on a before hook" do
+      @t.forward!
+      @t.before_hook_log.should == %w(green)
+      @t.forward!
+      @t.before_hook_log.should == %w(green yellow)
+      @t.forward!
+      @t.before_hook_log.should == %w(green yellow red)
+    end
+
+    it "should log final state before state is changed on a before hook" do
+      @t.forward!
+      @t.after_hook_log.should == %w(yellow)
+      @t.forward!
+      @t.after_hook_log.should == %w(yellow red)
+      @t.forward!
+      @t.after_hook_log.should == %w(yellow red green)
+    end
+
+  end
+
+  describe "overwriting event methods" do
+
+    before(:all) do
+      TrafficLight.class_eval "def forward!(added_param); log << added_param; transition!(:forward); end"
+    end
+
+    it "should transition normally with added functionality" do
+      @t.color.should == "green"
+      @t.forward!("test")
+      @t.color.should == "yellow"
+      @t.log.should == %w(G test Y)
+    end
+
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,6 @@
+--exclude "spec,^/"
+--sort coverage
+--callsites
+--xrefs
+--profile
+--text-summary

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--loadby random
+--format profile
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-state_machine'
+require 'dm-migrations'
+
+DataMapper::Spec.setup
+
+Spec::Runner.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

data/spec/unit/data/event_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module EventHelper
+  def new_event(*args)
+    DataMapper::Is::StateMachine::Data::Event.new(*args)
+  end
+end
+
+describe DataMapper::Is::StateMachine::Data::Event do
+  include EventHelper
+
+  before(:each) do
+    @machine = mock("machine")
+    @event = new_event(:ping, @machine)
+  end
+
+  it "#initialize should work" do
+    @event.name.should        == :ping
+    @event.machine.should     == @machine
+    @event.transitions.should == []
+  end
+
+  it "#add_transition should work" do
+    @event.add_transition(:nothing, :pinged)
+    @event.transitions.should == [{:from => :nothing, :to => :pinged }]
+  end
+end

data/spec/unit/data/machine_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+module MachineHelper
+  def new_machine(*args)
+    DataMapper::Is::StateMachine::Data::Machine.new(*args)
+  end
+
+  def new_state(name, machine, options = {})
+    mock(name, :name => name, :machine => machine, :options => options)
+  end
+
+  def new_event(name, machine)
+    mock(name, :name => name, :machine => machine)
+  end
+end
+
+describe DataMapper::Is::StateMachine::Data::Machine do
+  include MachineHelper
+
+  describe "new Machine, no events" do
+    before(:each) do
+      @machine = new_machine(:power, :off)
+    end
+
+    it "#column should work" do
+      @machine.column.should == :power
+    end
+
+    it "#initial should work" do
+      @machine.initial.should == :off
+    end
+
+    it "#events should work" do
+      @machine.events.should == []
+    end
+
+    it "#states should work" do
+      @machine.states.should == []
+    end
+
+    it "#find_event should return nothing" do
+      @machine.find_event(:turn_on).should == nil
+    end
+
+    it "#fire_event should raise error" do
+      lambda {
+        @machine.fire_event(:turn_on, nil)
+      }.should raise_error(DataMapper::Is::StateMachine::InvalidEvent)
+    end
+  end
+
+  describe "new Machine, 2 states, 1 event" do
+    before(:each) do
+      @machine = new_machine(:power, :off)
+      @machine.states << (@off_state = new_state(:off, @machine))
+      @machine.states << (@on_state = new_state(:on, @machine))
+      @machine.events << (@turn_on = new_event(:turn_on, @machine))
+      @turn_on.stub!(:transitions).and_return([{ :from => :off, :to => :on }])
+    end
+
+    it "#column should work" do
+      @machine.column.should == :power
+    end
+
+    it "#initial should work" do
+      @machine.initial.should == :off
+    end
+
+    it "#events should work" do
+      @machine.events.should == [@turn_on]
+    end
+
+    it "#states should work" do
+      @machine.states.should == [@off_state, @on_state]
+    end
+
+    it "#current_state should work" do
+      @machine.current_state.should == @off_state
+    end
+
+    it "#current_state_name should work" do
+      @machine.current_state_name.should == :off
+    end
+
+    it "#find_event should return nothing" do
+      @machine.find_event(:turn_on).should == @turn_on
+    end
+
+    it "#fire_event should change state" do
+      resource = mock("resource")
+      resource.should_receive(:run_hook_if_present).exactly(2).times.with(nil)
+      @machine.fire_event(:turn_on, resource)
+      @machine.current_state.should == @on_state
+      @machine.current_state_name.should == :on
+    end
+
+  end
+
+  # TODO: spec fire_event where :run_hook_if_present fires two times,
+  # but with :enter the first and :exit the second.
+
+end

data/spec/unit/data/state_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module StateHelper
+  def new_state(*args)
+    DataMapper::Is::StateMachine::Data::State.new(*args)
+  end
+end
+
+describe DataMapper::Is::StateMachine::Data::State do
+  include StateHelper
+
+  before(:each) do
+    @machine = mock("machine")
+    @state = new_state(:off, @machine)
+  end
+
+  it "#initialize should work" do
+    @state.name.should    == :off
+    @state.machine.should == @machine
+  end
+end