resque 1.13.0 → 1.14.0

data/HISTORY.md

@@ -1,3 +1,16 @@
+## 1.14.0 (2011-03-17)
+
+* Sleep interval can now be a float
+* Added Resque.inline to allow in-process performing of jobs (for testing)
+* Fixed tests for Ruby 1.9.2
+* Added Resque.validate(klass) to validate a Job
+* Decode errors are no longer ignored to help debugging
+* Web: Sinatra 1.2 compatibility
+* Fixed after_enqueue hook to actually run in `Resque.enqueue`
+* Fixed very_verbose timestamps to use 24 hour time (AM/PM wasn't included)
+* Fixed monit example
+* Fixed Worker#pid
+
 ## 1.13.0 (2011-02-07)
 
 * Depend on redis-namespace >= 0.10

data/README.markdown

@@ -662,6 +662,11 @@ this way we can tell our Sinatra app about the config file:
 
 Now everyone is on the same page.
 
+Also, you could disable jobs queueing by setting 'inline' attribute.
+For example, if you want to run all jobs in the same process for cucumber, try:
+
+    Resque.inline = ENV['RAILS_ENV'] == "cucumber"
+
 
 Plugins and Hooks
 -----------------

data/Rakefile

@@ -3,7 +3,6 @@
 #
 
 load 'tasks/redis.rake'
-require 'rake/testtask'
 
 $LOAD_PATH.unshift 'lib'
 require 'resque/tasks'
@@ -17,14 +16,22 @@ end
 # Tests
 #
 
+require 'rake/testtask'
+
 task :default => :test
 
-desc "Run the test suite"
-task :test do
-  rg = command?(:rg)
-  Dir['test/**/*_test.rb'].each do |f|
-    rg ? sh("rg #{f}") : ruby(f)
+if command?(:rg)
+  desc "Run the test suite with rg"
+  task :test do
+    Dir['test/**/*_test.rb'].each do |f|
+      sh("rg #{f}")
+    end
   end
+else
+  Rake::TestTask.new do |test|
+    test.libs << "test"
+    test.test_files = FileList['test/**/*_test.rb']
+  end  
 end
 
 if command? :kicker

data/lib/resque.rb

@@ -118,6 +118,17 @@ module Resque
     "Resque Client connected to #{redis_id}"
   end
 
+  # If 'inline' is true Resque will call #perform method inline
+  # without queuing it into Redis and without any Resque callbacks.
+  # The 'inline' is false Resque jobs will be put in queue regularly.
+  def inline?
+    @inline
+  end
+  alias_method :inline, :inline?
+
+  def inline=(inline)
+    @inline = inline
+  end
 
   #
   # queue manipulation
@@ -204,6 +215,10 @@ module Resque
   # This method is considered part of the `stable` API.
   def enqueue(klass, *args)
     Job.create(queue_from_class(klass), klass, *args)
+
+    Plugin.after_enqueue_hooks(klass).each do |hook|
+      klass.send(hook, *args)
+    end
   end
 
   # This method can be used to conveniently remove a job from a queue.
@@ -253,6 +268,23 @@ module Resque
     Job.reserve(queue)
   end
 
+  # Validates if the given klass could be a valid Resque job
+  #
+  # If no queue can be inferred this method will raise a `Resque::NoQueueError`
+  #
+  # If given klass is nil this method will raise a `Resque::NoClassError`
+  def validate(klass, queue = nil)
+    queue ||= queue_from_class(klass)
+
+    if !queue
+      raise NoQueueError.new("Jobs must be placed onto a queue.")
+    end
+
+    if klass.to_s.empty?
+      raise NoClassError.new("Jobs must be given a class.")
+    end
+  end
+
 
   #
   # worker shortcuts

data/lib/resque/failure.rb

@@ -62,5 +62,9 @@ module Resque
     def self.requeue(index)
       backend.requeue(index)
     end
+
+    def self.remove(index)
+      backend.remove(index)
+    end
   end
 end

data/lib/resque/failure/base.rb

@@ -52,6 +52,9 @@ module Resque
       def self.requeue(index)
       end
 
+      def self.remove(index)
+      end
+
       # Logging!
       def log(message)
         @worker.log(message)

data/lib/resque/failure/hoptoad.rb

@@ -109,6 +109,7 @@ module Resque
           end
           x.tag!("server-environment") do
             x.tag!("environment-name",server_environment)
+            x.tag!("project-root", "RAILS_ROOT")
           end
 
         end

data/lib/resque/failure/redis.rb

@@ -35,6 +35,12 @@ module Resque
         Resque.redis.lset(:failed, index, Resque.encode(item))
         Job.create(item['queue'], item['payload']['class'], *item['payload']['args'])
       end
+
+      def self.remove(index)
+        id = rand(0xffffff)
+        Resque.redis.lset(:failed, index, id)
+        Resque.redis.lrem(:failed, 1, id)
+      end
     end
   end
 end

data/lib/resque/helpers.rb

@@ -1,6 +1,8 @@
 module Resque
   # Methods used by various classes in Resque.
   module Helpers
+    class DecodeException < StandardError; end
+
     # Direct access to the Redis instance.
     def redis
       Resque.redis
@@ -23,12 +25,14 @@ module Resque
       if defined? Yajl
         begin
           Yajl::Parser.parse(object, :check_utf8 => false)
-        rescue Yajl::ParseError
+        rescue Yajl::ParseError => e
+          raise DecodeException, e
         end
       else
         begin
           JSON.parse(object)
-        rescue JSON::ParserError
+        rescue JSON::ParserError => e
+          raise DecodeException, e
         end
       end
     end

data/lib/resque/job.rb

@@ -40,19 +40,13 @@ module Resque
     #
     # Raises an exception if no queue or class is given.
     def self.create(queue, klass, *args)
-      if !queue
-        raise NoQueueError.new("Jobs must be placed onto a queue.")
-      end
-
-      if klass.to_s.empty?
-        raise NoClassError.new("Jobs must be given a class.")
-      end
+      Resque.validate(klass, queue)
 
-      ret = Resque.push(queue, :class => klass.to_s, :args => args)
-      Plugin.after_enqueue_hooks(klass).each do |hook|
-        klass.send(hook, *args)
+      if Resque.inline?
+        constantize(klass).perform(*decode(encode(args)))
+      else
+        Resque.push(queue, :class => klass.to_s, :args => args)
       end
-      ret
     end
 
     # Removes a job from a queue. Expects a string queue name, a

data/lib/resque/server.rb

@@ -16,17 +16,17 @@ module Resque
       alias_method :h, :escape_html
 
       def current_section
-        url request.path_info.sub('/','').split('/')[0].downcase
+        url_path request.path_info.sub('/','').split('/')[0].downcase
       end
 
       def current_page
-        url request.path_info.sub('/','')
+        url_path request.path_info.sub('/','')
       end
 
-      def url(*path_parts)
+      def url_path(*path_parts)
         [ path_prefix, path_parts ].join("/").squeeze('/')
       end
-      alias_method :u, :url
+      alias_method :u, :url_path
 
       def path_prefix
         request.env['SCRIPT_NAME']
@@ -38,7 +38,7 @@ module Resque
 
       def tab(name)
         dname = name.to_s.downcase
-        path = url(dname)
+        path = url_path(dname)
         "<li #{class_if_current(path)}><a href='#{path}'>#{name}</a></li>"
       end
 
@@ -127,7 +127,7 @@ module Resque
 
     # to make things easier on ourselves
     get "/?" do
-      redirect url(:overview)
+      redirect url_path(:overview)
     end
 
     %w( overview queues working workers key ).each do |page|
@@ -175,8 +175,13 @@ module Resque
       end
     end
 
+    get "/failed/remove/:index" do
+      Resque::Failure.remove(params[:index])
+      redirect u('failed')
+    end
+
     get "/stats" do
-      redirect url("/stats/resque")
+      redirect url_path("/stats/resque")
     end
 
     get "/stats/:id" do

data/lib/resque/server/public/ranger.js

@@ -50,6 +50,12 @@ $(function() {
     return false
   })
 
+  $('ul.failed li').hover(function() {
+    $(this).addClass('hover');
+  }, function() {
+    $(this).removeClass('hover');
+  })
+
   $('ul.failed a[rel=retry]').click(function() {
     var href = $(this).attr('href');
     $(this).text('Retrying...');

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

@@ -67,7 +67,11 @@ body { padding:0; margin:0; }
 #main ul.failed li {background:-webkit-gradient(linear, left top, left bottom, from(#efefef), to(#fff)) #efefef; margin-top:10px; padding:10px; overflow:hidden; -webkit-border-radius:5px; border:1px solid #ccc; }
 #main ul.failed li dl dt {font-size:80%; color:#999; width:60px; float:left; padding-top:1px; text-align:right;}
 #main ul.failed li dl dd {margin-bottom:10px; margin-left:70px;}
-#main ul.failed li dl dd .retry { float: right; }
+#main ul.failed li dl dd .retried { float:right; text-align: right; }
+#main ul.failed li dl dd .retried .remove { display:none; margin-top: 8px; }
+#main ul.failed li.hover dl dd .retried .remove { display:block; }
+#main ul.failed li dl dd .controls { display:none; float:right; }
+#main ul.failed li.hover dl dd .controls { display:block; }
 #main ul.failed li dl dd code, #main ul.failed li dl dd pre { font-family:Monaco, "Courier New", monospace; font-size:90%;}
 #main ul.failed li dl dd.error a {font-family:Monaco, "Courier New", monospace; font-size:90%; }
 #main ul.failed li dl dd.error pre { margin-top:3px; line-height:1.3;}

data/lib/resque/server/views/failed.erb

@@ -16,22 +16,31 @@
     <% index += 1 %>
     <li>
       <dl>
+        <% if job.nil? %>
+        <dt>Error</dt>
+        <dd>Job <%= index%> could not be parsed; perhaps it contains invalid JSON?</dd>
+        <% else %>
         <dt>Worker</dt>
         <dd>
-          <a href="<%= url(:workers, job['worker']) %>"><%= job['worker'].split(':')[0...2].join(':') %></a> on <b class='queue-tag'><%= job['queue'] %></b > at <b><span class="time"><%= job['failed_at'] %></span></b>
-          <div class='retry'>
-            <% if job['retried_at'] %>
+          <a href="<%= u(:workers, job['worker']) %>"><%= job['worker'].split(':')[0...2].join(':') %></a> on <b class='queue-tag'><%= job['queue'] %></b > at <b><span class="time"><%= job['failed_at'] %></span></b>
+          <% if job['retried_at'] %>
+            <div class='retried'>
               Retried <b><span class="time"><%= job['retried_at'] %></span></b>
-            <% else %>
+              <a href="<%= u "failed/remove/#{start + index - 1}" %>" class="remove" rel="remove">Remove</a>
+            </div>
+          <% else %>
+            <div class='controls'>
               <a href="<%= u "failed/requeue/#{start + index - 1}" %>" rel="retry">Retry</a>
-            <% end %>
-          </div>
+              or
+              <a href="<%= u "failed/remove/#{start + index - 1}" %>" rel="remove">Remove</a>
+            </div>
+          <% end %>
         </dd>
         <dt>Class</dt>
         <dd><code><%= job['payload'] ? job['payload']['class'] : 'nil' %></code></dd>
         <dt>Arguments</dt>
         <dd><pre><%=h job['payload'] ? show_args(job['payload']['args']) : 'nil' %></pre></dd>
-        <dt>Exception</td>
+        <dt>Exception</dt>
         <dd><code><%= job['exception'] %></code></dd>
         <dt>Error</dt>
         <dd class='error'>
@@ -42,6 +51,7 @@
             <%=h job['error'] %>
           <% end %>
         </dd>
+        <% end %>
       </dl>
       <div class='r'>
       </div>

data/lib/resque/server/views/queues.erb

@@ -36,12 +36,12 @@
     </tr>
     <% for queue in resque.queues.sort_by { |q| q.to_s } %>
     <tr>
-      <td class='queue'><a class="queue" href="<%= url "queues/#{queue}" %>"><%= queue %></a></td>
+      <td class='queue'><a class="queue" href="<%= u "queues/#{queue}" %>"><%= queue %></a></td>
       <td class='size'><%= resque.size queue %></td>
     </tr>
     <% end %>
     <tr class="<%= Resque::Failure.count.zero? ? "failed" : "failure" %>">
-      <td class='queue failed'><a class="queue" href="<%= url :failed %>">failed</a></td>
+      <td class='queue failed'><a class="queue" href="<%= u :failed %>">failed</a></td>
       <td class='size'><%= Resque::Failure.count %></td>
     </tr>
   </table>

data/lib/resque/server/views/workers.erb

@@ -95,12 +95,12 @@
     </tr>
     <% for hostname, workers in worker_hosts.sort_by { |h,w| h } %>
     <tr>
-      <td class='queue'><a class="queue" href="<%= url "workers/#{hostname}" %>"><%= hostname %></a></td>
+      <td class='queue'><a class="queue" href="<%= u "workers/#{hostname}" %>"><%= hostname %></a></td>
       <td class='size'><%= workers.size %></td>
     </tr>
     <% end %>
     <tr class="failed">
-      <td class='queue failed'><a class="queue" href="<%= url "workers/all" %>">all workers</a></td>
+      <td class='queue failed'><a class="queue" href="<%= u "workers/all" %>">all workers</a></td>
       <td class='size'><%= Resque.workers.size %></td>
     </tr>
   </table>

data/lib/resque/tasks.rb

@@ -19,7 +19,7 @@ namespace :resque do
     end
 
     if ENV['PIDFILE']
-      File.open(ENV['PIDFILE'], 'w') { |f| f << Process.pid.to_s }
+      File.open(ENV['PIDFILE'], 'w') { |f| f << worker.pid }
     end
 
     worker.log "Starting worker #{worker}"

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  Version = VERSION = '1.13.0'
+  Version = VERSION = '1.14.0'
 end

data/lib/resque/worker.rb

@@ -102,13 +102,14 @@ module Resque
     # 2. Work loop: Jobs are pulled from a queue and processed.
     # 3. Teardown:  This worker is unregistered.
     #
-    # Can be passed an integer representing the polling frequency.
+    # Can be passed a float representing the polling frequency.
     # The default is 5 seconds, but for a semi-active site you may
     # want to use a smaller value.
     #
     # Also accepts a block which will be passed the job as soon as it
     # has completed processing. Useful for testing.
-    def work(interval = 5, &block)
+    def work(interval = 5.0, &block)
+      interval = Float(interval)
       $0 = "resque: Starting"
       startup
 
@@ -133,10 +134,10 @@ module Resque
           done_working
           @child = nil
         else
-          break if interval.to_i == 0
-          log! "Sleeping for #{interval.to_i}"
+          break if interval.zero?
+          log! "Sleeping for #{interval} seconds"
           procline @paused ? "Paused" : "Waiting for #{@queues.join(',')}"
-          sleep interval.to_i
+          sleep interval
         end
       end
 
@@ -453,7 +454,7 @@ module Resque
     # The string representation is the same as the id for this worker
     # instance. Can be used with `Worker.find`.
     def to_s
-      @to_s ||= "#{hostname}:#{pid}:#{@queues.join(',')}"
+      @to_s ||= "#{hostname}:#{Process.pid}:#{@queues.join(',')}"
     end
     alias_method :id, :to_s
 
@@ -462,9 +463,9 @@ module Resque
       @hostname ||= `hostname`.chomp
     end
 
-    # Returns PID of running worker
+    # Returns Integer PID of running worker
     def pid
-      @pid ||= Process.pid
+      @pid ||= to_s.split(":")[1].to_i
     end
 
     # Returns an array of string pids of all the other workers on this
@@ -488,7 +489,7 @@ module Resque
       if verbose
         puts "*** #{message}"
       elsif very_verbose
-        time = Time.now.strftime('%I:%M:%S %Y-%m-%d')
+        time = Time.now.strftime('%H:%M:%S %Y-%m-%d')
         puts "** [#{time}] #$$: #{message}"
       end
     end

data/test/job_hooks_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 context "Resque::Job before_perform" do
   include PerformJob
@@ -232,6 +232,7 @@ context "Resque::Job after_enqueue" do
   include PerformJob
 
   class ::AfterEnqueueJob
+    @queue = :jobs
     def self.after_enqueue_record_history(history)
       history << :after_enqueue
     end
@@ -243,7 +244,7 @@ context "Resque::Job after_enqueue" do
   test "the after enqueue hook should run" do
     history = []
     @worker = Resque::Worker.new(:jobs)
-    Resque::Job.create(:jobs, AfterEnqueueJob, history)
+    Resque.enqueue(AfterEnqueueJob, history)
     @worker.work(0)
     assert_equal history, [:after_enqueue], "after_enqueue was not run"
   end

data/test/job_plugins_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 context "Multiple plugins with multiple hooks" do
   include PerformJob
@@ -45,7 +45,7 @@ context "Resque::Plugin ordering before_perform" do
     end
   end
 
-  class ::BeforePerformJob
+  class ::JobPluginsTestBeforePerformJob
     extend BeforePerformPlugin
     def self.perform(history)
       history << :perform
@@ -56,7 +56,7 @@ context "Resque::Plugin ordering before_perform" do
   end
 
   test "before_perform hooks are executed in order" do
-    result = perform_job(BeforePerformJob, history=[])
+    result = perform_job(JobPluginsTestBeforePerformJob, history=[])
     assert_equal true, result, "perform returned true"
     assert_equal [:before_perform, :before_perform1, :perform], history
   end
@@ -71,7 +71,7 @@ context "Resque::Plugin ordering after_perform" do
     end
   end
 
-  class ::AfterPerformJob
+  class ::JobPluginsTestAfterPerformJob
     extend AfterPerformPlugin
     def self.perform(history)
       history << :perform
@@ -82,7 +82,7 @@ context "Resque::Plugin ordering after_perform" do
   end
 
   test "after_perform hooks are executed in order" do
-    result = perform_job(AfterPerformJob, history=[])
+    result = perform_job(JobPluginsTestAfterPerformJob, history=[])
     assert_equal true, result, "perform returned true"
     assert_equal [:perform, :after_perform, :after_perform1], history
   end
@@ -111,7 +111,7 @@ context "Resque::Plugin ordering around_perform" do
     assert_equal [:around_perform_plugin1, :perform], history
   end
 
-  class ::AroundPerformJob
+  class ::JobPluginsTestAroundPerformJob
     extend AroundPerformPlugin1
     def self.perform(history)
       history << :perform
@@ -123,7 +123,7 @@ context "Resque::Plugin ordering around_perform" do
   end
 
   test "around_perform hooks are executed in order" do
-    result = perform_job(AroundPerformJob, history=[])
+    result = perform_job(JobPluginsTestAroundPerformJob, history=[])
     assert_equal true, result, "perform returned true"
     assert_equal [:around_perform, :around_perform_plugin1, :perform], history
   end

data/test/plugin_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 context "Resque::Plugin finding hooks" do
   module SimplePlugin

data/test/resque-web_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 require 'resque/server/test_helper'
  
 # Root path test

data/test/resque_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 context "Resque" do
   setup do
@@ -8,7 +8,7 @@ context "Resque" do
     Resque.push(:people, { 'name' => 'bob' })
     Resque.push(:people, { 'name' => 'mark' })
   end
-  
+
   test "can set a namespace through a url-like string" do
     assert Resque.redis
     assert_equal :resque, Resque.redis.namespace
@@ -128,6 +128,12 @@ context "Resque" do
     end
   end
 
+  test "validates job for queue presence" do
+    assert_raises Resque::NoQueueError do
+      Resque.validate(SomeJob)
+    end
+  end
+
   test "can put items on a queue" do
     assert Resque.push(:people, { 'name' => 'jon' })
   end
@@ -227,6 +233,18 @@ context "Resque" do
   end
 
   test "decode bad json" do
-    assert_nil Resque.decode("{\"error\":\"Module not found \\u002\"}")
+    assert_raises Resque::Helpers::DecodeException do
+      Resque.decode("{\"error\":\"Module not found \\u002\"}")
+    end
+  end
+
+  test "inlining jobs" do
+    begin
+      Resque.inline = true
+      Resque.enqueue(SomeIvarJob, 20, '/tmp')
+      assert_equal 0, Resque.size(:ivar)
+    ensure
+      Resque.inline = false
+    end
   end
-end
+end

data/test/test_helper.rb

@@ -66,6 +66,8 @@ def context(*args, &block)
   end
   (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
   klass.class_eval &block
+  # XXX: In 1.8.x, not all tests will run unless anonymous classes are kept in scope.
+  ($test_classes ||= []) << klass
 end
 
 ##
@@ -128,3 +130,16 @@ def with_failure_backend(failure_backend, &block)
 ensure
   Resque::Failure.backend = previous_backend
 end
+
+class Time
+  # Thanks, Timecop
+  class << self
+    alias_method :now_without_mock_time, :now
+
+    def now_with_mock_time
+      $fake_time || now_without_mock_time
+    end
+
+    alias_method :now, :now_with_mock_time
+  end
+end

data/test/worker_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require 'test_helper'
 
 context "Resque::Worker" do
   setup do
@@ -301,6 +301,19 @@ context "Resque::Worker" do
     assert $BEFORE_FORK_CALLED
   end
 
+  test "very verbose works in the afternoon" do
+    require 'time'
+    $last_puts = ""
+    $fake_time = Time.parse("15:44:33 2011-03-02")
+    singleton = class << @worker; self end
+    singleton.send :define_method, :puts, lambda { |thing| $last_puts = thing }
+
+    @worker.very_verbose = true
+    @worker.log("some log text")
+
+    assert_match /\*\* \[15:44:33 2011-03-02\] \d+: some log text/, $last_puts
+  end
+
   test "Will call an after_fork hook after forking" do
     Resque.redis.flushall
     $AFTER_FORK_CALLED = false
@@ -314,6 +327,6 @@ context "Resque::Worker" do
   end
 
   test "returns PID of running process" do
-    assert_equal Process.pid, @worker.pid
+    assert_equal @worker.to_s.split(":")[1].to_i, @worker.pid
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque
 version: !ruby/object:Gem::Version 
-  hash: 35
+  hash: 47
   prerelease: false
   segments: 
   - 1
-  - 13
+  - 14
   - 0
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 -08:00
+date: 2011-03-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency