aasm 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5029171b777f00050a1716352f38a6d8336f51b3
-  data.tar.gz: d6b83b034f6c930f136307697c9c54d8d20a3fcf
+  metadata.gz: 83a1f3168fccb10e8b1514ced2d81ec931c5c53a
+  data.tar.gz: 216b3cdd8404f5b2cd963c99a975946848a06e69
 SHA512:
-  metadata.gz: 47341842399bd8f3e6428602c7d13aed2c19c54f41ae63ecc491809dd8c1617b1374b1df300ebbed1598e2d8f1751540b1e1d93f7683eed24e8ab315877699b5
-  data.tar.gz: 768b6d0acb5ede97db9f890b804d5402585477886653a989f7ddb2ca304f4291af15668560c073252654dd52bb424eea193891a3e351abd0e3f8a846b8d27367
+  metadata.gz: ea1641220521468b48b11ce9e8fb868a85d1e34d44ddc8256cb2a26ccc055f2cddcf3b557358a651239d2d6cc5d3bedf6f53e9baaf9122b6329c5d3cdd2ed25e
+  data.tar.gz: 2f4e51a87d973d04a16cd64692d0fbcf48df87ab7ee8d412411ca7cb742005b68f7a7ee2ae3d953b0ab01bd8f7956ffd98dd95ba6eda0e3e9b7a6b3533eaa0ea

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
  * deprecated old aasm_* class methods (old-style DSL), in preparation for AASM v4.0.0
 
+## 3.3.2
+
+ * bugfix: avoid conflicts with `failed` and `fired` event names (see [issue #157](https://github.com/aasm/aasm/issues/157)), thanks to [@MichaelXavier](https://github.com/MichaelXavier)
+ * bugfix: not using transactions unless saving to the database (see [issue #162](https://github.com/aasm/aasm/issues/162) and [issue #164](https://github.com/aasm/aasm/issues/164)), thanks to [@roberthoner](https://github.com/roberthoner)
+ * bugfix: `after_commit` should only run if saving to the database (see [issue #151](https://github.com/aasm/aasm/issues/151)), thanks to [@ivantsepp](https://github.com/ivantsepp)
+
 ## 3.3.1
 
  * bugfix: permissible events will respect given `guards` (see [issue #150](https://github.com/aasm/aasm/issues/150))

data/README.md

@@ -147,7 +147,9 @@ Also, you can pass parameters to events:
   job.run(:running, :defragmentation)
 ```
 
-In this case the `set_process` would be called with `:defagmentation` argument.
+In this case the `set_process` would be called with `:defragmentation` argument.
+
+Note that when passing arguments to a state transition, the first argument must be the desired end state. In the above example, we wish to transition to `:running` state and run the callback with `:defragmentation` argument. You can also pass in `nil` as the desired end state, and AASM will try to transition to the first end state defined for that event.
 
 In case of an error during the event processing the error is rescued and passed to `:error`
 callback, which can handle it or re-raise it for further propagation.
@@ -212,7 +214,7 @@ You can even provide a number of guards, which all have to succeed to proceed
     end
 ```
 
-If you want to provide guards for all transitions withing an event, you can use event guards
+If you want to provide guards for all transitions within an event, you can use event guards
 
 ```ruby
     event :sleep, :guards => [:walked_the_dog?] do

data/lib/aasm/aasm.rb

@@ -155,16 +155,16 @@ private
       event.fire_callbacks(:before, self)
 
       if new_state_name = event.fire(self, *args)
-        fired(event, old_state, new_state_name, options, &block)
+        aasm_fired(event, old_state, new_state_name, options, &block)
       else
-        failed(event_name, old_state)
+        aasm_failed(event_name, old_state)
       end
     rescue StandardError => e
       event.fire_callbacks(:error, self, e) || raise(e)
     end
   end
 
-  def fired(event, old_state, new_state_name, options)
+  def aasm_fired(event, old_state, new_state_name, options)
     persist = options[:persist]
 
     new_state = aasm.state_object_for_name(new_state_name)
@@ -200,7 +200,7 @@ private
     persist_successful
   end
 
-  def failed(event_name, old_state)
+  def aasm_failed(event_name, old_state)
     if self.respond_to?(:aasm_event_failed)
       self.aasm_event_failed(event_name, old_state.name)
     end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -171,11 +171,9 @@ module AASM
         end
 
         def aasm_fire_event(name, options, *args, &block)
-          success = self.class.transaction(:requires_new => requires_new?) do
-            super
-          end
+          success = options[:persist] ? self.class.transaction(:requires_new => requires_new?) { super } : super
 
-          if success
+          if success && options[:persist]
             new_state = aasm.state_object_for_name(aasm.current_state)
             new_state.fire_callbacks(:after_commit, self)
           end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -84,7 +84,7 @@ module AASM
         # NOTE: intended to be called from an event
         def aasm_write_state state
           aasm_column = self.class.aasm_column
-          update_ony({aasm_column => state.to_s}, aasm_column)
+          update_only({aasm_column => state.to_s}, aasm_column)
         end
 
         # Writes <tt>state</tt> to the state column, but does not persist it to the database

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.3.1"
+  VERSION = "3.3.2"
 end

data/spec/unit/event_naming_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+class SimpleStateMachine
+  include AASM
+
+  aasm do
+    state :init, :initial => true
+    state :failed
+
+    event :failed do
+      transitions :from => :init, :to => :failed
+    end
+  end
+end
+
+describe "event naming" do
+  let(:state_machine) { SimpleStateMachine.new }
+
+  it "allows an event of failed without blowing the stack" do
+    state_machine.failed
+
+    expect { state_machine.failed }.to raise_error(AASM::InvalidTransition)
+  end
+end

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -438,6 +438,31 @@ describe 'transitions with persistence' do
         expect(validator.name).to eq("name")
       end
 
+      it "should not fire if not saving" do
+        validator = Validator.create(:name => 'name')
+        expect(validator).to be_sleeping
+        validator.run
+        expect(validator).to be_running
+        expect(validator.name).to eq("name")
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Scott Barron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -166,6 +166,7 @@ files:
 - spec/unit/api_spec.rb
 - spec/unit/callbacks_spec.rb
 - spec/unit/complex_example_spec.rb
+- spec/unit/event_naming_spec.rb
 - spec/unit/event_spec.rb
 - spec/unit/guard_spec.rb
 - spec/unit/initial_state_spec.rb
@@ -237,6 +238,7 @@ test_files:
 - spec/unit/api_spec.rb
 - spec/unit/callbacks_spec.rb
 - spec/unit/complex_example_spec.rb
+- spec/unit/event_naming_spec.rb
 - spec/unit/event_spec.rb
 - spec/unit/guard_spec.rb
 - spec/unit/initial_state_spec.rb