perform_later 1.1.1 → 1.2.0

data/README.md

@@ -141,4 +141,12 @@ Be as descriptive as you can in the pull request description, just to be clear w
 
 ## Author
 
-Avi Tzurel ([@kensodev](http://twitter.com/kensodev)) http://www.kensodev.com
+Avi Tzurel ([@kensodev](http://twitter.com/kensodev)) http://www.kensodev.com
+
+## Contributors
+
+* Felipe Lima ([@felipecsl](http://twitter.com/felipecsl)) 
+http://blog.felipel.com/
+
+Felipe did awesome work on making sure `perform_later` can work with any args and any number of args passed into the methods.
+Felipe now has commit rights to the repo.

data/lib/object_perform_later.rb

@@ -1,13 +1,13 @@
 module ObjectPerformLater
   def perform_later(queue, method, *args)
-    return self.send(method, *args) unless PerformLater.config.enabled?
+    return perform_now(method, args) unless PerformLater.config.enabled?
 
     worker = PerformLater::Workers::Objects::Worker
     perform_later_enqueue(worker, queue, method, args)
   end
 
   def perform_later!(queue, method, *args)
-    return self.send(method, *args) unless PerformLater.config.enabled?
+    return perform_now(method, args) unless PerformLater.config.enabled?
 
     return "EXISTS!" if loner_exists(method, args)
 
@@ -16,16 +16,21 @@ module ObjectPerformLater
   end
 
   private 
-    def loner_exists(method, args)
+    def loner_exists(method, *args)
       digest = PerformLater::PayloadHelper.get_digest(self.name, method, args)
+
       return true unless Resque.redis.get(digest).blank?
       Resque.redis.set(digest, 'EXISTS')
       return false
     end
 
-    def perform_later_enqueue(worker, queue, method, *args)
+    def perform_later_enqueue(worker, queue, method, args)
       args = PerformLater::ArgsParser.args_to_resque(args)
-      Resque::Job.create(queue, worker, self.name, method, *args)
+      args.size == 1 ? Resque::Job.create(queue, worker, self.name, method, args.first) : Resque::Job.create(queue, worker, self.name, method, *args)
+    end
+
+    def perform_now(method, args)
+      args.size == 1 ? send(method, args.first) : send(method, *args)
     end
 end
 

data/lib/perform_later/args_parser.rb

@@ -1,30 +1,22 @@
+require 'json'
+
 module PerformLater
   class ArgsParser
-    APP_ROOT = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ".") unless defined?(APP_ROOT)
-
     # inspired by DelayedJob
     CLASS_STRING_FORMAT = /^CLASS\:([A-Z][\w\:]+)$/
     AR_STRING_FORMAT    = /^AR\:([A-Z][\w\:]+)\:(\d+)$/
     YAML_STRING_FORMAT  = /\A---/
 
-    def self.args_to_resque(*args)
-      args = args.flatten.map { |o|
-        case o
-          when ActiveRecord::Base
-            "AR:#{o.class.name}:#{o.id}"
-          when Class, Module
-            "CLASS:#{o.name}"
-          when Hash
-            o.to_yaml
-          else
-            o
-        end
-      } if args
+    def self.args_to_resque(args)
+      return nil unless args
+      return arg_to_resque(args) unless args.is_a?(Array)
+      return args.map { |o| arg_to_resque o }
     end
     
-    def self.args_from_resque(*args)
-      args = args.flatten.map { |o|
+    def self.args_from_resque(args)
+      args = args.map { |o|
         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)
@@ -32,18 +24,22 @@ module PerformLater
           else o
           end
         end
-      } if args
+      } if args      
     end
 
-    private
-      def self.env_str
-        if defined? Rails
-          Rails.env.to_s
-        elsif defined? Rack
-          Rack.env.to_s
-        else
-          'production'
-        end
+  private
+
+    def self.arg_to_resque(arg)
+      case arg
+      when ActiveRecord::Base
+        "AR:#{arg.class.name}:#{arg.id}"
+      when Class, Module
+        "CLASS:#{arg.name}"
+      when Hash
+        arg.to_yaml
+      else
+        arg
       end
+    end
   end
 end

data/lib/perform_later/version.rb

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

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

@@ -2,7 +2,7 @@ module PerformLater
   module Workers
     module ActiveRecord
       class LoneWorker
-        def self.perform(klass, id, method, args)
+        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)
@@ -11,7 +11,12 @@ module PerformLater
           runner_klass = eval(klass)
           
           record = runner_klass.where(:id => id).first
-          record.send(method, *args) if record
+          
+          if args.length > 0
+            record.send(method, *args) if record
+          else
+            record.send(method) if record
+          end
         end
       end
     end

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

@@ -7,7 +7,12 @@ module PerformLater
           runner_klass = eval(klass)
           
           record = runner_klass.where(:id => id).first
-          record.send(method, *args) if record
+          
+          if args.length > 0
+            record.send(method, *args) if record
+          else
+            record.send(method) if record
+          end
         end
       end
     end

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

@@ -8,7 +8,12 @@ module PerformLater
           Resque.redis.del(digest)
 
           args = PerformLater::ArgsParser.args_from_resque(args)
-          klass_name.constantize.send(method, *args)
+          
+          if args.length > 0
+            klass_name.constantize.send(method, *args)
+          else
+            klass_name.constantize.send(method)
+          end
         end
       end
     end

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

@@ -3,8 +3,17 @@ module PerformLater
     module Objects
       class Worker
         def self.perform(klass_name, method, *args)
-          args = PerformLater::ArgsParser.args_from_resque(args)
-          klass_name.constantize.send(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
         end
       end
     end

data/lib/resque/plugins/later/method.rb

@@ -19,7 +19,7 @@ module Resque::Plugins::Later::Method
           Resque.redis.set(digest, 'EXISTS')
         end
         
-        Resque::Job.create(queue, klass, send(:class).name, send(:id), "now_#{method_name}", args)
+        Resque::Job.create(queue, klass, send(:class).name, send(:id), "now_#{method_name}", *args)
       end
     end
   end
@@ -41,7 +41,7 @@ module Resque::Plugins::Later::Method
   end
 
   private 
-    def loner_exists(method, *args)
+    def loner_exists(method, args)
       args = PerformLater::ArgsParser.args_to_resque(args)
       digest = PerformLater::PayloadHelper.get_digest(self.class.name, method, args)
 
@@ -51,8 +51,8 @@ module Resque::Plugins::Later::Method
       return false
     end
 
-    def enqueue_in_resque_or_send(worker, queue, method, *args)
+    def enqueue_in_resque_or_send(worker, queue, method, args)
       args = PerformLater::ArgsParser.args_to_resque(args)
-      Resque::Job.create(queue, worker, self.class.name, self.id, method, *args)   
+      Resque::Job.create(queue, worker, self.class.name, self.id, method, *args)
     end
 end

data/lib/resque_mailer_patch.rb

@@ -2,16 +2,16 @@ module Resque
   module Mailer
     module ClassMethods
       def perform(action, *args)
-        args = ResquePerformLater.args_from_resque(args)
+        args = PerformLater::ArgsParser.args_from_resque(args)
         self.send(:new, action, *args).message.deliver
       end
     end
 
     class MessageDecoy
       def deliver
-        args = ResquePerformLater.args_to_resque(@args)
+        args = PerformLater::ArgsParser.args_to_resque(@args)
         resque.enqueue(@mailer_class, @method_name, *args)
       end
     end
   end
-end
+end

data/spec/lib/object_perform_later_spec.rb

@@ -13,9 +13,17 @@ class DummyClass
     user
   end
 
+  def self.do_something_with_multiple_args(a, b)
+    "#{a}, #{b}"
+  end
+
   def self.do_something_with_optional_hash(options = {})
     options.blank?
   end
+
+  def self.do_something_with_array(arr)
+    arr
+  end
 end
 
 describe ObjectPerformLater do
@@ -48,10 +56,38 @@ describe ObjectPerformLater do
     Resque.peek(:generic, 0, 20).length.should == 1
   end
 
+  describe "When Enabled" do
+    it "should pass no values" do
+      PerformLater.config.stub!(:enabled?).and_return(true)
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::Objects::Worker, "DummyClass", :do_something_with_array)
+      DummyClass.perform_later(:generic, :do_something_with_array)
+    end
+
+    it "should pass the correct value (array)" do
+      PerformLater.config.stub!(:enabled?).and_return(true)
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::Objects::Worker, "DummyClass", :do_something_with_array, [1,2,3,4,5])
+      DummyClass.perform_later(:generic, :do_something_with_array, [1,2,3,4,5])
+    end
+
+    it "should pass multiple args" do
+      PerformLater.config.stub!(:enabled?).and_return(true)
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::Objects::Worker, "DummyClass", :do_something_with_multiple_args, 1, 2)
+      DummyClass.perform_later(:generic, :do_something_with_multiple_args, 1, 2)
+    end
+
+    it "should pass AR and hash" do
+      u = User.create
+      PerformLater.config.stub!(:enabled?).and_return(true)
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::Objects::Worker, "DummyClass", :do_something_with_multiple_args, "AR:User:2", "---\n:a: 2\n")
+      DummyClass.perform_later(:generic, :do_something_with_multiple_args, u, {a: 2})
+    end
+  end
+
   describe :perform_later do
     before(:each) do
       PerformLater.config.stub!(:enabled?).and_return(false)
     end
