aasm 4.0.8 → 4.5.2

data/spec/unit/complex_multiple_example_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe 'on initialization' do
+  let(:auth) {ComplexExampleMultiple.new}
+
+  it 'should be in the initial state' do
+    expect(auth.aasm(:left).current_state).to eq(:pending)
+    expect(auth.aasm(:right).current_state).to eq(:pending)
+  end
+
+  it 'should have an activation code' do
+    expect(auth.has_activation_code?).to be_truthy
+    expect(auth.activation_code).to eq '12'
+  end
+end
+
+describe 'when being unsuspended' do
+  let(:auth) {ComplexExampleMultiple.new}
+
+  it 'should be able to unsuspend' do
+    auth.left_activate!
+    auth.left_suspend!
+    expect(auth.may_left_unsuspend?).to be true
+
+    auth.right_activate!
+    auth.right_suspend!
+    expect(auth.may_right_unsuspend?).to be true
+  end
+
+  it 'should not be able to unsuspend into active' do
+    auth.left_suspend!
+    expect(auth.may_left_unsuspend?(:active)).not_to be true
+
+    auth.right_activate!
+    auth.right_suspend!
+    expect(auth.may_right_unsuspend?(:active)).to be true
+  end
+
+  it 'should be able to wait into waiting if polite' do
+    auth.left_suspend!
+    expect(auth.may_left_wait?(:waiting, :please)).to be true
+    auth.left_wait!(nil, :please)
+
+    auth.right_suspend!
+    expect(auth.may_right_wait?(:waiting)).to be false
+    auth.right_wait!(nil, :please)
+  end
+
+  it 'should not be able to be unsuspended into active if not polite' do
+    auth.left_suspend!
+    expect(auth.may_left_wait?(:waiting)).not_to be true
+    expect(auth.may_left_wait?(:waiting, :rude)).not_to be true
+    expect {auth.left_wait!(nil, :rude)}.to raise_error(AASM::InvalidTransition)
+    expect {auth.left_wait!}.to raise_error(AASM::InvalidTransition)
+  end
+
+  it 'should not be able to be unpassified' do
+    auth.left_activate!
+    auth.left_suspend!
+    auth.left_unsuspend!
+
+    expect(auth.may_left_unpassify?).not_to be true
+    expect {auth.left_unpassify!}.to raise_error(AASM::InvalidTransition)
+  end
+
+  it 'should be active if previously activated' do
+    auth.left_activate!
+    auth.left_suspend!
+    auth.left_unsuspend!
+
+    expect(auth.aasm(:left).current_state).to eq(:active)
+  end
+
+  it 'should be pending if not previously activated, but an activation code is present' do
+    auth.left_suspend!
+    auth.left_unsuspend!
+
+    expect(auth.aasm(:left).current_state).to eq(:pending)
+  end
+
+  it 'should be passive if not previously activated and there is no activation code' do
+    auth.activation_code = nil
+    auth.left_suspend!
+    auth.left_unsuspend!
+
+    expect(auth.aasm(:left).current_state).to eq(:passive)
+  end
+
+  it "should be able to fire known events" do
+    expect(auth.aasm(:left).may_fire_event?(:left_activate)).to be true
+    expect(auth.aasm(:right).may_fire_event?(:right_activate)).to be true
+  end
+
+  it "should not be able to fire unknown events" do
+    expect(auth.aasm(:left).may_fire_event?(:unknown)).to be false
+    expect(auth.aasm(:right).may_fire_event?(:unknown)).to be false
+  end
+
+end

data/spec/unit/edge_cases_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "edge cases" do
+  describe "for classes with multiple state machines" do
+    it "allows accessing a multiple state machine class without state machine name" do
+      # it's like starting to define a new state machine within the
+      # requested class
+      expect(SimpleMultipleExample.aasm.states.map(&:name)).to be_empty
+    end
+
+    it "do not know yet" do
+      example = ComplexExampleMultiple.new
+      expect { example.aasm.states.inspect }.to raise_error(AASM::UnknownStateMachineError)
+    end
+  end
+end

data/spec/unit/event_multiple_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'current event' do
+  let(:pe) {ParametrisedEventMultiple.new}
+
+  it 'if no event has been triggered' do
+    expect(pe.aasm(:left).current_event).to be_nil
+  end
+
+  it 'if a event has been triggered' do
+    pe.wakeup
+    expect(pe.aasm(:left).current_event).to eql :wakeup
+  end
+
+  it 'if no event has been triggered' do
+    pe.wakeup!
+    expect(pe.aasm(:left).current_event).to eql :wakeup!
+  end
+end
+
+describe 'parametrised events' do
+  let(:pe) {ParametrisedEventMultiple.new}
+
+  it 'should transition to specified next state (sleeping to showering)' do
+    pe.wakeup!(:showering)
+    expect(pe.aasm(:left).current_state).to eq(:showering)
+  end
+
+  it 'should transition to specified next state (sleeping to working)' do
+    pe.wakeup!(:working)
+    expect(pe.aasm(:left).current_state).to eq(:working)
+  end
+
+  it 'should transition to default (first or showering) state' do
+    pe.wakeup!
+    expect(pe.aasm(:left).current_state).to eq(:showering)
+  end
+
+  it 'should transition to default state when :after transition invoked' do
+    pe.dress!(nil, 'purple', 'dressy')
+    expect(pe.aasm(:left).current_state).to eq(:working)
+  end
+
+  it 'should call :after transition method with args' do
+    pe.wakeup!(:showering)
+    expect(pe).to receive(:wear_clothes).with('blue', 'jeans')
+    pe.dress!(:working, 'blue', 'jeans')
+  end
+
+  it 'should call :after transition proc' do
+    pe.wakeup!(:showering)
+    expect(pe).to receive(:wear_clothes).with('purple', 'slacks')
+    pe.dress!(:dating, 'purple', 'slacks')
+  end
+
+  it 'should call :after transition with an array of methods' do
+    pe.wakeup!(:showering)
+    expect(pe).to receive(:condition_hair)
+    expect(pe).to receive(:fix_hair)
+    pe.dress!(:prettying_up)
+  end
+end
+
+describe 'event firing without persistence' do
+  it 'should attempt to persist if aasm_write_state is defined' do
+    foo = Foo.new
+    def foo.aasm_write_state; end
+    expect(foo).to be_open
+
+    expect(foo).to receive(:aasm_write_state_without_persistence)
+    foo.close
+  end
+end

data/spec/unit/event_naming_spec.rb

@@ -1,22 +1,9 @@
 require 'spec_helper'
 
-class SimpleStateMachine
-  include AASM
-
-  aasm do
-    state :init, :initial => true
-    state :failed
-
-    event :failed do
-      transitions :from => :init, :to => :failed
-    end
-  end
-end
-
 describe "event naming" do
-  let(:state_machine) { SimpleStateMachine.new }
+  let(:state_machine) { StateMachineWithFailedEvent.new }
 
-  it "allows an event of failed without blowing the stack" do
+  it "allows an event of failed without blowing the stack aka stack level too deep" do
     state_machine.failed
 
     expect { state_machine.failed }.to raise_error(AASM::InvalidTransition)

data/spec/unit/event_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
 describe 'adding an event' do
+  let(:state_machine) { AASM::StateMachine.new(:name) }
   let(:event) do
-    AASM::Core::Event.new(:close_order, {:success => :success_callback}) do
+    AASM::Core::Event.new(:close_order, state_machine, {:success => :success_callback}) do
       before :before_callback
       after :after_callback
       transitions :to => :closed, :from => [:open, :received]
@@ -35,8 +36,9 @@ describe 'adding an event' do
 end
 
 describe 'transition inspection' do
+  let(:state_machine) { AASM::StateMachine.new(:name) }
   let(:event) do
-    AASM::Core::Event.new(:run) do
+    AASM::Core::Event.new(:run, state_machine) do
       transitions :to => :running, :from => :sleeping
     end
   end
@@ -59,8 +61,9 @@ describe 'transition inspection' do
 end
 
 describe 'transition inspection without from' do
+  let(:state_machine) { AASM::StateMachine.new(:name) }
   let(:event) do
-    AASM::Core::Event.new(:run) do
+    AASM::Core::Event.new(:run, state_machine) do
       transitions :to => :running
     end
   end
@@ -76,15 +79,17 @@ describe 'transition inspection without from' do
 end
 
 describe 'firing an event' do
+  let(:state_machine) { AASM::StateMachine.new(:name) }
+
   it 'should return nil if the transitions are empty' do
     obj = double('object', :aasm => double('aasm', :current_state => 'open'))
 
-    event = AASM::Core::Event.new(:event)
+    event = AASM::Core::Event.new(:event, state_machine)
     expect(event.fire(obj)).to be_nil
   end
 
   it 'should return the state of the first matching transition it finds' do
-    event = AASM::Core::Event.new(:event) do
+    event = AASM::Core::Event.new(:event, state_machine) do
       transitions :to => :closed, :from => [:open, :received]
     end
 
@@ -94,7 +99,7 @@ describe 'firing an event' do
   end
 
   it 'should call the guard with the params passed in' do
-    event = AASM::Core::Event.new(:event) do
+    event = AASM::Core::Event.new(:event, state_machine) do
       transitions :to => :closed, :from => [:open, :received], :guard => :guard_fn
     end
 

