yipdw-after_commit 0.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+test.sqlite3
+pkg

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

@@ -0,0 +1,16 @@
+after_commit
+===========
+
+A Ruby on Rails plugin to add after_commit callbacks. The callbacks that are provided can be used
+to trigger events that run only after the entire transaction is complete. This is beneficial
+in situations where you are doing asynchronous processing and need committed objects.
+
+The following callbacks are provided:
+  
+   * (1) after_commit
+   * (2) after_commit_on_create
+   * (3) after_commit_on_update
+   * (4) after_commit_on_destroy
+   
+The after_commit callback is run for any object that has just been committed. You can obtain finer
+callback control by using the additional <tt>after_commit_on_*</tt> callbacks.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "after_commit"
+    gem.summary = %Q{after_commit callback for ActiveRecord}
+    gem.description = %Q{
+      A Ruby on Rails plugin to add an after_commit callback. This can be used to trigger things only after the entire transaction is complete.
+    }
+    gem.email = "yipdw@northwestern.edu"
+    gem.homepage = "http://github.com/yipdw/after_commit"
+    gem.authors = ["Nick Muerdter", "David Yip"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the after_commit plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the after_commit plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AfterCommit'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/init.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.send(:include, AfterCommit::ActiveRecord)
+
+Object.subclasses_of(ActiveRecord::ConnectionAdapters::AbstractAdapter).each do |klass|
+  klass.send(:include, AfterCommit::ConnectionAdapters)
+end

data/lib/after_commit/active_record.rb

@@ -0,0 +1,87 @@
+module AfterCommit
+  module ActiveRecord
+    # Based on the code found in Thinking Sphinx:
+    # http://ts.freelancing-gods.com/ which was based on code written by Eli
+    # Miller:
+    # http://elimiller.blogspot.com/2007/06/proper-cache-expiry-with-aftercommit.html
+    # with slight modification from Joost Hietbrink. And now me! Whew.
+    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
+        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
+          end
+        end
+
+        after_save    :add_committed_record
+        after_create  :add_committed_record_on_create
+        after_update  :add_committed_record_on_update
+        after_destroy :add_committed_record_on_destroy
+
+        # We need to keep track of records that have been saved or destroyed
+        # within this transaction.
+        def add_committed_record
+          AfterCommit.committed_records << self
+        end
+        
+        def add_committed_record_on_create
+          AfterCommit.committed_records_on_create << self
+        end
+        
+        def add_committed_record_on_update
+          AfterCommit.committed_records_on_update << self
+        end
+        
+        def add_committed_record_on_destroy
+          AfterCommit.committed_records << self
+          AfterCommit.committed_records_on_destroy << self
+        end
+
+        # Wraps a call to the private callback method so that the the
+        # after_commit callback can be made from the ConnectionAdapters when
+        # the commit for the transaction has finally succeeded. 
+        def after_commit_callback
+          callback(:after_commit)
+        end
+        
+        def after_commit_on_create_callback
+          callback(:after_commit_on_create)
+        end
+        
+        def after_commit_on_update_callback
+          callback(:after_commit_on_update)
+        end
+        
+        def after_commit_on_destroy_callback
+          callback(:after_commit_on_destroy)
+        end
+      end
+    end
+  end
+end

data/lib/after_commit/connection_adapters.rb

@@ -0,0 +1,103 @@
+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          
+          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
+        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.
+        def rollback_db_transaction_with_callback
+          rollback_db_transaction_without_callback
+
+          AfterCommit.committed_records = []
+          AfterCommit.committed_records_on_create = []
+          AfterCommit.committed_records_on_update = []
+          AfterCommit.committed_records_on_destroy = []
+        end
+        alias_method_chain :rollback_db_transaction, :callback
+        
+        protected        
+          def trigger_after_commit_callbacks
+            # Trigger the after_commit callback for each of the committed
+            # records.
+            if AfterCommit.committed_records.any?
+              AfterCommit.committed_records.each do |record|
+                begin
+                  record.after_commit_callback
+                rescue
+                end
+              end 
+            end 
+
+            # Make sure we clear out our list of committed records now that we've
+            # triggered the callbacks for each one. 
+            AfterCommit.committed_records = []
+          end
+        
+          def trigger_after_commit_on_create_callbacks
+            # Trigger the after_commit_on_create callback for each of the committed
+            # records.
+            if AfterCommit.committed_records_on_create.any?
+              AfterCommit.committed_records_on_create.each do |record|
+                begin
+                  record.after_commit_on_create_callback
+                rescue
+                end
+              end 
+            end 
+
+            # Make sure we clear out our list of committed records now that we've
+            # triggered the callbacks for each one. 
+            AfterCommit.committed_records_on_create = []
+          end
+        
+          def trigger_after_commit_on_update_callbacks
+            # Trigger the after_commit_on_update callback for each of the committed
+            # records.
+            if AfterCommit.committed_records_on_update.any?
+              AfterCommit.committed_records_on_update.each do |record|
+                begin
+                  record.after_commit_on_update_callback
+                rescue
+                end
+              end 
+            end 
+
+            # Make sure we clear out our list of committed records now that we've
+            # triggered the callbacks for each one. 
+            AfterCommit.committed_records_on_update = []
+          end
+        
+          def trigger_after_commit_on_destroy_callbacks
+            # Trigger the after_commit_on_destroy callback for each of the committed
+            # records.
+            if AfterCommit.committed_records_on_destroy.any?
+              AfterCommit.committed_records_on_destroy.each do |record|
+                begin
+                  record.after_commit_on_destroy_callback
+                rescue
+                end
+              end 
+            end 
+
+            # Make sure we clear out our list of committed records now that we've
+            # triggered the callbacks for each one. 
+            AfterCommit.committed_records_on_destroy = []
+          end
+        #end protected
+      end 
+    end 
+  end
+end

data/lib/after_commit.rb

@@ -0,0 +1,33 @@
+module AfterCommit
+  def self.committed_records
+    @@committed_records ||= []
+  end
+
+  def self.committed_records=(committed_records)
+    @@committed_records = committed_records
+  end
+  
+  def self.committed_records_on_create
+    @@committed_records_on_create ||= []
+  end
+  
+  def self.committed_records_on_create=(committed_records)
+    @@committed_records_on_create = committed_records
+  end
+  
+  def self.committed_records_on_update
+    @@committed_records_on_update ||= []
+  end
+  
+  def self.committed_records_on_update=(committed_records)
+    @@committed_records_on_update = committed_records
+  end
+  
+  def self.committed_records_on_destroy
+    @@committed_records_on_destroy ||= []
+  end
+  
+  def self.committed_records_on_destroy=(committed_records)
+    @@committed_records_on_destroy = committed_records
+  end
+end

data/test/after_commit_test.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class MockRecord < ActiveRecord::Base
+  attr_accessor :after_commit_on_create_called
+  attr_accessor :after_commit_on_update_called
+  attr_accessor :after_commit_on_destroy_called
+
+  after_commit_on_create :do_create
+  def do_create
+    self.after_commit_on_create_called = true
+  end
+
+  after_commit_on_update :do_update
+  def do_update
+    self.after_commit_on_update_called = true
+  end
+
+  after_commit_on_create :do_destroy
+  def do_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_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,60 @@
+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
+    ObservableMockRecordObserver.instance
+  end
+
+  def test_after_commit_is_called
+    record = ObservableMockRecord.new
+    record.save
+
+    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,23 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'rubygems'
+require 'activerecord'
+require 'after_commit'
+require 'after_commit/active_record'
+require 'after_commit/connection_adapters'
+
+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 File.dirname(__FILE__) + '/../init.rb'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: yipdw-after_commit
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Nick Muerdter
+- David Yip
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Ruby on Rails plugin to add an after_commit callback. This can be used to trigger things only after the entire transaction is complete.
+email: yipdw@northwestern.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/after_commit.rb
+- lib/after_commit/active_record.rb
+- lib/after_commit/connection_adapters.rb
+- test/after_commit_test.rb
+- test/observer_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/yipdw/after_commit
+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.2.0
+signing_key: 
+specification_version: 2
+summary: after_commit callback for ActiveRecord
+test_files: 
+- test/after_commit_test.rb
+- test/observer_test.rb
+- test/test_helper.rb