+    
     it "should pass the correct value (String)" do
       DummyClass.perform_later(:generic, :do_something_with_string, "Avi Tzurel").should == "Avi Tzurel"
     end
@@ -64,6 +100,15 @@ describe ObjectPerformLater do
     it "should pass the correct value (optional hash)" do
       DummyClass.perform_later(:generic, :do_something_with_optional_hash).should == true
     end
+
+    it "should pass multiple args" do
+      DummyClass.perform_later(:generic, :do_something_with_multiple_args, 1, 2).should == "1, 2"
+    end
+
+    it "should pass AR and hash" do
+      u = User.create
+      DummyClass.perform_later(:generic, :do_something_with_multiple_args, u, {a: 2}).should == "#{u}, {:a=>2}"
+    end
   end
 
   describe :perform_later! do
@@ -82,5 +127,14 @@ describe ObjectPerformLater do
     it "should pass the correct value (optional hash)" do
       DummyClass.perform_later!(:generic, :do_something_with_optional_hash).should == true
     end
+
+    it "should pass multiple args" do
+      DummyClass.perform_later!(:generic, :do_something_with_multiple_args, 1, 2).should == "1, 2"
+    end
+
+    it "should pass AR and hash" do
+      u = User.create
+      DummyClass.perform_later!(:generic, :do_something_with_multiple_args, u, {a: 2}).should == "#{u}, {:a=>2}"
+    end
   end
 end

