perform_later 1.2.0 → 1.3.0

data/README.md

@@ -33,7 +33,7 @@ In an initializer, all you need to say is whether you want perform later to be e
 
 ```ruby
 unless Rails.env.test?
-  PerformLater.config.later.enabled = true # this will default to false if unset
+  PerformLater.config.enabled = true # this will default to false if unset
 end
 ```
 
@@ -130,6 +130,34 @@ Basically, the `ArgsParser` class allows you to keep passing any args you want t
 
 `ArgsParser` also patched `resque-mailer` so you can pass in AR objects to mailers as well.
 
+## The custom finder
+I found the need to add a custom finder to the args parser.
+
+### Why?
+At Gogobot for example, we use slave databases, those sometimes have lag, so when the finder is executed it returns nil, even though the record is actually on the master.
+
+So, I added support for custom finders.
+
+#### Example:
+
+```ruby
+	class CustomFinder
+		def self.find(klass, id)
+			Octopus.using(:master) {
+				klass.where(id: id).first
+			} unless klass.where(id: id).first
+		end
+	end
+```
+
+Then in an initializer
+
+```ruby
+	PerformLater::Plugins.add_finder(CustomFinder)
+```
+
+So, at Gogobot for example, we will fall back to master if the record was not found on the slave DB.
+
  
 ## Contribute / Bug reports
 

data/lib/perform_later.rb

@@ -3,10 +3,12 @@ require 'perform_later/version'
 require 'perform_later/config'
 require 'perform_later/payload_helper'
 require 'perform_later/args_parser'
+require 'perform_later/plugins'
 require 'resque'
 require 'active_record'
 require 'resque_mailer_patch'
 require 'object_perform_later'
+require 'perform_later/workers/base'
 require 'perform_later/workers/active_record/worker'
 require 'perform_later/workers/active_record/lone_worker'
 require 'perform_later/workers/objects/worker'

data/lib/perform_later/args_parser.rb

@@ -18,13 +18,24 @@ module PerformLater
         if o
           o = args_from_resque(o) if o.is_a?(Array)
           case o
-          when CLASS_STRING_FORMAT  then $1.constantize
-          when AR_STRING_FORMAT     then $1.constantize.find_by_id($2)
-          when YAML_STRING_FORMAT   then YAML.load(o)
-          else o
+            when CLASS_STRING_FORMAT
+              $1.constantize
+            when AR_STRING_FORMAT
+              runner_class = $1.constantize
+              id = $2
+
+              if PerformLater::Plugins.finder_class
+                PerformLater::Plugins.finder_class.find(runner_class, id)
+              else
+                runner_class.where(id: id).first  
+              end
+            when YAML_STRING_FORMAT
+              YAML.load(o)
+            else 
+              o
           end
         end
-      } if args      
+      } if args
     end
 
   private

data/lib/perform_later/plugins.rb

@@ -0,0 +1,17 @@
+module PerformLater
+  class Plugins
+    def self.finder_class
+      @@finder_class ||= nil
+    end
+
+    def self.add_finder(klass)
+      if klass.respond_to?(:find)
+        @@finder_class = klass
+      end
+    end
+
+    def self.clear_finder!
+      @@finder_class = nil
+    end
+  end
+end

data/lib/perform_later/version.rb

@@ -1,3 +1,3 @@
 module PerformLater
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/perform_later/workers/active_record/lone_worker.rb

@@ -1,22 +1,18 @@
 module PerformLater
   module Workers
     module ActiveRecord
-      class LoneWorker
+      class LoneWorker < PerformLater::Workers::Base
         def self.perform(klass, id, method, *args)
           # Remove the loner flag from redis
           digest = PerformLater::PayloadHelper.get_digest(klass, method, args)
           Resque.redis.del(digest)
 
           args = PerformLater::ArgsParser.args_from_resque(args)
-          runner_klass = eval(klass)
+          runner_klass = klass.constantize
           
-          record = runner_klass.where(:id => id).first
-          
-          if args.length > 0
-            record.send(method, *args) if record
-          else
-            record.send(method) if record
-          end
+          record = runner_klass.find(id)
+
+          perform_job(record, method, args)
         end
       end
     end

data/lib/perform_later/workers/active_record/worker.rb

@@ -1,18 +1,14 @@
 module PerformLater
   module Workers
     module ActiveRecord
-      class Worker
+      class Worker < PerformLater::Workers::Base
         def self.perform(klass, id, method, *args)
           args = PerformLater::ArgsParser.args_from_resque(args)
-          runner_klass = eval(klass)
+          runner_klass = klass.constantize
           
-          record = runner_klass.where(:id => id).first
+          record = runner_klass.find(id)
           
-          if args.length > 0
-            record.send(method, *args) if record
-          else
-            record.send(method) if record
-          end
+          perform_job(record, method, args)
         end
       end
     end

data/lib/perform_later/workers/base.rb

@@ -0,0 +1,19 @@
+module PerformLater
+  module Workers
+		class Base
+      
+  		protected
+  			def self.perform_job(object, method, arguments)
+  				unless arguments.empty?
+            if arguments.size == 1
+              object.send(method, arguments.first)
+            else
+              object.send(method, *arguments)
+            end
+          else
+            object.send(method)
+          end
+  			end
+  		end
+	end
+end

data/lib/perform_later/workers/objects/lone_worker.rb

@@ -1,19 +1,14 @@
 module PerformLater
   module Workers
     module Objects
