aasm 5.0.6 → 5.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51dfd1ad2a78034c409ddc556625e765260dd067
-  data.tar.gz: f934e43d4a35fc75a06d161190a8794e36066c02
+  metadata.gz: aa5a74637dafaa4c06da6c03e96342997692ad3f
+  data.tar.gz: e46be5420174440acc2dea63d9e66958d7dc6efc
 SHA512:
-  metadata.gz: 983b08a4a0977c37dd73b77c5d80d014a05025d7f2841c26788518c82a8e738825ab9fa5fc8a36577e9c6a23fd33cf341c6fefc954630836e213ab40ee12c909
-  data.tar.gz: b091bca286362fb33a31f1b9705840f664ebd0a948c6b2dffbaa2436144c5931a04950080b18e16c1a7d9e4e1b8f517b7ea6c2c133259a3860905928fda32b90
+  metadata.gz: 359caf35d39d769ec0cc3d805cface2f89946692e62b1dd984fc42830be53305c3abfb300163d6e2f46317673fbd3a1c9e8ea366328feebdedab5806b85f1fd0
+  data.tar.gz: a1621683151f4ff00e1e83f4d7f3926bc1d5d4e0d945e2a38ed4f6355267c0165e2aabbeca553cdf17a8c9e4237130a0a63cc9715b0b0e8bb5801c71bd2bb053

data/.travis.yml

@@ -14,6 +14,8 @@ before_install:
 rvm:
   - 2.3.0
   - 2.5.0
+  - 2.6.5
+  - 2.7.0
   - jruby-9.1.12.0
 
 services:
@@ -56,12 +58,28 @@ matrix:
       gemfile: gemfiles/rails_5.1.gemfile
     - rvm: 2.3.0
       gemfile: gemfiles/rails_5.2.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_5.2.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_5.2.gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_3.2.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_3.2.gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_4.2.gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
 #    - rvm: 2.5.0
 #      gemfile: gemfiles/rails_4.2_nobrainer.gemfile
     - rvm: jruby-9.1.12.0

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## unreleased
 
