aasm 4.11.0 → 4.12.0

data/spec/models/mongoid/simple_mongoid.rb

@@ -5,7 +5,7 @@ class SimpleMongoid
   field :status, :type => String
 
   aasm column: :status do
-    state :unknown_scope
+    state :unknown_scope, :another_unknown_scope
     state :new
   end
 end
@@ -17,7 +17,7 @@ class SimpleMongoidMultiple
   field :status, :type => String
 
   aasm :left, column: :status do
-    state :unknown_scope
+    state :unknown_scope, :another_unknown_scope
     state :new
   end
 end

data/spec/models/mongoid/validator_mongoid.rb

@@ -0,0 +1,100 @@
+class ValidatorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  attr_accessor :invalid
+
+  validate do |model|
+    errors.add(:validator, "invalid") if invalid
+  end
+
+  include AASM
+
+  aasm :column => :status, :whiny_persistence => true do
+    before_all_transactions :before_all_transactions
+    after_all_transactions  :after_all_transactions
+
+    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
+end
+
+class MultipleValidatorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  attr_accessor :invalid
+
+  aasm :left, :column => :status, :whiny_persistence => true 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
+end

data/spec/models/multi_transitioner.rb

@@ -11,14 +11,24 @@ class MultiTransitioner
     state :sleeping, :initial => true
     state :running
     state :dancing
+    state :dead
 
     event :start do
       transitions :from => :sleeping, :to => :running, guard: :runnable?
       transitions :from => :sleeping, :to => :dancing
     end
+
+    event :sleep do
+      transitions to: :sleeping, if: :alive?
+      transitions to: :dead, from: [:running, :dancing]
+    end
   end
 
   def runnable?
     @can_run
   end
+
+  def alive?
+    true
+  end
 end

data/spec/models/multiple_transitions_that_differ_only_by_guard.rb

@@ -0,0 +1,31 @@
+class MultipleTransitionsThatDifferOnlyByGuard
+  include AASM
+
+  attr_accessor :executed_second
+
+  aasm do
+    state :start, :initial => true
+    state :gone
+
+    event :go do
+      transitions :from => :start, :to => :gone, :guard => :returns_false, :after => :this_should_not_execute
+      transitions :from => :start, :to => :gone, :guard => :returns_true, :after => :this_should_execute
+    end
+  end
+
+  def returns_false
+    false
+  end
+
+  def returns_true
+    true
+  end
+
+  def this_should_not_execute
+    raise RuntimeError, "This should not execute"
+  end
+
+  def this_should_execute
+    self.executed_second = true
+  end
+end

data/spec/models/parametrised_event.rb

@@ -11,6 +11,10 @@ class ParametrisedEvent
       transitions :from => :sleeping, :to => [:showering, :working]
     end
 
+    event :shower do
+      transitions :from => :sleeping, :to => :showering, :after => :wet_hair, :success => :wear_clothes
+    end
+
     event :dress do
       transitions :from => :sleeping, :to => :working, :after => :wear_clothes, :success => :wear_makeup
       transitions :from => :showering, :to => [:working, :dating], :after => Proc.new { |*args| wear_clothes(*args) }, :success => proc { |*args| wear_makeup(*args) }
@@ -24,6 +28,9 @@ class ParametrisedEvent
   def wear_makeup(makeup, moisturizer)
   end
 
+  def wet_hair(dryer)
+  end
+
   def condition_hair
   end
 

data/spec/models/simple_multiple_example.rb

@@ -27,4 +27,16 @@ class SimpleMultipleExample
       transitions :from => :processing, :to => :sleeping
     end
   end
+
+  aasm(:question) do
+    state :answered, :initial => true
+    state :asked
+
+    event :ask, :binding_event => :start do
+      transitions :from => :answered, :to => :asked
+    end
+    event :answer, :binding_event => :stop do
+      transitions :from => :asked, :to => :answered
+    end
+  end
 end

data/spec/models/sub_class.rb

@@ -1,7 +1,41 @@
 require_relative 'super_class'
 
 class SubClass < SuperClass
+  # Add an after callback that is not defined in the parent
+  aasm.state_machine.events[:foo].options[:after] = [:after_foo_event]
+
+  # Add global callback that is not defined in the parent
+  aasm.state_machine.global_callbacks[:after_all_transitions] = :after_all_event
+
+  attr_accessor :called_after
+
+  def after_foo_event
+    self.called_after = true
+  end
+
+  def after_all_event; end
 end
 
 class SubClassMultiple < SuperClassMultiple
