aasm 4.12.3 → 5.1.1

data/spec/models/nobrainer/simple_no_brainer.rb

@@ -0,0 +1,23 @@
+class SimpleNoBrainer
+  include NoBrainer::Document
+  include AASM
+
+  field :status, type: String
+
+  aasm column: :status do
+    state :unknown_scope, :another_unknown_scope
+    state :new
+  end
+end
+
+class SimpleNoBrainerMultiple
+  include NoBrainer::Document
+  include AASM
+
+  field :status, type: String
+
+  aasm :left, column: :status do
+    state :unknown_scope, :another_unknown_scope
+    state :new
+  end
+end

data/spec/models/nobrainer/validator_no_brainer.rb

@@ -0,0 +1,98 @@
+class ValidatorNoBrainer
+  include NoBrainer::Document
+  include AASM
+
+  field :name
+  field :status
+
+  attr_accessor :invalid
+
+  validate do |_|
+    errors.add(:validator, 'invalid') if invalid
+  end
+
+  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: %i[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, 'failed on purpose'
+  end
+end
+
+class MultipleValidatorNoBrainer
+  include NoBrainer::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: %i[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, 'failed on purpose'
+  end
+end

data/spec/models/simple_example.rb

@@ -3,13 +3,21 @@ class SimpleExample
   aasm do
     state :initialised, :initial => true
     state :filled_out
+    state :denied
     state :authorised
 
     event :fill_out do
       transitions :from => :initialised, :to => :filled_out
     end
+
+    event :deny do
+      transitions from: :initialised, to: :denied
+    end
+
     event :authorise do
       transitions :from => :filled_out, :to => :authorised
     end
+
   end
+
 end

data/spec/models/simple_example_with_guard_args.rb

@@ -0,0 +1,17 @@
+class SimpleExampleWithGuardArgs
+  include AASM
+  aasm do
+    state :initialised, :initial => true
+    state :filled_out_with_args
+
+    event :fill_out_with_args do
+      transitions :guard => [:arg_is_valid?],
+                  :from => :initialised,
+                  :to => :filled_out_with_args
+    end
+  end
+
+  def arg_is_valid?(arg)
+    return arg
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,19 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 $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 'aasm/rspec'
+require 'i18n'
 require 'pry'
 
 # require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
@@ -24,3 +35,7 @@ Dir[File.dirname(__FILE__) + "/spec_helpers/**/*.rb"].sort.each { |f| require Fi
 
 # example model classes
 Dir[File.dirname(__FILE__) + "/models/*.rb"].sort.each { |f| require File.expand_path(f) }
+
+I18n.load_path << 'spec/en.yml'
+I18n.enforce_available_locales = false
+I18n.default_locale = :en

data/spec/spec_helpers/active_record.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 begin
   require 'active_record'
-  puts "active_record gem found, running ActiveRecord specs \e[32m#{'✔'}\e[0m"
+
+  puts "active_record #{ActiveRecord::VERSION::STRING} 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

@@ -1,20 +1,22 @@
 # encoding: utf-8
+
 begin
   require 'dynamoid'
   require 'aws-sdk-resources'
-  puts "dynamoid gem found, running Dynamoid specs \e[32m#{'✔'}\e[0m"
+  puts "dynamoid #{Dynamoid::VERSION} gem found, running Dynamoid specs \e[32m#{'✔'}\e[0m"
 
   ENV['ACCESS_KEY'] ||= 'abcd'
   ENV['SECRET_KEY'] ||= '1234'
 
-  Aws.config.update({
+  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.namespace = 'dynamoid_tests'
+    config.endpoint = "http://#{ENV['DYNAMODB_HOST'] || '127.0.0.1'}:" \
+                      "#{ENV['DYNAMODB_PORT'] || 30180}"
     config.warn_on_scan = false
   end
 

data/spec/spec_helpers/mongoid.rb

@@ -1,7 +1,26 @@
 # encoding: utf-8
+
 begin
   require 'mongoid'
-  puts "mongoid gem found, running mongoid specs \e[32m#{'✔'}\e[0m"
+  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

@@ -1,9 +1,12 @@
 # encoding: utf-8
+
 begin
   require 'redis-objects'
-  puts "redis-objects gem found, running Redis specs \e[32m#{'✔'}\e[0m"
+  require 'redis/objects/version'
+  puts "redis-objects #{Redis::Objects::VERSION} gem found, running Redis specs \e[32m#{'✔'}\e[0m"
 
-  Redis.current = Redis.new(host: '127.0.0.1', port: 6379)
+  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

data/spec/spec_helpers/sequel.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 begin
   require 'sequel'
-  puts "sequel gem found, running Sequel specs \e[32m#{'✔'}\e[0m"
+  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

@@ -13,6 +13,10 @@ if defined?(ActiveRecord)
       expect(DefaultState.new.aasm.current_state).to eql :alpha
     end
 
+    it "uses display option" do
+      expect(DefaultState.new.aasm.human_state).to eql "ALPHA"
+    end
+
     it "uses the provided method" do
       expect(ProvidedState.new.aasm.current_state).to eql :beta
     end

data/spec/unit/callback_multiple_spec.rb

@@ -49,7 +49,7 @@ describe 'callbacks for the new DSL' do
 
     expect {
       callback.left_close!
-    }.to raise_error(AASM::InvalidTransition, "Event 'left_close' cannot transition from 'open'. Failed callback(s): [:after_transition, :event_guard].")
+    }.to raise_error(AASM::InvalidTransition, "Event 'left_close' cannot transition from 'open'. Failed callback(s): [:event_guard].")
 
   end
 
@@ -88,7 +88,7 @@ describe 'callbacks for the new DSL' do
 
       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].")
+      }.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
@@ -154,6 +154,8 @@ describe 'callbacks for the new DSL' do
     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)
 
@@ -161,6 +163,8 @@ describe 'callbacks for the new DSL' do
     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
@@ -287,7 +291,7 @@ describe 'event callbacks' 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].")
+      }.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

