aasm 5.0.6 → 5.2.0

data/spec/unit/persistence/active_record_persistence_multiple_spec.rb

@@ -331,6 +331,23 @@ if defined?(ActiveRecord)
         expect(MultipleSimpleNewDsl.unknown_scope).to contain_exactly(dsl2)
       end
     end
+
+    context "when namespeced" do
+      it "add namespaced scopes" do
+        expect(MultipleNamespaced).to respond_to(:car_unsold)
+        expect(MultipleNamespaced).to respond_to(:car_sold)
+
+        expect(MultipleNamespaced.car_unsold.is_a?(ActiveRecord::Relation)).to be_truthy
+        expect(MultipleNamespaced.car_sold.is_a?(ActiveRecord::Relation)).to be_truthy
+      end
+      it "add unnamespaced scopes" do
+        expect(MultipleNamespaced).to respond_to(:unsold)
+        expect(MultipleNamespaced).to respond_to(:sold)
+
+        expect(MultipleNamespaced.unsold.is_a?(ActiveRecord::Relation)).to be_truthy
+        expect(MultipleNamespaced.sold.is_a?(ActiveRecord::Relation)).to be_truthy
+      end
+    end
   end # scopes
 
   describe "direct assignment" do

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -613,6 +613,73 @@ if defined?(ActiveRecord)
           expect(validator).to be_running
           expect(validator.name).to eq("name")
         end
+
+        context "nested transaction" do
+          it "should fire :after_commit if root transaction was successful" do
+            validator = Validator.create(:name => 'name')
+            expect(validator).to be_sleeping
+
+            validator.transaction do
+              validator.run!
+              expect(validator.name).to eq("name")
+              expect(validator).to be_running
+            end
+
+            expect(validator.name).to eq("name changed")
+            expect(validator.reload).to be_running
+          end
+
+          it "should not fire :after_commit if root transaction failed" do
+            validator = Validator.create(:name => 'name')
+            expect(validator).to be_sleeping
+
+            validator.transaction do
+              validator.run!
+              expect(validator.name).to eq("name")
+              expect(validator).to be_running
+
+              raise ActiveRecord::Rollback, "failed on purpose"
+            end
+
+            expect(validator.name).to eq("name")
+            expect(validator.reload).to be_sleeping
+          end
+        end
+      end
+
+      describe 'callbacks for the new DSL' do
+
+        it "be called in order" do
+          show_debug_log = false
+
+          callback = ActiveRecordCallback.create
+          callback.aasm.current_state
+
+          unless show_debug_log
+            expect(callback).to receive(:before_all_events).once.ordered
+            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_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
+            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                    # these should be after the state changes
+            expect(callback).to receive(:after_enter_closed).once.ordered
+            expect(callback).to receive(:after_event).once.ordered
+            expect(callback).to receive(:after_all_events).once.ordered
+            expect(callback).to receive(:ensure_event).once.ordered
+            expect(callback).to receive(:ensure_on_all_events).once.ordered
+            expect(callback).to receive(:event_after_commit).once.ordered
+          end
+
+          callback.close!
+        end
       end
 
       describe 'before and after transaction callbacks' do
@@ -770,4 +837,16 @@ if defined?(ActiveRecord)
       expect(example.complete!).to be_falsey
     end
   end
+
+  describe 'testing the timestamps option' do
+    let(:example) { TimestampExample.create! }
+
+    it 'should update existing timestamp columns' do
+      expect { example.open! }.to change { example.reload.opened_at }.from(nil).to(instance_of(::Time))
+    end
+
+    it 'should not fail if there is no corresponding timestamp column' do
+      expect { example.close! }.to change { example.reload.aasm_state }
+    end
+  end
 end

data/spec/unit/persistence/mongoid_persistence_spec.rb

@@ -161,5 +161,17 @@ if defined?(Mongoid::Document)
       end
     end
 
