aasm/spec/unit/event_spec.rb

require 'spec_helper'

describe 'adding an event' do

  def new_event
    @event = AASM::SupportingClasses::Event.new(:close_order, {:success => :success_callback}) do
      transitions :to => :closed, :from => [:open, :received]
    end
  end

  it 'should set the name' do
    new_event
    @event.name.should == :close_order
  end

  it 'should set the success option' do
    new_event
    @event.success.should == :success_callback
  end

  it 'should create StateTransitions' do
    AASM::SupportingClasses::StateTransition.should_receive(:new).with({:to => :closed, :from => :open})
    AASM::SupportingClasses::StateTransition.should_receive(:new).with({:to => :closed, :from => :received})
    new_event
  end
end

describe 'transition inspection' do
  before do
    @event = AASM::SupportingClasses::Event.new(:run) do
      transitions :to => :running, :from => :sleeping
    end
  end

  it 'should support inspecting transitions from states' do
    @event.transitions_from_state(:sleeping).map(&:to).should == [:running]
    @event.transitions_from_state?(:sleeping).should be_true

    @event.transitions_from_state(:cleaning).map(&:to).should == []
    @event.transitions_from_state?(:cleaning).should be_false
  end

  it 'should support inspecting transitions to states' do
    @event.transitions_to_state(:running).map(&:from).should == [:sleeping]
    @event.transitions_to_state?(:running).should be_true

    @event.transitions_to_state(:cleaning).map(&:to).should == []
    @event.transitions_to_state?(:cleaning).should be_false
  end
end

describe 'firing an event' do
  it 'should return nil if the transitions are empty' do
    obj = mock('object')
    obj.stub!(:aasm_current_state)

    event = AASM::SupportingClasses::Event.new(:event)
    event.fire(obj).should be_nil
  end

  it 'should return the state of the first matching transition it finds' do
    event = AASM::SupportingClasses::Event.new(:event) do
      transitions :to => :closed, :from => [:open, :received]
    end

    obj = mock('object')
    obj.stub!(:aasm_current_state).and_return(:open)

    event.fire(obj).should == :closed
  end

  it 'should call the guard with the params passed in' do
    event = AASM::SupportingClasses::Event.new(:event) do
      transitions :to => :closed, :from => [:open, :received], :guard => :guard_fn
    end

    obj = mock('object')
    obj.stub!(:aasm_current_state).and_return(:open)
    obj.should_receive(:guard_fn).with('arg1', 'arg2').and_return(true)

    event.fire(obj, nil, 'arg1', 'arg2').should == :closed
  end

end

describe 'executing the success callback' do

  it "should send the success callback if it's a symbol" do
    ThisNameBetterNotBeInUse.instance_eval {
      aasm_event :with_symbol, :success => :symbol_success_callback do
        transitions :to => :symbol, :from => [:initial]
      end
    }

    model = ThisNameBetterNotBeInUse.new
    model.should_receive(:symbol_success_callback)
    model.with_symbol!
  end

  it "should send the success callback if it's a string" do
    ThisNameBetterNotBeInUse.instance_eval {
      aasm_event :with_string, :success => 'string_success_callback' do
        transitions :to => :string, :from => [:initial]
      end
    }

    model = ThisNameBetterNotBeInUse.new
    model.should_receive(:string_success_callback)
    model.with_string!
  end

  it "should call each success callback if passed an array of strings and/or symbols" do
    ThisNameBetterNotBeInUse.instance_eval {
      aasm_event :with_array, :success => [:success_callback1, 'success_callback2'] do
        transitions :to => :array, :from => [:initial]
      end
    }

    model = ThisNameBetterNotBeInUse.new
    model.should_receive(:success_callback1)
    model.should_receive(:success_callback2)
    model.with_array!
  end

  it "should call each success callback if passed an array of strings and/or symbols and/or procs" do
    ThisNameBetterNotBeInUse.instance_eval {
      aasm_event :with_array_including_procs, :success => [:success_callback1, 'success_callback2', lambda { |obj| obj.proc_success_callback }] do
        transitions :to => :array, :from => [:initial]
      end
    }

    model = ThisNameBetterNotBeInUse.new
    model.should_receive(:success_callback1)
    model.should_receive(:success_callback2)
    model.should_receive(:proc_success_callback)
    model.with_array_including_procs!
  end

  it "should call the success callback if it's a proc" do
    ThisNameBetterNotBeInUse.instance_eval {
      aasm_event :with_proc, :success => lambda { |obj| obj.proc_success_callback } do
        transitions :to => :proc, :from => [:initial]
      end
    }

    model = ThisNameBetterNotBeInUse.new
    model.should_receive(:proc_success_callback)
    model.with_proc!
  end
end

describe 'parametrised events' do
  let(:pe) {ParametrisedEvent.new}

  it 'should transition to specified next state (sleeping to showering)' do
    pe.wakeup!(:showering)
    pe.aasm_current_state.should == :showering
  end

  it 'should transition to specified next state (sleeping to working)' do
    pe.wakeup!(:working)
    pe.aasm_current_state.should == :working
  end

  it 'should transition to default (first or showering) state' do
    pe.wakeup!
    pe.aasm_current_state.should == :showering
  end

  it 'should transition to default state when on_transition invoked' do
    pe.dress!(nil, 'purple', 'dressy')
    pe.aasm_current_state.should == :working
  end

  it 'should call on_transition method with args' do
    pe.wakeup!(:showering)
    pe.should_receive(:wear_clothes).with('blue', 'jeans')
    pe.dress!(:working, 'blue', 'jeans')
  end

  it 'should call on_transition proc' do
    pe.wakeup!(:showering)
    pe.should_receive(:wear_clothes).with('purple', 'slacks')
    pe.dress!(:dating, 'purple', 'slacks')
  end

  it 'should call on_transition with an array of methods' do
    pe.wakeup!(:showering)
    pe.should_receive(:condition_hair)
    pe.should_receive(:fix_hair)
    pe.dress!(:prettying_up)
  end
end