resque-scheduler 1.9.5 → 1.9.6

data/HISTORY.md

@@ -1,7 +1,12 @@
-## 1.9.5 (???)
+## 1.9.6 (2010-10-08)
+
+* Support for custom job classes (like resque-status) (mattetti)
+
+## 1.9.5 (2010-09-09)
 
 * Updated scheduler rake task to allow for an alternate setup task
   to avoid loading the entire stack. (chewbranca)
+* Fixed sig issue on win32 (#25)
 
 ## 1.9.4 (2010-07-29)
 

data/README.markdown

@@ -138,6 +138,40 @@ Multiple envs are allowed, separated by commas:
 NOTE: If you specify the `rails_env` arg without setting RAILS_ENV as an 
 environment variable, the job won't be loaded.
 
+### Support for customized Job classes
+
+Some Resque extensions like [resque-status](http://github.com/quirkey/resque-status) use custom job classes with a slightly different API signature.
+Resque-scheduler isn't trying to support all existing and future custom job classes, instead it supports a schedule flag so you can extend your custom class
+and make it support scheduled job.
+
+Let's pretend we have a JobWithStatus class called FakeLeaderboard
+
+		class FakeLeaderboard < Resque::JobWithStatus
+			def perfom
+				# do something and keep track of the status
+			end
+		end
+
+    create_fake_leaderboards:
+      cron: "30 6 * * 1"
+      queue: scoring
+      custom_job_class: FakeLeaderboard
+      args: 
+      rails_env: demo
+      description: "This job will auto-create leaderboards for our online demo and the status will update as the worker makes progress"
+
+If your extension doesn't support scheduled job, you would need to extend the custom job class to support the #scheduled method:
+
+    module Resque
+      class JobWithStatus
+        # Wrapper API to forward a Resque::Job creation API call into a JobWithStatus call.
+        def self.scheduled(queue, klass, *args)
+          create(args)
+        end
+      end
+    end
+
+
 Resque-web additions
 --------------------
 
@@ -199,6 +233,10 @@ any nonempty value, they will take effect.  `VERBOSE` simply dumps more output
 to stdout.  `MUTE` does the opposite and silences all output. `MUTE` supercedes
 `VERBOSE`.
 
+NOTE: You DO NOT want to run >1 instance of the scheduler.  Doing so will result
+in the same job being queued more than once.  You only need one instnace of the
+scheduler running per resque instance (regardless of number of machines).
+
 
 Plagurism alert
 ---------------

data/Rakefile

@@ -1,4 +1,4 @@
-load 'tasks/resque_scheduler.rake'
+load File.expand_path('tasks/resque_scheduler.rake')
 
 $LOAD_PATH.unshift 'lib'
 
@@ -7,7 +7,7 @@ task :default => :test
 desc "Run tests"
 task :test do
   Dir['test/*_test.rb'].each do |f|
-    require f
+    require File.expand_path(f)
   end
 end
 

data/lib/resque/scheduler.rb

@@ -97,7 +97,13 @@ module Resque
             if item = Resque.next_item_for_timestamp(timestamp)
               log "queuing #{item['class']} [delayed]"
               queue = item['queue'] || Resque.queue_from_class(constantize(item['class']))
-              Job.create(queue, item['class'], *item['args'])
+              # Support custom job classes like job with status
+              if (job_klass = item['custom_job_class']) && (job_klass != 'Resque::Job')
+                # custom job classes not supporting the same API calls must implement the #schedule method
+                constantize(job_klass).scheduled(queue, item['class'], *item['args'])
+              else
+                Resque::Job.create(queue, item['class'], *item['args'])
+              end
             end
           end
         # continue processing until there are no more ready items in this timestamp
@@ -116,7 +122,13 @@ module Resque
         klass_name = config['class'] || config[:class]
         params = args.nil? ? [] : Array(args)
         queue = config['queue'] || config[:queue] || Resque.queue_from_class(constantize(klass_name))
-        Resque::Job.create(queue, klass_name, *params)
+        # Support custom job classes like job with status
+        if (job_klass = config['custom_job_class']) && (job_klass != 'Resque::Job')
+          # custom job classes not supporting the same API calls must implement the #schedule method
+          constantize(job_klass).scheduled(queue, klass_name, *params)
+        else
+          Resque::Job.create(queue, klass_name, *params)
+        end        
       end
 
       def rufus_scheduler

data/lib/resque_scheduler/version.rb

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

data/resque-scheduler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-scheduler}
-  s.version = "1.9.5"
+  s.version = "1.9.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben VandenBos"]
-  s.date = %q{2010-09-09}
+  s.date = %q{2010-10-08}
   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/scheduler_test.rb

@@ -2,6 +2,10 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class Resque::SchedulerTest < Test::Unit::TestCase
 
+  class FakeJob
+    def self.scheduled(queue, klass, *args); end
+  end
+
   def setup
     Resque::Scheduler.clear_schedule!
   end
@@ -15,6 +19,11 @@ class Resque::SchedulerTest < Test::Unit::TestCase
     Resque::Job.stubs(:create).once.returns(true).with(:ivar, 'SomeIvarJob', '/tmp')
     Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp")
   end
+  
+  def test_enqueue_from_config_with_custom_class_job_in_the_resque_queue
+    FakeJob.stubs(:scheduled).once.returns(true).with(:ivar, 'SomeIvarJob', '/tmp')
+    Resque::Scheduler.enqueue_from_config('cron' => "* * * * *", 'class' => 'SomeIvarJob', 'custom_job_class' => 'Resque::SchedulerTest::FakeJob', 'args' => "/tmp")
+  end
 
   def test_enqueue_from_config_puts_stuff_in_the_resque_queue_when_env_match
     # The job should be loaded : its rails_env config matches the RAILS_ENV variable:

metadata

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