after_commit 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nick Muerdter
+
+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 OR COPYRIGHT HOLDERS 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.textile

@@ -0,0 +1,51 @@
+h1. after_commit
+
+An ActiveRecord/Rails library to add @before_commit@, @after_commit@, @before_rollback@ and @after_rollback@ callbacks. These callbacks are focused on the transactions, instead of specific model actions. This is beneficial in situations where you are doing asynchronous processing and need committed objects.
+
+h2. Installation
+
+<pre><code>gem install after_commit --source http://gemcutter.org</code></pre>
+
+h2. Usage
+
+The following callbacks are provided:
+
+* before_commit
+* before_commit_on_create
+* before_commit_on_update
+* before_commit_on_destroy
+* after_commit
+* after_commit_on_create
+* after_commit_on_update
+* after_commit_on_destroy
+* before_rollback
+* after_rollback
+
+You can use these just like you would any other callback:
+
+<pre><code>class Article < ActiveRecord::Base
+  after_commit :method_to_call_after_commit
+  
+  # ...
+  
+  private
+  
+  def method_to_call_after_commit
+    # Do something knowing that the transaction is committed.
+  end
+end</code></pre>
+
+h2. Credits
+
+This code first appeared in a blog post "by Eli Miller":http://elimiller.blogspot.com/2007/06/proper-cache-expiry-with-aftercommit.html, and was then included in "Thinking Sphinx":http://ts.freelancing-gods.com by "Pat Allan":http://freelancing-gods.com, with modifications from Joost Hietbrink. The code was then "put on GitHub as a plugin":http://github.com/GUI/after_commit by Nick Muerdter, and many people forked and added their own contributions.
+
+This version (maintained by Pat Allan) includes the following patches:
+
+* Callbacks for specific types of actions (create, update, destroy) ("DeLynn Berry":http://delynnberry.com/)
+* Fixes to extra callbacks ("Xavier Shay":http://rhnh.net/)
+* Gemspec and extended tests ("David Yip":http://github.com/yipdw)
+* Thread-safety ("Dmitry Galinsky":http://dima-exe.ru/)
+* after_rollback callback ("Justin Balthrop":http://github.com/ninjudd)
+* Test environment fix ("Pivotal Labs":http://pivotalblabs.com/)
+* Scoping callbacks to specific connections ("Mat Brown":http://outofti.me/)
+* before_* callbacks ("Trotter Cashion":http://trottercashion.com/)

data/lib/after_commit.rb

@@ -0,0 +1,65 @@
+module AfterCommit
+  def self.record(connection, record)
+    Thread.current[:committed_records] ||= {}
+    Thread.current[:committed_records][connection.object_id] ||= []
+    Thread.current[:committed_records][connection.object_id] << record
+  end
+
+  def self.record_created(connection, record)
+    Thread.current[:committed_records_on_create] ||= {}
+    Thread.current[:committed_records_on_create][connection.object_id] ||= []
+    Thread.current[:committed_records_on_create][connection.object_id] << record
+  end
+
+  def self.record_updated(connection, record)
+    Thread.current[:committed_records_on_update] ||= {}
+    Thread.current[:committed_records_on_update][connection.object_id] ||= []
+    Thread.current[:committed_records_on_update][connection.object_id] << record
+  end
+
+  def self.record_destroyed(connection, record)
+    Thread.current[:committed_records_on_destroy] ||= {}
+    Thread.current[:committed_records_on_destroy][connection.object_id] ||= []
+    Thread.current[:committed_records_on_destroy][connection.object_id] << record
+  end
+
+  def self.created_records(connection)
+    Thread.current[:committed_records_on_create] ||= {}
+    Thread.current[:committed_records_on_create][connection.object_id] ||= []
+  end
+
+  def self.updated_records(connection)
+    Thread.current[:committed_records_on_update] ||= {}
+    Thread.current[:committed_records_on_update][connection.object_id] ||= []
+  end
+
+  def self.destroyed_records(connection)
+    Thread.current[:committed_records_on_destroy] ||= {}
+    Thread.current[:committed_records_on_destroy][connection.object_id] ||= []
+  end
+
+  def self.records(connection)
+    Thread.current[:committed_records] ||= {}
+    Thread.current[:committed_records][connection.object_id] ||= []
+  end
+
+  def self.cleanup(connection)
+    Thread.current[:committed_records]            = {}
+    Thread.current[:committed_records_on_create]  = {}
+    Thread.current[:committed_records_on_update]  = {}
+    Thread.current[:committed_records_on_destroy] = {}
+  end
+end
+
+require 'after_commit/active_record'
+require 'after_commit/connection_adapters'
+
+ActiveRecord::Base.send(:include, AfterCommit::ActiveRecord)
+
+Object.subclasses_of(ActiveRecord::ConnectionAdapters::AbstractAdapter).each do |klass|
+  klass.send(:include, AfterCommit::ConnectionAdapters)
+end
+
+if defined?(JRUBY_VERSION) and defined?(JdbcSpec::MySQL)
+  JdbcSpec::MySQL.send :include, AfterCommit::ConnectionAdapters
+end

data/lib/after_commit/active_record.rb

@@ -0,0 +1,94 @@
+module AfterCommit
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        # The define_callbacks method was added post Rails 2.0.2 - if it
+        # doesn't exist, we define the callback manually
+        if respond_to?(:define_callbacks)
+          define_callbacks  :after_commit,
+                            :after_commit_on_create,
+                            :after_commit_on_update,
+                            :after_commit_on_destroy,
+                            :after_rollback,
+                            :before_commit,
+                            :before_commit_on_create,
+                            :before_commit_on_update,
+                            :before_commit_on_destroy,
+                            :before_rollback
+        else
+          class << self
+            # Handle after_commit callbacks - call all the registered callbacks.
+            def after_commit(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:after_commit, callbacks)
+            end
+            
+            def after_commit_on_create(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:after_commit_on_create, callbacks)
+            end
+            
+            def after_commit_on_update(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:after_commit_on_update, callbacks)
+            end
+            
+            def after_commit_on_destroy(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:after_commit_on_destroy, callbacks)
+            end
+
+            def after_rollback(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:after_commit, callbacks)
+            end
+
+            def before_commit(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:before_commit, callbacks)
+            end
+            
+            def before_commit_on_create(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:before_commit_on_create, callbacks)
+            end
+            
+            def before_commit_on_update(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:before_commit_on_update, callbacks)
+            end
+            
+            def before_commit_on_destroy(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:before_commit_on_destroy, callbacks)
+            end
+
+            def before_rollback(*callbacks, &block)
+              callbacks << block if block_given?
+              write_inheritable_array(:before_commit, callbacks)
+            end
+          end
+        end
+
+        after_create  :add_committed_record_on_create
+        after_update  :add_committed_record_on_update
+        after_destroy :add_committed_record_on_destroy
+        
+        def add_committed_record_on_create
+          AfterCommit.record(self.class.connection, self)
+          AfterCommit.record_created(self.class.connection, self)
+        end
+        
+        def add_committed_record_on_update
+          AfterCommit.record(self.class.connection, self)
+          AfterCommit.record_updated(self.class.connection, self)
+        end
+        
+        def add_committed_record_on_destroy
+          AfterCommit.record(self.class.connection, self)
+          AfterCommit.record_destroyed(self.class.connection, self)
+        end
+      end
+    end
+  end
+end

data/lib/after_commit/connection_adapters.rb

@@ -0,0 +1,140 @@
+module AfterCommit
+  module ConnectionAdapters
+    def self.included(base)
+      base.class_eval do
+        # The commit_db_transaction method gets called when the outermost
+        # transaction finishes and everything inside commits. We want to
+        # override it so that after this happens, any records that were saved
+        # or destroyed within this transaction now get their after_commit
+        # callback fired.
+        def commit_db_transaction_with_callback          
+          begin
+            trigger_before_commit_callbacks
+            trigger_before_commit_on_create_callbacks
+            trigger_before_commit_on_update_callbacks
+            trigger_before_commit_on_destroy_callbacks
+            
+            commit_db_transaction_without_callback
+            
+            trigger_after_commit_callbacks
+            trigger_after_commit_on_create_callbacks
+            trigger_after_commit_on_update_callbacks
+            trigger_after_commit_on_destroy_callbacks
+          ensure
+            AfterCommit.cleanup(self)
+          end
+        end 
+        alias_method_chain :commit_db_transaction, :callback
+
+        # In the event the transaction fails and rolls back, nothing inside
+        # should recieve the after_commit callback, but do fire the after_rollback
+        # callback for each record that failed to be committed.
+        def rollback_db_transaction_with_callback
+          begin
+            trigger_before_rollback_callbacks
+            rollback_db_transaction_without_callback
+            trigger_after_rollback_callbacks
+          ensure
+            AfterCommit.cleanup(self)
+          end
+        end
+        alias_method_chain :rollback_db_transaction, :callback
+        
+        protected
+        
+        def trigger_before_commit_callbacks
+          AfterCommit.records(self).each do |record|
+            record.send :callback, :before_commit
+          end 
+        end
+
+        def trigger_before_commit_on_create_callbacks
+          AfterCommit.created_records(self).each do |record|
+            record.send :callback, :before_commit_on_create
+          end 
+        end
+      
+        def trigger_before_commit_on_update_callbacks
+          AfterCommit.updated_records(self).each do |record|
+            record.send :callback, :before_commit_on_update
+          end 
+        end
+      
+        def trigger_before_commit_on_destroy_callbacks
+          AfterCommit.destroyed_records(self).each do |record|
+            record.send :callback, :before_commit_on_destroy
+          end 
+        end
+
+        def trigger_before_rollback_callbacks
+          AfterCommit.records(self).each do |record|
+            begin
+              record.send :callback, :before_rollback
+            rescue
+              #
+            end
+          end 
+        end
+
+        def trigger_after_commit_callbacks
+          # Trigger the after_commit callback for each of the committed
+          # records.
+          AfterCommit.records(self).each do |record|
+            begin
+              record.send :callback, :after_commit
+            rescue
+              #
+            end
+          end
+        end
+      
+        def trigger_after_commit_on_create_callbacks
+          # Trigger the after_commit_on_create callback for each of the committed
+          # records.
+          AfterCommit.created_records(self).each do |record|
+            begin
+              record.send :callback, :after_commit_on_create
+            rescue
+              #
+            end
+          end
+        end
+      
+        def trigger_after_commit_on_update_callbacks
+          # Trigger the after_commit_on_update callback for each of the committed
+          # records.
+          AfterCommit.updated_records(self).each do |record|
+            begin
+              record.send :callback, :after_commit_on_update
+            rescue
+              #
+            end
+          end
+        end
+      
+        def trigger_after_commit_on_destroy_callbacks
+          # Trigger the after_commit_on_destroy callback for each of the committed
+          # records.
+          AfterCommit.destroyed_records(self).each do |record|
+            begin
+              record.send :callback, :after_commit_on_destroy
+            rescue
+              #
+            end
+          end
+        end
+
+        def trigger_after_rollback_callbacks
+          # Trigger the after_rollback callback for each of the committed
+          # records.
+          AfterCommit.records(self).each do |record|
+            begin
+              record.send :callback, :after_rollback
+            rescue
+            end
+          end 
+        end
+      end 
+    end 
+  end
+end

data/lib/after_commit/test_bypass.rb

@@ -0,0 +1,31 @@
+# Fix problems caused because tests all run in a single transaction.
+
+# The single transaction means that after_commit callback never happens in tests.  Each of these method definitions
+# overwrites the method in the after_commit plugin that stores the callback for after the commit.  In each case here
+# we simply call the callback rather than waiting for a commit that will never come.
+
+module AfterCommit::TestBypass
+  def self.included(klass)
+    klass.class_eval do
+      [:add_committed_record, :add_committed_record_on_create, :add_committed_record_on_update, :add_committed_record_on_destroy].each do |method|
+        remove_method(method)
+      end
+    end
+  end
+
+  def add_committed_record
+    after_commit_callback
+  end
+
+  def add_committed_record_on_create
+    after_commit_on_create_callback
+  end
+
+  def add_committed_record_on_update
+    after_commit_on_update_callback
+  end
+
+  def add_committed_record_on_destroy
+    after_commit_on_destroy_callback
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+require 'after_commit'
+
+ActiveRecord::Base.class_eval do 
+  include AfterCommit::ActiveRecord
+  include AfterCommit::TestBypass if RAILS_ENV == 'test'
+end

data/test/after_commit_test.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class MockRecord < ActiveRecord::Base
+  attr_accessor :before_commit_on_create_called
+  attr_accessor :before_commit_on_update_called
+  attr_accessor :before_commit_on_destroy_called
+  attr_accessor :after_commit_on_create_called
+  attr_accessor :after_commit_on_update_called
+  attr_accessor :after_commit_on_destroy_called
+
+  before_commit_on_create :do_before_create
+  def do_before_create
+    self.before_commit_on_create_called = true
+  end
+
+  before_commit_on_update :do_before_update
+  def do_before_update
+    self.before_commit_on_update_called = true
+  end
+
+  before_commit_on_create :do_before_destroy
+  def do_before_destroy
+    self.before_commit_on_destroy_called = true
+  end
+
+  after_commit_on_create :do_after_create
+  def do_after_create
+    self.after_commit_on_create_called = true
+  end
+
+  after_commit_on_update :do_after_update
+  def do_after_update
+    self.after_commit_on_update_called = true
+  end
+
+  after_commit_on_create :do_after_destroy
+  def do_after_destroy
+    self.after_commit_on_destroy_called = true
+  end
+end
+
+class UnsavableRecord < ActiveRecord::Base
+  attr_accessor :after_commit_called
+
+  set_table_name 'mock_records'
+
+  protected
+
+  def after_initialize
+    self.after_commit_called = false
+  end
+
+  def after_save
+    raise
+  end
+
+  after_commit :after_commit
+
+  def after_commit
+    self.after_commit_called = true
+  end
+end
+
+class AfterCommitTest < Test::Unit::TestCase
+  def test_before_commit_on_create_is_called
+    assert_equal true, MockRecord.create!.before_commit_on_create_called
+  end
+
+  def test_before_commit_on_update_is_called
+    record = MockRecord.create!
+    record.save
+    assert_equal true, record.before_commit_on_update_called
+  end
+
+  def test_before_commit_on_destroy_is_called
+    assert_equal true, MockRecord.create!.destroy.before_commit_on_destroy_called
+  end
+
+  def test_after_commit_on_create_is_called
+    assert_equal true, MockRecord.create!.after_commit_on_create_called
+  end
+
+  def test_after_commit_on_update_is_called
+    record = MockRecord.create!
+    record.save
+    assert_equal true, record.after_commit_on_update_called
+  end
+
+  def test_after_commit_on_destroy_is_called
+    assert_equal true, MockRecord.create!.destroy.after_commit_on_destroy_called
+  end
+
+  def test_after_commit_does_not_trigger_when_transaction_rolls_back
+    record = UnsavableRecord.new
+    begin; record.save; rescue; end
+
+    assert_equal false, record.after_commit_called
+  end
+end

data/test/observer_test.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ObservableMockRecord < ActiveRecord::Base
+  set_table_name 'mock_records'
+
+  attr_accessor :after_commit_called
+  attr_accessor :after_commit_on_create_called
+  attr_accessor :after_commit_on_update_called
+  attr_accessor :after_commit_on_destroy_called
+end
+
+class ObservableMockRecordObserver < ActiveRecord::Observer
+  def after_commit(model)
+    model.after_commit_called = true
+  end
+
+  def after_commit_on_create(model)
+    model.after_commit_on_create_called = true
+  end
+
+  def after_commit_on_update(model)
+    model.after_commit_on_update_called = true
+  end
+
+  def after_commit_on_destroy(model)
+    model.after_commit_on_destroy_called = true
+  end
+end
+
+class ObserverTest < Test::Unit::TestCase
+  def setup
+    ObservableMockRecord.add_observer ObservableMockRecordObserver.instance
+  end
+
+  def test_after_commit_is_called
+    record = ObservableMockRecord.create!
+
+    assert record.after_commit_called
+  end
+
+  def test_after_commit_on_create_is_called
+    record = ObservableMockRecord.create!
+
+    assert record.after_commit_on_create_called
+  end
+
+  def test_after_commit_on_update_is_called
+    record = ObservableMockRecord.create!
+    record.save
+
+    assert record.after_commit_on_update_called
+  end
+
+  def test_after_commit_on_destroy_is_called
+    record = ObservableMockRecord.create!.destroy
+
+    assert record.after_commit_on_destroy_called
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'rubygems'
+require 'activerecord'
+
+begin
+  require 'sqlite3'
+rescue LoadError
+  gem 'sqlite3-ruby'
+  retry
+end
+
+ActiveRecord::Base.establish_connection({"adapter" => "sqlite3", "database" => 'test.sqlite3'})
+begin
+  ActiveRecord::Base.connection.execute("drop table mock_records");
+rescue
+end
+ActiveRecord::Base.connection.execute("create table mock_records(id int)");
+
+require 'after_commit'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: after_commit
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Nick Muerdter
+- David Yip
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-10 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "\n    A Ruby on Rails plugin to add an after_commit callback. This can be used to trigger methods only after the entire transaction is complete.\n  "
+email: pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- lib/after_commit.rb
+- lib/after_commit/active_record.rb
+- lib/after_commit/connection_adapters.rb
+- lib/after_commit/test_bypass.rb
+- rails/init.rb
+- README.textile
+has_rdoc: true
+homepage: http://github.com/freelancing-god/after_commit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: after_commit callback for ActiveRecord
+test_files: 
+- test/after_commit_test.rb
+- test/observer_test.rb
+- test/test_helper.rb