extra-after-commit-callbacks 0.1.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011 Charles Barbier <http://github.com/unixcharles>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+extra-after-commit-callbacks
+============================
+
+Add extra callbacks for ActiveRecord models and observers.
+
+Replacement for ActiveRecord models `after_commit :method_name, :on => :create`.
+
+Getting started
+===============
+
+```
+gem 'extra-after-commit-callbacks'
+```
+
+#### Directly from the an ActiveRecord model:
+
+```ruby
+class Model < ActiveRecord::Base
+  after_commit_on_create :test
+end
+```
+
+#### From an ActiveRecord observer:
+
+```ruby
+class AnotherObserver < ActiveRecord::Observer
+  observe :model
+
+  def after_commit(object)
+    # ...
+  end
+
+  def after_commit_on_create(object)
+    # ...
+  end
+
+  def after_commit_on_save(object)
+    # ...
+  end
+
+  def after_commit_on_update(object)
+    # ...
+  end
+
+  def after_commit_on_destroy(object)
+    # ...
+  end
+end
+```
+
+### How this differ from `after_commit :on => :{create/update/destroy}`
+
+First, you can't use the `:on` option from the observers.
+
+Also, the behaviour of this Gem is different from the `:on` option because it doesn't interfere with other object inside the transaction.
+
+When you `:on` with `after_commit` in Rails, if any of the objects being commited within the transaction fullfill the requirement, the callback will be triggered.
+
+#### i.e.:
+
+With `after_commit :on` option:
+
+```ruby
+class Boat < ActiveRecord::Base
+  after_commit :on => :destroy do
+    puts 'The boat sink...'
+  end
+end
+
+class Plane < ActiveRecord::Base
+  after_commit :on => :destroy do
+    puts 'The plane crash...'
+  end
+end
+
+> boat, plane = Boat.create, Plane.create; ActiveRecord::Base.transaction { boat.save; plane.destroy }
+   (0.3ms)  BEGIN
+   ...
+   (0.2ms)  COMMIT
+'The boat sink...'
+'The plane crash...'
+=> nil
+```
+
+Pull request?
+=============
+Yes.

data/lib/extra-after-commit-callbacks.rb

@@ -0,0 +1,2 @@
+require 'extra-after-commit-callbacks/active_record_extension'
+require 'extra-after-commit-callbacks/railtie' if defined?(Rails)

data/lib/extra-after-commit-callbacks/active_record_extension.rb

@@ -0,0 +1,62 @@
+require 'active_support/concern'
+
+module ExtraAfterCommitCallbacks
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    EXTRA_AFTER_COMMIT_CALLBACK_TYPES = [:commit_on_save, :commit_on_create, :commit_on_update, :commit_on_destroy]
+
+    included do
+      EXTRA_AFTER_COMMIT_CALLBACK_TYPES.each do |callback_type|
+        define_model_callbacks callback_type, :only => :after
+      end
+
+      before_save    :_mark_for_after_commit_on_save!
+      before_create  :_mark_for_after_commit_on_create!
+      before_update  :_mark_for_after_commit_on_update!
+      before_destroy :_mark_for_after_commit_on_destroy!
+
+      after_commit   :_run_extra_after_commit_callbacks!
+      after_rollback :_clear_after_commit_callbacks!
+    end
+
+    private
+
+    def _mark_for_after_commit_on_save!
+      @_trigger_after_commit_on_save_for_successfull_transaction = true
+    end
+
+    def _mark_for_after_commit_on_create!
+      @_trigger_after_commit_on_create_for_successfull_transaction = true
+    end
+
+    def _mark_for_after_commit_on_update!
+      @_trigger_after_commit_on_update_for_successfull_transaction = true
+    end
+
+    def _mark_for_after_commit_on_destroy!
+      @_trigger_after_commit_on_destroy_for_successfull_transaction = true
+    end
+
+    def _run_extra_after_commit_callbacks!
+      notify_observers(:after_commit_on_save)    if @_trigger_after_commit_on_save_for_successfull_transaction
+      notify_observers(:after_commit_on_create)  if @_trigger_after_commit_on_create_for_successfull_transaction
+      notify_observers(:after_commit_on_update)  if @_trigger_after_commit_on_update_for_successfull_transaction
+      notify_observers(:after_commit_on_destroy) if @_trigger_after_commit_on_destroy_for_successfull_transaction
+
+      run_callbacks :commit_on_save,    :only => :after if @_trigger_after_commit_on_save_for_successfull_transaction
+      run_callbacks :commit_on_create,  :only => :after if @_trigger_after_commit_on_create_for_successfull_transaction
+      run_callbacks :commit_on_update,  :only => :after if @_trigger_after_commit_on_update_for_successfull_transaction
+      run_callbacks :commit_on_destroy, :only => :after if @_trigger_after_commit_on_destroy_for_successfull_transaction
+
+      _clear_after_commit_callbacks!
+    end
+
+    def _clear_after_commit_callbacks!
+      @_trigger_after_commit_on_save_for_successfull_transaction    = false
+      @_trigger_after_commit_on_create_for_successfull_transaction  = false
+      @_trigger_after_commit_on_update_for_successfull_transaction  = false
+      @_trigger_after_commit_on_destroy_for_successfull_transaction = false
+    end
+  end
+end

data/lib/extra-after-commit-callbacks/railtie.rb

@@ -0,0 +1,7 @@
+module ExtraAfterCommitCallbacks
+  class Initialization < Rails::Railtie
+    initializer "extra_after_commit_callbacks" do
+      ::ActiveRecord::Base.send(:include, ::ExtraAfterCommitCallbacks::ActiveRecordExtension)
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: extra-after-commit-callbacks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Charles Barbier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-26 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.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email: unixcharles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/extra-after-commit-callbacks/active_record_extension.rb
+- lib/extra-after-commit-callbacks/railtie.rb
+- lib/extra-after-commit-callbacks.rb
+homepage: http://github.com/unixcharles/extra-after-commit-callbacks
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Fine grained after_commit callbacks for ActiveRecord observers
+test_files: []