aasm 4.11.1 → 5.2.0

data/spec/unit/persistence/redis_persistence_multiple_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+if defined?(Redis)
+  describe 'redis' do
+
+    Dir[File.dirname(__FILE__) + "/../../models/redis/*.rb"].sort.each do |f|
+      require File.expand_path(f)
+    end
+
+    before(:all) do
+      @model = RedisMultiple
+    end
+
+    describe "instance methods" do
+      let(:model) {@model.new}
+
+      it "should respond to aasm persistence methods" do
+        expect(model).to respond_to(:aasm_read_state)
+        expect(model).to respond_to(:aasm_write_state)
+        expect(model).to respond_to(:aasm_write_state_without_persistence)
+      end
+
+      it "should return the initial state when new and the aasm field is nil" do
+        expect(model.aasm(:left).current_state).to eq(:alpha)
+      end
+
+      it "should save the initial state" do
+        expect(model.status).to eq("alpha")
+      end
+
+      it "should return the aasm column the aasm field is not nil" do
+        model.status = "beta"
+        expect(model.aasm(:left).current_state).to eq(:beta)
+      end
+
+      it "should allow a nil state" do
+        model.status = nil
+        expect(model.aasm(:left).current_state).to be_nil
+      end
+    end
+
+    describe 'subclasses' do
+      it "should have the same states as its parent class" do
+        expect(Class.new(@model).aasm(:left).states).to eq(@model.aasm(:left).states)
+      end
+
+      it "should have the same events as its parent class" do
+        expect(Class.new(@model).aasm(:left).events).to eq(@model.aasm(:left).events)
+      end
+
+      it "should have the same column as its parent even for the new dsl" do
+        expect(@model.aasm(:left).attribute_name).to eq(:status)
+        expect(Class.new(@model).aasm(:left).attribute_name).to eq(:status)
+      end
+    end
+
+    describe "complex example" do
+      it "works" do
+        record = RedisComplexExample.new
+
+        expect(record.aasm(:left).current_state).to eql :one
+        expect(record.aasm(:right).current_state).to eql :alpha
+
+        expect_aasm_states record, :one, :alpha
+
+        record.increment!
+        expect_aasm_states record, :two, :alpha
+
+        record.level_up!
+        expect_aasm_states record, :two, :beta
+
+        record.increment!
+        expect { record.increment! }.to raise_error(AASM::InvalidTransition)
+        expect_aasm_states record, :three, :beta
+
+        record.level_up!
+        expect_aasm_states record, :three, :gamma
+      end
+
+      def expect_aasm_states(record, left_state, right_state)
+        expect(record.aasm(:left).current_state).to eql left_state.to_sym
+        expect(record.left.value.to_s).to eql left_state.to_s
+        expect(record.aasm(:right).current_state).to eql right_state.to_sym
+        expect(record.right.value.to_s).to eql right_state.to_s
+      end
+    end
+  end
+end

data/spec/unit/persistence/redis_persistence_spec.rb

@@ -1,35 +1,14 @@
+require 'spec_helper'
 
-describe 'redis' do
-  begin
-    require 'redis-objects'
-    require 'logger'
-    require 'spec_helper'
+if defined?(Redis::Objects)
+  describe 'redis' do
 
-    before(:all) do
-      Redis.current = Redis.new(host: '127.0.0.1', port: 6379)
-
-      @model = Class.new do
-        attr_accessor :default
-
-        include Redis::Objects
-        include AASM
-
-        value :status
-
-        def id
-          1
-        end
+    Dir[File.dirname(__FILE__) + "/../../models/redis/*.rb"].sort.each do |f|
+      require File.expand_path(f)
+    end
 
-        aasm column: :status
-        aasm do
-          state :alpha, initial: true
-          state :beta
-          state :gamma
-          event :release do
-            transitions from: [:alpha, :beta, :gamma], to: :beta
-          end
-        end
-      end
+    before(:all) do
+      @model = RedisSimple
     end
 
     describe "instance methods" do