+  # Add after callbacks that are not defined in the parent
+  aasm(:left).state_machine.events[:foo].options[:after] = [:left_after_foo_event]
+  aasm(:right).state_machine.events[:close].options[:after] = [:right_after_close_event]
+
+  # Add global callback that is not defined in the parent
+  aasm(:left).state_machine.global_callbacks[:after_all_transitions] = :left_after_all_event
+  aasm(:right).state_machine.global_callbacks[:after_all_transitions] = :right_after_all_event
+
+  attr_accessor :left_called_after, :right_called_after
+
+  def left_after_foo_event
+    self.left_called_after = true
+  end
+
+  def right_after_close_event
+    self.right_called_after = true
+  end
+
+  def left_after_all_event; end
+
+  def right_after_all_event; end
 end

data/spec/spec_helper.rb

@@ -19,39 +19,6 @@ def load_schema
   require File.dirname(__FILE__) + "/database.rb"
 end
 
-# Dynamoid initialization
-begin
-  require 'dynamoid'
-  require 'aws-sdk-resources'
-
-  ENV['ACCESS_KEY'] ||= 'abcd'
-  ENV['SECRET_KEY'] ||= '1234'
-
-  Aws.config.update({
-    region: 'us-west-2',
-    credentials: Aws::Credentials.new(ENV['ACCESS_KEY'], ENV['SECRET_KEY'])
-  })
-
-  Dynamoid.configure do |config|
-    config.namespace = "dynamoid_tests"
-    config.endpoint = 'http://127.0.0.1:30180'
-    config.warn_on_scan = false
-  end
-
-  Dynamoid.logger.level = Logger::FATAL
-
-  RSpec.configure do |c|
-    c.before(:each) do
-      Dynamoid.adapter.list_tables.each do |table|
-        Dynamoid.adapter.delete_table(table) if table =~ /^#{Dynamoid::Config.namespace}/
-      end
-      Dynamoid.adapter.tables.clear
-    end
-  end
-rescue LoadError
-  # Without Dynamoid settings
-end
-
 # custom spec helpers
 Dir[File.dirname(__FILE__) + "/spec_helpers/**/*.rb"].sort.each { |f| require File.expand_path(f) }
 

data/spec/spec_helpers/active_record.rb

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

data/spec/spec_helpers/dynamoid.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+begin
+  require 'dynamoid'
+  require 'aws-sdk-resources'
+  puts "dynamoid gem found, running Dynamoid specs \e[32m#{'✔'}\e[0m"
+
+  ENV['ACCESS_KEY'] ||= 'abcd'
+  ENV['SECRET_KEY'] ||= '1234'
+
+  Aws.config.update({
+    region: 'us-west-2',
+    credentials: Aws::Credentials.new(ENV['ACCESS_KEY'], ENV['SECRET_KEY'])
+  })
+
+  Dynamoid.configure do |config|
+    config.namespace = "dynamoid_tests"
+    config.endpoint = 'http://127.0.0.1:30180'
+    config.warn_on_scan = false
+  end
+
+  Dynamoid.logger.level = Logger::FATAL
+
+  RSpec.configure do |c|
+    c.before(:each) do
+      Dynamoid.adapter.list_tables.each do |table|
+        Dynamoid.adapter.delete_table(table) if table =~ /^#{Dynamoid::Config.namespace}/
+      end
+      Dynamoid.adapter.tables.clear
+    end
+  end
+rescue LoadError
+  puts "dynamoid gem not found, not running Dynamoid specs \e[31m#{'✖'}\e[0m"
+end

data/spec/spec_helpers/mongoid.rb

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

data/spec/spec_helpers/redis.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+begin
+  require 'redis-objects'
+  puts "redis-objects gem found, running Redis specs \e[32m#{'✔'}\e[0m"
+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 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/api_spec.rb

@@ -1,97 +1,100 @@
 require 'spec_helper'
-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
+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'
 
-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
+  load_schema
 
-  it "uses the persistence storage" do
-    expect(PersistedState.new.aasm.current_state).to eql :alpha
-  end
+  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 even if persisted" do
-    expect(ProvidedAndPersistedState.new.aasm.current_state).to eql :gamma
-  end
+    it "uses the provided method" do
+      expect(ProvidedState.new.aasm.current_state).to eql :beta
+    end
 
-  context "after dup" do
     it "uses the persistence storage" do
-      source = PersistedState.create!
-      copy = source.dup
-      copy.save!
+      expect(PersistedState.new.aasm.current_state).to eql :alpha
+    end
 
-      copy.release!
+    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!
 
-      expect(source.aasm_state).to eql 'alpha'
-      expect(source.aasm.current_state).to eql :alpha
+        copy.release!
 
