brianjlandau-resque-scheduler 1.10.2 → 1.10.3

data/README.markdown

@@ -140,20 +140,11 @@ environment variable, the job won't be loaded.
 
 ### Dynamic Schedules
 
-If you need schedules that are defined based on user interactions inside of your application, this can be completed by loading it initially wherever you configure Resque and defining `Resque.reload_schedule!`:
+If needed you can also have schedules that are dynamically defined and updated inside of your application. This can be completed by loading the schedule initially wherever you configure Resque and setting `Resque::Scheduler.dynamic` to `true`. Then subsequently updating the "`schedule`" key in redis (namespaced to the Resque namespace) with a JSON encoded version of the schedule hash will cause the schedule to be updated.
 
-    module Resque
-      def self.reload_schedule!
-        self.schedule = MyScheduleModel.all.inject({}) {|schedule_hash, record| 
-          schedule_hash[record.name.to_sym] = record.attributes.select{|key, value| key != 'name' }
-          schedule_hash
-        }
-      end
-    end
-    
-    Resque.reload_schedule!
+When the scheduler loops it will look for differences between the existing schedule and the current schedule in redis. If there are differences it will make the necessary changes to the running schedule.
 
-To have the scheduler reload the schedule you just send it the `USR2` signal.
+To force the scheduler to reload the schedule you just send it the `USR2` signal.
 
 ### Support for customized Job classes
 

data/brianjlandau-resque-scheduler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{brianjlandau-resque-scheduler}
-  s.version = "1.10.2"
+  s.version = "1.10.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben VandenBos", "Brian Landau"]
-  s.date = %q{2010-10-18}
+  s.date = %q{2010-10-20}
   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/lib/resque/scheduler.rb

@@ -14,6 +14,14 @@ module Resque
       
       # If set, produces no output
       attr_accessor :mute
+      
+      # If set, will try to update the schulde in the loop
+      attr_accessor :dynamic
+      
+      # the Rufus::Scheduler jobs that are scheduled
+      def scheduled_jobs
+        @@scheduled_jobs
+      end
 
       # Schedule all jobs and continually look for delayed jobs (never returns)
       def run
@@ -27,6 +35,7 @@ module Resque
         # Now start the scheduling part of the loop.
         loop do
           handle_delayed_items
+          update_schedule if dynamic
           poll_sleep
         end
 
@@ -53,22 +62,29 @@ module Resque
       # rufus scheduler instance
       def load_schedule!
         log! "Schedule empty! Set Resque.schedule" if Resque.schedule.empty?
-
+        
+        @@scheduled_jobs = {}
+        
         Resque.schedule.each do |name, config|
-          # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as
-          # required for the jobs to be scheduled.  If rails_env is missing, the
-          # job should be scheduled regardless of what ENV['RAILS_ENV'] is set
-          # 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)
-              end
-            else
-              log! "no cron found for #{config['class']} (#{name}) - skipping"
+          load_schedule_job(name, config)
+        end
+      end
+      
+      # Loads a job schedule into the Rufus::Scheduler and stores it in @@scheduled_jobs
+      def load_schedule_job(name, config)
+        # If rails_env is set in the config, enforce ENV['RAILS_ENV'] as
+        # required for the jobs to be scheduled.  If rails_env is missing, the
+        # job should be scheduled regardless of what ENV['RAILS_ENV'] is set
+        # to.
+        if config['rails_env'].nil? || rails_env_matches?(config)
+          log! "Scheduling #{name} "
+          if !config['cron'].nil? && config['cron'].length > 0
+            @@scheduled_jobs[name] = rufus_scheduler.cron config['cron'] do
+              log! "queuing #{config['class']} (#{name})"
+              enqueue_from_config(config)
             end
+          else
+            log! "no cron found for #{config['class']} (#{name}) - skipping"
           end
         end
       end
@@ -150,6 +166,34 @@ module Resque
         Resque.reload_schedule!
         load_schedule!
       end
+      
+      def update_schedule
+        schedule_from_redis = Resque.decode(Resque.redis.get(:schedule))
+        if !schedule_from_redis.nil? && !schedule_from_redis.empty? && schedule_from_redis != Resque.schedule
+          # unload schedules that no longer exist
+          (Resque.schedule.keys - schedule_from_redis.keys).each do |name|
+            unschedule_job(name)
+          end
+          
+          # find changes and stop and reload or add new
+          schedule_from_redis.each do |name, config|
+            if (Resque.schedule[name].nil? || Resque.schedule[name].empty?) || (config != Resque.schedule[name])
+              unschedule_job(name)
+              load_schedule_job(name, config)
+            end
+          end
+          
+          # load new schedule into Resque.schedule
+          Resque.schedule = schedule_from_redis
+        end
+      end
+      
+      def unschedule_job(name)
+        if scheduled_jobs[name]
+          scheduled_jobs[name].unschedule
+          @@scheduled_jobs.delete(name)
+        end
+      end
 
       # Sleeps and returns true
       def poll_sleep

data/lib/resque_scheduler.rb

@@ -33,6 +33,11 @@ module ResqueScheduler
   def schedule
     @schedule ||= {}
   end