@@ -70,8 +49,5 @@ describe 'redis' do
         expect(Class.new(@model).aasm.attribute_name).to eq(:status)
       end
     end
-
-  rescue LoadError
-    puts "Not running Redis specs because sequel gem is not installed!!!"
   end
 end

data/spec/unit/persistence/sequel_persistence_multiple_spec.rb

@@ -1,15 +1,14 @@
-describe 'sequel' do
-  begin
-    require 'sequel'
-    require 'logger'
-    require 'spec_helper'
+require 'spec_helper'
+
+if defined?(Sequel)
+  describe 'sequel' do
 
     Dir[File.dirname(__FILE__) + "/../../models/sequel/*.rb"].sort.each do |f|
       require File.expand_path(f)
     end
 
     before(:all) do
-      @model = SequelMultiple
+      @model = Sequel::Multiple
     end
 
     describe "instance methods" do
@@ -94,7 +93,7 @@ describe 'sequel' do
 
     describe "complex example" do
       it "works" do
-        record = ComplexSequelExample.new
+        record = Sequel::ComplexExample.new
         expect(record.aasm(:left).current_state).to eql :one
         expect(record.left).to be_nil
         expect(record.aasm(:right).current_state).to eql :alpha
@@ -145,9 +144,5 @@ describe 'sequel' do
       end
     end
 
-  rescue LoadError
-    puts "------------------------------------------------------------------------"
-    puts "Not running Sequel multiple-specs because sequel gem is not installed!!!"
-    puts "------------------------------------------------------------------------"
   end
 end

data/spec/unit/persistence/sequel_persistence_spec.rb

@@ -1,15 +1,13 @@
-describe 'sequel' do
-  begin
-    require 'sequel'
-    require 'logger'
-    require 'spec_helper'
+require 'spec_helper'
+if defined?(Sequel)
+  describe 'sequel' do
 
     Dir[File.dirname(__FILE__) + "/../../models/sequel/*.rb"].sort.each do |f|
       require File.expand_path(f)
     end
 
     before(:all) do
-      @model = SequelSimple
+      @model = Sequel::Simple
     end
 
     describe "instance methods" do
@@ -92,9 +90,279 @@ describe 'sequel' do
       end
     end
 
