resque-jobs-per-fork 0.3.0

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) 2010 Sam Granieri (Inspired by 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,37 @@
+= resque-jobs-per-fork
+
+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 jobs you want each fork to run using the JOBS_PER_FORK environment variable:
+
+  QUEUE=* JOBS_PER_FORK=5 rake resque:work
+
+You *have* to specify JOBS_PER_FORK environment variable or else your jobs won't run with this gem
+
+This will have each fork 5 jobs, before terminating.
+
+This plugin also defines 2 new hooks that get called after the fork starts and before the fork terminates
+
+  Resque.before_perform_jobs_per_fork do |worker|
+    worker.log("Your message here")
+  end
+  
+  Resque.after_perform_jobs_per_fork do |worker|
+    worker.log("Your message here")
+  end
+  
+Version 0.3.0 works on Resque 1.8.x 
+
+== 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 Sam Granieri (Inspired by 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-jobs-per-fork"
+    gem.version     = "0.3.0"
+    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       = "sam@samgranieri.com"
+    gem.homepage    = "http://github.com/samgranieri/resque-jobs-per-fork"
+    gem.authors     = ["Sam Granieri, Mick Staugaard"]
+    gem.add_dependency "resque", "~> 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-jobs-per-fork #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/resque-jobs-per-fork.rb

@@ -0,0 +1,55 @@
+require 'resque'
+require 'resque/worker'
+
+
+module Resque
+  
+  # the `before_perform_jobs_per_fork` hook will run in the child perform
+  # right before the child perform starts
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def self.before_perform_jobs_per_fork(&block)
+    block ? (@before_perform_jobs_per_fork = block) : @before_perform_jobs_per_fork
+  end
+
+  # Set the before_perform_jobs_per_fork proc.
+  def self.before_perform_jobs_per_fork=(before_perform_jobs_per_fork)
+    @before_perform_jobs_per_fork = before_perform_jobs_per_fork
+  end
+  
+  # the `after_perform_jobs_per_fork` hook will run in the child perform
+  # right before the child perform terminates
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def self.after_perform_jobs_per_fork(&block)
+    block ? (@after_perform_jobs_per_fork = block) : @after_perform_jobs_per_fork
+  end
+  
+  # Set the after_perform_jobs_per_fork proc.
+  def self.after_perform_jobs_per_fork=(after_perform_jobs_per_fork)
+    @after_perform_jobs_per_fork = after_perform_jobs_per_fork
+  end
+  
+  class Worker
+    
+    def perform_with_jobs_per_fork(job)
+      raise "You need to set JOBS_PER_FORK on the command line" unless ENV['JOBS_PER_FORK']
+      run_hook :before_perform_jobs_per_fork, self
+      jobs_performed ||= 0
+      while jobs_performed < ENV['JOBS_PER_FORK'].to_i do
+        if jobs_performed == 0
+          perform_without_jobs_per_fork(job)
+        elsif another_job = reserve
+          perform_without_jobs_per_fork(another_job)
+        end
+        jobs_performed += 1
+      end
+      jobs_performed = nil
+      run_hook :after_perform_jobs_per_fork, self
+    end
+    alias_method :perform_without_jobs_per_fork, :perform
+    alias_method :perform, :perform_with_jobs_per_fork
+  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-jobs-per-fork'

data/test/test_resque-jobs-per-fork.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class SomeJob
+  def self.perform(i)
+    $SEQUENCE << "work_#{i}".to_sym
+    puts 'working...'
+    sleep(0.1)
+  end
+end
+
+Resque.before_perform_jobs_per_fork do |worker|
+  $SEQUENCE << "before_perform_jobs_per_fork".to_sym
+end
+
+Resque.after_perform_jobs_per_fork do |worker|
+  $SEQUENCE << "after_perform_jobs_per_fork".to_sym
+end
+
+class TestResqueMultiJobFork < Test::Unit::TestCase
+  def setup
+    $SEQUENCE = []
+    Resque.redis.flushdb
+    ENV['JOBS_PER_FORK'] = '2'
+    @worker = Resque::Worker.new(:jobs)
+  end
+
+  def test_one_job
+    Resque::Job.create(:jobs, SomeJob, 1)
+    @worker.work(0)
+    assert_equal([:before_perform_jobs_per_fork, :work_1, :after_perform_jobs_per_fork], $SEQUENCE)
+  end
+
+  def test_two_jobs
+    Resque::Job.create(:jobs, SomeJob, 1)
+    Resque::Job.create(:jobs, SomeJob, 2)
+    @worker.work(0)
+    assert_equal([:before_perform_jobs_per_fork, :work_1, :work_2, :after_perform_jobs_per_fork], $SEQUENCE)
+  end
+
+  def test_three_jobs
+    Resque::Job.create(:jobs, SomeJob, 1)
+    Resque::Job.create(:jobs, SomeJob, 2)
+    Resque::Job.create(:jobs, SomeJob, 3)
+    @worker.work(0)
+    assert_equal([:before_perform_jobs_per_fork, :work_1, :work_2, :after_perform_jobs_per_fork, 
+      :before_perform_jobs_per_fork, :work_3, :after_perform_jobs_per_fork], $SEQUENCE)
+  end
+
+  def test_work_normally_if_env_var_set
+    assert_nothing_raised(RuntimeError) do
+      Resque::Job.create(:jobs, SomeJob, 1)
+      @worker.work(0)
+    end
+  end
+
+  def test_crash_if_no_env_var_set
+    ENV.delete('JOBS_PER_FORK')
+    assert_raise(RuntimeError) do
+      Resque::Job.create(:jobs, SomeJob, 1)
+      @worker.work(0)
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: resque-jobs-per-fork
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Sam Granieri, Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-29 00:00:00 -05: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
+        - 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: sam@samgranieri.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/resque-jobs-per-fork.rb
+- test/helper.rb
+- test/test_resque-jobs-per-fork.rb
+has_rdoc: true
+homepage: http://github.com/samgranieri/resque-jobs-per-fork
+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-jobs-per-fork.rb