data/spec/lib/perform_later/args_parser_spec.rb

@@ -5,11 +5,37 @@ describe PerformLater::ArgsParser do
   let(:user) { User.create }
 
   context "args to resque" do
+
+    it "should convert array of hashes correctly" do
+      arr = [
+        { something: "aaa" },
+        { something: "bbb" },
+        { something: "ccc" },
+        { something: "ddd" },
+        { something: "eee" }
+      ]
+      subject.args_to_resque(arr).class.should == Array
+    end
+
+    it "should translate array of hashes back and forth again" do
+      arr = [
+        { something: "aaa" },
+        { something: "bbb" },
+        { something: "ccc" },
+        { something: "ddd" },
+        { something: "eee" }
+      ]
+      to_resque = subject.args_to_resque(arr).to_json
+      a = JSON.parse(to_resque)
+      from_resque = subject.args_from_resque(a)
+      
+      from_resque.should == arr
+    end
+
     it "should convert the AR object to the proper string" do
       user_id = user.id
 
-      subject.args_to_resque(user).length.should == 1
-      subject.args_to_resque(user)[0].should == "AR:User:#{user_id}"
+      subject.args_to_resque(user).should == "AR:User:#{user_id}"
     end
 
     it "should convert a hash into YAML string so that Resque will be able to JSON convert it" do
@@ -19,24 +45,24 @@ describe PerformLater::ArgsParser do
 
     it "should be able to load a yaml from the string and translate it into the same hash again" do
       hash = { name: "something", other: "something else" }
-      yaml = subject.args_to_resque(hash)[0]
+      yaml = subject.args_to_resque(hash)
 
       loaded_yaml = YAML.load(yaml)
-      
+
       loaded_yaml[:name].should == "something"
       loaded_yaml[:other].should == "something else"
     end
 
     it "should convert a class to the proper string representation" do
       klass = User
-      subject.args_to_resque(klass)[0].should == "CLASS:User"
+      subject.args_to_resque(klass).should == "CLASS:User"
     end
   end
 
   context "args from resque" do
     it "should give me a hash back when I pass a yaml representation of it" do
       hash = { name: "something", other: "something else" }
-      yaml = hash.to_yaml
+      yaml = *hash.to_yaml
 
       args = subject.args_from_resque(yaml)
       args[0].class.name.should == "Hash"
@@ -45,7 +71,8 @@ describe PerformLater::ArgsParser do
     end
 
     it "Should give me a user model back when I pass the proper string" do