-  rescue LoadError
-    puts "------------------------------------------------------------------------"
-    puts "Not running Sequel specs because sequel gem is not installed!!!"
-    puts "------------------------------------------------------------------------"
+    describe 'transitions with persistence' do
+
+      it "should work for valid models" do
+        valid_object = Sequel::Validator.create(:name => 'name')
+        expect(valid_object).to be_sleeping
+        valid_object.status = :running
+        expect(valid_object).to be_running
+      end
+
+      it 'should not store states for invalid models' do
+        validator = Sequel::Validator.create(:name => 'name')
+        expect(validator).to be_valid
+        expect(validator).to be_sleeping
+
+        validator.name = nil
+        expect(validator).not_to be_valid
+        expect { validator.run! }.to raise_error(Sequel::ValidationFailed)
+        expect(validator).to be_sleeping
+
+        validator.reload
+        expect(validator).not_to be_running
+        expect(validator).to be_sleeping
+
+        validator.name = 'another name'
+        expect(validator).to be_valid
+        expect(validator.run!).to be_truthy
+        expect(validator).to be_running
+
+        validator.reload
+        expect(validator).to be_running
+        expect(validator).not_to be_sleeping
+      end
+
+      it 'should not store states for invalid models silently if configured' do
+        validator = Sequel::SilentPersistor.create(:name => 'name')
+        expect(validator).to be_valid
+        expect(validator).to be_sleeping
+
+        validator.name = nil
+        expect(validator).not_to be_valid
+        expect(validator.run!).to be_falsey
+        expect(validator).to be_sleeping
+
+        validator.reload
+        expect(validator).not_to be_running
+        expect(validator).to be_sleeping
+
+        validator.name = 'another name'
+        expect(validator).to be_valid
+        expect(validator.run!).to be_truthy
+        expect(validator).to be_running
+
+        validator.reload
+        expect(validator).to be_running
+        expect(validator).not_to be_sleeping
+      end
+
+      it 'should store states for invalid models if configured' do
+        persistor = Sequel::InvalidPersistor.create(:name => 'name')
+        expect(persistor).to be_valid
+        expect(persistor).to be_sleeping
+
+        persistor.name = nil
+        expect(persistor).not_to be_valid
+        expect(persistor.run!).to be_truthy
+        expect(persistor).to be_running
+
+        persistor = Sequel::InvalidPersistor[persistor.id]
+        persistor.valid?
+        expect(persistor).to be_valid
+        expect(persistor).to be_running
+        expect(persistor).not_to be_sleeping
+
+        persistor.reload
+        expect(persistor).to be_running
+        expect(persistor).not_to be_sleeping
+      end
+
+      describe 'pessimistic locking' do
+        let(:worker) { Sequel::Worker.create(:name => 'worker', :status => 'sleeping') }
+
+        subject { transactor.run! }
+
+        context 'no lock' do
+          let(:transactor) { Sequel::NoLockTransactor.create(:name => 'no_lock_transactor', :worker => worker) }
+
+          it 'should not invoke lock!' do
+            expect(transactor).to_not receive(:lock!)
+            subject
+          end
+        end
+
+        context 'a default lock' do
+          let(:transactor) { Sequel::LockTransactor.create(:name => 'lock_transactor', :worker => worker) }
+
+          it 'should invoke lock!' do
+            expect(transactor).to receive(:lock!).and_call_original
+            subject
+          end
+        end
+
+        context 'a FOR UPDATE NOWAIT lock' do
+          let(:transactor) { Sequel::LockNoWaitTransactor.create(:name => 'lock_no_wait_transactor', :worker => worker) }
+
+          it 'should invoke lock! with FOR UPDATE NOWAIT' do
+            # TODO: With and_call_original, get an error with syntax, should look into it.
+            expect(transactor).to receive(:lock!).with('FOR UPDATE NOWAIT')# .and_call_original
+            subject
+          end
+        end
+      end
+
+      describe 'transactions' do
+        let(:worker) { Sequel::Worker.create(:name => 'worker', :status => 'sleeping') }
+        let(:transactor) { Sequel::Transactor.create(:name => 'transactor', :worker => worker) }
+
+        it 'should rollback all changes' do
+          expect(transactor).to be_sleeping
+          expect(worker.status).to eq('sleeping')
+
+          expect {transactor.run!}.to raise_error(StandardError, 'failed on purpose')
+          expect(transactor).to be_running
+          expect(worker.reload.status).to eq('sleeping')
+        end
+
+        context "nested transactions" do
+          it "should rollback all changes in nested transaction" do
+            expect(transactor).to be_sleeping
+            expect(worker.status).to eq('sleeping')
+
+            Sequel::Worker.db.transaction do
+              expect { transactor.run! }.to raise_error(StandardError, 'failed on purpose')
+            end
+
+            expect(transactor).to be_running
+            expect(worker.reload.status).to eq('sleeping')
+          end
+
+          it "should only rollback changes in the main transaction not the nested one" do
+            # change configuration to not require new transaction
+            AASM::StateMachineStore[Sequel::Transactor][:default].config.requires_new_transaction = false
+
+            expect(transactor).to be_sleeping
+            expect(worker.status).to eq('sleeping')
+            Sequel::Worker.db.transaction do
+              expect { transactor.run! }.to raise_error(StandardError, 'failed on purpose')
+            end
+            expect(transactor).to be_running
+            expect(worker.reload.status).to eq('running')
+          end
+        end
+
+        describe "after_commit callback" do
+          it "should fire :after_commit if transaction was successful" do
+            validator = Sequel::Validator.create(:name => 'name')
+            expect(validator).to be_sleeping
+
+            validator.run!
+            expect(validator).to be_running
+            expect(validator.name).to eq("name changed")
+
+            validator.sleep!("sleeper")
+            expect(validator).to be_sleeping
+            expect(validator.name).to eq("sleeper")
+          end
+
+          it "should not fire :after_commit if transaction failed" do
+            validator = Sequel::Validator.create(:name => 'name')
+            expect { validator.fail! }.to raise_error(StandardError, 'failed on purpose')
+            expect(validator.name).to eq("name")
+          end
+
+          it "should not fire :after_commit if validation failed when saving object" do
+            validator = Sequel::Validator.create(:name => 'name')
+            validator.invalid = true
+            expect { validator.run! }.to raise_error(Sequel::ValidationFailed, 'validator invalid')
+            expect(validator).to be_sleeping
+            expect(validator.name).to eq("name")
+          end
+
+          it "should not fire if not saving" do
+            validator = Sequel::Validator.create(:name => 'name')
+            expect(validator).to be_sleeping
+            validator.run
+            expect(validator).to be_running
+            expect(validator.name).to eq("name")
+          end
+        end
+
+        describe 'before and after transaction callbacks' do
+          [:after, :before].each do |event_type|
+            describe "#{event_type}_transaction callback" do
+              it "should fire :#{event_type}_transaction if transaction was successful" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect(validator).to be_sleeping
+
+                expect { validator.run! }.to change { validator.send("#{event_type}_transaction_performed_on_run") }.from(nil).to(true)
+                expect(validator).to be_running
+              end
+
+              it "should fire :#{event_type}_transaction if transaction failed" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect do
+                  begin
+                    validator.fail!
+                  rescue => ignored
+                  end
+                end.to change { validator.send("#{event_type}_transaction_performed_on_fail") }.from(nil).to(true)
+                expect(validator).to_not be_running
+              end
+
+              it "should not fire :#{event_type}_transaction if not saving" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect(validator).to be_sleeping
+                expect { validator.run }.to_not change { validator.send("#{event_type}_transaction_performed_on_run") }
+                expect(validator).to be_running
+                expect(validator.name).to eq("name")
+              end
+            end
+          end
+        end
+
+        describe 'before and after all transactions callbacks' do
+          [:after, :before].each do |event_type|
+            describe "#{event_type}_all_transactions callback" do
+              it "should fire :#{event_type}_all_transactions if transaction was successful" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect(validator).to be_sleeping
+
+                expect { validator.run! }.to change { validator.send("#{event_type}_all_transactions_performed") }.from(nil).to(true)
+                expect(validator).to be_running
+              end
+
+              it "should fire :#{event_type}_all_transactions if transaction failed" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect do
+                  begin
+                    validator.fail!
+                  rescue => ignored
+                  end
+                end.to change { validator.send("#{event_type}_all_transactions_performed") }.from(nil).to(true)
+                expect(validator).to_not be_running
+              end
+
+              it "should not fire :#{event_type}_all_transactions if not saving" do
+                validator = Sequel::Validator.create(:name => 'name')
+                expect(validator).to be_sleeping
+                expect { validator.run }.to_not change { validator.send("#{event_type}_all_transactions_performed") }
+                expect(validator).to be_running
+                expect(validator.name).to eq("name")
+              end
+            end
+          end
+        end
+
+        context "when not persisting" do
+          it 'should not rollback all changes' do
+            expect(transactor).to be_sleeping
+            expect(worker.status).to eq('sleeping')
+
+            # Notice here we're calling "run" and not "run!" with a bang.
+            expect {transactor.run}.to raise_error(StandardError, 'failed on purpose')
+            expect(transactor).to be_running
+            expect(worker.reload.status).to eq('running')
+          end
+
+          it 'should not create a database transaction' do
+            expect(transactor.class).not_to receive(:transaction)
+            expect {transactor.run}.to raise_error(StandardError, 'failed on purpose')
+          end
+        end
+      end
+    end
+
   end
 end

