resque-multi-job-forks 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gemspec
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mick Staugaard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= 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 simple specify the number of jobs to perform using the JOBS_PER_FORK environment variable:
+
+  QUEUE=* JOBS_PER_FORK=100 rake resque:work
+
+This will have each fork process 100 jobs, before terminating. If less than 100 jobs are enqueued, the fork will terminate when the queue is empty.
+
+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/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-multi-job-forks"
+    gem.version = "0.1.2"
+    gem.summary = %Q{Have your resque workers process more that one job}
+    gem.description = %Q{When your resque jobs are frequent and fast,
+      the overhead of forking and running your after_fork might get too big.}
+    gem.email = "mick@staugaard.com"
+    gem.homepage = "http://github.com/staugaard/resque-multi-job-forks"
+    gem.authors = ["Mick Staugaard"]
+    gem.add_dependency "resque", ">= 1.6.0", "< 1.8.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque-multi-job-forks #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

@@ -0,0 +1,50 @@
+require 'resque'
+require 'resque/worker'
+
+module Resque
+  # 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.
+  def self.before_child_exit(&block)
+    block ? (@before_child_exit = block) : @before_child_exit
+  end
+
+  # Set the before_child_exit proc.
+  def self.before_child_exit=(before_child_exit)
+    @before_child_exit = before_child_exit
+  end
+
+  class Worker
+    attr_accessor :jobs_per_fork
+    attr_reader   :jobs_processed
+
+    unless method_defined?(:done_working_without_multi_job_forks)
+      def done_working_with_multi_job_forks
+        done_working_without_multi_job_forks
+
+        self.jobs_per_fork ||= [ ENV['JOBS_PER_FORK'].to_i, 1 ].max
+        @jobs_processed ||= 0
+
+        @jobs_processed += 1
+
+        if @jobs_processed == 1
+          old_after_fork = Resque.after_fork
+          Resque.after_fork = nil
+          
+          while @jobs_processed < jobs_per_fork && job = reserve
+            process(job)
+          end
+
+          Resque.after_fork = old_after_fork
+
+          run_hook :before_child_exit, self
+          @jobs_processed = 0
+        end
+      end
+      alias_method :done_working_without_multi_job_forks, :done_working
+      alias_method :done_working, :done_working_with_multi_job_forks
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$TESTING = true
+
+require 'resque-multi-job-forks'

data/test/test_resque-multi-job-forks.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class SomeJob
+  def self.perform(i)
+    $SEQUENCE << "work_#{i}".to_sym
+  end
+end
+
+Resque.after_fork do
+  $SEQUENCE << :after_fork
+end
+
+Resque.before_child_exit do |worker|
+  $SEQUENCE << "before_child_exit_#{worker.jobs_processed}".to_sym
+end
+
+class TestResqueMultiJobForks < Test::Unit::TestCase
+  def setup
+    $SEQUENCE = []
+  end
+  
+  def test_sequence_of_events
+    Resque.redis.flush_all
+    
+    ENV['JOBS_PER_FORK'] = '2'
+
+    worker = Resque::Worker.new(:jobs)
+
+    Resque::Job.create(:jobs, SomeJob, 1)
+    Resque::Job.create(:jobs, SomeJob, 2)
+    Resque::Job.create(:jobs, SomeJob, 3)
+
+    worker.work(0)
+
+    assert_equal([:after_fork, :work_1, :work_2, :before_child_exit_2, :after_fork, :work_3, :before_child_exit_1], $SEQUENCE)
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: resque-multi-job-forks
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+    - - <
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id001
+description: |-
+  When your resque jobs are frequent and fast,
+        the overhead of forking and running your after_fork might get too big.
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/resque-multi-job-forks.rb
+- test/helper.rb
+- test/test_resque-multi-job-forks.rb
+has_rdoc: true
+homepage: http://github.com/staugaard/resque-multi-job-forks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Have your resque workers process more that one job
+test_files: 
+- test/helper.rb
+- test/test_resque-multi-job-forks.rb