-      args = subject.args_from_resque("AR:User:#{user.id}")
+      args_input = *"AR:User:#{user.id}"
+      args = subject.args_from_resque(args_input)
       args[0].should == user
     end
   end

data/spec/lib/perform_later/payload_helper_spec.rb

@@ -14,7 +14,6 @@ describe PerformLater::PayloadHelper do
         }.to_s)
 
       args = PerformLater::ArgsParser.args_to_resque(user)
-      puts args
       subject.get_digest("DummyClass", :some_method, args).should == digest
     end
   end

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

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe PerformLater::Workers::ActiveRecord::Worker do
+
+end

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

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+class DummyClass 
+  def self.do_somthing_with_array_of_hashes(arr)
+    arr[0][:foo]
+  end
+
+  def self.do_something_without_args
+    true
+  end
+
+  def self.identity_function(data)
+    data
+  end
+
+  def self.join(arg1, arg2)
+    "#{arg1}|#{arg2}"
+  end
+end
+
+describe PerformLater::Workers::Objects::Worker do
+  subject { PerformLater::Workers::Objects::Worker }
+
+  it "should pass an array of hashes into the method" do
+    arr = [
+      { foo: "bar" },
+      { bar: "foo" }
+    ]
+    arr = PerformLater::ArgsParser.args_to_resque(arr)
+    subject.perform("DummyClass", :do_somthing_with_array_of_hashes, arr).should == "bar"
+  end
+
+  it "should pass no args to the method" do
+    subject.perform("DummyClass", :do_something_without_args).should == true
+  end
+
+  it "should pass a single argument (user)" do
+    user = User.create
+    args = PerformLater::ArgsParser.args_to_resque(user)
+    subject.perform("DummyClass", :identity_function, args).should == user
+  end
+
+  it "should pass an array with one entry" do
+    users = [User.create]
+    args = PerformLater::ArgsParser.args_to_resque(users)
+    subject.perform("DummyClass", :identity_function, args).should == users
+  end
+
+  it "should pass multi dimension arrays" do
+    data = [1, 2, User.create, ["a", "b", "c"]]
+    args = PerformLater::ArgsParser.args_to_resque(data)
+    subject.perform("DummyClass", :identity_function, args).should == data
+  end
+
+  it 'should pass AR and hash' do
+    user = User.create
+    arr = {
+        something_a: "aaa",
+        something_b: "bbb"
+      }
+    arg1 = PerformLater::ArgsParser.args_to_resque(user)
+    arg2 = PerformLater::ArgsParser.args_to_resque(arr)
+    subject.perform("DummyClass", :join, arg1, arg2).split("|")[1].should == "{:something_a=>\"aaa\", :something_b=>\"bbb\"}"
+  end
+end

data/spec/lib/resque/plugins/later/method_spec.rb

@@ -52,6 +52,20 @@ describe Resque::Plugins::Later::Method do
     end
   end
 
+  context 'arguments to Resque' do
+    it 'should send no args to resque' do
+      user = User.create
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::ActiveRecord::Worker, 'User', user.id, :lonely_long_running_method)
+      user.perform_later(:generic, :lonely_long_running_method)
+    end
+
+    it 'should send 1 arg to resque' do
+      user = User.create
+      Resque::Job.should_receive(:create).with(:generic, PerformLater::Workers::ActiveRecord::LoneWorker, 'User', user.id, :lonely_long_running_method, 1)
+      user.perform_later!(:generic, :lonely_long_running_method, 1)
+    end
+  end
+
   it "shold define the correct method on the user model" do
     user = User.create
     user.should respond_to(:long_running_method)
@@ -73,8 +87,4 @@ describe Resque::Plugins::Later::Method do
        user.perform_later!(:generic, :method_with_integer_option, 1)
     end 
   end
-
-
-
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perform_later
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -205,6 +205,8 @@ 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/workers/active_record/worker_spec.rb
+- spec/lib/perform_later/workers/objects/worker_spec.rb
 - spec/lib/perform_later_spec.rb
 - spec/lib/resque/plugins/later/method_spec.rb
 - spec/spec_helper.rb
@@ -242,6 +244,8 @@ 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/workers/active_record/worker_spec.rb
+- spec/lib/perform_later/workers/objects/worker_spec.rb
 - spec/lib/perform_later_spec.rb
 - spec/lib/resque/plugins/later/method_spec.rb
 - spec/spec_helper.rb