data/spec/unit/rspec_matcher_spec.rb

@@ -8,14 +8,17 @@ describe 'state machine' do
     it "works for simple state machines" do
       expect(simple).to transition_from(:initialised).to(:filled_out).on_event(:fill_out)
       expect(simple).to_not transition_from(:initialised).to(:authorised).on_event(:fill_out)
+      expect(simple).to_not transition_from(:authorised).to(:filled_out).on_event(:fill_out)
     end
 
     it "works for multiple state machines" do
       expect(multiple).to transition_from(:standing).to(:walking).on_event(:walk).on(:move)
       expect(multiple).to_not transition_from(:standing).to(:running).on_event(:walk).on(:move)
+      expect(multiple).to_not transition_from(:running).to(:walking).on_event(:walk).on(:move)
 
       expect(multiple).to transition_from(:sleeping).to(:processing).on_event(:start).on(:work)
       expect(multiple).to_not transition_from(:sleeping).to(:sleeping).on_event(:start).on(:work)
+      expect(multiple).to_not transition_from(:processing).to(:sleeping).on_event(:start).on(:work)
     end
   end
 
@@ -63,6 +66,12 @@ describe 'state machine' do
       expect(simple).to allow_event :authorise
     end
 
+    it "works with custom arguments" do
+      example = SimpleExampleWithGuardArgs.new
+      expect(example).to allow_event(:fill_out_with_args).with(true)
+      expect(example).to_not allow_event(:fill_out_with_args).with(false)
+    end
+
     it "works for multiple state machines" do
       expect(multiple).to allow_event(:walk).on(:move)
       expect(multiple).to_not allow_event(:hold).on(:move)

