aasm 3.0.22 → 3.0.23

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.23
+
+ * added support for `after_commit` callback (transaction support) (thanks to [@tisba](https://github.com/tisba))
+
 ## 3.0.22
 
  * fixed [issue 88](https://github.com/aasm/aasm/issues/88): wrong number of arguments for transaction method

data/README.md

@@ -1,6 +1,6 @@
 # AASM - Ruby state machines
 
-[![Build Status](https://secure.travis-ci.org/aasm/aasm.png?branch=master)](http://travis-ci.org/aasm/aasm) [![Code Climate](https://codeclimate.com/github/aasm/aasm.png)](https://codeclimate.com/github/aasm/aasm) [![Coverage Status](https://coveralls.io/repos/aasm/aasm/badge.png?branch=master)](https://coveralls.io/r/aasm/aasm)
+[![Gem Version](https://badge.fury.io/rb/aasm.png)](http://badge.fury.io/rb/aasm) [![Build Status](https://secure.travis-ci.org/aasm/aasm.png?branch=master)](http://travis-ci.org/aasm/aasm) [![Code Climate](https://codeclimate.com/github/aasm/aasm.png)](https://codeclimate.com/github/aasm/aasm) [![Coverage Status](https://coveralls.io/repos/aasm/aasm/badge.png?branch=master)](https://coveralls.io/r/aasm/aasm)
 
 This package contains AASM, a library for adding finite state machines to Ruby classes.
 
@@ -307,6 +307,28 @@ Since version *3.0.13* AASM supports ActiveRecord transactions. So whenever a tr
 callback or the state update fails, all changes to any database record are rolled back.
 Mongodb does not support transactions.
 
+If you want to make sure a depending action happens only after the transaction is committed,
+use the `after_commit` callback, like this:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run, :after_commit => :notify_about_running_job do
+      transitions :from => :sleeping, :to => :running
+    end
+  end
+
+  def notify_about_running_job
+    ...
+  end
+end
+```
+
 ### Column name & migration
 
 As a default AASM uses the column `aasm_state` to store the states. You can override
@@ -338,7 +360,7 @@ class AddJobState < ActiveRecord::Migration
 end
 ```
 
-### <a id="inspection">Inspection
+### Inspection
 
 AASM supports a couple of methods to find out which states or events are provided or permissible.
 

data/lib/aasm/persistence/active_record_persistence.rb

@@ -132,9 +132,16 @@ module AASM
         end
 
         def aasm_fire_event(name, options, *args)
-          self.class.transaction(:requires_new => true) do
+          success = self.class.transaction(:requires_new => true) do
             super
           end
+
+          if success
+            new_state = aasm.state_object_for_name(aasm.current_state)
+            new_state.fire_callbacks(:after_commit, self)
+          end
+
+          success
         end
       end # InstanceMethods
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.22"
+  VERSION = "3.0.23"
 end

data/spec/models/validator.rb

@@ -4,13 +4,26 @@ class Validator < ActiveRecord::Base
   include AASM
   aasm :column => :status do
     state :sleeping, :initial => true
-    state :running
+    state :running, :after_commit => :change_name!
+    state :failed, :after_enter => :fail, :after_commit => :change_name!
     event :run do
       transitions :to => :running, :from => :sleeping
     end
     event :sleep do
       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 fail
+    raise StandardError.new('failed on purpose')
+  end
 end

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -202,5 +202,22 @@ describe 'transitions with persistence' do
       transactor.should be_running
       worker.reload.status.should == 'sleeping'
     end
+
+    describe "after_commit callback" do
+      it "should fire :after_commit if transaction was successful" do
+        validator = Validator.create(:name => 'name')
+        validator.should be_sleeping
+        validator.run!
+        validator.should be_running
+        validator.name.should_not == "name"
+      end
+
+      it "should not fire :after_commit if transaction failed" do
+        validator = Validator.create(:name => 'name')
+        lambda { validator.fail! }.should raise_error(StandardError, 'failed on purpose')
+        validator.name.should == "name"
+      end
+
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.22
+  version: 3.0.23
   prerelease: 
 platform: ruby
 authors:
@@ -12,22 +12,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70096173850320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 3.2.12
   type: :development
   prerelease: false
-  version_requirements: *70096173850320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70096173849660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +40,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173849660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70096173849200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +56,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173849200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70096173848780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +72,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173848780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70096173848280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +88,15 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70096173848280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70096173847860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +104,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173847860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70096173847400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +120,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173847400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70096173382180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +136,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173382180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: &70096173381240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +152,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173381240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: &70096173380220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,7 +168,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70096173380220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: AASM is a continuation of the acts as state machine rails plugin, built
   for plain Ruby objects.
 email: scott@elitists.net, ttilley@gmail.com, aasm@mt7.de
@@ -223,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: State machine mixin for Ruby objects