edge-state-machine 0.0.1

data/spec/active_record_spec.rb

@@ -0,0 +1,248 @@
+require 'active_record_helper'
+
+ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
+
+class TrafficLight < ActiveRecord::Base
+  include ActiveRecord::EdgeStateMachine
+
+  state_machine do
+    state :off
+
+    state :red
+    state :green
+    state :yellow
+
+    event :red_on do
+      transitions :to => :red, :from => [:yellow]
+    end
+
+    event :green_on do
+      transitions :to => :green, :from => [:red]
+    end
+
+    event :yellow_on do
+      transitions :to => :yellow, :from => [:green]
+    end
+
+    event :reset do
+      transitions :to => :red, :from => [:off]
+    end
+  end
+end
+
+class ProtectedTrafficLight < TrafficLight
+  attr_protected :state
+end
+
+class ValidatingTrafficLight < TrafficLight
+  validate {|t| errors.add(:base, 'This TrafficLight will never validate after creation') unless t.new_record? }
+end
+
+class ConditionalValidatingTrafficLight < TrafficLight
+  validates :name, :presence => true, :length  => { :within => 20..40 }, :confirmation => true, :if => :red?
+end
+
+
+class Order < ActiveRecord::Base
+  include ActiveRecord::EdgeStateMachine
+
+  state_machine do
+    state :opened
+    state :placed
+    state :paid
+    state :prepared
+    state :delivered
+    state :cancelled
+
+    # no timestamp col is being specified here - should be ignored
+    event :place do
+      transitions :from => :opened, :to => :placed
+    end
+
+    # should set paid_at timestamp
+    event :pay, :timestamp => true do
+      transitions :from => :placed, :to => :paid
+    end
+
+    # should set prepared_on
+    event :prepare, :timestamp => true do
+      transitions :from => :paid, :to => :prepared
+    end
+
+    # should set dispatched_at
+    event :deliver, :timestamp => "dispatched_at" do
+      transitions :from => :prepared, :to => :delivered
+    end
+
+    # should set cancellation_date
+    event :cancel, :timestamp => :cancellation_date do
+      transitions :from => [:placed, :paid, :prepared], :to => :cancelled
+    end
+
+    # should raise an exception as there is no timestamp col
+    event :reopen, :timestamp => true do
+      transitions :from => :cancelled, :to => :opened
+    end
+
+  end
+end
+
+describe "active record state machine" do
+
+  context "existing active record" do
+    before do
+      ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
+      ActiveRecord::Migration.verbose = false
+      CreateTrafficLights.migrate(:up)
+      @light = TrafficLight.create!
+    end
+
+    it "should have an initial state" do
+      @light.off?.should == true
+      @light.current_state.should == :off
+    end
+
+    it "should go to a valid state on transition" do
+      @light.reset
+      @light.red?.should == true
+      @light.current_state.should == :red
+
+      @light.green_on
+      @light.green?.should == true
+      @light.current_state.should == :green
+    end
+
+    it "should not persist state on transition" do
+      @light.reset
+      @light.current_state.should == :red
+      @light.reload
+      @light.state.should == "off"
+    end
+
+    it "should persists state on transition" do
+      @light.reset!
+      @light.current_state.should == :red
+      @light.reload
+      @light.state.should == "red"
+    end
+
+    it "should raise error on transition to an invalid state" do
+      expect { @light.yellow_on }.should raise_error EdgeStateMachine::InvalidTransition
+      @light.current_state.should == :off
+    end
+
+    it "should persist state when state is protected on transition" do
+      protected_light = ProtectedTrafficLight.create!
+      protected_light.reset!
+      protected_light.current_state.should == :red
+      protected_light.reload
+      protected_light.state.should == "red"
+    end
+
+    it "should not validate when try transition with wrong state " do
+      for s in @light.class.state_machine.states
+        @light.state = s.name
+        @light.valid?.should == true
+      end
+      @light.state = "invalid_one"
+      @light.valid?.should_not == true
+    end
+
+    it "should raise exception when model validation fails on transition" do
+      validating_light = ValidatingTrafficLight.create!
+      expect {validating_light.reset!}.should raise_error ActiveRecord::RecordInvalid
+      validating_light.off?.should == true
+    end
+
+    #it "should state query method used in a validation condition" do
+      #validating_light = ConditionalValidatingTrafficLight.create!
+      #expect {validating_light.reset!}.should raise_error ActiveRecord::RecordInvalid
+      #validating_light.off?.should == true
+    #end
+
+    it "should reload the model when current state resets" do
+      @light.reset
+      @light.red?.should == true
+      @light.update_attribute(:state, 'green')
+      @light.reload.green?.should == false # reloaded state should come from instance variable not from database
+      # because the state can be changed without persist
+    end
+  end
+
+  context "new active record" do
+    before do
+      @light = TrafficLight.new
+    end
+
+    it "should have the initial state set" do
+      @light.current_state.should == :off
+    end
+  end
+
+  context "timestamp" do
+    before do
+      ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
+      ActiveRecord::Migration.verbose = false
+      CreateOrders.migrate(:up)
+    end
+
+    def create_order(state = nil)
+      Order.create! order_number: 234, state: state
+    end
+
+    # control case, no timestamp has been set so we should expect default behaviour
+    it "should not raise any exceptions when moving to placed" do
+      @order = create_order
+      expect { @order.place! }.should_not raise_error
+      @order.state.should == "placed"
+    end
+
+    it "should set paid_at when moving to paid" do
+      @order = create_order(:placed)
+      @order.pay!
+      @order.reload
+      @order.paid_at.should_not be_nil
+    end
+
+    it "should set prepared_on when moving to prepared" do
+      @order = create_order(:paid)
+      @order.prepare!
+      @order.reload
+      @order.prepared_on.should_not be_nil
+    end
+
+    it "should set dispatched_at when moving to delivered" do
+      @order = create_order(:prepared)
+      @order.deliver!
+      @order.reload
+      @order.dispatched_at.should_not be_nil
+    end
+
+    it "should set cancellation_date when moving to cancelled" do
+      @order = create_order(:placed)
+      @order.cancel!
+      @order.reload
+      @order.cancellation_date.should_not be_nil
+    end
+
+    it "should raise an exception as there is no attribute when moving to reopened" do
+      @order = create_order(:cancelled)
+      expect { @order.re_open! }.should raise_error NoMethodError
+      @order.reload
+    end
+
+    it "should raise an exception when passing an invalid value to timestamp options" do
+      expect {
+        class Order < ActiveRecord::Base
+          include ActiveRecord::EdgeStateMachine
+          state_machine do
+            event :replace, timestamp: 1 do
+              transitions :from => :prepared, :to => :placed
+            end
+          end
+        end
+      }.should raise_error ArgumentError
+    end
+
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+class ArgumentsTestSubject
+  include EdgeStateMachine
+  attr_accessor :date
+
+  state_machine do
+    state :initial
+    state :opened
+
+    event :open do
+      transitions :from => :initial, :to => :opened, :on_transition => :update_date
+    end
+  end
+
+  def update_date(date = Date.today)
+    self.date = date
+  end
+end
+
+def new_event
+  @event = EdgeStateMachine::Event.new(nil, @state_name, {:success => @success}) do
+    transitions :to => :closed, :from => [:open, :received]
+  end
+end
+
+describe EdgeStateMachine::Event do
+
+  before do
+    @state_name = :close_order
+    @success = :success_callback
+    @event = EdgeStateMachine::Event.new(nil, @state_name, {:success => @success}) do
+      transitions :to => :closed, :from => [:open, :received]
+    end
+  end
+
+  it "should set the name" do
+    @state_name.should == @event.name
+  end
+
+  it "should set the success option" do
+    @success.should == @event.success
+  end
+
+  it "should create StateTransitions" do
+    EdgeStateMachine::StateTransition.should_receive(:new).with(:to => :closed, :from => :open)
+    EdgeStateMachine::StateTransition.should_receive(:new).with(:to => :closed, :from => :received)
+    new_event
+  end
+
+  describe "event arguments" do
+    it "should pass arguments to transition method" do
+      subject = ArgumentsTestSubject.new
+      subject.current_state.should == :initial
+      subject.open!(Date.strptime('2001-02-03', '%Y-%m-%d'))
+      subject.current_state.should == :opened
+      subject.date.should == Date.strptime('2001-02-03', '%Y-%m-%d')
+    end
+  end
+
+  describe "events being fired" do
+    it "should raise an EdgeStateMachine::InvalidTransition error if the transitions are empty" do
+      event = EdgeStateMachine::Event.new(nil, :event)
+      expect {event.fire(nil)}.should raise_error EdgeStateMachine::InvalidTransition
+    end
+
+    it "should return the state of the first matching transition it finds" do
+      event = EdgeStateMachine::Event.new(nil, :event) do
+        transitions :to => :closed, :from => [:open, :received]
+      end
+      obj = mock
+      obj.stub!(:current_state).and_return(:open)
+      event.fire(obj).should == :closed
+    end
+  end
+end

data/spec/machine_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class MachineTestSubject
+  include EdgeStateMachine
+
+  state_machine do
+    state :open
+    state :closed
+  end
+
+  state_machine :initial => :foo do
+    event :shutdown do
+      transitions :from => :open, :to => :closed
+    end
+
+    event :timeout do
+      transitions :from => :open, :to => :closed
+    end
+  end
+
+  state_machine :extra, :initial => :bar do
+  end
+end
+
+describe EdgeStateMachine::Machine do
+
+  it 'should allow reuse of existing machines' do
+    MachineTestSubject.state_machines.size.should == 2
+  end
+
+  it "should set #initial_state from :initial option" do
+    MachineTestSubject.state_machine(:extra).initial_state.should == :bar
+  end
+
+  it "should accesse non-default state machine" do
+    MachineTestSubject.state_machine(:extra).class.should == EdgeStateMachine::Machine
+  end
+
+  it "should find event for given state" do
+    events = MachineTestSubject.state_machine.events_for(:open)
+    events.should be_include(:shutdown)
+    events.should be_include(:timeout)
+  end
+end

data/spec/migrations/create_orders.rb

@@ -0,0 +1,12 @@
+class CreateOrders < ActiveRecord::Migration
+  def self.up
+    create_table(:orders, force: true) do |t|
+      t.string :state
+      t.string :order_number
+      t.datetime :paid_at
+      t.datetime :prepared_on
+      t.datetime :dispatched_at
+      t.date :cancellation_date
+    end
+  end
+end