data/spec/unit/simple_example_spec.rb

@@ -23,6 +23,21 @@ describe 'state machine' do
     expect(simple).to be_authorised
   end
 
+  it 'shows the permitted transitions' do
+    expect(simple.aasm.permitted_transitions).to eq(
+      [
+        { event: :fill_out, state: :filled_out },
+        { event: :deny, state: :denied }
+      ]
+    )
+
+    simple.fill_out!
+    expect(simple.aasm.permitted_transitions).to eq([{ event: :authorise, state: :authorised }])
+
+    simple.authorise
+    expect(simple.aasm.permitted_transitions).to eq([])
+  end
+
   it 'denies transitions to other states' do
     expect {simple.authorise}.to raise_error(AASM::InvalidTransition)
     expect {simple.authorise!}.to raise_error(AASM::InvalidTransition)

data/spec/unit/simple_multiple_example_spec.rb

@@ -60,4 +60,32 @@ describe 'state machine' do
     expect(SimpleMultipleExample::STATE_PROCESSING).to eq(:processing)
     expect(SimpleMultipleExample::STATE_RUNNING).to eq(:running)
   end
+
+  context 'triggers binding_events in bindind_state_machine' do
+    it 'does persist' do
+      expect(simple).to be_sleeping
+      expect(simple).to be_answered
+      expect(simple).to receive(:start!).and_call_original
+      simple.ask!
+      expect(simple).to be_asked
+      expect(simple).to be_processing
+      expect(simple).to receive(:stop!).and_call_original
+      simple.answer!
+      expect(simple).to be_sleeping
+      expect(simple).to be_answered
+    end
+
+    it 'does not persist' do
+      expect(simple).to be_sleeping
+      expect(simple).to be_answered
+      expect(simple).to receive(:start).and_call_original
+      simple.ask
+      expect(simple).to be_asked
+      expect(simple).to be_processing
+      expect(simple).to receive(:stop).and_call_original
+      simple.answer
+      expect(simple).to be_sleeping
+      expect(simple).to be_answered
+    end
+  end
 end

data/spec/unit/state_spec.rb

@@ -17,12 +17,28 @@ describe AASM::Core::State do
     expect(state.name).to eq(:astate)
   end
 
