resque-cleaner 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0 (2010-11-24)
+
+* First official release
+
+

data/README.markdown

@@ -8,14 +8,14 @@ Description
 -----------
 
 ResqueCleaner is a [Resque](https://github.com/defunkt/resque) plugin which
-helps you to deal with failed jobs of Resque by:
+helps you to deal with failed jobs on Resque by:
 
 * Showing stats of failed jobs
 * Retrying failed jobs
 * Removing failed jobs
 * Filtering failed jobs
 
-Although ResqueCleaner hasn't integrated with Resque's web-based interface yet,
+Although ResqueCleaner has not integrated with Resque's web-based interface yet,
 it is pretty easy to use on irb(console).
 
 
@@ -23,6 +23,7 @@ Installation
 ------------
 
 Install as a gem:
+
     $ gem install resque-cleaner
 
 
@@ -53,9 +54,11 @@ You could also group them by class.
     => {'BadJob' => 3, ...}
 
 You can get the ones filtered with a block: it targets only jobs which the block
-evaluetes true. e.g. Show stats only of jobs entried with some arguments.
+evaluetes true.
+
+e.g. Show stats only of jobs entried with some arguments:
 
-    > cleaner.stats_by_date{|job| job["payload"]["args"].size > 0}
+    > cleaner.stats_by_date {|j| j["payload"]["args"].size > 0}
     2009/03/13:    3
     2009/11/13:    7
     2010/08/13:   11
@@ -69,28 +72,32 @@ You can retry all failed jobs with this method.
     > cleaner.requeue
 
 Of course, you can filter jobs with a block; it requeues only jobs which the
-block evaluates true. e.g. Retry only jobs with some arguments.
+block evaluates true. 
+
+e.g. Retry only jobs with some arguments:
 
-    > cleaner.requeue{ |job| job["payload"]["args"].size > 0}
+    > cleaner.requeue {|j| j["payload"]["args"].size > 0}
 
 The job hash is extended with a module which defines some useful methods. You
-can use it in the blcok. e.g. Retry only jobs entried within a day.
+can use it in the blcok.
+
+e.g. Retry only jobs entried within a day:
 
     > cleaner.requeue {|j| j.after?(1.day.ago)}
 
 e.g. Retry EmailJob entried with arguments within 3 days:
 
-    > cleaner.requeue {|j| j["payload"]["args"]>0 && j.after?(3.days.ago) && j.klass?(EmailJob)}
+    > cleaner.requeue {|j| j.after?(3.days.ago) && j.klass?(EmailJob) && j["payload"]["args"].size>0}
 
-See Helper Methods bellow for more.
+See Helper Methods section bellow for more information.
 
 NOTE:
 [1.day.ago](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/numeric/time.rb)
-is not in standard library. It is equivalent to `Time.now - 60*60*24*3`.
+is not in standard library. Using it for making explanation more understandable. It is equivalent to `Time.now - 60*60*24*3`.
 
 **Clear Jobs**
 
-You can clear all failed jobs with this method.
+You can clear all failed jobs with this method:
 
     > cleaner.clear
 
@@ -109,10 +116,25 @@ some examples:
 **Retry and Clear Jobs**
 
 You can retry(requeue) and clear failed jobs at the same time; just pass true
-as an argument. e.g. Retry EmailJob and remove from failed jobs.
+as an argument. 
+
+e.g. Retry EmailJob and remove from failed jobs:
 
     > cleaner.requeue(true) {|j| j.klass?(EmailJob)}
 
+**Retry with other queue**
+
+You can requeue failed jobs into other queue. In this way, you can retry failed
+jobs without blocking jobs being entried by your service running in the live.
+
+e.g. Retry failed jobs on :retry queue
+
+    > cleaner.requeue(false, :queue => :retry)
+
+Don't forget to launch resque worker for the queue.
+
+    % QUEUE=retry rake resque:work
+
 **Select Jobs**
 
 You can just select the jobs of course. Here are some examples:
@@ -123,7 +145,7 @@ You can just select the jobs of course. Here are some examples:
 
 **Helper Methods**
 
-Here is a list of methods a job extended.
+Here is a list of methods a failed job ratained through ResqueCleaner has:
 
     retried?: returns true if the job has already been retried.
     requeued?: alias of retried?.
@@ -136,8 +158,7 @@ Here is a list of methods a job extended.
 Failed Job
 -----------
 
-I show a sample of failed job here; it might help you when you write a block for
-filtering failed jobs.
+Here is a sample of failed jobs:
 
     {"failed_at": "2009/03/13 00:00:00",
      "payload": {"args": ["Johnson"], "class": "BadJob"},
@@ -165,16 +186,16 @@ process but on your Redis, it would not respond ages if you try to deal with all
 of those jobs.
 
 ResqueCleaner supposes recent jobs are more important than old jobs. Therefore
-ResqueCleaner deals with **ONLY LAST X(default=1000)** jobs. In that way, you
-don't have to worry that your block for filtering might be stuck. You can change
-its setting through `limiter` attribute. I will show you how it works with a
-sample situation.
+ResqueCleaner deals with **ONLY LAST X(default=1000) JOBS**. In this way, you
+could avoid slow responses. You can change the number through `limiter` attribute.
+
+Let's see how it works with an follwing example.
 
 **Sample Situation**
 
 * Number of failed jobs: 100,000
 
-Default limiter is 1000 so that it returns 1000 as a count.
+Default limiter is 1000 so that the limiter returns 1000 as a count.
 
     > cleaner.limiter.count
     => 1,000

data/lib/resque_cleaner.rb

@@ -94,8 +94,9 @@ module Resque
       end
 
       # Retries every jobs for which block evaluates to true.
-      def requeue(clear_after_requeue=false, &block)
+      def requeue(clear_after_requeue=false, options={}, &block)
         requeued = 0
+        queue = options["queue"] || options[:queue]
         @limiter.lock do
           @limiter.jobs.each_with_index do |job,i|
             if !block_given? || block.call(job)
@@ -111,7 +112,7 @@ module Resque
                 redis.lset(:failed, @limiter.start_index+i, Resque.encode(job))
               end
 
-              Job.create(job['queue'], job['payload']['class'], *job['payload']['args'])
+              Job.create(queue||job['queue'], job['payload']['class'], *job['payload']['args'])
               requeued += 1
             end
           end

data/test/resque_cleaner_test.rb

@@ -97,6 +97,15 @@ context "ResqueCleaner" do
     assert_equal 0, @cleaner.select.size
   end
 
+  test "#requeue with :queue option requeues the jobs to the queue" do
+    assert_equal 0, queue_size(:jobs,:jobs2,:retry)
+    requeued = @cleaner.requeue false, :queue => :retry
+    assert_equal 42, requeued
+    assert_equal 42, @cleaner.select.size # it doesn't clear jobs
+    assert_equal 0, queue_size(:jobs,:jobs2)
+    assert_equal 42, queue_size(:retry)
+  end
+
   test "#clear_stale deletes failure jobs which is queued before the last x enqueued" do
     @cleaner.limiter.maximum = 10
     @cleaner.clear_stale

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Tatsuya Ono
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +00:00
+date: 2010-11-24 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
         version: "1.0"
   type: :runtime
   version_requirements: *id001
-description: "    ResqueCleaner is a Resque plugin which helps you clean up failure jobs. It provides the following functionalities.\n\n    * Filters failure jobs with an easy and extensible way\n    * Retries failure jobs\n    * Removes failure jobs\n    * Shows stats\n\n"
+description: "    Resque helper plugin cleaning up failed jobs with some neat features such as filtering, retrying, removing and showing stats.\n"
 email: ononoma@gmail.com
 executables: []
 
@@ -42,8 +42,10 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.markdown
+- CHANGELOG.md
 files: 
 - README.markdown
+- CHANGELOG.md
 - Rakefile
 - LICENSE
 - lib/resque-cleaner.rb
@@ -84,6 +86,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A Resque plugin cleaning up failure jobs.
+summary: Resque plugin cleaning up failed jobs.
 test_files: []