chrismuc-after_commit 0.9.0

data/README

@@ -0,0 +1,40 @@
+after_commit
+============
+
+After_commit enables you to add after_commit methods to ActiveRecord models, which are called once the transaction has been committed to the database.
+Typically one needs this in asynchronous processing where you pass on IDs of new records to another thread or post them to a message queue. Using the stock after_XXX
+callbacks you cannot be sure that the other thread/process is already seeing the new record (at least if the database is ACID compliant).
+
+
+Usage:
+======
+
+class Blog < ActiveRecord::Base
+  include AfterCommit::ActiveRecord
+  
+  def after_commit_on_create
+    # do something
+  end
+
+  def after_commit_on_update
+    # do something
+  end
+
+  def after_commit_on_destroy
+    # do something
+  end
+end
+
+
+You have to include AfterCommit::ActiveRecord to add the new callbacks. They aren't automatically added to ActiveRecord::Base as tracking the committed
+records takes a little overhead and I thought it's better to be able to manually select which models should get that feature.
+  
+You have to explicitely define the methods like in the example above, something like after_commit_on_create :do_what_ever doesn't work.
+
+Credits:
+========
+I've take existing code and basically made it threadsafe (hopefully, so it should be safe when running config.threadsafe!). Sources are:
+
+http://github.com/GUI/after_commit/tree/master
+http://github.com/freelancing-god/thinking-sphinx
+

data/lib/after_commit.rb

@@ -0,0 +1,85 @@
+module AfterCommit  
+  def self.touched_records(type)
+    h = (Thread.current[:after_commit] ||= {})
+    h[type] ||= []
+  end
+  
+  def self.clear
+    Thread.current[:after_commit] = nil
+  end
+
+  def self.trigger
+    begin
+      [:create, :update, :destroy].each do |type|
+        callback_name = "after_commit_on_#{type}"
+        touched_records(type).each do |record|
+          begin
+            record.send(callback_name) if record.respond_to?(callback_name)
+          rescue => e
+            puts e
+          end
+        end
+      end
+    ensure
+      self.clear
+    end
+  end
+  
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        after_create  :add_touched_record_on_create
+        after_update  :add_touched_record_on_update
+        after_destroy :add_touched_record_on_destroy
+
+        def add_touched_record_on_create
+          AfterCommit.touched_records(:create) << self
+        end
+        
+        def add_touched_record_on_update
+          AfterCommit.touched_records(:update) << self
+        end
+        
+        def add_touched_record_on_destroy
+          AfterCommit.touched_records(:destroy) << self
+        end        
+      end
+    end
+  end
+  
+  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
+          commit_db_transaction_without_callback
+          AfterCommit.trigger
+        end
+        alias_method_chain :commit_db_transaction, :callback
+        
+        def rollback_db_transaction_with_callback
+          rollback_db_transaction_without_callback
+          AfterCommit.clear
+        end
+        alias_method_chain :rollback_db_transaction, :callback
+      end
+    end
+  end
+end
+
+unless defined? AFTER_COMMIT_PATCH_APPLIED
+  AFTER_COMMIT_PATCH_APPLIED=true   # in my test setup this was executed twice resulting in an infinite recursion  
+  
+  Object.subclasses_of(ActiveRecord::ConnectionAdapters::AbstractAdapter).each do |klass|
+    puts "Applying after_commit patch to: #{klass}"
+    klass.send(:include, AfterCommit::ConnectionAdapters)
+  end
+
+  if defined?(JRUBY_VERSION) and defined?(JdbcSpec::MySQL)
+    JdbcSpec::MySQL.send :include, AfterCommit::ConnectionAdapters
+  end  
+end

data/test/after_commit_test.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'rubygems'
+require 'activerecord'
+
+ActiveRecord::Base.establish_connection({"adapter" => defined?(JRUBY_VERSION) ? "jdbcsqlite3":"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 File.dirname(__FILE__) + '/../init.rb'
+
+class MockRecord < ActiveRecord::Base
+  include AfterCommit::ActiveRecord
+  attr_accessor :after_commit_on_create_called, :after_commit_on_update_called, :after_commit_on_destroy_called
+
+  def after_commit_on_create
+    self.after_commit_on_create_called = true
+  end
+
+  def after_commit_on_update
+    self.after_commit_on_update_called = true
+  end
+
+  def after_commit_on_destroy
+    self.after_commit_on_destroy_called = true
+  end
+end
+
+class AfterCommitTest < Test::Unit::TestCase
+  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
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: chrismuc-after_commit
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Christian Seiler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Threadsafe after_commit callbacks for ActiveRecord models.
+email: chr.seiler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- test/after_commit_test.rb
+- lib/after_commit.rb
+has_rdoc: false
+homepage: http://github.com/mislav/will_paginate/wikis
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Threadsafe after_commit callbacks for ActiveRecord models
+test_files: 
+- test/after_commit_test.rb