resque-scheduler 3.1.0 → 4.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzhjNDEyNjkyZWQ5MGY0YWUxNWNmN2JiMTAzODdhOGUyZTAyZTA1YQ==
+    YWQ5NjY1MDg2NGNmODVkNWQxZDNmOWJjNzAxMWRjMGNjZWFhM2RiNg==
   data.tar.gz: !binary |-
-    NTQzOWY4MDliZjUxZDhlMTZjYTc4OWM0NWVjMTA5MTVmZmJkYzQ1ZA==
+    ZWZiZjMwYWRkMzRlOWQxYzViN2EzOGU0MDAwMTAzMTM4NTY5OTNkZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDE1ZTBlZjlkOWM1MDEwMjc3Y2I2MWExNTNiNjFlMDUyNjY1YzZlMmYxYWQ0
-    MjdkMjQ3OTA0N2FhYjk4NWI5NTdkZmM2ODYwNTMzNGM4OTExNDdkMjA5ZjI1
-    MWI2Y2ExOWZkM2EyZjkxNTVlNTViODExNDYwZjk4OTAyMWM5YWI=
+    YWY0MjRlNjcyOWZjODM5YWNlYjFlNDM5ZGU1NjFjYmQwZDQ2NDY0YWFiMmJh
+    ZTkwMWJiYzljMGQ4MTI1MDY0NjA2ZWM1NGNjNjgwZDU1ZTIxZDk4N2ZmNjk4
+    ZWFjZjhkOTEyOWJmMDQ2YjBiY2MxMzBkYTg1ZjEzOGYzZDJhNDc=
   data.tar.gz: !binary |-
-    YzE3OTNjODE1YWI5NWQwNmNjZDJlMDM0Yjg2ZTAwZGRkMzA2NzY3NTc4ZjI4
-    NGQ4Y2Q4ZDM1NWUxNDViYjk3YmI1M2E5ZDMwYjAzMTk4MWYwZjMzNGVmNmE5
-    YTAyYWI4NGI1Zjc1M2U1MzgxZTk4NWNiODYzZDQyODFkM2M2MWM=
+    OTQ4NjVhMjZjYTEwMDYyOGMwODBkMmQ2MGUyNDIzYTgyNjI1NmNhZjg2MzRm
+    NWI3Mjk2MGM4N2E2MjhkY2IwNjlkYjZlYWZmY2Q2ZTFhY2Y0ZWUxNmY3MmM4
+    ODkwZjE3MjljOTVlZWM2ZjZhZmRmMTQwYjM3ZDk0OGFmNTA3ODY=

data/AUTHORS.md

@@ -58,6 +58,7 @@ Resque Scheduler authors
 - Spring MC
 - Tim Liner
 - Tony Lewis
+- Tom Crayford
 - Vincent Zhu
 - Vladislav Shub
 - V Sreekanth

data/HISTORY.md

@@ -1,5 +1,12 @@
 # Resque Scheduler History / ChangeLog / Release Notes
 
+## 4.0.0 (2014-12-21)
+* Bump rufus-scheduler dependency to `~> 3.0`
+* Address warning from redis-namespace related to `#unwatch`
+* Show current master in the web UI
+* Bugfix related to schedule check when no jobs are in the queue
+* Documentation updates
+
 ## 3.1.0 (2014-12-21)
 * Note in README.md about production redis deployment configuration
 * Bugfix to only override configuration options if provided

data/README.md