-  it 'should set the display_name from name' do
-    expect(new_state.display_name).to eq('Astate')
-  end
+  describe '#display_name' do
+    subject(:display_name) { new_state(options).display_name }
+
+    context 'without options' do
+      let(:options) { {} }
+
+      context 'without I18n' do
+        before { allow(Module).to receive(:const_defined?).with(:I18n).and_return(nil) }
+
+        it 'should set the display_name from name' do
+          expect(display_name).to eq('Astate')
+        end
+      end
+    end
 
-  it 'should set the display_name from options' do
-    expect(new_state(:display => "A State").display_name).to eq('A State')
+    context 'with :display option' do
+      let(:options) { { display: "A State" } }
+
+      it 'should set the display_name from options' do
+        expect(display_name).to eq('A State')
+      end
+    end
   end
 
   it 'should set the options and expose them as options' do
@@ -64,7 +80,7 @@ describe AASM::Core::State do
     expect(record).to receive(:c)
     expect(record).to receive(:foobar)
 
-    state.fire_callbacks(:entering, record)
+    state.fire_callbacks(:entering, record, record)
   end
 
   it "should stop calling actions if one of them raises :halt_aasm_chain" do
@@ -84,6 +100,6 @@ describe AASM::Core::State do
     record = double('record')
     expect(record).to receive(:foobar)
 
-    state.fire_callbacks(:entering, record)
+    state.fire_callbacks(:entering, record, record)
   end
 end

data/spec/unit/subclassing_multiple_spec.rb

@@ -19,7 +19,7 @@ describe 'subclassing with multiple state machines' do
     expect(SuperClassMultiple.aasm(:right).states).not_to include(:archived)
   end
 
-  it "should have the same events as its parent" do
+  it 'should have the same events as its parent' do
     expect(SubClassMultiple.aasm(:left).events).to eq(SuperClassMultiple.aasm(:left).events)
     expect(SubClassMultiple.aasm(:right).events).to eq(SuperClassMultiple.aasm(:right).events)
   end
@@ -35,5 +35,40 @@ describe 'subclassing with multiple state machines' do
     expect(son.aasm(:left).current_state).to eq(:ended)
   end
 
-end
+  it 'should allow the child to modify its left state machine' do
+    son = SubClassMultiple.new
+    expect(son.left_called_after).to eq(nil)
+    expect(son.right_called_after).to eq(nil)
+    son.foo
+    expect(son.left_called_after).to eq(true)
+    expect(son.right_called_after).to eq(nil)
+    global_callbacks = SubClassMultiple.aasm(:left).state_machine.global_callbacks
+    expect(global_callbacks).to_not be_empty
+    expect(global_callbacks[:after_all_transitions]).to eq :left_after_all_event
+  end
+
+  it 'should allow the child to modify its right state machine' do
+    son = SubClassMultiple.new
+    expect(son.right_called_after).to eq(nil)
+    expect(son.left_called_after).to eq(nil)
+    son.close
+    expect(son.right_called_after).to eq(true)
+    expect(son.left_called_after).to eq(nil)
+    global_callbacks = SubClassMultiple.aasm(:right).state_machine.global_callbacks
+    expect(global_callbacks).to_not be_empty
+    expect(global_callbacks[:after_all_transitions]).to eq :right_after_all_event
+  end
 
+  it 'should not modify the parent left state machine' do
+    super_class_event = SuperClassMultiple.aasm(:left).events.select { |event| event.name == :foo }.first
+    expect(super_class_event.options).to be_empty
+    expect(SuperClassMultiple.aasm(:left).state_machine.global_callbacks).to be_empty
+  end
+
+  it 'should not modify the parent right state machine' do
+    super_class_event = SuperClassMultiple.aasm(:right).events.select { |event| event.name == :close }.first
+    expect(super_class_event.options).to be_empty
+    expect(SuperClassMultiple.aasm(:right).state_machine.global_callbacks).to be_empty
+  end
+
+end