+    describe 'testing the timestamps option' do
+      let(:example) { TimestampExampleMongoid.create }
+
+      it 'should update existing timestamp fields' do
+        expect { example.open! }.to change { example.reload.opened_at }.from(nil).to(instance_of(::Time))
+      end
+
+      it 'should not fail if there is no corresponding timestamp field' do
+        expect { example.close! }.to change { example.reload.status }
+      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
 

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/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
+
+    context 'with :display option' do
+      let(:options) { { display: "A State" } }
 
-  it 'should set the display_name from options' do
-    expect(new_state(:display => "A State").display_name).to eq('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

data/spec/unit/timestamps_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'timestamps option' do
+  it 'calls a timestamp setter based on the state name when entering a new state' do
+    object = TimestampsExample.new
+    expect { object.open }.to change { object.opened_at }.from(nil).to(instance_of(::Time))
+  end
+
+  it 'overwrites any previous timestamp if a state is entered repeatedly' do
+    object = TimestampsExample.new
+    object.opened_at = ::Time.new(2000, 1, 1)
+    expect { object.open }.to change { object.opened_at }
+  end
+
+  it 'does nothing if there is no setter matching the new state' do
+    object = TimestampsExample.new
+    expect { object.close }.not_to change { object.closed_at }
+  end
+
+  it 'can be turned off and on' do
+    object = TimestampsExample.new
+    object.class.aasm.state_machine.config.timestamps = false
+    expect { object.open }.not_to change { object.opened_at }
+    object.class.aasm.state_machine.config.timestamps = true
+    expect { object.open }.to change { object.opened_at }
+  end
+
+  it 'calls a timestamp setter when using a named state machine' do
+    object = TimestampsWithNamedMachineExample.new
+    expect { object.open }.to change { object.opened_at }.from(nil).to(instance_of(::Time))
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.2.0
 platform: ruby
 authors:
 - Thorsten Boettger
 - Anil Maurya
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.1.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.1.21
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -165,10 +165,8 @@ files:
 - Rakefile
 - TESTING.md
 - aasm.gemspec
-- callbacks.txt
 - docker-compose.yml
 - gemfiles/norails.gemfile
-- gemfiles/rails_3.2.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_4.2_mongoid_5.gemfile
 - gemfiles/rails_4.2_nobrainer.gemfile
@@ -228,10 +226,12 @@ files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
+- spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
 - spec/models/active_record/derivate_new_dsl.rb
@@ -240,6 +240,7 @@ files:
 - spec/models/active_record/instance_level_skip_validation_example.rb
 - spec/models/active_record/invalid_persistor.rb
 - spec/models/active_record/localizer_test_model.rb
+- spec/models/active_record/namespaced.rb
 - spec/models/active_record/no_direct_assignment.rb
 - spec/models/active_record/no_scope.rb
 - spec/models/active_record/persisted_state.rb
@@ -250,6 +251,7 @@ files:
 - spec/models/active_record/silent_persistor.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
+- spec/models/active_record/timestamp_example.rb
 - spec/models/active_record/transactor.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/validator.rb
@@ -296,6 +298,7 @@ files:
 - spec/models/mongoid/silent_persistor_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
+- spec/models/mongoid/timestamp_example_mongoid.rb
 - spec/models/mongoid/validator_mongoid.rb
 - spec/models/multi_transitioner.rb
 - spec/models/multiple_transitions_that_differ_only_by_guard.rb
@@ -337,6 +340,8 @@ files:
 - spec/models/sub_classing.rb
 - spec/models/super_class.rb
 - spec/models/this_name_better_not_be_in_use.rb
+- spec/models/timestamps_example.rb
+- spec/models/timestamps_with_named_machine_example.rb
 - spec/models/valid_state_name.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/active_record.rb
@@ -401,6 +406,7 @@ files:
 - spec/unit/states_on_one_line_example_spec.rb
 - spec/unit/subclassing_multiple_spec.rb
 - spec/unit/subclassing_spec.rb
+- spec/unit/timestamps_spec.rb
 - spec/unit/transition_spec.rb
 - test/minitest_helper.rb
 - test/unit/minitest_matcher_test.rb
@@ -408,7 +414,7 @@ homepage: https://github.com/aasm/aasm
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -423,19 +429,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: State machine mixin for Ruby objects
 test_files:
 - spec/database.rb
 - spec/database.yml
 - spec/en.yml
-- spec/en_deprecated_style.yml
 - spec/generators/active_record_generator_spec.rb
 - spec/generators/mongoid_generator_spec.rb
 - spec/generators/no_brainer_generator_spec.rb
+- spec/localizer_test_model_deprecated_style.yml
+- spec/localizer_test_model_new_style.yml
+- spec/models/active_record/active_record_callback.rb
 - spec/models/active_record/basic_active_record_two_state_machines_example.rb
 - spec/models/active_record/complex_active_record_example.rb
 - spec/models/active_record/derivate_new_dsl.rb
@@ -444,6 +451,7 @@ test_files:
 - spec/models/active_record/instance_level_skip_validation_example.rb
 - spec/models/active_record/invalid_persistor.rb
 - spec/models/active_record/localizer_test_model.rb
+- spec/models/active_record/namespaced.rb
 - spec/models/active_record/no_direct_assignment.rb
 - spec/models/active_record/no_scope.rb
 - spec/models/active_record/persisted_state.rb
@@ -454,6 +462,7 @@ test_files:
 - spec/models/active_record/silent_persistor.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
+- spec/models/active_record/timestamp_example.rb
 - spec/models/active_record/transactor.rb
 - spec/models/active_record/transient.rb
 - spec/models/active_record/validator.rb
@@ -500,6 +509,7 @@ test_files:
 - spec/models/mongoid/silent_persistor_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
+- spec/models/mongoid/timestamp_example_mongoid.rb
 - spec/models/mongoid/validator_mongoid.rb
 - spec/models/multi_transitioner.rb
 - spec/models/multiple_transitions_that_differ_only_by_guard.rb
@@ -541,6 +551,8 @@ test_files:
 - spec/models/sub_classing.rb
 - spec/models/super_class.rb
 - spec/models/this_name_better_not_be_in_use.rb
+- spec/models/timestamps_example.rb
+- spec/models/timestamps_with_named_machine_example.rb
 - spec/models/valid_state_name.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/active_record.rb
@@ -605,6 +617,7 @@ test_files:
 - spec/unit/states_on_one_line_example_spec.rb
 - spec/unit/subclassing_multiple_spec.rb
 - spec/unit/subclassing_spec.rb
+- spec/unit/timestamps_spec.rb
 - spec/unit/transition_spec.rb
 - test/minitest_helper.rb
 - test/unit/minitest_matcher_test.rb

data/callbacks.txt

@@ -1,51 +0,0 @@
-callbacks
-
-AASM 3
-
-begin
-  old_state       exit                # old? should be deprecated -> use old_state.before_exit instead
-  event           before
-  old_state       before_exit
-  new_state       before_enter
-  new_state       enter               # old? should be deprecated -> use new_state.before_enter instead
-    ...update state...
-    transition    guard
-    event         guard
-    transition    on_transition
-    event         success             # if persist successful
-  old_state       after_exit
-  new_state       after_enter
-  event           after
-rescue
-  event           error
-end
-
-AASM 4
-
-todo
-
-done
-- move event.before before everything else
-- move old_state.before_exit before old_state.exit
-- move event.guard before transition.guard
-- fire guards before running state callbacks (test run)
-
-begin
-  event           before
-  event           guard               # test run
-  transition      guard               # test run
-  old_state       before_exit
-  old_state       exit
-  new_state       before_enter
-  new_state       enter
-    event         guard
-    transition    guard
-    transition    on_transition
-    ...update state...
-    event         success             # if persist successful
-  old_state       after_exit
-  new_state       after_enter
-  event           after
-rescue
-  event           error
-end