data/spec/unit/callbacks_spec.rb

@@ -3,14 +3,14 @@ Dir[File.dirname(__FILE__) + "/../models/callbacks/*.rb"].sort.each { |f| requir
 
 shared_examples 'an implemented callback that accepts error' do
   context 'with callback defined' do
-    it "should run error_callback if an exception is raised" do
+    it "should run error_callback if an exception is raised and always return false" do
       aasm_model.class.send(:define_method, callback_name) do |e|
         @data = [e]
       end
 
       allow(aasm_model).to receive(:before_enter).and_raise(e = StandardError.new)
 
-      aasm_model.safe_close!
+      expect(aasm_model.safe_close!).to be false
       expect(aasm_model.data).to eql [e]
     end
 
@@ -203,6 +203,32 @@ describe 'callbacks for the new DSL' do
       }.to raise_error(AASM::InvalidTransition)
     end
 
+    it "does not propagate failures to next attempt of same transition" do
+      callback = Callbacks::Basic.new(:log => false, :fail_transition_guard => true)
+
+      expect {
+        callback.close!
+      }.to raise_error(AASM::InvalidTransition, "Event 'close' cannot transition from 'open'. Failed callback(s): [:transition_guard].")
+
+      expect {
+        callback.close!
+      }.to raise_error(AASM::InvalidTransition, "Event 'close' cannot transition from 'open'. Failed callback(s): [:transition_guard].")
+    end
+
+    it "does not propagate failures to next attempt of same event when no transition is applicable" do
+      callback = Callbacks::Basic.new(:log => false, :fail_transition_guard => true)
+
+      expect {
+        callback.close!
+      }.to raise_error(AASM::InvalidTransition, "Event 'close' cannot transition from 'open'. Failed callback(s): [:transition_guard].")
+
+      callback.aasm.current_state = :closed
+
+      expect {
+        callback.close!
+      }.to raise_error(AASM::InvalidTransition, "Event 'close' cannot transition from 'closed'.")
+    end
+
     it "does not run transition_guard twice for multiple permitted transitions" do
       show_debug_log = false
       callback = Callbacks::MultipleTransitionsTransitionGuard.new(:log => show_debug_log, :fail_transition_guard => true)
@@ -289,7 +315,9 @@ describe 'callbacks for the new DSL' do
     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(:before_success_method).with(:arg1).once.ordered
     expect(cb).to receive(:success_method).with(:arg1).once.ordered
+    expect(cb).to receive(:success_method3).with(:arg1).once.ordered
     expect(cb).to receive(:success_method).never
     expect(cb).to receive(:after_method).with(:arg1).once.ordered
     cb.close!(:arg1)
@@ -299,7 +327,9 @@ describe 'callbacks for the new DSL' do
     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(:before_success_method).with(some_object).once.ordered
     expect(cb).to receive(:success_method).with(some_object).once.ordered
+    expect(cb).to receive(:success_method3).with(some_object).once.ordered
     expect(cb).to receive(:success_method).never
     expect(cb).to receive(:after_method).with(some_object).once.ordered
     cb.close!(some_object)