data/spec/migrations/create_traffic_lights.rb

@@ -0,0 +1,8 @@
+class CreateTrafficLights < ActiveRecord::Migration
+  def self.up
+    create_table(:traffic_lights, force: true) do |t|
+      t.string :state
+      t.string :name
+    end
+  end
+end

data/spec/mongoid_helper.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'mongoid'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mongoid/edge-state-machine'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('edge_state_machine_test')
+  config.allow_dynamic_fields = false
+end
+

data/spec/mongoid_spec.rb

@@ -0,0 +1,251 @@
+require 'mongoid_helper'
+
+class MongoTrafficLight
+  include Mongoid::Document
+  include Mongoid::EdgeStateMachine
+  field :state
+
+  state_machine do
+    state :off
+
+    state :red
+    state :green
+    state :yellow
+
+    event :red_on do
+      transitions :to => :red, :from => [:yellow]
+    end
+
+    event :green_on do
+      transitions :to => :green, :from => [:red]
+    end
+
+    event :yellow_on do
+      transitions :to => :yellow, :from => [:green]
+    end
+
+    event :reset do
+      transitions :to => :red, :from => [:off]
+    end
+  end
+end
+
+class MongoProtectedTrafficLight < MongoTrafficLight
+  attr_protected :state
+end
+
+class MongoValidatingTrafficLight < MongoTrafficLight
+  validate {|t| errors.add(:base, 'This TrafficLight will never validate after creation') unless t.new_record? }
+end
+
+class MongoConditionalValidatingTrafficLight < MongoTrafficLight
+  validates :name, :presence => true, :length  => { :within => 20..40 }, :confirmation => true, :if => :red?
+end
+
+class MongoOrder
+  include Mongoid::Document
+  include Mongoid::EdgeStateMachine
+
+  field :state, :type => String
+  field :order_number, :type => Integer
+  field :paid_at, :type => DateTime
+  field :prepared_on, :type => DateTime
+  field :dispatched_at, :type => DateTime
+  field :cancellation_date, :type => Date
+
+  state_machine do
+    state :opened
+    state :placed
+    state :paid
+    state :prepared
+    state :delivered
+    state :cancelled
+
+    # no timestamp col is being specified here - should be ignored
+    event :place do
+      transitions :from => :opened, :to => :placed
+    end
+
+    # should set paid_at timestamp
+    event :pay, :timestamp => true do
+      transitions :from => :placed, :to => :paid
+    end
+
+    # should set prepared_on
+    event :prepare, :timestamp => true do
+      transitions :from => :paid, :to => :prepared
+    end
+
+    # should set dispatched_at
+    event :deliver, :timestamp => "dispatched_at" do
+      transitions :from => :prepared, :to => :delivered
+    end
+
+    # should set cancellation_date
+    event :cancel, :timestamp => :cancellation_date do
+      transitions :from => [:placed, :paid, :prepared], :to => :cancelled
+    end
+
+    # should raise an exception as there is no timestamp col
+    event :reopen, :timestamp => true do
+      transitions :from => :cancelled, :to => :opened
+    end
+
+  end
+end
+
+describe "mongoid state machine" do
+
+  context "existing mongo document" do
+    before do
+      Mongoid.master.collections.reject { |c| c.name =~ /^system\./ }.each(&:drop)
+      @light = MongoTrafficLight.create!
+    end
+
+    it "should have an initial state" do
+      @light.off?.should == true
+      @light.current_state.should == :off
+    end
+
+    it "should go to a valid state on transition" do
+      @light.reset
+      @light.red?.should == true
+      @light.current_state.should == :red
+
+      @light.green_on
+      @light.green?.should == true
+      @light.current_state.should == :green
+    end
+
+    it "should not persist state on transition" do
+      @light.reset
+      @light.current_state.should == :red
+      @light.reload
+      @light.state.should == "off"
+    end
+
+    it "should persists state on transition" do
+      @light.reset!
+      @light.current_state.should == :red
+      @light.reload
+      @light.state.should == "red"
+    end
+
+    it "should raise error on transition to an invalid state" do
+      expect { @light.yellow_on }.should raise_error EdgeStateMachine::InvalidTransition
+      @light.current_state.should == :off
+    end
+
+    it "should persist state when state is protected on transition" do
+      protected_light = MongoProtectedTrafficLight.create!
+      protected_light.reset!
+      protected_light.current_state.should == :red
+      protected_light.reload
+      protected_light.state.should == "red"
+    end
+
+    it "should not validate when try transition with wrong state " do
+      for s in @light.class.state_machine.states
+        @light.state = s.name
+        @light.valid?.should == true
+      end
+      @light.state = "invalid_one"
+      @light.valid?.should_not == true
+    end
+
+    it "should raise exception when model validation fails on transition" do
+      validating_light = MongoValidatingTrafficLight.create!
+      expect {validating_light.reset!}.should raise_error Mongoid::Errors::Validations
+    end
+
+    #it "should state query method used in a validation condition" do
+      #validating_light = MongoConditionalValidatingTrafficLight.create!
+      #expect {validating_light.reset!}.should raise_error Mongoid::RecordInvalid
+      #validating_light.off?.should == true
+    #end
+
+    it "should reload the model when current state resets" do
+      @light.reset
+      @light.red?.should == true
+      @light.update_attribute(:state, 'green')
+      @light.reload.green?.should == false # reloaded state should come from instance variable not from database
+      # because the state can be changed without persist
+    end
+  end
+
+  context "new active record" do
+    before do
+      @light = MongoTrafficLight.new
+    end
+
+    it "should have the initial state set" do
+      @light.current_state.should == :off
+    end
+  end
+
+  context "timestamp" do
+    before do
+      Mongoid.master.collections.reject { |c| c.name =~ /^system\./ }.each(&:drop)
+    end
+
+    def create_order(state = nil)
+      MongoOrder.create! order_number: 234, state: state
+    end
+
+    # control case, no timestamp has been set so we should expect default behaviour
+    it "should not raise any exceptions when moving to placed" do
+      @order = create_order
+      expect { @order.place! }.should_not raise_error
+      @order.state.should == "placed"
+    end
+
+    it "should set paid_at when moving to paid" do
+      @order = create_order(:placed)
+      @order.pay!
+      @order.reload
+      @order.paid_at.should_not be_nil
+    end
+
+    it "should set prepared_on when moving to prepared" do
+      @order = create_order(:paid)
+      @order.prepare!
+      @order.reload
+      @order.prepared_on.should_not be_nil
+    end
+
+    it "should set dispatched_at when moving to delivered" do
+      @order = create_order(:prepared)
+      @order.deliver!
+      @order.reload
+      @order.dispatched_at.should_not be_nil
+    end
+
+    it "should set cancellation_date when moving to cancelled" do
+      @order = create_order(:placed)
+      @order.cancel!
+      @order.reload
+      @order.cancellation_date.should_not be_nil
+    end
+
+    it "should raise an exception as there is no attribute when moving to reopened" do
+      @order = create_order(:cancelled)
+      expect { @order.re_open! }.should raise_error NoMethodError
+      @order.reload
+    end
+
+    it "should raise an exception when passing an invalid value to timestamp options" do
+      expect {
+        class MongoOrder
+          include Mongoid::Document
+          include Mongoid::EdgeStateMachine
+
+          state_machine do
+            event :replace, timestamp: 1 do
+              transitions :from => :prepared, :to => :placed
+            end
+          end
+        end
+      }.should raise_error ArgumentError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'edge-state-machine'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end