+## 5.0.7
+
+* Fix :after_commit within nested transaction [#666](https://github.com/aasm/aasm/pull/666), thanks to [stokarenko](https://github.com/stokarenko)
+* Add permitted_transitions to group permitted event with state [#664](https://github.com/aasm/aasm/pull/664), thanks to [dnamsons](https://github.com/dnamsons)
+* Add Ruby 2.7.0 & 2.6.5 to Travis CI Test Matrix [#661](https://github.com/aasm/aasm/pull/661), thanks to [the-spectator](https://github.com/the-spectator)
+* Handle InvalidTransition in transition_from matcher [#653](https://github.com/aasm/aasm/pull/653), thanks to [ryanwood](https://github.com/ryanwood)
+
 ## 5.0.6
 
 * Fix no_direct_assignment, couldn't be turned off pragmatically [#636](https://github.com/aasm/aasm/issues/636)

data/README.md

@@ -436,12 +436,12 @@ job.aasm.current_state # stage3
 ### Multiple state machines per class
 
 Multiple state machines per class are supported. Be aware though that _AASM_ has been
-built with one state machine per class in mind. Nonetheless, here's how to do it:
+built with one state machine per class in mind. Nonetheless, here's how to do it (see below). Please note that you will need to specify database columns for where your pertinent states will be stored - we have specified two columns `move_state` and `work_state` in the example below. See the [Column name & migration](https://github.com/aasm/aasm#column-name--migration) section for further info. 
 
 ```ruby
 class SimpleMultipleExample
   include AASM
-  aasm(:move) do
+  aasm(:move, column: 'move_state') do
     state :standing, initial: true
     state :walking
     state :running
@@ -457,7 +457,7 @@ class SimpleMultipleExample
     end
   end
 
-  aasm(:work) do
+  aasm(:work, column: 'work_state') do
     state :sleeping, initial: true
     state :processing
 
@@ -1065,11 +1065,11 @@ this by defining your favorite column name, using `:column` like this:
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm column: 'my_state' do
+  aasm column: :my_state do
     ...
   end
 
-  aasm :another_state_machine, column: 'second_state' do
+  aasm :another_state_machine, column: :second_state do
     ...
   end
 end
@@ -1141,6 +1141,10 @@ job = Job.new
 job.aasm.states(permitted: true).map(&:name)
 #=> [:running]
 
+# List all the permitted transitions(event and state pairs) from initial state
+job.aasm.permitted_transitions
+#=> [{ :event => :run, :state => :running }]
+
 job.run
 job.aasm.states(permitted: true).map(&:name)
 #=> [:sleeping]

data/aasm.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
 
   s.add_dependency 'concurrent-ruby', '~> 1.0'
+  s.add_dependency 'after_commit_action', '~> 1.0'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'

data/gemfiles/norails.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "sqlite3", "~> 1.3", ">= 1.3.5", platforms: :ruby
 gem "rails", install_if: false
 gem "sequel"
 gem "redis-objects"

data/lib/aasm/instance_base.rb

@@ -78,6 +78,17 @@ module AASM
       events
     end
 
+    def permitted_transitions
+      events(permitted: true).flat_map do |event|
+        available_transitions = event.transitions_from_state(current_state)
+        allowed_transitions = available_transitions.select { |t| t.allowed?(@instance) }
+
+        allowed_transitions.map do |transition|
+          { event: event.name, state: transition.to }
+        end
+      end
+    end
+
     def state_object_for_name(name)
       obj = @instance.class.aasm(@name).states.find {|s| s.name == name}
       raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?

data/lib/aasm/persistence/active_record_persistence.rb

@@ -1,3 +1,4 @@
+require 'after_commit_action'
 require 'aasm/persistence/orm'
 module AASM
   module Persistence
@@ -28,6 +29,7 @@ module AASM
       #   end
       #
       def self.included(base)
+        base.send(:include, ::AfterCommitAction) unless base.include?(::AfterCommitAction)
         base.send(:include, AASM::Persistence::Base)
         base.send(:include, AASM::Persistence::ORM)
         base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
@@ -88,6 +90,12 @@ module AASM
           end
         end
 
+        def aasm_execute_after_commit
+          execute_after_commit do
+            yield
+          end
+        end
+
         def aasm_enum(name=:default)
           case AASM::StateMachineStore.fetch(self.class, true).machine(name).config.enum
           when false then nil

data/lib/aasm/persistence/orm.rb

@@ -81,6 +81,10 @@ module AASM
         true
       end
 
+      def aasm_execute_after_commit
+        yield
+      end
+
       def aasm_write_state_attribute(state, name=:default)
         aasm_write_attribute(self.class.aasm(name).attribute_name, aasm_raw_attribute_value(state, name))
       end
@@ -116,32 +120,32 @@ module AASM
 
       # Returns true if event was fired successfully and transaction completed.
       def aasm_fire_event(state_machine_name, name, options, *args, &block)
-        if aasm_supports_transactions? && options[:persist]
-          event = self.class.aasm(state_machine_name).state_machine.events[name]
-          event.fire_callbacks(:before_transaction, self, *args)
-          event.fire_global_callbacks(:before_all_transactions, self, *args)
-
-          begin
-            success = if options[:persist] && use_transactions?(state_machine_name)
-              aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
-                super
-              end
-            else
+        return super unless aasm_supports_transactions? && options[:persist]
+
+        event = self.class.aasm(state_machine_name).state_machine.events[name]
+        event.fire_callbacks(:before_transaction, self, *args)
+        event.fire_global_callbacks(:before_all_transactions, self, *args)
+
+        begin
+          success = if options[:persist] && use_transactions?(state_machine_name)
+            aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
               super
             end
+          else
+            super
+          end
 
-            if success
+          if success
+            aasm_execute_after_commit do
               event.fire_callbacks(:after_commit, self, *args)
               event.fire_global_callbacks(:after_all_commits, self, *args)
             end
-
-            success
-          ensure
-            event.fire_callbacks(:after_transaction, self, *args)
-            event.fire_global_callbacks(:after_all_transactions, self, *args)
           end
-        else
-          super
+
+          success
+        ensure
+          event.fire_callbacks(:after_transaction, self, *args)
+          event.fire_global_callbacks(:after_all_transactions, self, *args)
         end
       end
 

data/lib/aasm/rspec/transition_from.rb

@@ -2,7 +2,11 @@ RSpec::Matchers.define :transition_from do |from_state|
   match do |obj|
     @state_machine_name ||= :default
     obj.aasm(@state_machine_name).current_state = from_state.to_sym
-    obj.send(@event, *@args) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    begin
+      obj.send(@event, *@args) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    rescue AASM::InvalidTransition
+      false
+    end
   end
 
   chain :on do |state_machine_name|

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "5.0.6"
+  VERSION = "5.0.7"
 end

data/spec/models/simple_example.rb

@@ -3,11 +3,17 @@ 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

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -613,6 +613,38 @@ 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
+        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
 
       describe 'before and after transaction callbacks' do

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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.0.7
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: after_commit_action
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement