outside_transaction 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in outside_transaction.gemspec
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# outside_transaction
+
+Makes sure the given block is only executed when not inside a transaction.
+If there is an open transaction it will be executed after the next
+successful commit or not executed at all if there is a rollback or failure.
+
+This is useful when you're notifying another process.
+If the other process starts processing the message before the transaction
+is actually committed, it will not see your uncommitted changes as
+transactions are isolated (usually).
+
+In the example below, if there is a lot of work after saving and
+article, and `ArticleEmailSender` is started too soon, it will not find
+the article you just inserted.
+
+## Example:
+
+```ruby
+class Article
+  after_create :send_emails
+
+  def send_emails
+    outside_transaction do
+      Resque.enqueue(ArticleEmailSender, id) # notifies another process
+    end
+  end
+end
+```
+
+This example is using [Resque](https://github.com/defunkt/resque).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/outside_transaction/version.rb

@@ -0,0 +1,3 @@
+module OutsideTransaction
+  VERSION = "0.0.1"
+end

data/lib/outside_transaction.rb

@@ -0,0 +1,95 @@
+require "outside_transaction/version"
+require 'active_record'
+
+Object.class_eval do
+  def outside_transaction(&block)
+    ActiveRecord::Base.connection.outside_transaction(&block)
+  end
+end
+
+module OutsideTransaction
+  def self.enabled?
+    ! (@@disabled ||= false)
+  end
+
+  def self.disable
+    @@disabled = true
+  end
+
+  module Connection
+    def self.included(base)
+      unless base.method_defined? :commit_db_transaction_without_outside_transaction
+        base.alias_method_chain :commit_db_transaction, :outside_transaction
+      end
+      unless base.method_defined? :transaction_without_outside_transaction
+        base.alias_method_chain :transaction, :outside_transaction
+      end
+    end
+
+    def outside_transaction(&block)
+      if block_given?
+        if open_transactions == 0 || !::OutsideTransaction.enabled?
+          block.call
+        else
+          (@outside_transaction ||= []) << block
+        end
+      end
+    end
+
+    def commit_db_transaction_with_outside_transaction
+      outside_transaction_actions = @outside_transaction
+      @outside_transaction = nil
+      commit_db_transaction_without_outside_transaction
+      if outside_transaction_actions
+        outside_transaction_actions.each do |block|
+          block.call
+        end
+      end
+    end
+
+    def transaction_with_outside_transaction(*args, &block)
+      transaction_without_outside_transaction(*args, &block)
+    ensure
+      @outside_transaction = nil if open_transactions == 0
+    end
+  end
+
+  module ModelMethods
+    module ClassMethods
+      def outside_transaction(&block)
+        connection.outside_transaction(&block)
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def outside_transaction(&block)
+      self.class.connection.outside_transaction(&block)
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, OutsideTransaction::ModelMethods)
+
+# Hack into the adapter class when the connection is made.
+ActiveRecord::Base.instance_eval do
+  class << self
+
+    def establish_connection_with_outside_transaction(*args, &block)
+      establish_connection_without_outside_transaction(*args, &block).tap {|pool|
+
+        # ActiveRecord::ConnectionAdapters::SQLite3Adapter.class_eval do
+        pool.connection.class.class_eval do
+          include OutsideTransaction::Connection
+        end
+
+      }
+    end
+
+    alias_method_chain :establish_connection, :outside_transaction
+
+  end
+end
+

data/outside_transaction.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "outside_transaction/version"
+
+Gem::Specification.new do |s|
+  s.name        = "outside_transaction"
+  s.version     = OutsideTransaction::VERSION
+  s.authors     = ["Levente Bagi"]
+  s.email       = ["levente@picklive.com"]
+  s.homepage    = "https://github.com/Picklive/outside_transaction"
+  s.summary     = %q{Run block outside transaction.}
+  s.description = %q{Run block only if not inside a transaction or when transaction is committed.}
+
+  s.rubyforge_project = "outside_transaction"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 3.0.0"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+end

data/spec/outside_transaction_spec.rb

@@ -0,0 +1,64 @@
+require 'outside_transaction'
+
+ROOT_DIR = File.expand_path('../..')
+FileUtils.makedirs "#{ROOT_DIR}/tmp"
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => "#{ROOT_DIR}/tmp/test_db.sqlite3",
+  :pool => 5,
+  :timeout => 5000
+)
+
+describe OutsideTransaction do
+
+  let(:connection) { ActiveRecord::Base.connection }
+  delegate :transaction, :to => :connection
+
+  before(:each) { @block_ran = 0 }
+  let(:test_block) { Proc.new { @block_ran += 1 } }
+
+  def should_have_been_run
+    @block_ran.should >= 1
+  end
+
+  def should_not_have_been_run
+    @block_ran.should == 0
+  end
+
+  context "when there is no transaction open" do
+    it "runs the block" do
+      outside_transaction(&test_block)
+      should_have_been_run
+    end
+  end
+
+  context "when a transaction is open" do
+    it "runs the block when the transaction is commited" do
+      transaction do
+        outside_transaction(&test_block)
+        should_not_have_been_run
+      end
+      should_have_been_run
+    end
+
+    it "doesn't run the block if the transaction is rolled back" do
+      transaction do
+        outside_transaction(&test_block)
+        raise ActiveRecord::Rollback
+      end
+      should_not_have_been_run
+    end
+
+    it "doesn't run the block if the commit fails" do
+      begin
+        transaction do
+          outside_transaction(&test_block)
+          raise "Something went wrong"
+        end
+      rescue
+      end
+      should_not_have_been_run
+    end
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: outside_transaction
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Levente Bagi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-09 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Run block only if not inside a transaction or when transaction is committed.
+email: 
+- levente@picklive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/outside_transaction.rb
+- lib/outside_transaction/version.rb
+- outside_transaction.gemspec
+- spec/outside_transaction_spec.rb
+has_rdoc: true
+homepage: https://github.com/Picklive/outside_transaction
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: outside_transaction
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Run block outside transaction.
+test_files: 
+- spec/outside_transaction_spec.rb