-      source2 = PersistedState.find(source.id)
-      expect(source2.reload.aasm_state).to eql 'alpha'
-      expect(source2.aasm.current_state).to eql :alpha
+        expect(source.aasm_state).to eql 'alpha'
+        expect(source.aasm.current_state).to eql :alpha
 
-      expect(copy.aasm_state).to eql 'beta'
-      expect(copy.aasm.current_state).to eql :beta
+        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
-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
+  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 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 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
+    it "uses the provided method even if persisted" do
+      o = ProvidedAndPersistedState.new
+      o.release!
+      expect(o.persisted_store).to eql :beta
+    end
   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
+  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 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 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
+    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/callbacks_spec.rb

@@ -118,6 +118,7 @@ describe 'callbacks for the new DSL' do
       expect(callback).to receive(:before_enter_closed).once.ordered
       expect(callback).to receive(:enter_closed).once.ordered
       expect(callback).to receive(:aasm_write_state).once.ordered.and_return(true)   # this is when the state changes
+      expect(callback).to receive(:event_before_success).once.ordered
       expect(callback).to receive(:success_transition).once.ordered.and_return(true) # these should be after the state changes
       expect(callback).to receive(:after_exit_open).once.ordered
       expect(callback).to receive(:after_enter_closed).once.ordered
@@ -143,6 +144,7 @@ describe 'callbacks for the new DSL' do
     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(:event_before_success)
     expect(callback).to_not receive(:success_transition)
     expect(callback).to_not receive(:after_exit_open)
     expect(callback).to_not receive(:after_enter_closed)
@@ -186,6 +188,7 @@ describe 'callbacks for the new DSL' do
         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(:event_before_success)
         expect(callback).to_not receive(:success_transition)
         expect(callback).to_not receive(:after_exit_open)
         expect(callback).to_not receive(:after_enter_closed)
@@ -217,6 +220,7 @@ describe 'callbacks for the new DSL' do
         expect(callback).to receive(:after).once.ordered
 
         expect(callback).to_not receive(:transitioning)
+        expect(callback).to_not receive(:event_before_success)
         expect(callback).to_not receive(:success_transition)
         expect(callback).to_not receive(:before_enter_closed)
         expect(callback).to_not receive(:enter_closed)
@@ -240,6 +244,7 @@ describe 'callbacks for the new DSL' do
       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(:event_before_success)
       expect(callback).to_not receive(:success_transition)
       expect(callback).to_not receive(:after_exit_open)
       expect(callback).to_not receive(:after_enter_closed)

data/spec/unit/event_spec.rb

@@ -325,6 +325,12 @@ describe 'parametrised events' do
     pe.dress!(:working, 'blue', 'jeans')
   end
 
+  it 'should call :after transition method if arg is nil' do
+    dryer = nil
+    expect(pe).to receive(:wet_hair).with(dryer)
+    pe.shower!(dryer)
+  end
+
   it 'should call :after transition proc' do
     pe.wakeup!(:showering)
     expect(pe).to receive(:wear_clothes).with('purple', 'slacks')
@@ -344,6 +350,12 @@ describe 'parametrised events' do
     pe.dress!(:working, 'foundation', 'SPF')
   end
 
+  it 'should call :success transition method if arg is nil' do
+    shirt_color = nil
+    expect(pe).to receive(:wear_clothes).with(shirt_color)
+    pe.shower!(shirt_color)
+  end
+
   it 'should call :success transition proc' do
     pe.wakeup!(:showering)
     expect(pe).to receive(:wear_makeup).with('purple', 'slacks')

data/spec/unit/guard_with_params_multiple_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe "guards with params" do
+  let(:guard) { GuardWithParamsMultiple.new }
+  let(:user) {GuardParamsClass.new}
+
+  it "list permitted states" do
+    expect(guard.aasm(:left).states({:permitted => true}, user).map(&:name)).to eql [:reviewed]
+  end
+end

data/spec/unit/guard_with_params_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "guards with params" do
+  let(:guard) { GuardWithParams.new }
+  let(:user) {GuardParamsClass.new}
+
+  it "list permitted states" do
+    expect(guard.aasm.states({:permitted => true}, user).map(&:name)).to eql [:reviewed]
+  end
+
+  it "list no states if user is blank" do
+    expect(guard.aasm.states({:permitted => true}, nil).map(&:name)).to eql []
+  end
+end

data/spec/unit/inspection_spec.rb

@@ -74,6 +74,11 @@ describe 'inspection for common cases' do
       expect(states).to include(:running)
       expect(states).to_not include(:dancing)
     end
+
+    it "transitions to correct state if from state is missing from one transitions" do
+      multi.sleep
+      expect(multi.aasm.current_state).to eq(:sleeping)
+    end
   end
 
   it 'should list states in the order they have been defined' do