lantins-resque-multi-job-forks 0.3.0 → 0.3.1

data/README.md

@@ -0,0 +1,64 @@
+resque-multi-job-forks
+======================
+
+If you have very frequent and fast resque jobs, the overhead of forking and
+running your after_fork hook, might get too big. Using this resque plugin, you
+can have your workers perform more than one job, before terminating.
+
+Install & Quick Start
+---------------------
+
+To install:
+
+    $ gem install lantins-resque-multi-job-forks
+
+You'll need to require the code; perhaps inside your `resque:setup` hook of
+your `Rakefile` ?:
+
+    namespace :resque do
+      task :setup do
+        require 'resque-multi-job-forks'
+      end
+    end
+
+### Limit Per Fork
+
+You have two limit options available, only one can be used at once.
+
+  * `JOBS_PER_FORK` - number of jobs to process per fork.
+  * `MINUTES_PER_FORK` - process jobs for *n* minutes per fork.
+
+**Default:** process jobs for *1 minute* before terminating.
+
+You may specify the limit by setting the appropriate each variable:
+
+    # process jobs for 5 minutes, then terminate the fork.
+    QUEUE=* MINUTES_PER_FORK=5 rake resque:work
+
+    # process 5000 jobs per fork, then terminate.
+    QUEUE=* JOBS_PER_FORK=5000 rake resque:work
+
+### Resque Hooks
+
+This plugin also defines a new hook, that gets called right before the fork
+terminates:
+
+    Resque.before_child_exit do |worker|
+      worker.log("#{worker.jobs_processed} were processed in this fork")
+    end
+
+Note on Patches/Pull Requests
+-----------------------------
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history.
+    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 Mick Staugaard. See LICENSE for details.

data/lib/resque-multi-job-forks.rb

@@ -2,10 +2,13 @@ require 'resque'
 require 'resque/worker'
 
 module Resque
+
+  # Add support to allow a single fork to process multiple jobs.
+  # You may limit the fork to n minutes of execution time, or a total job limit.
   class Worker
-    attr_accessor :seconds_per_fork
-    attr_accessor :jobs_per_fork
-    attr_reader   :jobs_processed
+    attr_accessor :seconds_per_fork # seconds fork may process jobs for.
+    attr_accessor :jobs_per_fork    # total jobs to process per fork.
+    attr_reader   :jobs_processed   # jobs processed by this fork.
 
     unless method_defined?(:shutdown_without_multi_job_forks)
       def perform_with_multi_job_forks(job = nil)
@@ -70,8 +73,8 @@ module Resque
     end
   end
 
-  # the `before_child_exit` hook will run in the child process
-  # right before the child process terminates
+  # the `before_child_exit` hook will run in the child process right before
+  # the child process terminates.
   #
   # Call with a block to set the hook.
   # Call with no arguments to return the hook.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lantins-resque-multi-job-forks
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Mick Staugaard
@@ -75,12 +75,12 @@ extra_rdoc_files: []
 files: 
 - LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - test/helper.rb
 - test/test_resque-multi-job-forks.rb
 - lib/resque-multi-job-forks.rb
 has_rdoc: false
-homepage: http://github.com/lantins/lantins-resque-multi-job-forks
+homepage: http://github.com/lantins/resque-multi-job-forks/tree/personal_gem
 licenses: []
 
 post_install_message: 

data/README.rdoc

@@ -1,30 +0,0 @@
-= resque-multi-job-forks
-
-If you have very frequent and fast resque jobs, the overhead of forking and running your after_fork hook, might get too big. Using this resque plugin, you can have your workers perform more than one job, before terminating.
-
-You simply specify the number of minutes you want each fork to run using the MINUTES_PER_FORK environment variable:
-
-  QUEUE=* MINUTES_PER_FORK=5 rake resque:work
-
-This will have each fork process jobs for 5 minutes, before terminating.
-
-This plugin also defines a new hook, that gets called right before the fork terminates:
-
-  Resque.before_child_exit do |worker|
-    worker.log("#{worker.jobs_processed} were processed in this fork")
-  end
-  
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Mick Staugaard. See LICENSE for details.