when_committed 0.9.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 PeopleAdmin
+
+MIT License
+
+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.md

@@ -0,0 +1,50 @@
+# WhenCommitted
+
+Provides `#when_commited` to run instance-specific code in an ActiveRecord
+`#after_commit` callback.
+
+This is very useful for things like enqueuing a background job that is triggered
+by a model changing state. Usually, it is not sufficient to enqueue the job in
+an `#after_save` hook, because there is always the chance that the save will be
+rolled back (or that the job gets picked up before the save is committed). You
+could try moving that code to an `after_commit` callback, but then you do not
+have access to the `#changes` to your model (they have already been applied), so
+it may be difficult to make decisions on whether to enqueue the job or not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'when_committed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install when_committed
+
+## Usage
+
+Include the WhenCommitted::ActiveRecord module in your model:
+
+    class Post < ActiveRecord::Base
+      include WhenCommitted::ActiveRecord
+    end
+
+Call `#when_committed` with a block of code that should run when the transaction
+is committed:
+
+    def update_score(new_score)
+      self.score = new_score
+      when_committed { Resque.enqueue(RecalculateAggregateScores, self.id) }
+    end
+
+## Contributing
+
+1. [Fork it](https://github.com/PeopleAdmin/when_committed/fork_select)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. [Create new Pull Request](https://github.com/PeopleAdmin/when_committed/pull/new/master)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/when_committed.rb

@@ -0,0 +1,30 @@
+require 'when_committed/version'
+
+module WhenCommitted
+  module ActiveRecord
+    def self.included(base)
+      base.after_commit :run_when_committed_callbacks
+      base.after_rollback :clear_when_committed_callbacks
+    end
+
+    def when_committed(&block)
+      when_committed_callbacks << block
+    end
+
+    private
+
+    def when_committed_callbacks
+      @when_committed_callbacks ||= []
+    end
+
+    def run_when_committed_callbacks
+      when_committed_callbacks.each {|cb| cb.call}
+      clear_when_committed_callbacks
+    end
+
+    def clear_when_committed_callbacks
+      when_committed_callbacks.clear
+    end
+  end
+end
+

data/lib/when_committed/version.rb

@@ -0,0 +1,3 @@
+module WhenCommitted
+  VERSION = "0.9.0"
+end

data/spec/when_committed_spec.rb

@@ -0,0 +1,105 @@
+require 'active_record'
+require 'when_committed'
+
+describe "WhenCommitted" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection :adapter => :nulldb
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Schema.define do
+      create_table(:widgets) do |t|
+        t.string  :name
+        t.integer :size
+      end
+    end
+  end
+
+  it "provides a #when_committed method" do
+    sample_class = Class.new(ActiveRecord::Base)
+    model = sample_class.new
+    model.should_not respond_to(:when_committed)
+    sample_class.send :include, WhenCommitted::ActiveRecord
+    model.should respond_to(:when_committed)
+  end
+
+  describe "#when_committed" do
+    before do
+      Backgrounder.reset
+    end
+    let(:model) { Widget.new }
+
+    it "runs the provided block after the transaction is committed" do
+      model.action_that_needs_follow_up_after_commit
+      model.save
+      Backgrounder.jobs.should == [:important_work]
+    end
+
+    it "does not run the provided block until the transaction is committed" do
+      Widget.transaction do
+        model.action_that_needs_follow_up_after_commit
+        Backgrounder.jobs.should be_empty
+        model.save
+        Backgrounder.jobs.should be_empty
+      end
+      Backgrounder.jobs.should == [:important_work]
+    end
+
+    it "does not run the provided block if the transaction is rolled back" do
+      begin
+        Widget.transaction do
+          model.action_that_needs_follow_up_after_commit
+          model.save
+          raise Catastrophe
+        end
+      rescue Catastrophe
+      end
+      Backgrounder.jobs.should be_empty
+    end
+
+    it "allows you to register multiple after_commit blocks" do
+      Widget.transaction do
+        model.action_that_needs_follow_up_after_commit
+        model.another_action_with_follow_up
+        model.save
+      end
+      Backgrounder.jobs.should == [:important_work,:more_work]
+    end
+
+    it "does not run a registered block more than once" do
+      Widget.transaction do
+        model.action_that_needs_follow_up_after_commit
+        model.save
+      end
+      Widget.transaction do
+        model.name = "changed"
+        model.save
+      end
+      Backgrounder.should have(1).job
+    end
+  end
+end
+
+class Widget < ActiveRecord::Base
+  include WhenCommitted::ActiveRecord
+  def action_that_needs_follow_up_after_commit
+    when_committed { Backgrounder.enqueue :important_work }
+  end
+  def another_action_with_follow_up
+    when_committed { Backgrounder.enqueue :more_work }
+  end
+end
+
+class Backgrounder
+  def self.enqueue job
+    jobs << job
+  end
+
+  def self.jobs
+    @jobs ||= []
+  end
+
+  def self.reset
+    @jobs = []
+  end
+end
+
+class Catastrophe < StandardError; end

data/when_committed.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'when_committed/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "when_committed"
+  gem.version       = WhenCommitted::VERSION
+  gem.authors       = ["Joshua Flanagan"]
+  gem.email         = ["jflanagan@peopleadmin.com"]
+  gem.description   = %q{Run a piece of code after the current transaction is committed}
+  gem.summary       = %q{Some actions (like enqueuing a background job) should not run until
+the current ActiveRecord transaction has committed. ActiveRecord defines an `#after_commit` callback,
+but it run for every transaction, for every instance of a class. `#when_committed` allows you to
+dynamically define a block of code that should run when the transaction is committed.}
+  gem.homepage      = "https://github.com/PeopleAdmin/when_committed"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "activerecord", ">=3.1"
+  gem.add_development_dependency "activerecord-nulldb-adapter"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: when_committed
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Run a piece of code after the current transaction is committed
+email:
+- jflanagan@peopleadmin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/when_committed.rb
+- lib/when_committed/version.rb
+- spec/when_committed_spec.rb
+- when_committed.gemspec
+homepage: https://github.com/PeopleAdmin/when_committed
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Some actions (like enqueuing a background job) should not run until the current
+  ActiveRecord transaction has committed. ActiveRecord defines an `#after_commit`
+  callback, but it run for every transaction, for every instance of a class. `#when_committed`
+  allows you to dynamically define a block of code that should run when the transaction
+  is committed.
+test_files:
+- spec/when_committed_spec.rb