data/spec/unit/guard_multiple_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "per-transition guards" do
+  let(:guardian) { GuardianMultiple.new }
+
+  it "allows the transition if the guard succeeds" do
+    expect { guardian.use_one_guard_that_succeeds! }.to_not raise_error
+    expect(guardian).to be_beta
+  end
+
+  it "stops the transition if the guard fails" do
+    expect { guardian.use_one_guard_that_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+
+  it "allows the transition if all guards succeeds" do
+    expect { guardian.use_guards_that_succeed! }.to_not raise_error
+    expect(guardian).to be_beta
+  end
+
+  it "stops the transition if the first guard fails" do
+    expect { guardian.use_guards_where_the_first_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+
+  it "stops the transition if the second guard fails" do
+    expect { guardian.use_guards_where_the_second_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+end
+
+describe "event guards" do
+  let(:guardian) { GuardianMultiple.new }
+
+  it "allows the transition if the event guards succeed" do
+    expect { guardian.use_event_guards_that_succeed! }.to_not raise_error
+    expect(guardian).to be_beta
+  end
+
+  it "allows the transition if the event and transition guards succeed" do
+    expect { guardian.use_event_and_transition_guards_that_succeed! }.to_not raise_error
+    expect(guardian).to be_beta
+  end
+
+  it "stops the transition if the first event guard fails" do
+    expect { guardian.use_event_guards_where_the_first_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+
+  it "stops the transition if the second event guard fails" do
+    expect { guardian.use_event_guards_where_the_second_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+
+  it "stops the transition if the transition guard fails" do
+    expect { guardian.use_event_and_transition_guards_where_third_fails! }.to raise_error(AASM::InvalidTransition)
+    expect(guardian).to be_alpha
+  end
+
+end

data/spec/unit/guard_spec.rb

@@ -27,6 +27,18 @@ describe "per-transition guards" do
     expect { guardian.use_guards_where_the_second_fails! }.to raise_error(AASM::InvalidTransition)
     expect(guardian).to be_alpha
   end
+
+  describe "with params" do
+    it "using a Proc" do
+      expect(guardian).to receive(:inner_guard).with({:flag => true}).and_return(true)
+      guardian.use_proc_guard_with_params(:flag => true)
+    end
+
+    it "using a lambda" do
+      expect(guardian).to receive(:inner_guard).with({:flag => true}).and_return(true)
+      guardian.use_lambda_guard_with_params(:flag => true)
+    end
+  end
 end
 
 describe "event guards" do

data/spec/unit/initial_state_multiple_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'initial states' do
+  it 'should use the first state defined if no initial state is given' do
+    expect(NoInitialStateMultiple.new.aasm(:left).current_state).to eq(:read)
+  end
+
+  it 'should determine initial state from the Proc results' do
+    balance = InitialStateProcMultiple::RICH - 1
+    expect(InitialStateProcMultiple.new(balance).aasm(:left).current_state).to eq(:selling_bad_mortgages)
+
+    balance = InitialStateProcMultiple::RICH + 1
+    expect(InitialStateProcMultiple.new(balance).aasm(:left).current_state).to eq(:retired)
+  end
+end

data/spec/unit/initial_state_spec.rb

@@ -1,27 +1,12 @@
 require 'spec_helper'
 
-class Banker
-  include AASM
-  aasm do
-    state :retired
-    state :selling_bad_mortgages
-    initial_state Proc.new { |banker| banker.rich? ? :retired : :selling_bad_mortgages }
-  end
-  RICH = 1_000_000
-  attr_accessor :balance
-  def initialize(balance = 0); self.balance = balance; end
-  def rich?; self.balance >= RICH; end
-end
-
 describe 'initial states' do
-  let(:bar) {Bar.new}
-
   it 'should use the first state defined if no initial state is given' do
-    expect(bar.aasm.current_state).to eq(:read)
+    expect(NoInitialState.new.aasm.current_state).to eq(:read)
   end
 
   it 'should determine initial state from the Proc results' do
-    expect(Banker.new(Banker::RICH - 1).aasm.current_state).to eq(:selling_bad_mortgages)
-    expect(Banker.new(Banker::RICH + 1).aasm.current_state).to eq(:retired)
+    expect(InitialStateProc.new(InitialStateProc::RICH - 1).aasm.current_state).to eq(:selling_bad_mortgages)
+    expect(InitialStateProc.new(InitialStateProc::RICH + 1).aasm.current_state).to eq(:retired)
   end
 end

data/spec/unit/inspection_multiple_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe 'inspection for common cases' do
+  it 'should support the new DSL' do
+    # 1st state machine
+    expect(FooMultiple.aasm(:left)).to respond_to(:states)
+    expect(FooMultiple.aasm(:left).states.size).to eql 3
+    expect(FooMultiple.aasm(:left).states).to include(:open)
+    expect(FooMultiple.aasm(:left).states).to include(:closed)
+    expect(FooMultiple.aasm(:left).states).to include(:final)
+
+    expect(FooMultiple.aasm(:left)).to respond_to(:initial_state)
+    expect(FooMultiple.aasm(:left).initial_state).to eq(:open)
+
+    expect(FooMultiple.aasm(:left)).to respond_to(:events)
+    expect(FooMultiple.aasm(:left).events.size).to eql 2
+    expect(FooMultiple.aasm(:left).events).to include(:close)
+    expect(FooMultiple.aasm(:left).events).to include(:null)
+
+    # 2nd state machine
+    expect(FooMultiple.aasm(:right)).to respond_to(:states)
+    expect(FooMultiple.aasm(:right).states.size).to eql 3
+    expect(FooMultiple.aasm(:right).states).to include(:green)
+    expect(FooMultiple.aasm(:right).states).to include(:yellow)
+    expect(FooMultiple.aasm(:right).states).to include(:red)
+
+    expect(FooMultiple.aasm(:right)).to respond_to(:initial_state)
+    expect(FooMultiple.aasm(:right).initial_state).to eq(:green)
+
+    expect(FooMultiple.aasm(:right)).to respond_to(:events)
+    expect(FooMultiple.aasm(:right).events.size).to eql 3
+    expect(FooMultiple.aasm(:right).events).to include(:green)
+    expect(FooMultiple.aasm(:right).events).to include(:yellow)
+    expect(FooMultiple.aasm(:right).events).to include(:red)
+  end
+
+  context "instance level inspection" do
+    let(:foo) { FooMultiple.new }
+    let(:two) { FooTwoMultiple.new }
+
+    it "delivers all states" do
+      # 1st state machine
+      states = foo.aasm(:left).states
+      expect(states.size).to eql 3
+      expect(states).to include(:open)
+      expect(states).to include(:closed)
+      expect(states).to include(:final)
+
+      states = foo.aasm(:left).states(:permitted => true)
+      expect(states.size).to eql 1
+      expect(states).to include(:closed)
+      expect(states).not_to include(:open)
+      expect(states).not_to include(:final)
+
+      foo.close
+      expect(foo.aasm(:left).states(:permitted => true)).to be_empty
+
+      # 2nd state machine
+      states = foo.aasm(:right).states
+      expect(states.size).to eql 3
+      expect(states).to include(:green)
+      expect(states).to include(:yellow)
+      expect(states).to include(:red)
+
+      states = foo.aasm(:right).states(:permitted => true)
+      expect(states.size).to eql 1
+      expect(states).to include(:yellow)
+      expect(states).not_to include(:green)
+      expect(states).not_to include(:red)
+
+      foo.yellow
+      states = foo.aasm(:right).states(:permitted => true)
+      expect(states.size).to eql 2
+      expect(states).to include(:red)
+      expect(states).to include(:green)
+      expect(states).not_to include(:yellow)
+    end
+
+    it "delivers all states for subclasses" do
+      # 1st state machine
+      states = two.aasm(:left).states
+      expect(states.size).to eql 4
+      expect(states).to include(:open)
+      expect(states).to include(:closed)
+      expect(states).to include(:final)
+      expect(states).to include(:foo)
+
+      states = two.aasm(:left).states(:permitted => true)
+      expect(states.size).to eql 1
+      expect(states).to include(:closed)
+      expect(states).not_to include(:open)
+
+      two.close
+      expect(two.aasm(:left).states(:permitted => true)).to be_empty
+
+      # 2nd state machine
+      states = two.aasm(:right).states
+      expect(states.size).to eql 4
+      expect(states).to include(:green)
+      expect(states).to include(:yellow)
+      expect(states).to include(:red)
+      expect(states).to include(:bar)
+
+      states = two.aasm(:right).states(:permitted => true)
+      expect(states.size).to eql 1
+      expect(states).to include(:yellow)
+      expect(states).not_to include(:red)
+      expect(states).not_to include(:green)
+      expect(states).not_to include(:bar)
+
+      two.yellow
+      states = two.aasm(:right).states(:permitted => true)
+      expect(states.size).to eql 2
+      expect(states).to include(:green)
+      expect(states).to include(:red)
+      expect(states).not_to include(:yellow)
+      expect(states).not_to include(:bar)
+    end
+
+    it "delivers all events" do
+      # 1st state machine
+      events = foo.aasm(:left).events
+      expect(events.size).to eql 2
+      expect(events).to include(:close)
+      expect(events).to include(:null)
+
+      foo.close
+      expect(foo.aasm(:left).events).to be_empty
+
+      # 2nd state machine
+      events = foo.aasm(:right).events
+      expect(events.size).to eql 1
+      expect(events).to include(:yellow)
+      expect(events).not_to include(:green)
+      expect(events).not_to include(:red)
+
+      foo.yellow
+      events = foo.aasm(:right).events
+      expect(events.size).to eql 2
+      expect(events).to include(:green)
+      expect(events).to include(:red)
+      expect(events).not_to include(:yellow)
+    end
+  end
+
+  it 'should list states in the order they have been defined' do
+    expect(ConversationMultiple.aasm(:left).states).to eq([
+      :needs_attention, :read, :closed, :awaiting_response, :junk
+    ])
+  end
+end
+
+describe "special cases" do
+  it "should support valid as state name" do
+    expect(ValidStateNameMultiple.aasm(:left).states).to include(:invalid)
+    expect(ValidStateNameMultiple.aasm(:left).states).to include(:valid)
+
+    argument = ValidStateNameMultiple.new
+    expect(argument.invalid?).to be_truthy
+    expect(argument.aasm(:left).current_state).to eq(:invalid)
+
+    argument.valid!
+    expect(argument.valid?).to be_truthy
+    expect(argument.aasm(:left).current_state).to eq(:valid)
+  end
+end
+
+describe 'aasm.states_for_select' do
+  it "should return a select friendly array of states" do
+    expect(FooMultiple.aasm(:left)).to respond_to(:states_for_select)
+    expect(FooMultiple.aasm(:left).states_for_select).to eq(
+      [['Open', 'open'], ['Closed', 'closed'], ['Final', 'final']]
+    )
+  end
+end
+
+describe 'aasm.from_states_for_state' do
+  it "should return all from states for a state" do
+    expect(ComplexExampleMultiple.aasm(:left)).to respond_to(:from_states_for_state)
+    froms = ComplexExampleMultiple.aasm(:left).from_states_for_state(:active)
+    [:pending, :passive, :suspended].each {|from| expect(froms).to include(from)}
+  end
+
+  it "should return from states for a state for a particular transition only" do
+    froms = ComplexExampleMultiple.aasm(:left).from_states_for_state(:active, :transition => :left_unsuspend)
+    [:suspended].each {|from| expect(froms).to include(from)}
+  end
+end
+
+describe 'permitted events' do
+  let(:foo) {FooMultiple.new}
+
+  it 'work' do
+    expect(foo.aasm(:left).events(:permitted => true)).to include(:close)
+    expect(foo.aasm(:left).events(:permitted => true)).not_to include(:null)
+
+    expect(foo.aasm(:right).events(:permitted => true)).to include(:yellow)
+    expect(foo.aasm(:right).events(:permitted => true)).not_to include(:green)
+    expect(foo.aasm(:right).events(:permitted => true)).not_to include(:red)
+  end
+end

data/spec/unit/inspection_spec.rb

@@ -62,11 +62,11 @@ describe 'inspection for common cases' do
 end
 
 describe "special cases" do
-  it "should support valid a state name" do
-    expect(Argument.aasm.states).to include(:invalid)
-    expect(Argument.aasm.states).to include(:valid)
+  it "should support valid as state name" do
+    expect(ValidStateName.aasm.states).to include(:invalid)
+    expect(ValidStateName.aasm.states).to include(:valid)
 
-    argument = Argument.new
+    argument = ValidStateName.new
     expect(argument.invalid?).to be_truthy
     expect(argument.aasm.current_state).to eq(:invalid)
 
@@ -85,13 +85,13 @@ end
 
 describe 'aasm.from_states_for_state' do
   it "should return all from states for a state" do
-    expect(AuthMachine.aasm).to respond_to(:from_states_for_state)
-    froms = AuthMachine.aasm.from_states_for_state(:active)
+    expect(ComplexExample.aasm).to respond_to(:from_states_for_state)
+    froms = ComplexExample.aasm.from_states_for_state(:active)
     [:pending, :passive, :suspended].each {|from| expect(froms).to include(from)}
   end
 
   it "should return from states for a state for a particular transition only" do
-    froms = AuthMachine.aasm.from_states_for_state(:active, :transition => :unsuspend)
+    froms = ComplexExample.aasm.from_states_for_state(:active, :transition => :unsuspend)
     [:suspended].each {|from| expect(froms).to include(from)}
   end
 end
@@ -103,4 +103,9 @@ describe 'permitted events' do
     expect(foo.aasm.events(:permitted => true)).to include(:close)
     expect(foo.aasm.events(:permitted => true)).not_to include(:null)
   end
+
+  it 'should not include events in the reject option' do
+    expect(foo.aasm.events(:permitted => true, reject: :close)).not_to include(:close)
+    expect(foo.aasm.events(:permitted => true, reject: [:close])).not_to include(:close)
+  end
 end