@@ -11,14 +11,6 @@ resque-scheduler
 Resque-scheduler is an extension to [Resque](http://github.com/resque/resque)
 that adds support for queueing items in the future.
 
-This table explains the version requirements for redis
-
-| resque-scheduler version | required redis gem version|
-|:-------------------------|----------------------:|
-| ~> 2.0                   | >= 3.0.0              |
-| >= 0.0.1                 | ~> 1.3                |
-
-
 Job scheduling is supported in two different way: Recurring (scheduled) and
 Delayed.
 
@@ -71,10 +63,13 @@ require 'resque/scheduler/tasks'
 namespace :resque do
   task :setup do
     require 'resque'
-    require 'resque-scheduler'
 
     # you probably already have this somewhere
     Resque.redis = 'localhost:6379'
+  end
+
+  task :setup_schedule => :setup do
+    require 'resque-scheduler'
 
     # If you want to be able to dynamically change the schedule,
     # uncomment this line.  A dynamic schedule can be updated via the
@@ -95,6 +90,8 @@ namespace :resque do
     # So, something like this:
     require 'jobs'
   end
+
+  task :scheduler_setup => :setup_schedule
 end
 ```
 
@@ -463,7 +460,9 @@ run, leading to undesired behaviour. To allow different scheduler configs run at
 on one redis, you can either namespace your redis connections, or supply an environment variable
 to split the shared lock key resque-scheduler uses thus:
 
-    RESQUE_SCHEDULER_MASTER_LOCK_PREFIX=MyApp: rake resque:scheduler
+``` bash
+RESQUE_SCHEDULER_MASTER_LOCK_PREFIX=MyApp: rake resque:scheduler
+```
 
 ### resque-web Additions
 
@@ -601,11 +600,34 @@ vagrant up
 
 ### Deployment Notes
 
-It is recommended that a production deployment of resque_scheduler be hosted on
-a dedicated Redis database.  While making and managing scheduled tasks,
-resque_scheudler currently scans the entire Redis keyspace, which may cause latency
-and stability issues if resque_scheduler is hosted on a Redis instance storing a large
-number of keys (such as those written by a different system hosted on the same Redis instance).
+It is recommended that a production deployment of `resque-scheduler` be hosted
+on a dedicated Redis database.  While making and managing scheduled tasks,
+`resque-scheduler` currently scans the entire Redis keyspace, which may cause
+latency and stability issues if `resque-scheduler` is hosted on a Redis instance
+storing a large number of keys (such as those written by a different system
+hosted on the same Redis instance).
+
+#### Compatibility Notes
+
+Different versions of the `redis` and `rufus-scheduler` gems are needed
+depending on your version of `resque-scheduler`.  This is typically not a
+problem with `resque-scheduler` itself, but when mixing dependencies with an
+existing application.
+
+This table explains the version requirements for redis gem
+
+| resque-scheduler | redis gem  |
+|:-----------------|-----------:|
+| `~> 2.0`         | `>= 3.0.0` |
+| `>= 0.0.1`       | `~> 1.3`   |
+
+This table explains the version requirements for rufus-scheduler
+
+| resque-scheduler | rufus-scheduler |
+|:-----------------|----------------:|
+| `~> 4.0`         | `~> 3.0`        |
+| `< 4.0`          | `~> 2.0`        |
+
 
 ### Contributing
 

data/lib/resque/scheduler.rb

@@ -70,7 +70,7 @@ module Resque
       def print_schedule
         if rufus_scheduler
           log! "Scheduling Info\tLast Run"
-          scheduler_jobs = rufus_scheduler.all_jobs
+          scheduler_jobs = rufus_scheduler.jobs
           scheduler_jobs.each do |_k, v|
             log! "#{v.t}\t#{v.last}\t"
           end
@@ -102,11 +102,14 @@ module Resque
         if args.is_a?(::Array)
           return args.first if args.size > 2 || !args.last.is_a?(::Hash)
           # symbolize keys of hash for options
-          args[1] = args[1].reduce({}) do |m, i|
+          args[2] = args[1].reduce({}) do |m, i|
             key, value = i
             m[(key.respond_to?(:to_sym) ? key.to_sym : key) || key] = value
             m
           end
+
+          args[2][:job] = true
+          args[1] = nil
         end
         args
       end
@@ -128,6 +131,10 @@ module Resque
           interval_types.each do |interval_type|
             if !config[interval_type].nil? && config[interval_type].length > 0
               args = optionizate_interval_value(config[interval_type])
+              if args.is_a?(::String)
+                args = [args, nil, job: true]
+              end
+
               job = rufus_scheduler.send(interval_type, *args) do
                 if master?
                   log! "queueing #{config['class']} (#{name})"
@@ -268,7 +275,7 @@ module Resque
       end
 
       def rufus_scheduler
-        @rufus_scheduler ||= Rufus::Scheduler.start_new
+        @rufus_scheduler ||= Rufus::Scheduler.new
       end
 
       # Stops old rufus scheduler and creates a new one.  Returns the new
@@ -292,7 +299,8 @@ module Resque
           loop do
             schedule_name = Resque.redis.spop(:schedules_changed)
             break unless schedule_name
-            if Resque.reload_schedule!.keys.include?(schedule_name)
+            Resque.reload_schedule!
+            if Resque.schedule.keys.include?(schedule_name)
               unschedule_job(schedule_name)
               load_schedule_job(schedule_name, Resque.schedule[schedule_name])
             else

data/lib/resque/scheduler/cli.rb

@@ -122,7 +122,7 @@ module Resque
       attr_reader :argv, :env
 
       def runtime_env
-        Resque::Scheduler::Env.new(options)
+        @runtime_env ||= Resque::Scheduler::Env.new(options)
       end
 
       def option_parser

data/lib/resque/scheduler/delaying_extensions.rb

@@ -256,18 +256,18 @@ module Resque
       end
 
       def clean_up_timestamp(key, timestamp)
-        # If the list is empty, remove it.
-
         # Use a watch here to ensure nobody adds jobs to this delayed
         # queue while we're removing it.
-        redis.watch key
-        if 0 == redis.llen(key).to_i
-          redis.multi do
-            redis.del key
-            redis.zrem :delayed_queue_schedule, timestamp.to_i
+        redis.watch(key) do
+          if redis.llen(key).to_i == 0
+            # If the list is empty, remove it.
+            redis.multi do
+              redis.del(key)
+              redis.zrem(:delayed_queue_schedule, timestamp.to_i)
+            end
+          else
+            redis.redis.unwatch
           end
-        else
-          redis.unwatch
         end
       end
 

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

@@ -4,6 +4,7 @@
   The list below contains all scheduled jobs.  Click "Queue now" to queue
   a job immediately.
   Server local time: <%= Time.now %>
+  Current master: <%= Resque.redis.get(Resque::Scheduler.master_lock.key) %>
 </p>
 <div style="overflow-y: auto; width:100%; padding: 0px 5px;">
 <table>

data/lib/resque/scheduler/version.rb

@@ -2,6 +2,6 @@
 
 module Resque
   module Scheduler
-    VERSION = '3.1.0'
+    VERSION = '4.0.0'
   end
 end

data/resque-scheduler.gemspec

@@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mono_logger', '~> 1.0'
   spec.add_runtime_dependency 'redis', '~> 3.0'
   spec.add_runtime_dependency 'resque', '~> 1.25'
-  spec.add_runtime_dependency 'rufus-scheduler', '~> 2.0'
+  spec.add_runtime_dependency 'rufus-scheduler', '~> 3.0'
 end

data/test/scheduler_args_test.rb

@@ -57,7 +57,7 @@ context 'scheduling jobs with arguments' do
 
   test 'enqueue_from_config puts stuff in resque when env matches' do
     Resque::Scheduler.env = 'production'
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     Resque.schedule = {
       'some_ivar_job' => {
@@ -69,7 +69,7 @@ context 'scheduling jobs with arguments' do
     }
 
     Resque::Scheduler.load_schedule!
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     Resque.schedule = {
       'some_ivar_job' => {
@@ -81,12 +81,12 @@ context 'scheduling jobs with arguments' do
     }
 
     Resque::Scheduler.load_schedule!
-    assert_equal(2, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(2, Resque::Scheduler.rufus_scheduler.jobs.size)
   end
 
   test 'enqueue_from_config does not enqueue when env does not match' do
     Resque::Scheduler.env = nil
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
     Resque.schedule = {
       'some_ivar_job' => {
         'cron' => '* * * * *',
@@ -97,7 +97,7 @@ context 'scheduling jobs with arguments' do
     }
 
     Resque::Scheduler.load_schedule!
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     Resque::Scheduler.env = 'production'
     Resque.schedule = {
@@ -109,12 +109,12 @@ context 'scheduling jobs with arguments' do
       }
     }
     Resque::Scheduler.load_schedule!
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
   end
 
   test 'enqueue_from_config when env env arg is not set' do
     Resque::Scheduler.env = 'production'
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     Resque.schedule = {
       'some_ivar_job' => {
@@ -124,7 +124,7 @@ context 'scheduling jobs with arguments' do
       }
     }
     Resque::Scheduler.load_schedule!
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
   end
 
   test "calls the worker without arguments when 'args' is missing " \

data/test/scheduler_test.rb

@@ -56,7 +56,7 @@ context 'Resque::Scheduler' do
   end
 
   test 'config makes it into the rufus_scheduler' do
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     Resque.schedule = {
       some_ivar_job: {
@@ -67,7 +67,7 @@ context 'Resque::Scheduler' do
     }
     Resque::Scheduler.load_schedule!
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert Resque::Scheduler.scheduled_jobs.include?('some_ivar_job')
   end
 
@@ -83,7 +83,7 @@ context 'Resque::Scheduler' do
 
     Resque::Scheduler.load_schedule!
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert Resque::Scheduler.scheduled_jobs.include?('some_ivar_job')
 
     Resque.redis.del(:schedules)
@@ -93,7 +93,7 @@ context 'Resque::Scheduler' do
 
     Resque::Scheduler.reload_schedule!
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
 
     assert_equal '/tmp/2', Resque.schedule['some_ivar_job2']['args']
     assert Resque::Scheduler.scheduled_jobs.include?('some_ivar_job2')
@@ -107,7 +107,7 @@ context 'Resque::Scheduler' do
       'args' => '/tmp'
     )
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(1, Resque::Scheduler.scheduled_jobs.size)
     assert Resque::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
   end
@@ -120,11 +120,11 @@ context 'Resque::Scheduler' do
       'args' => '/tmp'
     )
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(1, Resque::Scheduler.scheduled_jobs.size)
     assert Resque::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
     job = Resque::Scheduler.scheduled_jobs['some_ivar_job']
-    assert job.params.keys.include?(:first_in)
+    assert job.opts.keys.include?(:first_in)
   end
 
   test 'load_schedule_job with cron with options' do
@@ -135,11 +135,11 @@ context 'Resque::Scheduler' do
       'args' => '/tmp'
     )
 
-    assert_equal(1, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(1, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(1, Resque::Scheduler.scheduled_jobs.size)
     assert Resque::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
     job = Resque::Scheduler.scheduled_jobs['some_ivar_job']
-    assert job.params.keys.include?(:allow_overlapping)
+    assert job.opts.keys.include?(:allow_overlapping)
   end
 
   test 'load_schedule_job without cron' do
@@ -149,7 +149,7 @@ context 'Resque::Scheduler' do
       'args' => '/tmp'
     )
 
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
     assert !Resque::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
   end
@@ -162,7 +162,7 @@ context 'Resque::Scheduler' do
       'args' => '/tmp'
     )
 
-    assert_equal(0, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
     assert !Resque::Scheduler.scheduled_jobs.keys.include?('some_ivar_job')
   end
@@ -199,7 +199,7 @@ context 'Resque::Scheduler' do
 
     Resque::Scheduler.update_schedule
 
-    assert_equal(3, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(3, Resque::Scheduler.rufus_scheduler.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)
@@ -210,6 +210,26 @@ context 'Resque::Scheduler' do
     assert_equal 0, Resque.redis.scard(:schedules_changed)
   end
 
+  test 'update_schedule when all jobs have been removed' do
+    Resque::Scheduler.dynamic = true
+    Resque.schedule = {
+      'some_ivar_job' => {
+        'cron' => '* * * * *', 'class' => 'SomeIvarJob', 'args' => '/tmp'
+      }
+    }
+
+    Resque::Scheduler.load_schedule!
+
+    Resque.remove_schedule('some_ivar_job')
+
+    Resque::Scheduler.update_schedule
+
+    assert_equal(0, Resque::Scheduler.rufus_scheduler.jobs.size)
+    assert_equal(0, Resque::Scheduler.scheduled_jobs.size)
+    assert_equal([], Resque::Scheduler.scheduled_jobs.keys)
+    assert_equal 0, Resque.redis.scard(:schedules_changed)
+  end
+
   test 'update_schedule with mocks' do
     Resque::Scheduler.dynamic = true
     Resque.schedule = {
@@ -271,7 +291,7 @@ context 'Resque::Scheduler' do
 
     background_delayed_update.join
     Resque::Scheduler.update_schedule
-    assert_equal(jobs_count, Resque::Scheduler.rufus_scheduler.all_jobs.size)
+    assert_equal(jobs_count, Resque::Scheduler.rufus_scheduler.jobs.size)
     assert_equal(jobs_count, Resque::Scheduler.scheduled_jobs.size)
     assert_equal 0, Resque.redis.scard(:schedules_changed)
   end
@@ -435,7 +455,7 @@ context 'Resque::Scheduler' do
 
     test 'prints schedule' do
       fake_rufus_scheduler = mock
-      fake_rufus_scheduler.expects(:all_jobs).at_least_once
+      fake_rufus_scheduler.expects(:jobs).at_least_once
         .returns(foo: OpenStruct.new(t: nil, last: nil))
       Resque::Scheduler.expects(:rufus_scheduler).at_least_once
         .returns(fake_rufus_scheduler)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Ben VandenBos
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: ! "    Light weight job scheduling on top of Resque.\n    Adds methods
   enqueue_at/enqueue_in to schedule jobs in the future.\n    Also supports queueing
   jobs on a fixed, cron-like schedule.\n"
@@ -231,7 +231,6 @@ files:
 - HISTORY.md
 - LICENSE
 - README.md
-- ROADMAP.md
 - Rakefile
 - Vagrantfile
 - bin/resque-scheduler

data/ROADMAP.md

@@ -1,4 +0,0 @@
-TODO for v3.1.0
-===============
-
-- Compatibility with Resque 2