aasm 4.0.8 → 4.5.2

data/spec/models/silencer.rb

@@ -1,6 +1,11 @@
 class Silencer
   include AASM
 
+  # yes, this line is here on purpose
+  # by this, we test if overriding configuration options works if
+  # the state machine is "re-opened"
+  aasm :whiny_transitions => true
+
   aasm :whiny_transitions => false do
     state :silent, :initial => true
     state :crying

data/spec/models/simple_example.rb

@@ -0,0 +1,15 @@
+class SimpleExample
+  include AASM
+  aasm do
+    state :initialised, :initial => true
+    state :filled_out
+    state :authorised
+
+    event :fill_out do
+      transitions :from => :initialised, :to => :filled_out
+    end
+    event :authorise do
+      transitions :from => :filled_out, :to => :authorised
+    end
+  end
+end

data/spec/models/simple_multiple_example.rb

@@ -0,0 +1,30 @@
+class SimpleMultipleExample
+  include AASM
+  aasm(:move) do
+    state :standing, :initial => true
+    state :walking
+    state :running
+
+    event :walk do
+      transitions :from => :standing, :to => :walking
+    end
+    event :run do
+      transitions :from => [:standing, :walking], :to => :running
+    end
+    event :hold do
+      transitions :from => [:walking, :running], :to => :standing
+    end
+  end
+
+  aasm(:work) do
+    state :sleeping, :initial => true
+    state :processing
+
+    event :start do
+      transitions :from => :sleeping, :to => :processing
+    end
+    event :stop do
+      transitions :from => :processing, :to => :sleeping
+    end
+  end
+end

data/spec/models/state_machine_with_failed_event.rb

@@ -0,0 +1,12 @@
+class StateMachineWithFailedEvent
+  include AASM
+
+  aasm do
+    state :init, :initial => true
+    state :failed
+
+    event :failed do
+      transitions :from => :init, :to => :failed
+    end
+  end
+end

data/spec/models/sub_class.rb

@@ -0,0 +1,7 @@
+require_relative 'super_class'
+
+class SubClass < SuperClass
+end
+
+class SubClassMultiple < SuperClassMultiple
+end

data/spec/models/sub_class_with_more_states.rb

@@ -0,0 +1,18 @@
+require_relative 'super_class'
+
+class SubClassWithMoreStates < SuperClass
+  include AASM
+  aasm do
+    state :foo
+  end
+end
+
+class SubClassWithMoreStatesMultiple < SuperClassMultiple
+  include AASM
+  aasm(:left) do
+    state :foo
+  end
+  aasm(:right) do
+    state :archived
+  end
+end

data/spec/models/super_class.rb

@@ -0,0 +1,46 @@
+class SuperClass
+  include AASM
+
+  aasm do
+    state :read
+    state :ended
+
+    event :foo do
+      transitions :to => :ended, :from => [:read]
+    end
+  end
+
+  def update_state
+    if may_foo?
+      foo!
+    end
+  end
+end
+
+class SuperClassMultiple
+  include AASM
+
+  aasm(:left) do
+    state :read
+    state :ended
+
+    event :foo do
+      transitions :to => :ended, :from => [:read]
+    end
+  end
+
+  aasm(:right) do
+    state :opened
+    state :closed
+
+    event :close do
+      transitions :to => :closed, :from => [:opened]
+    end
+  end
+
+  def update_state
+    if may_foo?
+      foo!
+    end
+  end
+end

data/spec/models/transactor.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+
 class Transactor < ActiveRecord::Base
 
   belongs_to :worker
@@ -24,3 +25,29 @@ private
   end
 
 end
+
+class MultipleTransactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+  aasm :left, :column => :status do
+    state :sleeping, :initial => true
+    state :running, :before_enter => :start_worker, :after_enter => :fail
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+
+private
+
+  def start_worker
+    worker.update_attribute(:status, 'running')
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+
+end

data/spec/models/valid_state_name.rb

@@ -0,0 +1,23 @@
+class ValidStateName
+  include AASM
+  aasm do
+    state :invalid, :initial => true
+    state :valid
+
+    event :valid do
+      transitions :to => :valid, :from => [:invalid]
+    end
+  end
+end
+
+class ValidStateNameMultiple
+  include AASM
+  aasm(:left) do
+    state :invalid, :initial => true
+    state :valid
+
+    event :valid do
+      transitions :to => :valid, :from => [:invalid]
+    end
+  end
+end