-      class LoneWorker
+      class LoneWorker < PerformLater::Workers::Base
         def self.perform(klass_name, method, *args)
-          # 
           digest = PerformLater::PayloadHelper.get_digest(klass_name, method, args)
           Resque.redis.del(digest)
 
-          args = PerformLater::ArgsParser.args_from_resque(args)
+          arguments = PerformLater::ArgsParser.args_from_resque(args)
           
-          if args.length > 0
-            klass_name.constantize.send(method, *args)
-          else
-            klass_name.constantize.send(method)
-          end
+          perform_job(klass_name.constantize, method, arguments)
         end
       end
     end

data/lib/perform_later/workers/objects/worker.rb

@@ -1,19 +1,11 @@
 module PerformLater
   module Workers
     module Objects
-      class Worker
+      class Worker < PerformLater::Workers::Base
         def self.perform(klass_name, method, *args)
           arguments = PerformLater::ArgsParser.args_from_resque(args)
 
-          if arguments.any?
-            if arguments.size == 1
-              klass_name.constantize.send(method, arguments.first)
-            else
-              klass_name.constantize.send(method, *arguments)
-            end
-          else
-            klass_name.constantize.send(method)
-          end
+          perform_job(klass_name.constantize, method, arguments)
         end
       end
     end

data/spec/lib/perform_later/args_parser_spec.rb

@@ -1,9 +1,26 @@
 require 'spec_helper'
 
+class CustomFinder 
+  def self.find(klass, id)
+    klass.find(id)
+  end
+end
+
 describe PerformLater::ArgsParser do
   subject { PerformLater::ArgsParser }
   let(:user) { User.create }
 
+  context "Custom finder" do
+    it "should invoke the custom class finder method" do
+      CustomFinder.should_receive(:find).with(User, user.id.to_s)
+      PerformLater::Plugins.add_finder(CustomFinder)
+      
+      subject.args_from_resque(["AR:User:#{user.id}"])
+
+      PerformLater::Plugins.clear_finder!
+    end
+  end
+
   context "args to resque" do
 
     it "should convert array of hashes correctly" do

data/spec/lib/perform_later/plugins_spec.rb

@@ -0,0 +1,33 @@
+require 'perform_later/plugins'
+
+class BadDummyFinder 
+
+end
+
+class GoodDummyFinder 
+  def self.find(runner_class, id)
+    runner_class.find(id)
+  end
+end
+
+describe PerformLater::Plugins do
+  subject { PerformLater::Plugins }
+
+  describe :finder_class do
+    it "should be nil" do
+      subject.finder_class.should == nil
+    end
+  end
+  
+  describe :add_finder do
+    it "should not add the finder since it doens't have the proper method" do
+      subject.add_finder(BadDummyFinder)
+      subject.finder_class.should == nil
+    end
+
+    it "should add the finder since it has the proper method" do
+      subject.add_finder(GoodDummyFinder)
+      subject.finder_class.should == GoodDummyFinder
+    end
+  end    
+end

data/spec/lib/perform_later/workers/objects/worker_spec.rb

@@ -40,6 +40,15 @@ describe PerformLater::Workers::Objects::Worker do
     subject.perform("DummyClass", :identity_function, args).should == user
   end
 
+  it "should pass a single argument (user) when translated args are passed in" do
+    user = User.create
+    user_arg = "AR:User:#{user.id}"
+    mock_user = double(:user, first: nil)
+    User.should_receive(:where).with(id: user.id.to_s).and_return { mock_user }
+    
+    subject.perform("DummyClass", :identity_function, user_arg).should == nil
+  end
+
   it "should pass an array with one entry" do
     users = [User.create]
     args = PerformLater::ArgsParser.args_to_resque(users)

data/spec/spec_helper.rb

@@ -27,6 +27,7 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
+    PerformLater::Plugins.clear_finder!
     $redis.flushdb
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perform_later
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -191,10 +191,12 @@ files:
 - lib/perform_later/args_parser.rb
 - lib/perform_later/config.rb
 - lib/perform_later/payload_helper.rb
+- lib/perform_later/plugins.rb
 - lib/perform_later/railtie.rb
 - lib/perform_later/version.rb
 - lib/perform_later/workers/active_record/lone_worker.rb
 - lib/perform_later/workers/active_record/worker.rb
+- lib/perform_later/workers/base.rb
 - lib/perform_later/workers/objects/lone_worker.rb
 - lib/perform_later/workers/objects/worker.rb
 - lib/resque/plugins/later/method.rb
@@ -205,6 +207,7 @@ files:
 - spec/lib/perform_later/args_parser_spec.rb
 - spec/lib/perform_later/config_spec.rb
 - spec/lib/perform_later/payload_helper_spec.rb
+- spec/lib/perform_later/plugins_spec.rb
 - spec/lib/perform_later/workers/active_record/worker_spec.rb
 - spec/lib/perform_later/workers/objects/worker_spec.rb
 - spec/lib/perform_later_spec.rb
@@ -244,6 +247,7 @@ test_files:
 - spec/lib/perform_later/args_parser_spec.rb
 - spec/lib/perform_later/config_spec.rb
 - spec/lib/perform_later/payload_helper_spec.rb
+- spec/lib/perform_later/plugins_spec.rb
 - spec/lib/perform_later/workers/active_record/worker_spec.rb
 - spec/lib/perform_later/workers/objects/worker_spec.rb
 - spec/lib/perform_later_spec.rb