+  
+  # reloads the schedule from redis
+  def reload_schedule!
+    @schedule = decode(redis.get(:schedule))
+  end
 
   # This method is nearly identical to +enqueue+ only it also
   # takes a timestamp which will be used to schedule the job

data/lib/resque_scheduler/version.rb

@@ -1,3 +1,3 @@
 module ResqueScheduler
-  Version = '1.10.2'
+  Version = '1.10.3'
 end

data/test/scheduler_test.rb

@@ -1,11 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-module ::Resque
-  def self.reload_schedule!
-    self.schedule = {:some_ivar_job2 => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}}
-  end
-end
-
 class Resque::SchedulerTest < Test::Unit::TestCase
 
   class FakeJob
@@ -13,7 +7,9 @@ class Resque::SchedulerTest < Test::Unit::TestCase
   end
 
   def setup
+    Resque::Scheduler.mute = true
     Resque::Scheduler.clear_schedule!
+    Resque::Scheduler.send(:class_variable_set, :@@scheduled_jobs, {})
   end
 
   def test_enqueue_from_config_puts_stuff_in_the_resque_queue_without_class_loaded
@@ -76,19 +72,110 @@ class Resque::SchedulerTest < Test::Unit::TestCase
     Resque::Scheduler.load_schedule!
 
     assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.include?(:some_ivar_job)
   end
   
   def test_can_reload_schedule
-    Resque.schedule = {:some_ivar_job => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque.schedule = {"some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}}
+    Resque.redis.set(:schedule, Resque.encode({
+      "some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"}
+    }))
+  
     Resque::Scheduler.load_schedule!
 
     assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.include?("some_ivar_job")
+    
+    Resque.redis.set(:schedule, Resque.encode({
+      "some_ivar_job2" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"}
+    }))
     
     Resque::Scheduler.reload_schedule!
     
     assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
     
-    assert_equal '/tmp/2', Resque.schedule[:some_ivar_job2]["args"]
+    assert_equal '/tmp/2', Resque.schedule["some_ivar_job2"]["args"]
+    assert Resque::Scheduler.scheduled_jobs.include?("some_ivar_job2")
+  end
+  
+  def test_load_schedule_job
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.scheduled_jobs.size)
+    assert Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_load_schedule_job_with_no_cron
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_load_schedule_job_with_blank_cron
+    Resque::Scheduler.load_schedule_job("some_ivar_job", {'cron' => '', 'class' => 'SomeIvarJob', 'args' => "/tmp"})
+    
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("some_ivar_job")
+  end
+  
+  def test_update_schedule
+    Resque.schedule = {
+      "some_ivar_job"    => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"},
+      "another_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/5"},
+      "stay_put_job"     => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }
+    
+    Resque::Scheduler.load_schedule!
+    
+    Resque.redis.set(:schedule, Resque.encode({
+      "some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"},
+      "new_ivar_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"},
+      "stay_put_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }))
+    
+    Resque::Scheduler.update_schedule
+    
+    assert_equal(3, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(3, Resque::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Resque::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Resque.schedule.keys.include?(job_name)
+    end
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Resque.schedule.keys.include?("another_ivar_job")
+  end
+  
+  def test_update_schedule_with_mocks
+    Resque.schedule = {
+      "some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp"},
+      "another_ivar_job"  => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/5"},
+      "stay_put_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }
+    
+    Resque::Scheduler.load_schedule!
+    
+    Resque::Scheduler.rufus_scheduler.expects(:unschedule).with(Resque::Scheduler.scheduled_jobs["some_ivar_job"].job_id)
+    Resque::Scheduler.rufus_scheduler.expects(:unschedule).with(Resque::Scheduler.scheduled_jobs["another_ivar_job"].job_id)
+    
+    Resque.redis.set(:schedule, Resque.encode({
+      "some_ivar_job" => {'cron' => "* * * * *", 'class' => 'SomeIvarJob', 'args' => "/tmp/2"},
+      "new_ivar_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp/3"},
+      "stay_put_job"  => {'cron' => "* * * * *", 'class' => 'SomeJob', 'args' => "/tmp"}
+    }))
+    
+    Resque::Scheduler.update_schedule
+    
+    assert_equal(3, Resque::Scheduler.scheduled_jobs.size)
+    %w(some_ivar_job new_ivar_job stay_put_job).each do |job_name|
+      assert Resque::Scheduler.scheduled_jobs.keys.include?(job_name)
+      assert Resque.schedule.keys.include?(job_name)
+    end
+    assert !Resque::Scheduler.scheduled_jobs.keys.include?("another_ivar_job")
+    assert !Resque.schedule.keys.include?("another_ivar_job")
   end
 
   def test_adheres_to_lint

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brianjlandau-resque-scheduler
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 57
   prerelease: false
   segments: 
   - 1
   - 10
-  - 2
-  version: 1.10.2
+  - 3
+  version: 1.10.3
 platform: ruby
 authors: 
 - Ben VandenBos
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-18 00:00:00 -04:00
+date: 2010-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency