resque-scheduler 1.9.6 → 1.9.7

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 1.9.7 (2010-11-09)
+
+* Support for rufus-scheduler "every" syntax (fallwith)
+* Ability to pass a Time to handle_delayed_items for testing/staging (rcarver)
+
 ## 1.9.6 (2010-10-08)
 
 * Support for custom job classes (like resque-status) (mattetti)

data/lib/resque/scheduler.rb

@@ -60,13 +60,20 @@ module Resque
           # to.
           if config['rails_env'].nil? || rails_env_matches?(config)
             log! "Scheduling #{name} "
-            if !config['cron'].nil? && config['cron'].length > 0
-              rufus_scheduler.cron config['cron'] do
-                log! "queuing #{config['class']} (#{name})"
-                enqueue_from_config(config)
+            interval_defined = false
+            interval_types = %w{cron every}
+            interval_types.each do |interval_type|
+              if !config[interval_type].nil? && config[interval_type].length > 0
+                rufus_scheduler.send(interval_type, config[interval_type]) do
+                  log! "queueing #{config['class']} (#{name})"
+                  enqueue_from_config(config)
+                end
+                interval_defined = true
+                break
               end
-            else
-              log! "no cron found for #{config['class']} (#{name}) - skipping"
+            end
+            unless interval_defined
+              log! "no #{interval_types.join(' / ')} found for #{config['class']} (#{name}) - skipping"
             end
           end
         end
@@ -79,10 +86,11 @@ module Resque
       end
 
       # Handles queueing delayed items
-      def handle_delayed_items
-        item = nil
+      # at_time - Time to start scheduling items (default: now).
+      def handle_delayed_items(at_time=nil)
+        timestamp = nil
         begin
-          if timestamp = Resque.next_delayed_timestamp
+          if timestamp = Resque.next_delayed_timestamp(at_time)
             enqueue_delayed_items_for_timestamp(timestamp)
           end
         # continue processing until there are no more ready timestamps

data/lib/resque_scheduler.rb

@@ -18,6 +18,8 @@ module ResqueScheduler
   #
   # :name can be anything and is used only to describe the scheduled job
   # :cron can be any cron scheduling string :job can be any resque job class
+  # :every can be used in lieu of :cron. see rufus-scheduler's 'every' usage for 
+  #   valid syntax. If :cron is present it will take precedence over :every.
   # :class must be a resque worker class
   # :args can be any yaml which will be converted to a ruby literal and passed
   #   in a params. (optional)
@@ -89,8 +91,8 @@ module ResqueScheduler
 
   # Returns the next delayed queue timestamp
   # (don't call directly)
-  def next_delayed_timestamp
-    items = redis.zrangebyscore :delayed_queue_schedule, '-inf', Time.now.to_i, :limit => [0, 1]
+  def next_delayed_timestamp(at_time=nil)
+    items = redis.zrangebyscore :delayed_queue_schedule, '-inf', (at_time || Time.now).to_i, :limit => [0, 1]
     timestamp = items.nil? ? nil : Array(items).first
     timestamp.to_i unless timestamp.nil?
   end

data/lib/resque_scheduler/server/views/scheduler.erb

@@ -10,7 +10,7 @@
     <th></th>
     <th>Name</th>
     <th>Description</th>
-    <th>Cron</th>
+    <th>Interval</th>
     <th>Class</th>
     <th>Queue</th>
     <th>Arguments</th>
@@ -26,7 +26,9 @@
       </td>
       <td><%= h name %></td>
       <td><%= h config['description'] %></td>
-      <td style="white-space:nowrap"><%= h config['cron'] %></td>
+      <td style="white-space:nowrap"><%= (config['cron'].nil? && !config['every'].nil?) ?
+                                         h('every: ' + config['every']) : 
+                                         h('cron: ' + config['cron']) %></td>
       <td><%= h config['class'] %></td>
       <td><%= h config['queue'] || queue_from_class_name(config['class']) %></td>
       <td><%= h config['args'].inspect %></td>

data/lib/resque_scheduler/version.rb

@@ -1,3 +1,3 @@
 module ResqueScheduler
-  Version = '1.9.6'
+  Version = '1.9.7'
 end

data/resque-scheduler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-scheduler}
-  s.version = "1.9.6"
+  s.version = "1.9.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben VandenBos"]
-  s.date = %q{2010-10-08}
+  s.date = %q{2010-11-10}
   s.description = %q{Light weight job scheduling on top of Resque.
   Adds methods enqueue_at/enqueue_in to schedule jobs in the future.
   Also supports queueing jobs on a fixed, cron-like schedule.}

data/test/delayed_queue_test.rb

@@ -50,6 +50,16 @@ class Resque::DelayedQueueTest < Test::Unit::TestCase
     assert_nil(read_timestamp, "No timestamps should be ready for queueing")
   end
 
+  def test_something_in_the_future_comes_out_if_you_want_it_to
+    timestamp = Time.now + 600 # 10 minutes from now
+
+    Resque.enqueue_at(timestamp, SomeIvarJob, "path")
+
+    read_timestamp = Resque.next_delayed_timestamp(timestamp)
+
+    assert_equal(timestamp.to_i, read_timestamp, "The timestamp we pull out of redis should match the one we put in")
+  end
+
   def test_enqueue_at_and_enqueue_in_are_equivelent
     timestamp = Time.now + 60
 
@@ -120,6 +130,17 @@ class Resque::DelayedQueueTest < Test::Unit::TestCase
     Resque.expects(:queue_from_class).never # Should NOT need to load the class
     Resque::Scheduler.handle_delayed_items
   end
+
+  def test_handle_delayed_items_with_items_in_the_future
+    t = Time.now + 60 # in the future
+    Resque.enqueue_at(t, SomeIvarJob)
+    Resque.enqueue_at(t, SomeIvarJob)
+
+    # 2 SomeIvarJob jobs should be created in the "ivar" queue
+    Resque::Job.expects(:create).twice.with('ivar', 'SomeIvarJob', nil)
+    Resque.expects(:queue_from_class).never # Should NOT need to load the class
+    Resque::Scheduler.handle_delayed_items(t)
+  end
   
   def test_enqueue_delayed_items_for_timestamp
     t = Time.now + 60

data/test/scheduler_test.rb

@@ -14,7 +14,12 @@ class Resque::SchedulerTest < Test::Unit::TestCase
     Resque::Job.stubs(:create).once.returns(true).with('joes_queue', 'BigJoesJob', '/tmp')
     Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'BigJoesJob', 'args' => "/tmp", 'queue' => 'joes_queue')
   end
-  
+
+  def test_enqueue_from_config_with_every_syntax
+    Resque::Job.stubs(:create).once.returns(true).with('james_queue', 'JamesJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('every' => '1m', 'class' => 'JamesJob', 'args' => '/tmp', 'queue' => 'james_queue')
+  end
+
   def test_enqueue_from_config_puts_stuff_in_the_resque_queue
     Resque::Job.stubs(:create).once.returns(true).with(:ivar, 'SomeIvarJob', '/tmp')
     Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-scheduler
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 1
   - 9
-  - 6
-  version: 1.9.6
+  - 7
+  version: 1.9.7
 platform: ruby
 authors: 
 - Ben VandenBos
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 -07:00
+date: 2010-11-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency