mongo-resque 1.19.0.1 → 1.20.0

data/HISTORY.md

@@ -1,3 +1,21 @@
+## 1.20.0 (2012-04-10)
+
+* Fixed demos for ruby 1.9 (@BMorearty, #445)
+* Web UI: optional trailing slashes of URLs (@elisehuard, #449)
+* Allow * to appear anywhere in queue list (@tapajos, #405, #407)
+* Wait for child with specific PID (@jacobkg)
+* #decode raise takes a string when re-raising as a different exception class (Trevor Hart)
+* Use Sinatra's `public_folder` if it exists (@defunkt, #420, #421)
+* Assign the job's worker before calling `before_fork` (@quirkey)
+* Fix Resque::Helpers#constantize to work correctly on 1.9.2 (@rtlong)
+* Added before & after hooks for dequeue (@humancopy, #398)
+* daemonize support using `ENV["BACKGROUND"]` (@chrisleishman)
+* Added `Resque.enqueue_to`: allows you to specif the queue and still run hooks (@dan-g)
+* Web UI: Set the default encoding to UTF-8 (@elubow)
+* fix finding worker pids on JRuby (John Andrews + Andrew Grieser)
+* Added better failure hooks (@raykrueger)
+* Added before & after dequeue hooks (@humancopy)
+
 ## 1.19.1 (2011-10-07)
 
 * Change mongo gem dependency to include all 1.x versions from 1.3

data/bin/resque-web

@@ -18,6 +18,6 @@ Vegas::Runner.new(Resque::Server, 'resque-web', {
 }) do |runner, opts, app|
   opts.on('-N NAMESPACE', "--namespace NAMESPACE", "set the Mongo database") {|namespace|
     runner.logger.info "Using Mongo database '#{namespace}'"
-    Resque.mongo = Resque.mongo.conn.db(namespace)
+    Resque.mongo = Resque.mongo.connection.db(namespace)
   }
 end

data/docs/HOOKS.md

@@ -86,7 +86,7 @@ The available hooks are:
   `Resque::Failure` backend.
 
 * `on_failure`: Called with the exception and job args if any exception occurs
-  while performing the job (or hooks).
+  while performing the job (or hooks), this includes Resque::DirtyExit.
 
 Hooks are easily implemented with superclasses or modules. A superclass could
 look something like this.

data/lib/resque.rb

@@ -271,19 +271,37 @@ module Resque
   #
   # If no queue can be inferred this method will raise a `Resque::NoQueueError`
   #
+  # Returns true if the job was queued, nil if the job was rejected by a
+  # before_enqueue hook.
+  #
   # This method is considered part of the `stable` API.
   def enqueue(klass, *args)
+    enqueue_to(queue_from_class(klass), klass, *args)
+  end
+
+  # Just like `enqueue` but allows you to specify the queue you want to
+  # use. Runs hooks.
+  #
+  # `queue` should be the String name of the queue you're targeting.
+  #
+  # Returns true if the job was queued, nil if the job was rejected by a
+  # before_enqueue hook.
+  #
+  # This method is considered part of the `stable` API.
+  def enqueue_to(queue, klass, *args)
     # Perform before_enqueue hooks. Don't perform enqueue if any hook returns false
     before_hooks = Plugin.before_enqueue_hooks(klass).collect do |hook|
       klass.send(hook, *args)
     end
-    return if before_hooks.any? { |result| result == false }
+    return nil if before_hooks.any? { |result| result == false }
+
+    Job.create(queue, klass, *args)
 
-    Job.create(queue_from_class(klass), klass, *args)
-    
     Plugin.after_enqueue_hooks(klass).each do |hook|
       klass.send(hook, *args)
     end
+
+    return true
   end
   
   def enqueue_delayed(klass, *args)
@@ -318,7 +336,17 @@ module Resque
   #
   # This method is considered part of the `stable` API.
   def dequeue(klass, *args)
+    # Perform before_dequeue hooks. Don't perform dequeue if any hook returns false
+    before_hooks = Plugin.before_dequeue_hooks(klass).collect do |hook|
+      klass.send(hook, *args)
+    end
+    return if before_hooks.any? { |result| result == false }
+
     Job.destroy(queue_from_class(klass), klass, *args)
+
+    Plugin.after_dequeue_hooks(klass).each do |hook|
+      klass.send(hook, *args)
+    end
   end
 
   # Given a class, try to extrapolate an appropriate queue based on a

data/lib/resque/helpers.rb

@@ -37,7 +37,7 @@ module Resque
       begin
         ::MultiJson.decode(object)
       rescue ::MultiJson::DecodeError => e
-        raise DecodeException, e
+        raise DecodeException, e.message, e.backtrace
       end
     end
 
@@ -48,9 +48,23 @@ module Resque
       dashed_word.split('-').each { |part| part[0] = part[0].chr.upcase }.join
     end
 
-    # Given a camel cased word, returns the constant it represents
+    # Tries to find a constant with the name specified in the argument string:
     #
-    # constantize('JobName') # => JobName
+    # constantize("Module") # => Module
+    # constantize("Test::Unit") # => Test::Unit
+    #
+    # The name is assumed to be the one of a top-level constant, no matter
+    # whether it starts with "::" or not. No lexical context is taken into
+    # account:
+    #
+    # C = 'outside'
+    # module M
+    #   C = 'inside'
+    #   C # => 'inside'
+    #   constantize("C") # => 'outside', same as ::C
+    # end
+    #
+    # NameError is raised when the constant is unknown.
     def constantize(camel_cased_word)
       camel_cased_word = camel_cased_word.to_s
 
@@ -63,7 +77,13 @@ module Resque
 
       constant = Object
       names.each do |name|
-        constant = constant.const_get(name) || constant.const_missing(name)
+        args = Module.method(:const_get).arity != 1 ? [false] : []
+
+        if constant.const_defined?(name, *args)
+          constant = constant.const_get(name)
+        else
+          constant = constant.const_missing(name)
+        end
       end
       constant
     end

data/lib/resque/job.rb

@@ -116,11 +116,6 @@ module Resque
       job_args = args || []
       job_was_performed = false
 
-      before_hooks  = Plugin.before_hooks(job)
-      around_hooks  = Plugin.around_hooks(job)
-      after_hooks   = Plugin.after_hooks(job)
-      failure_hooks = Plugin.failure_hooks(job)
-
       begin
         # Execute before_perform hook. Abort the job gracefully if
         # Resque::DontPerform is raised.
@@ -168,7 +163,7 @@ module Resque
       # If an exception occurs during the job execution, look for an
       # on_failure hook then re-raise.
       rescue Object => e
-        failure_hooks.each { |hook| job.send(hook, e, *job_args) }
+        run_failure_hooks(e)
         raise e
       end
     end
@@ -186,6 +181,7 @@ module Resque
     # Given an exception object, hands off the needed parameters to
     # the Failure module.
     def fail(exception)
+      run_failure_hooks(exception)
       Failure.create \
         :payload   => payload,
         :exception => exception,
@@ -211,5 +207,27 @@ module Resque
         payload_class == other.payload_class &&
         args == other.args
     end
+
+    def before_hooks
+      @before_hooks ||= Plugin.before_hooks(payload_class)
+    end
+
+    def around_hooks
+      @around_hooks ||= Plugin.around_hooks(payload_class)
+    end
+
+    def after_hooks
+      @after_hooks ||= Plugin.after_hooks(payload_class)
+    end
+
+    def failure_hooks 
+      @failure_hooks ||= Plugin.failure_hooks(payload_class)
+    end
+    
+    def run_failure_hooks(exception)
+      job_args = args || []
+      failure_hooks.each { |hook| payload_class.send(hook, exception, *job_args) }
+    end
+
   end
 end

data/lib/resque/plugin.rb

@@ -52,5 +52,15 @@ module Resque
     def before_enqueue_hooks(job)
       job.methods.grep(/^before_enqueue/).sort
     end
+
+    # Given an object, returns a list `after_dequeue` hook names.
+    def after_dequeue_hooks(job)
+      job.methods.grep(/^after_dequeue/).sort
+    end
+
+    # Given an object, returns a list `before_dequeue` hook names.
+    def before_dequeue_hooks(job)
+      job.methods.grep(/^before_dequeue/).sort
+    end
   end
 end

data/lib/resque/server.rb

@@ -4,12 +4,22 @@ require 'resque'
 require 'resque/version'
 require 'time'
 
+if defined? Encoding
+  Encoding.default_external = Encoding::UTF_8
+end
+
 module Resque
   class Server < Sinatra::Base
     dir = File.dirname(File.expand_path(__FILE__))
 
     set :views,  "#{dir}/server/views"
-    set :public, "#{dir}/server/public"
+
+    if respond_to? :public_folder
+      set :public_folder, "#{dir}/server/public"
+    else
+      set :public, "#{dir}/server/public"
+    end
+
     set :static, true
 
     helpers do
@@ -177,21 +187,21 @@ module Resque
     end
 
     %w( overview workers ).each do |page|
-      get "/#{page}.poll" do
+      get "/#{page}.poll/?" do
         show_for_polling(page)
       end
 
-      get "/#{page}/:id.poll" do
+      get "/#{page}/:id.poll/?" do
         show_for_polling(page)
       end
     end
 
     %w( overview queues working workers key ).each do |page|
-      get "/#{page}" do
+      get "/#{page}/?" do
         show page
       end
 
-      get "/#{page}/:id" do
+      get "/#{page}/:id/?" do
         show page
       end
     end
@@ -201,7 +211,7 @@ module Resque
       redirect u('queues')
     end
 
-    get "/failed" do
+    get "/failed/?" do
       if Resque::Failure.url
         redirect Resque::Failure.url
       else
@@ -221,7 +231,7 @@ module Resque
       redirect u('failed')
     end
 
-    get "/failed/requeue/:index" do
+    get "/failed/requeue/:index/?" do
       Resque::Failure.requeue(params[:index])
       if request.xhr?
         return Resque::Failure.all(params[:index])['retried_at']
@@ -230,24 +240,24 @@ module Resque
       end
     end
 
-    get "/failed/remove/:index" do
+    get "/failed/remove/:index/?" do
       Resque::Failure.remove(params[:index])
       redirect u('failed')
     end
 
-    get "/stats" do
+    get "/stats/?" do
       redirect url_path("/stats/resque")
     end
 
-    get "/stats/:id" do
+    get "/stats/:id/?" do
       show :stats
     end
 
-    get "/stats/keys/:key" do
+    get "/stats/keys/:key/?" do
       show :stats
     end
 
-    get "/stats.txt" do
+    get "/stats.txt/?" do
       info = Resque.info
 
       stats = []

data/lib/resque/server/public/style.css

@@ -48,6 +48,7 @@ body { padding:0; margin:0; }
 
 
 #main table.workers td.icon {width:1%; background:#efefef;text-align:center;}
+#main table.workers td.icon img { height: 16px; width: 16px; }
 #main table.workers td.where { width:25%;}
 #main table.workers td.queues { width:35%;}
 #main .queue-tag { background:#b1d2e9; padding:2px; margin:0 3px; font-size:80%; text-decoration:none; text-transform:uppercase; font-weight:bold; color:#3274a2; -webkit-border-radius:4px; -moz-border-radius:4px;}

data/lib/resque/tasks.rb

@@ -18,6 +18,13 @@ namespace :resque do
       abort "set QUEUE env var, e.g. $ QUEUE=critical,high rake resque:work"
     end
 
+    if ENV['BACKGROUND']
+      unless Process.respond_to?('daemon')
+        abort "env var BACKGROUND is set, which requires ruby >= 1.9"
+      end
+      Process.daemon(true)
+    end
+
     if ENV['PIDFILE']
       File.open(ENV['PIDFILE'], 'w') { |f| f << worker.pid }
     end

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  Version = VERSION = '1.19.0.1'
+  Version = VERSION = '1.20.0'
 end

data/lib/resque/worker.rb

@@ -24,13 +24,13 @@ module Resque
 
     # Returns an array of all worker objects.
     def self.all
-      mongo_workers.distinct(:worker).map{|worker| find(worker)}.compact
+      mongo_workers.distinct(:worker).map { |worker| find(worker) }.compact
     end
 
     # Returns an array of all worker objects currently processing
     # jobs.
     def self.working
-      working = mongo_workers.find({ 'working_on' => { '$exists' => true}}).to_a.map{|w| find(w['worker'])}
+      mongo_workers.find('working_on' => { '$exists' => true }).to_a.map { |w| find(w['worker']) }
     end
 
     # Returns a single worker object. Accepts a string id.
@@ -53,7 +53,7 @@ module Resque
     # Given a string worker id, return a boolean indicating whether the
     # worker exists
     def self.exists?(worker_id)
-      mongo_workers.find({ :worker => worker_id.to_s}).count > 0
+      mongo_workers.find(:worker => worker_id.to_s).count > 0
     end
 
     # Workers should be initialized with an array of string queue
@@ -108,13 +108,14 @@ module Resque
 
         if not paused? and job = reserve
           log "got: #{job.inspect}"
+          job.worker = self
           run_hook :before_fork, job
           working_on job
 
           if @child = fork
             srand # Reseeding
             procline "Forked #{@child} at #{Time.now.to_i}"
-            Process.wait
+            Process.wait(@child)
           else
             procline "Processing #{job.queue} since #{Time.now.to_i}"
             perform(job, &block)
@@ -140,6 +141,7 @@ module Resque
     def process(job = nil, &block)
       return unless job ||= reserve
 
+      job.worker = self
       working_on job
       perform(job, &block)
     ensure
@@ -188,7 +190,7 @@ module Resque
     # A splat ("*") means you want every queue (in alpha order) - this
     # can be useful for dynamically adding new queues.
     def queues
-      @queues[0] == "*" ? Resque.queues.sort : @queues
+      @queues.map {|queue| queue == "*" ? Resque.queues.sort : queue }.flatten.uniq
     end
 
     # Not every platform supports fork. Here we do our magic to
@@ -366,7 +368,6 @@ module Resque
     # Given a job, tells Mongo we're working on it. Useful for seeing
     # what workers are doing and when.
     def working_on(job)
-      job.worker = self
       data = { :queue   => job.queue,
                :run_at  => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
                :payload => job.payload }
@@ -459,7 +460,7 @@ module Resque
 
     # Returns Integer PID of running worker
     def pid
-      @pid ||= to_s.split(":")[1].to_i
+      Process.pid
     end
 
     # Returns an Array of string pids of all the other workers on this
@@ -477,7 +478,7 @@ module Resque
     # Returns an Array of string pids of all the other workers on this
     # machine. Useful when pruning dead workers on startup.
     def linux_worker_pids
-      `ps -A -o pid,command | grep [r]esque | grep -v "resque-web"`.split("\n").map do |line|
+      `ps -A -o pid,command | grep "[r]esque" | grep -v "resque-web"`.split("\n").map do |line|
         line.split(' ')[0]
       end
     end
@@ -487,7 +488,7 @@ module Resque
     # Returns an Array of string pids of all the other workers on this
     # machine. Useful when pruning dead workers on startup.
     def solaris_worker_pids
-      `ps -A -o pid,comm | grep [r]uby | grep -v "resque-web"`.split("\n").map do |line|
+      `ps -A -o pid,comm | grep "[r]uby" | grep -v "resque-web"`.split("\n").map do |line|
         real_pid = line.split(' ')[0]
         pargs_command = `pargs -a #{real_pid} 2>/dev/null | grep [r]esque | grep -v "resque-web"`
         if pargs_command.split(':')[1] == " resque-#{Resque::Version}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo-resque
 version: !ruby/object:Gem::Version
-  version: 1.19.0.1
+  version: 1.20.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-07 00:00:00.000000000Z
+date: 2012-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &2158173220 !ruby/object:Gem::Requirement
+  requirement: &70251593593060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2158173220
+  version_requirements: *70251593593060
 - !ruby/object:Gem::Dependency
   name: vegas
-  requirement: &2158172720 !ruby/object:Gem::Requirement
+  requirement: &70251593592440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2158172720
+  version_requirements: *70251593592440
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2158172260 !ruby/object:Gem::Requirement
+  requirement: &70251593591880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *2158172260
+  version_requirements: *70251593591880
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2158171800 !ruby/object:Gem::Requirement
+  requirement: &70251593591240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158171800
+  version_requirements: *70251593591240
 description: ! "    Resque is a Redis-backed Ruby library for creating background
   jobs,\n    placing those jobs on multiple queues, and processing them later.\n\n
   \   Mongo-Resque is the same thing, but for mongo. It would not exist\n    without
@@ -127,15 +127,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2109137887324305574
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2109137887324305574
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Mongo-Resque is a mongo-backed queueing system