ar_after_transaction 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'activerecord', :require => 'active_record'
+gem 'activesupport', :require => 'active_support'
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/Rakefile

@@ -0,0 +1,20 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color --backtrace']}
+
+begin
+  require 'jeweler'
+  project_name = 'ar_after_transaction'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Execute irreversible actions only when transactions are not rolled back"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency ['activerecord']
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,58 @@
+Perform stuff (only) after the currently open transactions have finished.
+
+Normally everything gets rolled back when a transaction fails, but you cannot roll back sending an email or adding a job to Resque.
+
+Its great for just-in-time callbacks:
+    class User
+      after_create :do_stuff, :oops
+
+      def do_stuff
+        after_transaction do
+          send_an_email # cannot be rolled back
+        end
+        comments.build(...) # can be rolled back
+      end
+
+      def oops
+        raise "do the rolback!"
+      end
+    end
+
+Or general 'this should be rolled back when in a transaction code like jobs:
+
+    class Resque
+      def revertable_enqueue(*args)
+        ActiveRecord::Base.after_transaction do
+          enqueue(*args)
+       end
+      end
+    end
+    
+There is a after_commit hook in Rails 3, which can replace the first usage:
+
+    class User
+      after_commit :send_an_email :on=>:create
+      ater_create :do_stuff, :oops
+      ...
+    end
+
+after_transaction will behave like it would not exist if you are not in an transaction when calling it.
+
+
+    rails plugin install git://github.com/grosser/ar_after_transaction
+    gem install ar_after_transaction
+
+TODO
+=====
+ - find out if we are in test mode with or without transactions (atm assumes depth of 1 for 'test' env)
+
+
+Author
+======
+Original idea and code comes from: Jeremy Kemper @ https://rails.lighthouseapp.com/projects/8994/tickets/2991-after-transaction-patch 
+
+
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ar_after_transaction.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_after_transaction}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2010-08-28}
+  s.email = %q{grosser.michael@gmail.com}
+  s.files = [
+    "Gemfile",
+     "Rakefile",
+     "Readme.md",
+     "VERSION",
+     "ar_after_transaction.gemspec",
+     "init.rb",
+     "lib/ar_after_transaction.rb",
+     "spec/ar_after_transaction_spec.rb",
+     "spec/setup_database.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/ar_after_transaction}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Execute irreversible actions only when transactions are not rolled back}
+  s.test_files = [
+    "spec/setup_database.rb",
+     "spec/spec_helper.rb",
+     "spec/ar_after_transaction_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'ar_after_transaction'

data/lib/ar_after_transaction.rb

@@ -0,0 +1,62 @@
+require 'active_record'
+
+module ARAfterTransaction
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+
+  def self.included(base)
+    base.extend(ClassMethods)
+
+    class << base
+      alias_method_chain :transaction, :callbacks
+    end
+  end
+
+  module ClassMethods
+    @@after_transaction_hooks = []
+
+    def transaction_with_callbacks(&block)
+      clean = true
+      transaction_without_callbacks(&block)
+    rescue Exception
+      clean = false
+      raise
+    ensure
+      unless transactions_open?
+        execute_after_transaction_callbacks if clean
+        clear_transaction_callbacks
+      end
+    end
+
+    def after_transaction(&block)
+      if transactions_open?
+        @@after_transaction_hooks << block
+      else
+        yield
+      end
+    end
+
+    private
+
+    def transactions_open?
+      connection.open_transactions > normally_open_transactions
+    end
+
+    def normally_open_transactions
+      Rails.env.test? ? 1 : 0
+    end
+
+    def execute_after_transaction_callbacks
+      @@after_transaction_hooks.each { |hook| hook.call }
+    end
+
+    def clear_transaction_callbacks
+      @@after_transaction_hooks.clear
+    end
+  end
+
+  def after_transaction(&block)
+    self.class.after_transaction(&block)
+  end
+end
+
+ActiveRecord::Base.send(:include, ARAfterTransaction)

data/spec/ar_after_transaction_spec.rb

@@ -0,0 +1,88 @@
+require "spec/spec_helper"
+
+class AnExpectedError < Exception
+end
+
+class User
+  cattr_accessor :test_callbacks, :test_stack
+  self.test_stack = []
+  self.test_callbacks = []
+
+  after_create :do_it
+  def do_it
+    self.class.test_callbacks.map{|callback| send(callback)}.last
+  end
+
+  def do_after
+    after_transaction do
+      self.class.test_stack << :after
+    end
+  end
+
+  def do_normal
+    self.class.test_stack << :normal
+  end
+
+  def oops
+    raise AnExpectedError
+  end
+end
+
+describe ARAfterTransaction do
+  before do
+    Rails.env = 'development'
+    User.send(:transactions_open?).should == false
+    User.test_stack.clear
+    User.test_callbacks.clear
+  end
+
+  it "has a VERSION" do
+    ARAfterTransaction::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+
+  it "executes after a transaction" do
+    User.test_callbacks = [:do_after, :do_normal]
+    User.create!
+    User.test_stack.should == [:normal, :after]
+  end
+
+  it "does not execute when transaction was rolled back" do
+    User.test_callbacks = [:do_after, :do_normal, :oops]
+    lambda{
+      User.create!
+    }.should raise_error(AnExpectedError)
+    User.test_stack.should == [:normal]
+  end
+
+  it "executes when no transaction is open" do
+    user = User.new
+    user.do_after
+    user.do_normal
+    User.test_stack.should == [:after, :normal]
+  end
+
+  it "executes when open transactions are normal" do
+    Rails.env = 'test'
+    User.test_callbacks = [:do_after, :do_normal]
+    User.create!
+    User.test_stack.should == [:after, :normal]
+  end
+
+  it "does not execute the same callback twice when successful" do
+    User.test_callbacks = [:do_after, :do_normal]
+    User.create!
+    User.create!
+    User.test_stack.should == [:normal, :after, :normal, :after]
+  end
+
+  it "does not execute the same callback twice when failed" do
+    User.test_callbacks = [:do_after, :do_normal, :oops]
+    lambda{
+      User.create!
+    }.should raise_error(AnExpectedError)
+    lambda{
+      User.create!
+    }.should raise_error(AnExpectedError)
+    User.test_stack.should == [:normal, :normal]
+  end
+end

data/spec/setup_database.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => "mysql", # need something that has transactions...
+  :database => "ar_after_transaction"
+)
+
+ActiveRecord::Base.connection.execute('drop table users')
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+    t.timestamps
+  end
+end
+
+#require 'logger'
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+class User < ActiveRecord::Base
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+$LOAD_PATH << "lib"
+require "init"
+require "spec/setup_database"
+
+class FakeEnv
+  def initialize(env)
+    @env = env
+  end
+
+  def test?
+    @env == 'test'
+  end
+end
+
+module Rails
+  def self.env
+    @@env
+  end
+
+  def self.env=(env)
+    @@env = FakeEnv.new(env)
+  end
+
+  self.env = 'development'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: ar_after_transaction
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Rakefile
+- Readme.md
+- VERSION
+- ar_after_transaction.gemspec
+- init.rb
+- lib/ar_after_transaction.rb
+- spec/ar_after_transaction_spec.rb
+- spec/setup_database.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/ar_after_transaction
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Execute irreversible actions only when transactions are not rolled back
+test_files: 
+- spec/setup_database.rb
+- spec/spec_helper.rb
+- spec/ar_after_transaction_spec.rb