aasm 3.0.23 → 3.0.24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a95f430c49bb639c7f0df66dc4ce2998636ef6a
+  data.tar.gz: 67293708b7b6fbaae038e97d229367d0ca074aa8
+SHA512:
+  metadata.gz: 90707f9d64e5e03e9b58acde6081c9fe5239ff5599ece71a1909abad871dfdb99dfe8d1d63fae89a94d6f5a908754649387cb792f150d09a94f3a3acab2f2714
+  data.tar.gz: 20f34ec847d1fe22c59a7e077c5ccdd54f5ab6483dbab086544c7f7995f8df408a018344248ed9017ce9f8ed23f5d64dfe549855700d68c8797911edae9ceafc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.24
+
+ * added support for event blocks (thanks to [@Intrepidd](https://github.com/Intrepidd))
+
 ## 3.0.23
 
  * added support for `after_commit` callback (transaction support) (thanks to [@tisba](https://github.com/tisba))

data/README.md

@@ -69,6 +69,15 @@ job.may_run?  # => false
 job.run       # => false
 ```
 
+When firing an event, you can pass a block to the method, it will be called only if
+the transition succeeds :
+
+```ruby
+  job.run do
+    job.user.notify_job_ran # Will be called if job.may_run? is true
+  end
+```
+
 ### Callbacks
 
 You can define a number of callbacks for your transitions. These methods will be

data/aasm.gemspec

@@ -13,19 +13,21 @@ Gem::Specification.new do |s|
   s.date        = Time.now
   s.licenses    = ["MIT"]
 
-  s.add_development_dependency 'activerecord', '3.2.12'
-  # s.add_development_dependency 'activerecord', '4.0.0.rc1'
+  s.add_development_dependency 'activerecord', '3.2.15'
+  # s.add_development_dependency 'activerecord', '4.0.1'
 
   s.add_development_dependency 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
-  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'rspec', '~> 2.14'
   s.add_development_dependency 'rr'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'minitest'
   # s.add_development_dependency 'debugger'
   # s.add_development_dependency 'pry'
   s.add_development_dependency 'ruby-debug-completion'
+
+  s.add_development_dependency 'mime-types', '~> 1.25' # needed by coveralls (>= 2.0 needs Ruby >=1.9.2)
   s.add_development_dependency 'coveralls'
 
   s.files         = `git ls-files`.split("\n")

data/lib/aasm/aasm.rb

@@ -141,7 +141,7 @@ module AASM
 
 private
 
-  def aasm_fire_event(event_name, options, *args)
+  def aasm_fire_event(event_name, options, *args, &block)
     event = self.class.aasm_events[event_name]
     begin
       old_state = aasm.state_object_for_name(aasm.current_state)
@@ -151,7 +151,7 @@ private
       event.fire_callbacks(:before, self)
 
       if new_state_name = event.fire(self, *args)
-        fired(event, old_state, new_state_name, options)
+        fired(event, old_state, new_state_name, options, &block)
       else
         failed(event_name, old_state)
       end
@@ -174,9 +174,13 @@ private
     persist_successful = true
     if persist
       persist_successful = aasm.set_current_state_with_persistence(new_state_name)
-      event.fire_callbacks(:success, self) if persist_successful
+      if persist_successful
+        yield if block_given?
+        event.fire_callbacks(:success, self)
+      end
     else
       aasm.current_state = new_state_name
+      yield if block_given?
     end
 
     if persist_successful

data/lib/aasm/base.rb

@@ -57,12 +57,12 @@ module AASM
         aasm.may_fire_event?(name, *args)
       end
 
-      @clazz.send(:define_method, "#{name.to_s}!") do |*args|
-        aasm_fire_event(name, {:persist => true}, *args)
+      @clazz.send(:define_method, "#{name.to_s}!") do |*args, &block|
+        aasm_fire_event(name, {:persist => true}, *args, &block)
       end
 
-      @clazz.send(:define_method, "#{name.to_s}") do |*args|
-        aasm_fire_event(name, {:persist => false}, *args)
+      @clazz.send(:define_method, "#{name.to_s}") do |*args, &block|
+        aasm_fire_event(name, {:persist => false}, *args, &block)
       end
     end
 

data/lib/aasm/persistence/active_record_persistence.rb

@@ -131,7 +131,7 @@ module AASM
           aasm.enter_initial_state if send(self.class.aasm_column).blank?
         end
 
-        def aasm_fire_event(name, options, *args)
+        def aasm_fire_event(name, options, *args, &block)
           success = self.class.transaction(:requires_new => true) do
             super
           end

data/lib/aasm/version.rb

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

data/spec/unit/callbacks_spec.rb

@@ -51,19 +51,19 @@ describe 'event callbacks' do
     it "should run error_callback if an exception is raised and error_callback defined" do
       def @foo.error_callback(e); end
 
-      @foo.stub!(:enter).and_raise(e=StandardError.new)
+      @foo.stub(:enter).and_raise(e=StandardError.new)
       @foo.should_receive(:error_callback).with(e)
 
       @foo.safe_close!
     end
 
     it "should raise NoMethodError if exceptionis raised and error_callback is declared but not defined" do
-      @foo.stub!(:enter).and_raise(StandardError)
+      @foo.stub(:enter).and_raise(StandardError)
       lambda{@foo.safe_close!}.should raise_error(NoMethodError)
     end
 
     it "should propagate an error if no error callback is declared" do
-        @foo.stub!(:enter).and_raise("Cannot enter safe")
+        @foo.stub(:enter).and_raise("Cannot enter safe")
         lambda{@foo.close!}.should raise_error(StandardError, "Cannot enter safe")
     end
   end
@@ -85,7 +85,7 @@ describe 'event callbacks' do
     end
 
     it 'should not call it for failing bang fire' do
-      @foo.aasm.stub!(:set_current_state_with_persistence).and_return(false)
+      @foo.aasm.stub(:set_current_state_with_persistence).and_return(false)
       @foo.should_not_receive(:aasm_event_fired)
       @foo.close!
     end
@@ -108,7 +108,7 @@ describe 'event callbacks' do
     end
 
     it 'should not call it if persist fails for bang fire' do
-      @foo.aasm.stub!(:set_current_state_with_persistence).and_return(false)
+      @foo.aasm.stub(:set_current_state_with_persistence).and_return(false)
       @foo.should_receive(:aasm_event_failed)
       @foo.close!
     end

data/spec/unit/event_spec.rb

@@ -60,8 +60,8 @@ end
 
 describe 'firing an event' do
   it 'should return nil if the transitions are empty' do
-    obj = mock('object')
-    obj.stub!(:aasm_current_state)
+    obj = double('object')
+    obj.stub(:aasm_current_state)
 
     event = AASM::Event.new(:event)
     event.fire(obj).should be_nil
@@ -72,8 +72,8 @@ describe 'firing an event' do
       transitions :to => :closed, :from => [:open, :received]
     end
 
-    obj = mock('object')
-    obj.stub!(:aasm_current_state).and_return(:open)
+    obj = double('object')
+    obj.stub(:aasm_current_state).and_return(:open)
 
     event.fire(obj).should == :closed
   end
@@ -83,8 +83,8 @@ describe 'firing an event' do
       transitions :to => :closed, :from => [:open, :received], :guard => :guard_fn
     end
 
-    obj = mock('object')
-    obj.stub!(:aasm_current_state).and_return(:open)
+    obj = double('object')
+    obj.stub(:aasm_current_state).and_return(:open)
     obj.should_receive(:guard_fn).with('arg1', 'arg2').and_return(true)
 
     event.fire(obj, nil, 'arg1', 'arg2').should == :closed

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -33,13 +33,13 @@ describe "instance methods" do
   end
 
   it "should return the aasm column when not new and the aasm_column is not nil" do
-    gate.stub!(:new_record?).and_return(false)
+    gate.stub(:new_record?).and_return(false)
     gate.aasm_state = "state"
     gate.aasm_current_state.should == :state
   end
 
   it "should allow a nil state" do
-    gate.stub!(:new_record?).and_return(false)
+    gate.stub(:new_record?).and_return(false)
     gate.aasm_state = nil
     gate.aasm_current_state.should be_nil
   end
@@ -50,7 +50,7 @@ describe "instance methods" do
   end
 
   it "should not call aasm_ensure_initial_state on validation before update" do
-    gate.stub!(:new_record?).and_return(false)
+    gate.stub(:new_record?).and_return(false)
     gate.should_not_receive(:aasm_ensure_initial_state)
     gate.valid?
   end

data/spec/unit/state_spec.rb

@@ -38,7 +38,7 @@ describe AASM::State do
   it 'should send a message to the record for an action if the action is present as a symbol' do
     state = new_state(:entering => :foo)
 
-    record = mock('record')
+    record = double('record')
     record.should_receive(:foo)
 
     state.fire_callbacks(:entering, record)
@@ -47,7 +47,7 @@ describe AASM::State do
   it 'should send a message to the record for an action if the action is present as a string' do
     state = new_state(:entering => 'foo')
 
-    record = mock('record')
+    record = double('record')
     record.should_receive(:foo)
 
     state.fire_callbacks(:entering, record)
@@ -56,7 +56,7 @@ describe AASM::State do
   it 'should send a message to the record for each action' do
     state = new_state(:entering => [:a, :b, "c", lambda {|r| r.foobar }])
 
-    record = mock('record')
+    record = double('record')
     record.should_receive(:a)
     record.should_receive(:b)
     record.should_receive(:c)
@@ -68,7 +68,7 @@ describe AASM::State do
   it "should stop calling actions if one of them raises :halt_aasm_chain" do
     state = new_state(:entering => [:a, :b, :c])
 
-    record = mock('record')
+    record = double('record')
     record.should_receive(:a)
     record.should_receive(:b).and_throw(:halt_aasm_chain)
     record.should_not_receive(:c)
@@ -79,7 +79,7 @@ describe AASM::State do
   it 'should call a proc, passing in the record for an action if the action is present' do
     state = new_state(:entering => Proc.new {|r| r.foobar})
 
-    record = mock('record')
+    record = double('record')
     record.should_receive(:foobar)
 
     state.fire_callbacks(:entering, record)

data/spec/unit/transition_spec.rb

@@ -26,6 +26,29 @@ describe 'transitions' do
     silencer.should be_smiling
   end
 
+  it 'should call the block when success' do
+    silencer = Silencer.new
+    success = false
+    lambda {
+      silencer.smile_any! do
+        success = true
+      end
+    }.should change { success }.to(true)
+  end
+
+  it 'should not call the block when failure' do
+    silencer = Silencer.new
+    success = false
+    lambda {
+      silencer.smile! do
+        success = true
+      end
+    }.should_not change { success }.to(true)
+  end
+
+end
+
+describe 'blocks' do
 end
 
 describe AASM::Transition do
@@ -42,9 +65,9 @@ describe AASM::Transition do
     opts = {:from => 'foo', :to => 'bar', :guard => 'g'}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
-    obj.stub!(:from).and_return(opts[:from])
-    obj.stub!(:to).and_return(opts[:to])
+    obj = double('object')
+    obj.stub(:from).and_return(opts[:from])
+    obj.stub(:to).and_return(opts[:to])
 
     st.should == obj
   end
@@ -53,9 +76,9 @@ describe AASM::Transition do
     opts = {:from => 'foo', :to => 'bar', :guard => 'g'}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
-    obj.stub!(:from).and_return('blah')
-    obj.stub!(:to).and_return(opts[:to])
+    obj = double('object')
+    obj.stub(:from).and_return('blah')
+    obj.stub(:to).and_return(opts[:to])
 
     st.should_not == obj
   end
@@ -64,9 +87,9 @@ describe AASM::Transition do
     opts = {:from => 'foo', :to => 'bar', :guard => 'g'}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
-    obj.stub!(:from).and_return(opts[:from])
-    obj.stub!(:to).and_return('blah')
+    obj = double('object')
+    obj.stub(:from).and_return(opts[:from])
+    obj.stub(:to).and_return('blah')
 
     st.should_not == obj
   end
@@ -84,7 +107,7 @@ describe AASM::Transition, '- when performing guard checks' do
     opts = {:from => 'foo', :to => 'bar', :guard => :test}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
+    obj = double('object')
     obj.should_receive(:test)
 
     st.perform(obj)
@@ -94,7 +117,7 @@ describe AASM::Transition, '- when performing guard checks' do
     opts = {:from => 'foo', :to => 'bar', :guard => 'test'}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
+    obj = double('object')
     obj.should_receive(:test)
 
     st.perform(obj)
@@ -104,7 +127,7 @@ describe AASM::Transition, '- when performing guard checks' do
     opts = {:from => 'foo', :to => 'bar', :guard => Proc.new {|o| o.test}}
     st = AASM::Transition.new(opts)
 
-    obj = mock('object')
+    obj = double('object')
     obj.should_receive(:test)
 
     st.perform(obj)
@@ -116,7 +139,7 @@ describe AASM::Transition, '- when executing the transition with a Proc' do
     opts = {:from => 'foo', :to => 'bar', :on_transition => Proc.new {|o| o.test}}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     opts[:on_transition].should_receive(:call).with(any_args)
 
@@ -127,7 +150,7 @@ describe AASM::Transition, '- when executing the transition with a Proc' do
     opts = {:from => 'foo', :to => 'bar', :on_transition => Proc.new {||}}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     opts[:on_transition].should_receive(:call).with(no_args)
 
@@ -140,7 +163,7 @@ describe AASM::Transition, '- when executing the transition with an :on_transtio
     opts = {:from => 'foo', :to => 'bar', :on_transition => 'test'}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     obj.should_receive(:test)
 
@@ -151,7 +174,7 @@ describe AASM::Transition, '- when executing the transition with an :on_transtio
     opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     obj.should_receive(:test)
 
@@ -162,7 +185,7 @@ describe AASM::Transition, '- when executing the transition with an :on_transtio
     opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     obj.class.class_eval do
       define_method(:test) {|*args| 'success'}
@@ -177,7 +200,7 @@ describe AASM::Transition, '- when executing the transition with an :on_transtio
     opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
     st = AASM::Transition.new(opts)
     args = {:arg1 => '1', :arg2 => '2'}
-    obj = mock('object')
+    obj = double('object')
 
     obj.class.class_eval do
       define_method(:test) {|*args| 'success'}

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.23
-  prerelease: 
+  version: 3.0.24
 platform: ruby
 authors:
 - Scott Barron
@@ -12,166 +11,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: 3.2.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: 3.2.15
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   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
@@ -255,27 +248,26 @@ files:
 homepage: https://github.com/aasm/aasm
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: State machine mixin for Ruby objects
 test_files:
 - spec/database.yml