wireframe-backgrounded 0.2.0 → 0.3.0

data/README.rdoc

@@ -15,13 +15,6 @@ Simple API for running model methods in the background
   #usage
   user = User.new
   user.do_stuff_backgrounded
-  
-= Configuration
-
-Packaged with Delayed Job handler out of the box, but can support any custom handler to perform background work.
-
-  # rails config/environment.rb
-  Backgrounded.handler = DelayedJobHandler.new
 
 = Installation
 
@@ -33,6 +26,17 @@ Rails environment.rb configuration
 
   config.gem 'wireframe-backgrounded', :source => 'http://gems.github.com', :lib => 'backgrounded'
 
+= Configuration
+
+Packaged with both Delayed Job and JobFu handler out of the box, but can support any custom handler to perform background work.
+
+  # rails config/initializers/backgrounded.rb
+  
+  # Delayed Job, see http://github.com/tobi/delayed_job/tree/master  
+  Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
+  
+  # Job Fu, see http://github.com/jnstq/job_fu/tree
+  Backgrounded.handler = Backgrounded::Handler::JobFuHandler.new
 
 == Copyright
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 2
+:minor: 3
 :patch: 0

data/backgrounded.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backgrounded}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Sonnek"]
-  s.date = %q{2009-07-21}
+  s.date = %q{2009-08-11}
   s.email = %q{ryan.sonnek@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -21,6 +21,10 @@ Gem::Specification.new do |s|
      "VERSION.yml",
      "backgrounded.gemspec",
      "lib/backgrounded.rb",
+     "lib/handler.rb",
+     "lib/handler/delayed_job_handler.rb",
+     "lib/handler/inprocess_handler.rb",
+     "lib/handler/job_fu_handler.rb",
      "test/backgrounded_test.rb",
      "test/test_helper.rb"
   ]

data/lib/backgrounded.rb

@@ -5,25 +5,9 @@ module Backgrounded
   def self.handler
     @@handler ||= Backgrounded::Handler::InprocessHandler.new
   end
-  module Handler
-    #simple handler to process synchronously and not actually in the background
-    #useful for testing
-    class InprocessHandler
-      def request(object, method)
-        object.send method
-      end
-    end
-
-    # invoke the operation in the background using delayed job
-    # see http://github.com/tobi/delayed_job/tree/master
-    class DelayedJobHandler
-      require 'delayed_job'
-      def request(object, method)
-        object.send_later(method.to_sym)
-      end
-    end
-  end
-
+  
+  autoload :Handler, 'handler'
+        
   module Model
     def self.included(base)
       base.extend(ClassMethods)
@@ -32,8 +16,9 @@ module Backgrounded
     module ClassMethods
       def backgrounded(*methods)
         methods.each do |method|
-          define_method "#{method.to_s}_backgrounded" do
-            Backgrounded.handler.request(self, method)
+          method_basename, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+          define_method :"#{method_basename}_backgrounded#{punctuation}" do |*args|
+            Backgrounded.handler.request(self, method, *args)
           end
         end
         include Backgrounded::Model::InstanceMethods
@@ -43,7 +28,7 @@ module Backgrounded
 
     module SingletonMethods
     end
-  
+
     module InstanceMethods
     end
   end

data/lib/handler.rb

@@ -0,0 +1,10 @@
+require 'activesupport'
+
+module Backgrounded
+  module Handler
+    Dir["#{File.dirname(__FILE__)}/#{name.demodulize.underscore}/*.rb"].each do |handler_file|
+      handler_name = File.basename(handler_file, '.rb').camelize.to_sym
+      autoload handler_name, File.expand_path(handler_file)
+    end
+  end
+end

data/lib/handler/delayed_job_handler.rb

@@ -0,0 +1,13 @@
+require 'delayed_job'
+
+module Backgrounded
+  module Handler
+    # invoke the operation in the background using delayed job
+    # see http://github.com/tobi/delayed_job/tree/master
+    class DelayedJobHandler
+      def request(object, method, *args)
+        object.send_later(method.to_sym, *args)
+      end
+    end
+  end
+end

data/lib/handler/inprocess_handler.rb

@@ -0,0 +1,11 @@
+module Backgrounded
+  module Handler
+    #simple handler to process synchronously and not actually in the background
+    #useful for testing
+    class InprocessHandler
+      def request(object, method, *args)
+        object.send method, *args
+      end
+    end
+  end
+end

data/lib/handler/job_fu_handler.rb

@@ -0,0 +1,21 @@
+require 'job_fu'
+
+module Backgrounded
+  module Handler
+    # invoke the operation in the background using job fu
+    # see http://github.com/jnstq/job_fu/tree
+    class JobFuHandler
+      # ==== Parameters
+      # Optional argment hash will be picked up by the request method
+      #
+      # * <tt>:priority</tt> - priority for the job
+      # * <tt>:at</tt> - when the job should run
+      #
+      def request(object, method, *args)
+        opt = args.extract_options!
+        priority, process_at = opt[:priority], opt[:at]
+        JobFu::Job.enqueue JobFu::ProcessableMethod.new(object, method, *args), priority, process_at
+      end
+    end
+  end
+end

data/test/backgrounded_test.rb

@@ -23,6 +23,13 @@ class Post
   end
 end
 
+class Comment
+  backgrounded :delete_spam!
+  
+  def delete_spam!
+  end
+end
+
 class BackgroundedTest < Test::Unit::TestCase
   context 'an object with a single backgrounded method' do
     setup do
@@ -38,10 +45,18 @@ class BackgroundedTest < Test::Unit::TestCase
     setup do
       @person = Person.new
     end
-    should 'raise error if passing method parameters' do
-      assert_raises ArgumentError, "method parameters are not currently supported for backgrounded methods." do
-        @person.do_stuff_backgrounded('ryan', 2, 3)
-      end
+    should 'forward them' do
+      @person.expects(:do_stuff).with('ryan', 2, 3)
+      @person.do_stuff_backgrounded('ryan', 2, 3)
+    end
+  end
+  
+  context 'an object with a backgrounded method included punctuation' do
+    setup do
+      @comment = Comment.new
+    end
+    should 'move punctuation to the end of the new method' do
+      assert @comment.respond_to?(:'delete_spam_backgrounded!')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wireframe-backgrounded
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-21 00:00:00 -07:00
+date: 2009-08-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,10 +31,15 @@ files:
 - VERSION.yml
 - backgrounded.gemspec
 - lib/backgrounded.rb
+- lib/handler.rb
+- lib/handler/delayed_job_handler.rb
+- lib/handler/inprocess_handler.rb
+- lib/handler/job_fu_handler.rb
 - test/backgrounded_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/wireframe/backgrounded
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -55,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Simple API to run Model methods in the background