resque-forker 1.1.0 → 1.2.0

data/CHANGELOG

@@ -1,10 +1,30 @@
+2010-09-06 v1.2 Capistrano task and script/trigger
+
+Added Capistrano tasks for pausing, resuming, reloading and listing worker
+processes. To use, add this at the top of your Capfile:
+
+  require "resque/capistrano"
+
+And associate your worker instances with the role :worker. The workers will be
+reloaded after deploy:restart, suspended before deploy:web:disable and resumed
+after deploy:web:enable.
+
+Added script/trigger to queue jobs from the command line (but more likely
+cronjob or upstart).
+
+Improved script/worker and /etc/init/workers based on real life experiences.
+And real life production deploys, let me tell you, can be a PITA.
+
+
 2010-08-11 v1.1 Accessible options.
 
 Allows accessing options from forker.
 Allows setting verbose and very_verbose options instead of being magically inferred.
 Allows passing workload to fork! method as an option.
 
+
 2010-08-03 v1.0 First release
 
+
 2010-07-30 v1.0.beta
 Extracted from Flowtown with permission

data/README.rdoc

@@ -1,6 +1,7 @@
 = Resque::Forker
 
-Super awesome forking action for Resque workers.
+Super awesome forking action for {Resque}[http://github.com/defunkt/resque]
+workers.
 
 == Forking Workers
 
@@ -24,17 +25,21 @@ queues) to process.
 Edit this to your needs and place it in script/workers:
 
   #!/usr/bin/env ruby
+  # If using Bundler, you might need to uncomment next two lines
+  #require "bundler"
+  #Bundler.setup
   require "resque/forker"
 
   # Load the application.
   Resque.setup do |forker|
-    require File.dirname(__FILE__) + "/../config/environment"
+    $:.unshift File.dirname(__FILE__) + "/.." # Makes 1.9.2 happy
+    require "config/environment"
     ActiveRecord::Base.connection.disconnect!
+    forker.options.interval = 1
     if Rails.env.production?
       forker.logger = Rails.logger
       forker.workload = ["*"] * 4        # 4 workers on all queues
       forker.user "www-data", "www-data" # don't run as root
-      forker.options.interval = 1
     else
       forker.options.verbose = true
     end
@@ -90,18 +95,20 @@ Of course, you want the workers to start after reboot and each way to control
 them. Read on how to use Resque::Forker with Upstart.
 
 
-== Using Upstart and Capistrano
+== Using Upstart
 
-If you're running a recent release of Ubuntu, you can get Upstart to manage your
-workers.
+If you're running a recent release of Ubuntu, you can get
+{Upstart}[http://upstart.ubuntu.com/] to manage your workers.
 
 Edit this to your needs and place it in /etc/init/workers:
 
   start on runlevel [2345]
   stop on runlevel [06]
+
   chdir /var/www/myapp/current
   env RAILS_ENV=production
   exec script/workers
+
   respawn
 
 After reading this, Upstart to make sure your workers are always up and running.
@@ -115,36 +122,50 @@ To start, stop, check status and reload:
   $ reload workers
 
 You need to be root to start/stop the workers. However, if you change ownership
-of the workers (see fork.user above) you can reload them as that user. You can
-do something like this in your Capfile:
-
-  namespace :workers do
-    task :pause do
-      run "status workers | cut -d ' ' -f 4 | xargs kill -USR2"
-    end
-    task :resume do
-      run "status workers | cut -d ' ' -f 4 | xargs kill -CONT"
-    end
-    task :reload do
-      run "reload workers"
-    end
-  end
-  after "deploy:update_code", "workers:reload"
+of the workers (see fork.user above) you can reload them as that user.
 
 Because of the way Upstart works, there is no need for PID file or running as
 daemon. Yay for sane process supervisors! When you reload workers,
 Resque::Forker reloads itself (and the application) while keeping the same PID.
 
 
+== Using Capistrano
+
+Make sure to require "resque/capistrano" at the top of your
+{Capfile}[http://www.capify.org/] and associate worker instances with the roles
+:worker.
+
+You now have four new task:
+* workers:pid -- Lists PID and additional information for all worker processes.
+* workers:suspend -- Suspends all workers (do not pick any new jobs).
+* workers:resume -- Resumes all workers.
+* workers:reload -- Reloads all workers.
+
+For convenience, the workers:reload task is wired to execute after
+deploy:restart. In addition, workers:suspend executes before
+deploy:web:disable, and workers:resume after deploy:web:enable.
+
+
 == Troubleshooting
  
-If you're using Bundler, you might need to run the script using: 
+If you're using {Bundler}[http://gembundler.com/], you might need to run the
+script {like this}[http://gembundler.com/man/bundle-exec.1.html]: 
 
   exec bundle exec script/workers
 
-If you're using RVM and Bundler, you might need to create a wrapper and use it:
+If you're using {RVM}[http://rvm.beginrescueend.com/] and have a system-wide
+install, you'll want to {create a
+wrapper}[http://rvm.beginrescueend.com/deployment/best-practices/], for
+example:
+
+  $ rvm wrapper 1.9.2 app ruby
+
+Then run the script using the wrapper:
+
+  exec app_ruby script/workers
 
-  exec run_bundle script/workers
+If you're using RVM and Bundler, don't forget to uncomment the relevant lines in
+script/workers.
 
 The point is, when the script starts it will expect both resque and
 resque-forker must be available for loading (that typically means GEMPATH).
@@ -163,4 +184,4 @@ that doesn't have your regular account settings:
 
 == Credits
 
-Copyright (c) 2010 Flowtown, Inc.
+Copyright (c) 2010 {Flowtow, Inc}[http://flowtown.com].

data/Rakefile

@@ -1,4 +1,6 @@
-spec = Gem::Specification.load(File.expand_path("resque-forker.gemspec", File.dirname(__FILE__)))
+require "yard"
+
+spec = Gem::Specification.load(Dir["*.gemspec"].first)
 
 desc "Build the Gem"
 task :build do
@@ -20,3 +22,7 @@ task :push=>["build"] do
   puts "Building and pushing gem .."
   sh "gem push #{spec.name}-#{spec.version}.gem"
 end
+
+YARD::Rake::YardocTask.new do |doc|
+  doc.files = FileList["lib/**/*.rb"]
+end

data/lib/resque/capistrano.rb

@@ -0,0 +1,31 @@
+# Capistrano task for Resque::Forker.
+#
+# To use these tasks, require "resque/capistrano" at the top of the Capfile and
+# associate your woker instances with the role 'workers'.
+#
+# Performs workers:reload after deploy:restart, workers:suspend before
+# deploy:web:disable and workers:resume after deploy:web:enable.
+Capistrano::Configuration.instance(:must_exist).load do
+  after "deploy:restart", "workers:reload"
+  before "deploy:web:disable", "workers:suspend"
+  after "deploy:web:enabled", "workers:resume"
+
+  namespace :workers do
+    desc "Suspend all resque workers"
+    task :suspend, :roles=>:workers do
+      run "status workers | cut -d ' ' -f 4 | xargs kill -USR2"
+    end
+    desc "Resume all workers that have been paused"
+    task :resume, :roles=>:workers do
+      run "status workers | cut -d ' ' -f 4 | xargs kill -CONT"
+    end
+    desc "Reload all workers"
+    task :reload, :roles=>:workers do
+      run "reload workers"
+    end
+    desc "List Resque processes"
+    task :pids, :roles=>:workers do
+      puts capture("ps aux | grep [r]esque")
+    end
+  end
+end

data/lib/resque/forker.rb

@@ -10,7 +10,8 @@ module Resque
   #
   # To use this library, wrap your setup and teardown blocks: 
   #   Resque.setup do |forker|
-  #     require File.dirname(__FILE__) + "/../config/environment"
+  #     $:.unshift File.dirname(__FILE__) + "/.."
+  #     require "config/environment"
   #     ActiveRecord::Base.connection.disconnect!
   #     forker.logger = Rails.logger
   #     forker.user "nobody", "nobody"

data/resque-forker.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |spec|
   spec.name           = "resque-forker"
-  spec.version        = "1.1.0"
+  spec.version        = "1.2.0"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://github.com/flowtown/resque-forker"
   spec.summary        = "Super awesome forking action for Resque workers"
   spec.post_install_message = ""
 
-  spec.files          = Dir["{lib,script}/**/*", "CHANGELOG", "MIT-LICENSE", "README.rdoc", "Rakefile", "resque-forker.gemspec"]
+  spec.files          = Dir["{lib,script}/**/*", "CHANGELOG", "MIT-LICENSE", "README.rdoc", "Rakefile", "*.gemspec"]
 
   spec.has_rdoc         = true
   spec.extra_rdoc_files = "README.rdoc", "CHANGELOG"

data/script/trigger

@@ -0,0 +1,11 @@
+#!ruby
+# Run like this:
+# run /var/app/current/script/trigger <queue> <ClassName> <arg1> ...
+
+# Go here to start from app's root directory.
+Dir.chdir File.expand_path(File.dirname(__FILE__) + "/..")
+# If using Bundler, you might need to uncomment next two lines
+#require "bundler"
+#Bundler.setup
+require "resque"
+Resque::Job.create *ARGV

data/script/workers

@@ -1,15 +1,21 @@
-#!/usr/bin/env ruby
+#!ruby
+# Go here to start from app's root directory.
+Dir.chdir File.expand_path(File.dirname(__FILE__) + "/..")
+# If using Bundler, you might need to uncomment next two lines
+#require "bundler"
+#Bundler.setup
 require "resque/forker"
 
 # Load the application.
 Resque.setup do |forker|
-  require File.dirname(__FILE__) + "/../config/environment"
+  $:.unshift Dir.pwd # Makes 1.9.2 happy
+  require "config/environment"
   ActiveRecord::Base.connection.disconnect!
+  forker.options.interval = 1
   if Rails.env.production?
     forker.logger = Rails.logger
     forker.workload = ["*"] * 4        # 4 workers on all queues
     forker.user "www-data", "www-data" # don't run as root
-    forker.options.interval = 1
   else
     forker.options.verbose = true
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-forker
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-11 00:00:00 -07:00
+date: 2010-09-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,9 @@ extra_rdoc_files:
 - README.rdoc
 - CHANGELOG
 files: 
+- lib/resque/capistrano.rb
 - lib/resque/forker.rb
+- script/trigger
 - script/workers
 - CHANGELOG
 - MIT-LICENSE
@@ -56,7 +58,7 @@ licenses: []
 post_install_message: ""
 rdoc_options: 
 - --title
-- Resque Forker  1.1.0
+- Resque Forker  1.2.0
 - --main
 - README.rdoc
 - --webcvs