backgrounded 2.0.0.pre2 → 2.0.0.rc1

data/README.rdoc

@@ -8,8 +8,9 @@ Backgrounded provides a thin wrapper around any background processing framework
 * clean and concise API which removes any dependency on external "worker" jobs and allows you to execute any model method in the background
 * integrates with any background processing framework (DelayedJob, Resque, JobFu, Workling, etc)
 * background methods can be actually unit tested by using an 'in process' runner
+* custom callbacks to execute ActiveRecord callbacks in the background after being committed to the database
 
-= Usage
+= General Usage
 
   class User
     def do_stuff
@@ -25,6 +26,20 @@ Backgrounded provides a thin wrapper around any background processing framework
   # execute class method in background
   User.backgrounded.do_something_else
 
+= after_commit_backgrounded Callback
+
+Automatically execute a callback in the background after a model has been saved to the database.  All of the standard after_commit options are 
+available as well as an optional :backgrounded option which will be passed to the Backgrounded::Handler.
+
+  class User < ActiveRecord::Base
+    # execute :do_something in the background after committed
+    after_commit_backgrounded :do_something
+
+    # execute :do_something_else in the background after committed
+    # passing custom options to the backgrounded handler
+    after_commit_backgrounded :do_something_else, :backgrounded => {:priority => :high}
+  end
+
 = Installation
 
 Bundler Gemfile configuration

data/lib/backgrounded.rb

@@ -1,7 +1,6 @@
 require 'active_support/all'
 
 require File.join(File.dirname(__FILE__), 'backgrounded', 'handler', 'inprocess_handler')
-require File.join(File.dirname(__FILE__), 'backgrounded', 'proxy')
 require File.join(File.dirname(__FILE__), 'backgrounded', 'concern')
 require File.join(File.dirname(__FILE__), 'backgrounded', 'active_record_extension')
 

data/lib/backgrounded/concern.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'proxy')
+
 module Backgrounded
   module Concern
     extend ActiveSupport::Concern
@@ -5,13 +7,15 @@ module Backgrounded
     module ClassMethods
       # @see Backgrounded::Concern#backgrounded
       def backgrounded(options={})
-        Backgrounded::Proxy.new self, options
+        Backgrounded.handler.options = options
+        Backgrounded::Proxy.new self
       end
     end
 
     # @param options (optional) options to pass into the backgrounded handler
     def backgrounded(options={})
-      Backgrounded::Proxy.new self, options
+      Backgrounded.handler.options = options
+      Backgrounded::Proxy.new self
     end
   end
 end

data/lib/backgrounded/handler/abstract_handler.rb

@@ -0,0 +1,11 @@
+module Backgrounded
+  module Handler
+    class AbstractHandler
+      attr_accessor :options
+
+      def options
+        self.options || {}
+      end
+    end
+  end
+end

data/lib/backgrounded/handler/inprocess_handler.rb

@@ -1,8 +1,10 @@
+require 'backgrounded/handler/abstract_handler'
+
 module Backgrounded
   module Handler
     #simple handler to process synchronously and not actually in the background
     #useful for testing
-    class InprocessHandler
+    class InprocessHandler < AbstractHandler
       def request(object, method, args, options={})
         object.send method, *args
       end

data/lib/backgrounded/handler/no_op_handler.rb

@@ -1,9 +1,11 @@
+require 'backgrounded/handler/abstract_handler'
+
 module Backgrounded
   module Handler
     # throw requests out the window
     # useful for test environment to avoid any background work
-    class NoOpHandler
-      def request(object, method, args, options={})
+    class NoOpHandler < AbstractHandler
+      def request(object, method, args)
         # do nothing
       end
     end

data/lib/backgrounded/proxy.rb

@@ -1,13 +1,12 @@
 module Backgrounded
   class Proxy
-    def initialize(delegate, options={})
+    def initialize(delegate)
       @delegate = delegate
-      @options = options
     end
 
     def method_missing(method_name, *args)
       Backgrounded.logger.debug("Requesting #{Backgrounded.handler} backgrounded method: #{method_name} for instance #{@delegate}")
-      Backgrounded.handler.request(@delegate, method_name, args, @options)
+      Backgrounded.handler.request(@delegate, method_name, args)
       nil
     end
   end

data/lib/backgrounded/version.rb

@@ -1,3 +1,3 @@
 module Backgrounded
-  VERSION = "2.0.0.pre2"
+  VERSION = "2.0.0.rc1"
 end

data/test/active_record_extension_test.rb

@@ -27,11 +27,11 @@ class ActiveRecordExtensionTest < Test::Unit::TestCase
     end
     context 'when callback has :backgrounded options' do
       setup do
-        Backgrounded.handler.expects(:request).with(anything, anything, anything, {:priority => :high})
+        Backgrounded.handler.expects(:options=).with(:priority => :high)
         @user = User.new
         @user.save
       end
-      should 'pass options onto the Backgrounded::Handler#request method' do end # see expectations
+      should 'pass configure Backgrounded.handler.options' do end # see expectations
     end
   end
 end

data/test/backgrounded_test.rb

@@ -35,11 +35,10 @@ class BackgroundedTest < Test::Unit::TestCase
     end
     context 'invoking with options' do
       setup do
+        Backgrounded.handler.expects(:options=).with(:priority => :high)
         @result = User.backgrounded(:priority => :high)
       end
-      should 'initialize proxy with options' do
-        assert_equal({:priority => :high}, @result.instance_variable_get(:@options))
-      end
+      should 'pass options onto Backgrounded.handler' do end # see expectations
     end
   end
 end

data/test/proxy_test.rb

@@ -36,14 +36,5 @@ class ProxyTest < Test::Unit::TestCase
       end
       should "execute method on delegate" do end #see expectations
     end
-    context 'context when proxy is configured with options' do
-      setup do
-        Backgrounded.handler.expects(:request).with(anything, anything, anything, {:priority => :high})
-        @delegate = User
-        @proxy = Backgrounded::Proxy.new @delegate, :priority => :high
-        @proxy.do_something_else
-      end
-      should 'pass options onto Backgrounded.handler' do end # see expectations
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backgrounded
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre2
+  version: 2.0.0.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2175352840 !ruby/object:Gem::Requirement
+  requirement: &2174074900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.10
   type: :runtime
   prerelease: false
-  version_requirements: *2175352840
+  version_requirements: *2174074900
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2175352300 !ruby/object:Gem::Requirement
+  requirement: &2174074380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.10
   type: :runtime
   prerelease: false
-  version_requirements: *2175352300
+  version_requirements: *2174074380
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2175351820 !ruby/object:Gem::Requirement
+  requirement: &2174073900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2175351820
+  version_requirements: *2174073900
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2175351340 !ruby/object:Gem::Requirement
+  requirement: &2174073420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2175351340
+  version_requirements: *2174073420
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &2175350860 !ruby/object:Gem::Requirement
+  requirement: &2174072940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *2175350860
+  version_requirements: *2174072940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2175350380 !ruby/object:Gem::Requirement
+  requirement: &2174072460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *2175350380
+  version_requirements: *2174072460
 description: Execute any ActiveRecord Model method in the background
 email:
 - ryan@codecrate.com
@@ -94,6 +94,7 @@ files:
 - lib/backgrounded.rb
 - lib/backgrounded/active_record_extension.rb
 - lib/backgrounded/concern.rb
+- lib/backgrounded/handler/abstract_handler.rb
 - lib/backgrounded/handler/inprocess_handler.rb
 - lib/backgrounded/handler/no_op_handler.rb
 - lib/backgrounded/proxy.rb
@@ -117,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2468636028347354976
+      hash: 1327129114002778537
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: