require 'spec_helper' Dir[File.dirname(__FILE__) + "/../models/callbacks/*.rb"].sort.each { |f| require File.expand_path(f) } describe 'callbacks for the new DSL' do it "be called in order" do show_debug_log = false callback = Callbacks::BasicMultiple.new(:log => show_debug_log) callback.aasm(:left).current_state unless show_debug_log expect(callback).to receive(:before_event).once.ordered expect(callback).to receive(:event_guard).once.ordered.and_return(true) expect(callback).to receive(:transition_guard).once.ordered.and_return(true) expect(callback).to receive(:before_exit_open).once.ordered # these should be before the state changes expect(callback).to receive(:exit_open).once.ordered # expect(callback).to receive(:event_guard).once.ordered.and_return(true) # expect(callback).to receive(:transition_guard).once.ordered.and_return(true) expect(callback).to receive(:after_transition).once.ordered expect(callback).to receive(:before_enter_closed).once.ordered expect(callback).to receive(:enter_closed).once.ordered expect(callback).to receive(:aasm_write_state).with(:closed, :left).once.ordered.and_return(true) # this is when the state changes expect(callback).to receive(:after_exit_open).once.ordered # these should be after the state changes expect(callback).to receive(:after_enter_closed).once.ordered expect(callback).to receive(:after_event).once.ordered end # puts "------- close!" callback.left_close! end it "does not run any state callback if the event guard fails" do callback = Callbacks::BasicMultiple.new(:log => false) callback.aasm(:left).current_state expect(callback).to receive(:before_event).once.ordered expect(callback).to receive(:event_guard).once.ordered.and_return(false) expect(callback).to_not receive(:transition_guard) expect(callback).to_not receive(:before_exit_open) expect(callback).to_not receive(:exit_open) expect(callback).to_not receive(:after_transition) expect(callback).to_not receive(:before_enter_closed) expect(callback).to_not receive(:enter_closed) expect(callback).to_not receive(:aasm_write_state) expect(callback).to_not receive(:after_exit_open) expect(callback).to_not receive(:after_enter_closed) expect(callback).to_not receive(:after_event) expect { callback.left_close! }.to raise_error(AASM::InvalidTransition, "Event 'left_close' cannot transition from 'open'. Failed callback(s): [:after_transition, :event_guard].") end it "handles private callback methods as well" do show_debug_log = false callback = Callbacks::PrivateMethodMultiple.new(:log => show_debug_log) callback.aasm(:left).current_state # puts "------- close!" expect { callback.close! }.to_not raise_error end context "if the transition guard fails" do it "does not run any state callback if guard is defined inline" do show_debug_log = false callback = Callbacks::BasicMultiple.new(:log => show_debug_log, :fail_transition_guard => true) callback.aasm(:left).current_state unless show_debug_log expect(callback).to receive(:before_event).once.ordered expect(callback).to receive(:event_guard).once.ordered.and_return(true) expect(callback).to receive(:transition_guard).once.ordered.and_return(false) expect(callback).to_not receive(:before_exit_open) expect(callback).to_not receive(:exit_open) expect(callback).to_not receive(:after_transition) expect(callback).to_not receive(:before_enter_closed) expect(callback).to_not receive(:enter_closed) expect(callback).to_not receive(:aasm_write_state) expect(callback).to_not receive(:after_exit_open) expect(callback).to_not receive(:after_enter_closed) expect(callback).to_not receive(:after_event) end expect { callback.left_close! }.to raise_error(AASM::InvalidTransition, "Event 'left_close' cannot transition from 'open'. Failed callback(s): [:after_transition, :event_guard, :transition_guard].") end it "does not run transition_guard twice for multiple permitted transitions" do show_debug_log = false callback = Callbacks::MultipleTransitionsTransitionGuardMultiple.new(:log => show_debug_log, :fail_transition_guard => true) callback.aasm(:left).current_state unless show_debug_log expect(callback).to receive(:before).once.ordered expect(callback).to receive(:event_guard).once.ordered.and_return(true) expect(callback).to receive(:transition_guard).once.ordered.and_return(false) expect(callback).to receive(:event_guard).once.ordered.and_return(true) expect(callback).to receive(:before_exit_open).once.ordered expect(callback).to receive(:exit_open).once.ordered expect(callback).to receive(:aasm_write_state).once.ordered.and_return(true) # this is when the state changes expect(callback).to receive(:after_exit_open).once.ordered expect(callback).to receive(:after).once.ordered expect(callback).to_not receive(:transitioning) expect(callback).to_not receive(:before_enter_closed) expect(callback).to_not receive(:enter_closed) expect(callback).to_not receive(:after_enter_closed) end callback.close! expect(callback.aasm(:left).current_state).to eql :failed end it "does not run any state callback if guard is defined with block" do callback = Callbacks::GuardWithinBlockMultiple.new #(:log => true, :fail_transition_guard => true) callback.aasm(:left).current_state expect(callback).to receive(:before).once.ordered expect(callback).to receive(:event_guard).once.ordered.and_return(true) expect(callback).to receive(:transition_guard).once.ordered.and_return(false) expect(callback).to_not receive(:before_exit_open) expect(callback).to_not receive(:exit_open) expect(callback).to_not receive(:transitioning) expect(callback).to_not receive(:before_enter_closed) expect(callback).to_not receive(:enter_closed) expect(callback).to_not receive(:aasm_write_state) expect(callback).to_not receive(:after_exit_open) expect(callback).to_not receive(:after_enter_closed) expect(callback).to_not receive(:after) expect { callback.close! }.to raise_error(AASM::InvalidTransition) end end it "should properly pass arguments" do cb = Callbacks::WithArgsMultiple.new(:log => false) cb.aasm(:left).current_state cb.reset_data cb.close!(:arg1, :arg2) expect(cb.data).to eql 'before(:arg1,:arg2) before_exit_open(:arg1,:arg2) transition_proc(:arg1,:arg2) before_enter_closed(:arg1,:arg2) aasm_write_state after_exit_open(:arg1,:arg2) after_enter_closed(:arg1,:arg2) after(:arg1,:arg2)' end it "should call the callbacks given the to-state as argument" do cb = Callbacks::WithStateArgMultiple.new expect(cb).to receive(:before_method).with(:arg1).once.ordered expect(cb).to receive(:transition_method).never expect(cb).to receive(:transition_method2).with(:arg1).once.ordered expect(cb).to receive(:after_method).with(:arg1).once.ordered cb.close!(:out_to_lunch, :arg1) cb = Callbacks::WithStateArgMultiple.new some_object = double('some object') expect(cb).to receive(:before_method).with(some_object).once.ordered expect(cb).to receive(:transition_method2).with(some_object).once.ordered expect(cb).to receive(:after_method).with(some_object).once.ordered cb.close!(:out_to_lunch, some_object) end it "should call the proper methods just with arguments" do cb = Callbacks::WithStateArgMultiple.new expect(cb).to receive(:before_method).with(:arg1).once.ordered expect(cb).to receive(:transition_method).with(:arg1).once.ordered expect(cb).to receive(:transition_method).never expect(cb).to receive(:after_method).with(:arg1).once.ordered cb.close!(:arg1) cb = Callbacks::WithStateArgMultiple.new some_object = double('some object') expect(cb).to receive(:before_method).with(some_object).once.ordered expect(cb).to receive(:transition_method).with(some_object).once.ordered expect(cb).to receive(:transition_method).never expect(cb).to receive(:after_method).with(some_object).once.ordered cb.close!(some_object) end end # callbacks for the new DSL describe 'event callbacks' do describe "with an error callback defined" do before do class FooCallbackMultiple # this hack is needed to allow testing of parameters, since RSpec # destroys a method's arity when mocked attr_accessor :data aasm(:left) do event :safe_close, :success => :success_callback, :error => :error_callback do transitions :to => :closed, :from => [:open] end end end @foo = FooCallbackMultiple.new end context "error_callback defined" do it "should run error_callback if an exception is raised" do def @foo.error_callback(e) @data = [e] end allow(@foo).to receive(:before_enter).and_raise(e = StandardError.new) @foo.safe_close! expect(@foo.data).to eql [e] end it "should run error_callback without parameters if callback does not support any" do def @foo.error_callback(e) @data = [] end allow(@foo).to receive(:before_enter).and_raise(e = StandardError.new) @foo.safe_close!('arg1', 'arg2') expect(@foo.data).to eql [] end it "should run error_callback with parameters if callback supports them" do def @foo.error_callback(e, arg1, arg2) @data = [arg1, arg2] end allow(@foo).to receive(:before_enter).and_raise(e = StandardError.new) @foo.safe_close!('arg1', 'arg2') expect(@foo.data).to eql ['arg1', 'arg2'] end end it "should raise NoMethodError if exception is raised and error_callback is declared but not defined" do allow(@foo).to receive(:before_enter).and_raise(StandardError) expect{@foo.safe_close!}.to raise_error(NoMethodError) end it "should propagate an error if no error callback is declared" do allow(@foo).to receive(:before_enter).and_raise("Cannot enter safe") expect{@foo.close!}.to raise_error(StandardError, "Cannot enter safe") end end describe "with aasm_event_fired defined" do before do @foo = FooMultiple.new def @foo.aasm_event_fired(event, from, to); end end it 'should call it for successful bang fire' do expect(@foo).to receive(:aasm_event_fired).with(:close, :open, :closed) @foo.close! end it 'should call it for successful non-bang fire' do expect(@foo).to receive(:aasm_event_fired) @foo.close end it 'should not call it for failing bang fire' do allow(@foo.aasm(:left)).to receive(:set_current_state_with_persistence).and_return(false) expect(@foo).not_to receive(:aasm_event_fired) @foo.close! end end describe "with aasm_event_failed defined" do before do @foo = FooMultiple.new def @foo.aasm_event_failed(event, from); end end it 'should call it when transition failed for bang fire' do expect(@foo).to receive(:aasm_event_failed).with(:null, :open) expect{ @foo.null! }.to raise_error(AASM::InvalidTransition, "Event 'null' cannot transition from 'open'. Failed callback(s): [:always_false].") end it 'should call it when transition failed for non-bang fire' do expect(@foo).to receive(:aasm_event_failed).with(:null, :open) expect{ @foo.null }.to raise_error(AASM::InvalidTransition, "Event 'null' cannot transition from 'open'. Failed callback(s): [:always_false, :always_false].") end it 'should not call it if persist fails for bang fire' do allow(@foo.aasm(:left)).to receive(:set_current_state_with_persistence).and_return(false) expect(@foo).to receive(:aasm_event_failed) @foo.close! end end end # event callbacks