aasm 5.0.8

data/spec/spec_helpers/mongoid.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+begin
+  require 'mongoid'
+  puts "mongoid #{Mongoid::VERSION} gem found, running mongoid specs \e[32m#{'✔'}\e[0m"
+
+  if Mongoid::VERSION.to_f <= 5
+    Mongoid::Config.sessions = {
+      default: {
+        database: "mongoid_#{Process.pid}",
+        hosts: ["#{ENV['MONGODB_HOST'] || 'localhost'}:" \
+                "#{ENV['MONGODB_PORT'] || 27017}"]
+      }
+    }
+  else
+    Mongoid::Config.send(:clients=, {
+      default: {
+        database: "mongoid_#{Process.pid}",
+        hosts: ["#{ENV['MONGODB_HOST'] || 'localhost'}:" \
+                "#{ENV['MONGODB_PORT'] || 27017}"]
+      }
+    })
+  end
+rescue LoadError
+  puts "mongoid gem not found, not running mongoid specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/nobrainer.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+begin
+  require 'nobrainer'
+
+  NoBrainer.configure do |config|
+    config.app_name = :aasm
+    config.environment = :test
+    config.warn_on_active_record = false
+  end
+
+  puts "nobrainer #{Gem.loaded_specs['nobrainer'].version} gem found, running nobrainer specs \e[32m#{'✔'}\e[0m"
+rescue LoadError
+  puts "nobrainer gem not found, not running nobrainer specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/redis.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+begin
+  require 'redis-objects'
+  require 'redis/objects/version'
+  puts "redis-objects #{Redis::Objects::VERSION} gem found, running Redis specs \e[32m#{'✔'}\e[0m"
+
+  Redis.current = Redis.new(host: (ENV['REDIS_HOST'] || '127.0.0.1'),
+                            port: (ENV['REDIS_PORT'] || 6379))
+
+  RSpec.configure do |c|
+    c.before(:each) do
+      Redis.current.keys('redis_*').each { |k| Redis.current.del k }
+    end
+  end
+rescue LoadError
+  puts "redis-objects gem not found, not running Redis specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/remove_warnings.rb

@@ -0,0 +1 @@
+AASM::Configuration.hide_warnings = true

data/spec/spec_helpers/sequel.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+begin
+  require 'sequel'
+  puts "sequel #{Sequel::VERSION} gem found, running Sequel specs \e[32m#{'✔'}\e[0m"
+rescue LoadError
+  puts "sequel gem not found, not running Sequel specs \e[31m#{'✖'}\e[0m"
+end

data/spec/unit/abstract_class_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+if defined?(ActiveRecord)
+  require 'models/active_record/person'
+
+  load_schema
+  describe 'Abstract subclassing' do
+
+    it 'should have the parent states' do
+      Person.aasm.states.each do |state|
+        expect(Base.aasm.states).to include(state)
+      end
+      expect(Person.aasm.states).to eq(Base.aasm.states)
+    end
+
+    it 'should have the same events as its parent' do
+      expect(Base.aasm.events).to eq(Person.aasm.events)
+    end
+
+    it 'should not break aasm methods when super class is abstract_class' do
+      person = Person.new
+      person.status = 'active'
+      person.deactivate!
+      expect(person.aasm.current_state).to eq(:inactive)
+    end
+
+  end
+end

data/spec/unit/api_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+if defined?(ActiveRecord)
+  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
+      expect(DefaultState.new.aasm.current_state).to eql :alpha
+    end
+
+    it "uses the provided method" do
+      expect(ProvidedState.new.aasm.current_state).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      expect(PersistedState.new.aasm.current_state).to eql :alpha
+    end
+
+    it "uses the provided method even if persisted" do
+      expect(ProvidedAndPersistedState.new.aasm.current_state).to eql :gamma
+    end
+
+    context "after dup" do
+      it "uses the persistence storage" do
+        source = PersistedState.create!
+        copy = source.dup
+        copy.save!
+
+        copy.release!
+
+        expect(source.aasm_state).to eql 'alpha'
+        expect(source.aasm.current_state).to eql :alpha
+
+        source2 = PersistedState.find(source.id)
+        expect(source2.reload.aasm_state).to eql 'alpha'
+        expect(source2.aasm.current_state).to eql :alpha
+
+        expect(copy.aasm_state).to eql 'beta'
+        expect(copy.aasm.current_state).to eql :beta
+      end
+    end
+  end
+
+  describe "writing and persisting the current state" do
+    it "uses the AASM default" do
+      o = DefaultState.new
+      o.release!
+      expect(o.persisted_store).to be_nil
+    end
+
+    it "uses the provided method" do
+      o = ProvidedState.new
+      o.release!
+      expect(o.persisted_store).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      o = PersistedState.new
+      o.release!
+      expect(o.persisted_store).to be_nil
+    end
+
+    it "uses the provided method even if persisted" do
+      o = ProvidedAndPersistedState.new
+      o.release!
+      expect(o.persisted_store).to eql :beta
+    end
+  end
+
+  describe "writing the current state without persisting it" do
+    it "uses the AASM default" do
+      o = DefaultState.new
+      o.release
+      expect(o.transient_store).to be_nil
+    end
+
+    it "uses the provided method" do
+      o = ProvidedState.new
+      o.release
+      expect(o.transient_store).to eql :beta
+    end
+
+    it "uses the persistence storage" do
+      o = PersistedState.new
+      o.release
+      expect(o.transient_store).to be_nil
+    end
+
+    it "uses the provided method even if persisted" do
+      o = ProvidedAndPersistedState.new
+      o.release
+      expect(o.transient_store).to eql :beta
+    end
+  end
+end

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,304 @@
+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): [: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): [: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(:before_success_method).with(:arg1).once.ordered
+    expect(cb).to receive(:success_method).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(:before_success_method).with(some_object).once.ordered
+    expect(cb).to receive(:success_method).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].")
+    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