data/spec/models/validator.rb

@@ -12,6 +12,9 @@ class Validator < ActiveRecord::Base
       transitions :to => :running, :from => :sleeping
     end
     event :sleep do
+      after_commit do |name|
+        change_name_on_sleep name
+      end
       transitions :to => :sleeping, :from => :running
     end
     event :fail do
@@ -26,6 +29,50 @@ class Validator < ActiveRecord::Base
     save!
   end
 
+  def change_name_on_sleep name
+    self.name = name
+    save!
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+end
+
+class MultipleValidator < ActiveRecord::Base
+
+  include AASM
+  aasm :left, :column => :status do
+    state :sleeping, :initial => true
+    state :running
+    state :failed, :after_enter => :fail
+
+    event :run, :after_commit => :change_name! do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      after_commit do |name|
+        change_name_on_sleep name
+      end
+      transitions :to => :sleeping, :from => :running
+    end
+    event :fail do
+      transitions :to => :failed, :from => [:sleeping, :running]
+    end
+  end
+
+  validates_presence_of :name
+
+  def change_name!
+    self.name = "name changed"
+    save!
+  end
+
+  def change_name_on_sleep name
+    self.name = name
+    save!
+  end
+
   def fail
     raise StandardError.new('failed on purpose')
   end

data/spec/spec_helper.rb

@@ -1,17 +1,17 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 require 'aasm'
-
 require 'rspec'
-
-require 'coveralls'
-Coveralls.wear!
+require 'aasm/rspec'
 
 # require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
 # require 'ruby-debug/completion'
 # require 'pry'
 
+SEQUEL_DB = defined?(JRUBY_VERSION) ? 'jdbc:sqlite::memory:' : 'sqlite:/'
+
 def load_schema
+  require 'logger'
   config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
   ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
   ActiveRecord::Base.establish_connection(config['sqlite3'])

data/spec/unit/api_spec.rb

@@ -1,5 +1,10 @@
 require 'spec_helper'
-require 'models/active_record/api.rb'
+require 'models/default_state.rb'
+require 'models/provided_state.rb'
+require 'models/active_record/persisted_state.rb'
+require 'models/active_record/provided_and_persisted_state.rb'
+
+load_schema
 
 describe "reading the current state" do
   it "uses the AASM default" do

data/spec/unit/basic_two_state_machines_example_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'on initialization' do
+  let(:example) { BasicTwoStateMachinesExample.new }
+
+  it 'should be in the initial state' do
+    expect(example.aasm(:search).current_state).to eql :initialised
+    expect(example.aasm(:sync).current_state).to eql :unsynced
+  end
+end

data/spec/unit/callback_multiple_spec.rb

@@ -0,0 +1,295 @@
+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)
+  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)
+    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)
+    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)
+    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

data/spec/unit/callbacks_spec.rb

@@ -17,6 +17,7 @@ describe 'callbacks for the new DSL' do
       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_all_transitions).once.ordered
       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
@@ -52,7 +53,7 @@ describe 'callbacks for the new DSL' do
     }.to raise_error(AASM::InvalidTransition)
   end
 
-  it "it handles private callback methods as well" do
+  it "handles private callback methods as well" do
     show_debug_log = false
 
     callback = Callbacks::PrivateMethod.new(:log => show_debug_log)
@@ -145,7 +146,7 @@ describe 'callbacks for the new DSL' do
 
     cb.reset_data
     cb.close!(:arg1, :arg2)
-    expect(cb.data).to eql 'before(:arg1,:arg2) before_exit_open transition_proc(:arg1,:arg2) before_enter_closed aasm_write_state after_exit_open after_enter_closed after(: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

data/spec/unit/complex_example_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'on initialization' do
-  let(:auth) {AuthMachine.new}
+  let(:auth) {ComplexExample.new}
 
   it 'should be in the pending state' do
     expect(auth.aasm.current_state).to eq(:pending)
@@ -14,7 +14,7 @@ describe 'on initialization' do
 end
 
 describe 'when being unsuspended' do
-  let(:auth) {AuthMachine.new}
+  let(:auth) {ComplexExample.new}
 
   it 'should be able to be unsuspended' do
     auth.activate!