backgrounded 0.4.1 → 0.5.0

data/.gitignore

@@ -1,3 +1,4 @@
+.document
 *.sw?
 .DS_Store
 coverage

data/README.rdoc

@@ -1,11 +1,13 @@
 = Backgrounded
 
-Background processing done right.
+The cleanest way to integrate background processing into your application.
+
+Backgrounded provides a thin wrapper around any background processing framework that implements the Backgrounded handler API which makes it trivial to swap out processing frameworks with no impact to your code.
 
 = Features
-* clean and concise API
-* testable
+* 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
 
 = Usage
 
@@ -31,43 +33,37 @@ Rails environment.rb configuration
 
   config.gem 'backgrounded'
 
-Gemfile configuration
+Bundler Gemfile configuration
 
   gem 'backgrounded'
 
 = Configuration
 
-Backgrounded provides a thin wrapper around any background processing framework that implements the Backgrounded handler API.  This makes it trivial to swap out processing frameworks with no impact on your code.
-
-= DelayedJob
+Backgrounded includes several configurable implementations out of the box for most popular background frameworks.
+If your framework isn't included, it's trivial to write your own implementation.  
+Submit a patch and we may consider it for official distribution!
 
-An implementation for DelayedJob is packaged directly with Backgrounded for a slick out of the box experience.
+== DelayedJob
 see http://github.com/tobi/delayed_job/tree/master
 
   # config/initializers/backgrounded.rb
   require 'backgrounded/handler/delayed_job_handler'
   Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
 
-= Resque
-
-An implementation for Resque is packaged directly with Backgrounded for a slick out of the box experience.
+== Resque
 see http://github.com/defunkt/resque/
 
   # config/initializers/backgrounded.rb
   require 'backgrounded/handler/resque_handler'
   Backgrounded.handler = Backgrounded::Handler::ResqueHandler.new
 
-= JobFu
-
-Developers using the JobFu library have it easy as well!
+== JobFu
 see http://github.com/jnstq/job_fu/tree
 
   # config/initializers/backgrounded.rb
   Backgrounded.handler = JobFu::Backgrounded::Handler.new
 
-= Custom Handlers
-
-It's trivial to write your own plugin for processing Backgrounded events! 
+== Custom Handlers
 
   # config/initializers/backgrounded.rb
   class MyHandler

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 4
+:minor: 5
 :build: 
-:patch: 1
+:patch: 0

data/backgrounded.gemspec

@@ -5,19 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backgrounded}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Sonnek"]
-  s.date = %q{2010-09-27}
+  s.date = %q{2010-10-01}
   s.email = %q{ryan.sonnek@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
-    ".document",
-     ".gitignore",
+    ".gitignore",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

data/lib/backgrounded/class_methods.rb

@@ -1,12 +1,17 @@
 module Backgrounded
   module ClassMethods
-    def backgrounded(*methods)
-      methods.each do |method|
+    def backgrounded(*args)
+      options = args.extract_options!
+      methods_with_options = args.inject({}) do |hash, method| hash[method] = {}; hash end
+      methods_with_options.merge! options
+      methods_with_options.each_pair do |method, options|
         method_basename, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
         define_method "#{method_basename}_backgrounded#{punctuation}" do |*args|
           Backgrounded.handler.request(self, method, *args)
         end
       end
+      cattr_accessor :backgrounded_options
+      self.backgrounded_options = methods_with_options
     end
   end
 end

data/lib/backgrounded/handler/resque_handler.rb

@@ -4,13 +4,16 @@ module Backgrounded
   module Handler
     #enque requests in resque
     class ResqueHandler
+      DEFAULT_QUEUE = 'backgrounded'
+      @@queue = DEFAULT_QUEUE
+
       def request(object, method, *args)
+        @@queue = object.backgrounded_options[method.to_sym][:queue] || DEFAULT_QUEUE
         Resque.enqueue(ResqueHandler, object.class.name, object.id, method, *args)
       end
       def self.queue
-        'backgrounded'
+        @@queue
       end
-
       def self.perform(clazz, id, method, *args)
         clazz.constantize.find(id).send(method, *args)
       end

data/test/backgrounded/handler/resque_handler_test.rb

@@ -5,6 +5,10 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :users, :force => true do |t|
     t.column :name, :string
   end
+
+  create_table :posts, :force => true do |t|
+    t.column :title, :string
+  end
 end
 
 class User < ActiveRecord::Base
@@ -14,6 +18,13 @@ class User < ActiveRecord::Base
   end
 end
 
+class Post < ActiveRecord::Base
+  backgrounded :do_stuff => {:queue => 'important'}
+
+  def do_stuff
+  end
+end
+
 class ResqueHandlerTest < Test::Unit::TestCase
   context 'when backgrounded is configured with resque' do
     setup do
@@ -32,6 +43,7 @@ class ResqueHandlerTest < Test::Unit::TestCase
         end
         should "enqueue job to resque" do
           assert_queued Backgrounded::Handler::ResqueHandler
+          assert_equal Backgrounded::Handler::ResqueHandler::DEFAULT_QUEUE, Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
         end
         context "running background job" do
           should "invoke method on user object" do
@@ -40,6 +52,21 @@ class ResqueHandlerTest < Test::Unit::TestCase
           end
         end
       end
+
+      context 'a persisted object with backgrounded method with options' do
+        setup do
+          @post = Post.create
+        end
+        context "invoking backgrounded method" do
+          setup do
+            @post.do_stuff_backgrounded
+          end
+          should "use configured queue" do
+            assert_equal 'important', Backgrounded::Handler::ResqueHandler.queue
+            assert_equal 'important', Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
+          end
+        end
+      end
     end
   end
 end

data/test/backgrounded_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 class User
   backgrounded :do_stuff
@@ -30,6 +30,13 @@ class Comment
   end
 end
 
+class Dog
+  backgrounded :bark => {:priority => :low}
+
+  def bark
+  end
+end
+
 class BackgroundedTest < Test::Unit::TestCase
   context 'an object with a single backgrounded method' do
     setup do
@@ -72,4 +79,13 @@ class BackgroundedTest < Test::Unit::TestCase
       @post.notify_users_backgrounded
     end
   end
+
+  context 'an object with backgrounded method options' do
+    setup do
+      @dog = Dog.new
+    end
+    should 'save method options for future use' do
+      assert_equal :low, @dog.backgrounded_options[:bark][:priority]
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backgrounded
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 -05:00
+date: 2010-10-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
 - .gitignore
 - LICENSE
 - README.rdoc

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE