backgrounded 2.0.0 → 2.1.0

data/.rvmrc

@@ -1,4 +1,4 @@
-rvm use 1.9.3@backgrounded --create
+rvm use @backgrounded --create
 if ! command -v bundle ; then
   gem install bundler
   bundle install --local

data/README.rdoc

@@ -28,7 +28,7 @@ Backgrounded provides a thin wrapper around any background processing framework
 
 = 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 
+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
@@ -48,7 +48,7 @@ Bundler Gemfile configuration
 
 = Configuration
 
-Backgrounded packages handlers for popular frameworks in separate gems.  Just drop in the gem for your particular framework or write your own!
+Backgrounded handlers are available for popular libraries in separate gems.  Just drop in the gem for your particular framework or write your own!
 
 == Resque
 see http://github.com/wireframe/backgrounded-resque
@@ -57,11 +57,16 @@ see http://github.com/wireframe/backgrounded-resque
 see http://github.com/jnstq/job_fu/tree
 
 == Custom Handlers
+Writing a custom handler is as simple as:
 
   # config/initializers/backgrounded.rb
   class MyHandler
-    def request(object, method, *args)
-      #process the call however you want!
+    # @param object is the target object to invoke the method upon
+    # @param method is the requested method to call
+    # @param args is the optional list of arguments to pass to the method
+    # @param options is the optional hash of options passed to the backgrounded call
+    def request(object, method, args, options={})
+      # process the call however you want!
     end
   end
   Backgrounded.handler = MyHandler.new

data/backgrounded.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<mocha>, [">= 0"])
   s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.2"])
   s.add_development_dependency(%q<rake>, [">= 0.9.2.2"])
+  s.add_development_dependency(%q<pry>, [">= 0.9.12"])
+  s.add_development_dependency(%q<test_after_commit>, [">= 0"])
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/backgrounded/active_record_extension.rb

@@ -9,8 +9,9 @@ module Backgrounded
       # @option options [Hash] :backgrounded (optional) options to pass into the backgrounded handler
       # @see after_commit
       def after_commit_backgrounded(method_name, options={})
-        backgrounded_options = options.delete :backgrounded
-        after_commit Proc.new {|o| o.backgrounded(backgrounded_options).send(method_name) }, options
+        self.after_commit options.except(:backgrounded) do |instance|
+          instance.backgrounded(options[:backgrounded]).send(method_name)
+        end
       end
     end
   end

data/lib/backgrounded/concern.rb

@@ -7,15 +7,13 @@ module Backgrounded
     module ClassMethods
       # @see Backgrounded::Concern#backgrounded
       def backgrounded(options={})
-        Backgrounded.handler.options = options
-        Backgrounded::Proxy.new self
+        Backgrounded::Proxy.new self, options
       end
     end
 
     # @param options (optional) options to pass into the backgrounded handler
     def backgrounded(options={})
-      Backgrounded.handler.options = options
-      Backgrounded::Proxy.new self
+      Backgrounded::Proxy.new self, options
     end
   end
 end

data/lib/backgrounded/handler/inprocess_handler.rb

@@ -1,10 +1,8 @@
-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 < AbstractHandler
+    class InprocessHandler
       def request(object, method, args, options={})
         object.send method, *args
       end

data/lib/backgrounded/handler/no_op_handler.rb

@@ -1,11 +1,9 @@
-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 < AbstractHandler
-      def request(object, method, args)
+    class NoOpHandler
+      def request(object, method, args, options={})
         # do nothing
       end
     end

data/lib/backgrounded/proxy.rb

@@ -1,12 +1,14 @@
 module Backgrounded
+  attr_reader :delegate, :options
   class Proxy
-    def initialize(delegate)
+    def initialize(delegate, options={})
       @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)
+      Backgrounded.logger.debug("Requesting #{Backgrounded.handler} backgrounded method: #{method_name} for instance #{@delegate} with options: #{@options}")
+      Backgrounded.handler.request(@delegate, method_name, args, @options)
       nil
     end
   end

data/lib/backgrounded/version.rb

@@ -1,3 +1,3 @@
 module Backgrounded
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/test/active_record_extension_test.rb

@@ -17,21 +17,21 @@ class ActiveRecordExtensionTest < Test::Unit::TestCase
     should 'be defined on ActiveRecord::Base' do
       assert ActiveRecord::Base.respond_to?(:after_commit_backgrounded)
     end
-    context 'when using default options' do
+    context 'without options' do
       setup do
         @blog = Blog.new
-        @blog.expects(:do_something_else)
-        @blog.save
+        Backgrounded.handler.expects(:request).with(@blog, :do_something_else, [], {})
+        @blog.save!
       end
-      should 'execute callbacks' do end # see expectations
+      should 'invoke Backgrounded.handler with no options' do end # see expectations
     end
-    context 'when callback has :backgrounded options' do
+    context 'with options[:backgrounded]' do
       setup do
-        Backgrounded.handler.expects(:options=).with(:priority => :high)
         @user = User.new
-        @user.save
+        Backgrounded.handler.expects(:request).with(@user, :do_stuff, [], {:priority => :high})
+        @user.save!
       end
-      should 'pass configure Backgrounded.handler.options' do end # see expectations
+      should 'pass options[:backgrounded] to Backgrounded.handler' do end # see expectations
     end
   end
 end

data/test/backgrounded_test.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 class BackgroundedTest < Test::Unit::TestCase
 
-  class User
+  class Dog
     def do_stuff
     end
     def self.do_something_else
@@ -11,14 +11,14 @@ class BackgroundedTest < Test::Unit::TestCase
 
   context '#backgrounded' do
     should 'be defined for class' do
-      assert User.respond_to?(:backgrounded)
+      assert Dog.respond_to?(:backgrounded)
     end
     should 'be defined for instance' do
-      assert User.new.respond_to?(:backgrounded)
+      assert Dog.new.respond_to?(:backgrounded)
     end
     context 'invoking on class' do
       setup do
-        @result = User.backgrounded
+        @result = Dog.backgrounded
       end
       should 'return instance of Backgrounded::Proxy' do
         assert @result.is_a?(Backgrounded::Proxy)
@@ -26,8 +26,8 @@ class BackgroundedTest < Test::Unit::TestCase
     end
     context 'invoking on an instance' do
       setup do
-        @user = User.new
-        @result = @user.backgrounded
+        @dog = Dog.new
+        @result = @dog.backgrounded
       end
       should 'return instance of Backgrounded::Proxy' do
         assert @result.is_a?(Backgrounded::Proxy)
@@ -35,8 +35,9 @@ 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)
+        @dog = Dog.new
+        Backgrounded.handler.expects(:request).with(@dog, :do_stuff, [], {:priority => :high})
+        @dog.backgrounded(:priority => :high).do_stuff
       end
       should 'pass options onto Backgrounded.handler' do end # see expectations
     end

data/test/proxy_test.rb

@@ -1,40 +1,51 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 class ProxyTest < Test::Unit::TestCase
-
-  class User
-    def do_stuff
-    end
+  class Person
     def self.do_something_else
     end
-  end
-
-  class Person
     def do_stuff(name, place, location)
     end
+    def do_stuff_without_arguments
+    end
   end
 
   context 'invoking delegate method' do
+    context 'with arguments and options' do
+      setup do
+        @delegate = Person.new
+        Backgrounded.handler.expects(:request).with(@delegate, :do_stuff, ['foo', 1, 'bar'], {:option_one => 'alpha'})
+        @proxy = Backgrounded::Proxy.new @delegate, :option_one => 'alpha'
+        @result = @proxy.do_stuff 'foo', 1, 'bar'
+      end
+      should "invokes Backgrounded.handler with delegate, method and args" do end #see expectations
+      should 'return nil' do
+        assert_nil @result
+      end
+    end
     context 'with arguments' do
       setup do
         @delegate = Person.new
-        @delegate.expects(:do_stuff).with('foo', 1, 'bar')
+        Backgrounded.handler.expects(:request).with(@delegate, :do_stuff, ['foo', 1, 'bar'], {})
         @proxy = Backgrounded::Proxy.new @delegate
         @result = @proxy.do_stuff 'foo', 1, 'bar'
       end
-      should "execute method on delegate" do end #see expectations
+      should "invokes Backgrounded.handler with delegate, method and args" do end #see expectations
       should 'return nil' do
         assert_nil @result
       end
     end
     context 'with no arguments' do
       setup do
-        @delegate = User.new
-        @delegate.expects(:do_stuff)
+        @delegate = Person.new
+        Backgrounded.handler.expects(:request).with(@delegate, :do_stuff_without_arguments, [], {})
         @proxy = Backgrounded::Proxy.new @delegate
-        @result = @proxy.do_stuff
+        @result = @proxy.do_stuff_without_arguments
+      end
+      should "invokes Backgrounded.handler with delegate, method and args" do end #see expectations
+      should 'return nil' do
+        assert_nil @result
       end
-      should "execute method on delegate" do end #see expectations
     end
   end
 end

data/test/setup_database.rb

@@ -0,0 +1,13 @@
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :blogs, :force => true do |t|
+    t.column :title, :string
+    t.column :body, :string
+  end
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+  end
+end

data/test/test_helper.rb

@@ -9,18 +9,16 @@ rescue Bundler::BundlerError => e
 end
 require 'test/unit'
 require 'shoulda'
+require 'pry'
 require 'mocha'
 require 'active_record'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'backgrounded'
+require 'setup_database'
 
 Backgrounded.logger.level = Logger::DEBUG
 
-config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
-ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
-ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
-
 class Test::Unit::TestCase
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backgrounded
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -107,6 +107,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: test_after_commit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Execute any ActiveRecord Model method in the background
 email:
 - ryan@codecrate.com
@@ -124,7 +156,6 @@ 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
@@ -133,6 +164,7 @@ files:
 - test/backgrounded_test.rb
 - test/database.yml
 - test/proxy_test.rb
+- test/setup_database.rb
 - test/test_helper.rb
 homepage: http://github.com/wireframe/backgrounded
 licenses: []
@@ -148,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1433093514713784314
+      hash: -3451700657100239997
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1433093514713784314
+      hash: -3451700657100239997
 requirements: []
 rubyforge_project: backgrounded
 rubygems_version: 1.8.24
@@ -169,4 +201,5 @@ test_files:
 - test/backgrounded_test.rb
 - test/database.yml
 - test/proxy_test.rb
+- test/setup_database.rb
 - test/test_helper.rb

data/lib/backgrounded/handler/abstract_handler.rb

@@ -1,11 +0,0 @@
-module Backgrounded
-  module Handler
-    class AbstractHandler
-      attr_writer :options
-
-      def options
-        @options ||= {}
-      end
-    end
-  end
-end