Job.destroy and Resque.dequeue return the # of destroyed jobs.

Author: defunkt

HISTORY.md

@@ -1,3 +1,7 @@
+## 1.5.1 (2010-??-??)
+
+* `Job.destroy` and `Resque.dequeue` return the # of destroyed jobs.
+
 ## 1.5.0 (2010-02-17)
 
 * Version now included in procline, e.g. `resque-1.5.0: Message`

lib/resque.rb

@@ -156,6 +156,8 @@ def enqueue(klass, *args)
   # the provided class. See `Resque::Job.destroy` for more
   # information.
   #
+  # Returns the number of jobs destroyed.
+  #
   # Example:
   #
   #   # Removes all jobs of class `UpdateNetworkGraph`

lib/resque/job.rb

@@ -50,6 +50,8 @@ def self.create(queue, klass, *args)
     # Removes a job from a queue. Expects a string queue name, a
     # string class name, and, optionally, args.
     #
+    # Returns the number of jobs destroyed.
+    #
     # If no args are provided, it will remove all jobs of the class
     # provided.
     #
@@ -72,6 +74,7 @@ def self.create(queue, klass, *args)
     def self.destroy(queue, klass, *args)
       klass = klass.to_s
       queue = "queue:#{queue}"
+      destroyed = 0
 
       redis.lrange(queue, 0, -1).each do |string|
         json   = decode(string)
@@ -80,9 +83,11 @@ def self.destroy(queue, klass, *args)
         match &= json['args'] == args unless args.empty?
 
         if match
-          redis.lrem(queue, 0, string)
+          destroyed += redis.lrem(queue, 0, string).to_i
         end
       end
+
+      destroyed
     end
 
     # Given a string queue name, returns an instance of Resque::Job

test/resque_test.rb

@@ -79,9 +79,9 @@
     assert Resque::Job.create(:jobs, 'BadJob', 20, '/tmp')
 
     assert_equal 5, Resque.size(:jobs)
-    Resque::Job.destroy(:jobs, 'SomeJob')
+    assert_equal 2, Resque::Job.destroy(:jobs, 'SomeJob')
     assert_equal 3, Resque.size(:jobs)
-    Resque::Job.destroy(:jobs, 'BadJob', 30, '/tmp')
+    assert_equal 1, Resque::Job.destroy(:jobs, 'BadJob', 30, '/tmp')
     assert_equal 2, Resque.size(:jobs)
   end