resque-scheduler 2.3.1 → 2.4.0

data/.gitignore

@@ -1,4 +1,6 @@
 .bundle/
+.idea/
+
 doc/
 pkg
 nbproject
@@ -6,3 +8,4 @@ Gemfile.lock
 .rvmrc
 *.swp
 
+/coverage/

data/.rubocop.yml

@@ -2,6 +2,9 @@
 # The point is for the user to remove these configuration records
 # one by one as the offences are removed from the code base.
 
+AccessorMethodName:
+  Enabled: false
+
 AlignParameters:
   Enabled: false
 
@@ -15,7 +18,7 @@ CaseEquality:
   Enabled: false
 
 ClassLength:
-  Enabled: false
+  Max: 300
 
 ClassVars:
   Enabled: false
@@ -30,17 +33,11 @@ CommentAnnotation:
   Enabled: false
 
 CyclomaticComplexity:
-  Enabled: false
+  Max: 18
 
 Documentation:
   Enabled: false
 
-EmptyLines:
-  Enabled: false
-
-EmptyLinesAroundBody:
-  Enabled: false
-
 Encoding:
   Enabled: false
 
@@ -59,9 +56,12 @@ HashSyntax:
 IfUnlessModifier:
   Enabled: false
 
-LineLength:
+IndentationWidth:
   Enabled: false
 
+LineLength:
+  Max: 152
+
 Loop:
   Enabled: false
 
@@ -69,7 +69,7 @@ MethodCallParentheses:
   Enabled: false
 
 MethodLength:
-  Enabled: false
+  Max: 90
 
 ModuleFunction:
   Enabled: false
@@ -80,7 +80,7 @@ NumericLiterals:
 ParenthesesAroundCondition:
   Enabled: false
 
-PerlBackrefs:
+PredicateName:
   Enabled: false
 
 RedundantBegin:

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start { add_filter '/test/' } if ENV['COVERAGE']

data/.travis.yml

@@ -1,9 +1,12 @@
 language: ruby
 rvm:
-- ree
 - 1.9.3
 - 2.0.0
-script: bundle exec rake rubocop test
+env:
+  global:
+  - RESQUE_SCHEDULER_DISABLE_TEST_REDIS_SERVER=1
+services:
+- redis-server
 notifications:
   email:
     recipients: daniel.buch+resque-scheduler@gmail.com

data/AUTHORS.md

@@ -45,9 +45,12 @@ Resque Scheduler authors
 - Olivier Brisse
 - Petteri Räty
 - Phil Cohen
+- Rob Olson
 - Russell Branca
 - Ryan Biesemeyer
 - Ryan Carver
+- Sameer Siruguri
+- Scott Francis
 - Sebastian Kippe
 - Spring MC
 - Tim Liner

data/HISTORY.md

@@ -1,3 +1,22 @@
+# Resque Scheduler History / ChangeLog / Release Notes
+
+## 2.4.0 (2014-01-14)
+
+* Including optional env name in procline
+* Fixing an explosion regarding `every` in the views
+* Bumping the copyright year
+* Corrected doc for syntax of class and every keys
+* Adding a standalone executable
+* **POSSIBLE BREAKING CHANGE**: Dropping support for ree
+* Add support for persistence of dynamic schedules
+* Fix unsafe shutdown in Ruby 2
+* Adding `.configure` convenience method for block-style configuration
+* Add `.remove_delayed_selection` method to remove based on result of a block
+* Add support for viewing all schedules for a job in web UI
+* Use resque redis namespace in the master lock key
+* Including optional app name in procline
+* Various test improvements, :bug: fixes, and documentation updates!
+
 ## 2.3.1 (2013-11-20)
 
 * Correcting `require_paths` in gemspec
@@ -93,6 +112,11 @@
 * Dynamic schedule support (brianjlandau, davidyang)
 * Now depends on redis >=1.3
 
+## 1.9.11 (2013-11-20)
+
+* Fixed behavior of `#validate_job!` via `#enqueue_at_with_queue` #286
+* Correcting `require_paths` in gemspec #288
+
 ## 1.9.10 (2013-09-19)
 
 * Backported `#enqueue_at_with_queue`
@@ -151,8 +175,8 @@
 
 ## 1.8.1 (2010-05-19)
 
-* Adding rails_env for scheduled jobs to support scoping jobs by
-  RAILS_ENV (gravis).
+* Adding `rails_env` for scheduled jobs to support scoping jobs by
+  `RAILS_ENV` (gravis).
 * Fixing ruby 1.8.6 compatibility issue.
 * Adding gemspec for bundler support.
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Ben VandenBos
+Copyright (c) 2014 Ben VandenBos
 
 MIT License
 

data/README.md

@@ -33,8 +33,9 @@ Resque.enqueue_at(5.days.from_now, SomeJob) # run SomeJob at a specific time
 
 ### Documentation
 
-This README covers what most people need to know.  If you're looking for
-details on individual methods, you might want to try the [rdoc](http://rdoc.info/github/bvandenbos/resque-scheduler/master/frames).
+This `README` covers what most people need to know.  If you're looking
+for details on individual methods, you might want to try the
+[rdoc](http://rdoc.info/github/resque/resque-scheduler/master/frames).
 
 ### Installation
 
@@ -45,7 +46,7 @@ To install:
 If you use a Gemfile, you may want to specify the `:require` explicitly:
 
 ```ruby
-gem 'resque-scheduler', :require => 'resque_scheduler'
+gem 'resque-scheduler'
 ```
 
 Adding the resque:scheduler rake task:
@@ -71,7 +72,6 @@ namespace :resque do
   task :setup do
     require 'resque'
     require 'resque_scheduler'
-    require 'resque/scheduler'
 
     # you probably already have this somewhere
     Resque.redis = 'localhost:6379'
@@ -105,6 +105,10 @@ never exits.
 
     $ rake resque:scheduler
 
+or, if you want to load the environment first:
+
+    $ rake environment resque:scheduler
+
 Supported environment variables are `VERBOSE` and `MUTE`.  If either is set to
 any nonempty value, they will take effect.  `VERBOSE` simply dumps more output
 to stdout.  `MUTE` does the opposite and silences all output. `MUTE`
@@ -112,7 +116,10 @@ supersedes `VERBOSE`.
 
 ### Resque Pool integration 
 
-For normal work with [resque-pool](https://github.com/nevans/resque-pool) gem add next lines in lib/rake/resque.rake
+For normal work with the
+[resque-pool](https://github.com/nevans/resque-pool) gem, add the
+following task to wherever tasks are kept, such as
+`./lib/tasks/resque.rake`:
 
 ```ruby
 task 'resque:pool:setup' do
@@ -150,7 +157,7 @@ standard resque jobs are persisted (redis writing to disk). Delayed jobs differ
 from scheduled jobs in that if your scheduler process is down or workers are
 down when a particular job is supposed to be queue, they will simply "catch up"
 once they are started again.  Jobs are guaranteed to run (provided they make it
-into the delayed queue) after their given queue_at time has passed.
+into the delayed queue) after their given `queue_at` time has passed.
 
 One other thing to note is that insertion into the delayed queue is O(log(n))
 since the jobs are stored in a redis sorted set (zset).  I can't imagine this
@@ -168,15 +175,38 @@ Resque.enqueue_at(5.days.from_now, SendFollowUpEmail, :user_id => current_user.i
 Resque.remove_delayed(SendFollowUpEmail, :user_id => current_user.id)
 ```
 
+If you need to cancel a delayed job based on some matching arguments, but don't wish to specify each argument from when the job was created, you can do like so:
+
+``` ruby
+# after you've enqueued a job like:
+Resque.enqueue_at(5.days.from_now, SendFollowUpEmail, :account_id => current_account.id, :user_id => current_user.id)
+# remove jobs matching just the account:
+Resque.remove_delayed_selection { |args| args[0]['account_id'] == current_account.id }
+# or remove jobs matching just the user:
+Resque.remove_delayed_selection { |args| args[0]['user_id'] == current_user.id }
+```
+
 ### Scheduled Jobs (Recurring Jobs)
 
 Scheduled (or recurring) jobs are logically no different than a standard cron
-job.  They are jobs that run based on a fixed schedule which is set at
-startup.
+job.  They are jobs that run based on a schedule which can be static or dynamic.
+
+#### Static schedules
 
-The schedule is a list of Resque worker classes with arguments and a
+Static schedules are set when `resque-scheduler` starts by passing a schedule file
+to `resque-scheduler` initialization like this (see *Installation* above for a more complete example):
+
+```ruby
+Resque.schedule = YAML.load_file('your_resque_schedule.yml')
+```
+
+If a static schedule is not set `resque-scheduler` will issue a "Schedule empty!" warning on
+startup, but despite that warning setting a static schedule is totally optional. It is possible
+to use only dynamic schedules (see below).
+
+The schedule file is a list of Resque job classes with arguments and a
 schedule frequency (in crontab syntax).  The schedule is just a hash, but
-is most likely stored in a YAML like so:
+is usually stored in a YAML like this:
 
 ```yaml
 CancelAbandonedOrders:
@@ -185,17 +215,17 @@ CancelAbandonedOrders:
 queue_documents_for_indexing:
   cron: "0 0 * * *"
   # you can use rufus-scheduler "every" syntax in place of cron if you prefer
-  # every: 1hr
+  # every: 1h
   # By default the job name (hash key) will be taken as worker class name.
   # If you want to have a different job name and class name, provide the 'class' option
-  class: QueueDocuments
+  class: "QueueDocuments"
   queue: high
   args:
   description: "This job queues all content for indexing in solr"
 
 clear_leaderboards_contributors:
   cron: "30 6 * * 1"
-  class: ClearLeaderboards
+  class: "ClearLeaderboards"
   queue: low
   args: contributors
   description: "This job resets the weekly leaderboard for contributions"
@@ -213,8 +243,8 @@ You can provide options to "every" or "cron" via Array:
 clear_leaderboards_moderator:
   every:
     - "30s"
-    - :first_in: "120s"
-  class: CheckDaemon
+    - :first_in: '120s'
+  class: "CheckDaemon"
   queue: daemons
   description: "This job will check Daemon every 30 seconds after 120 seconds after start"
 ```
@@ -232,6 +262,60 @@ seconds past the minute).
 A big shout out to [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler)
 for handling the heavy lifting of the actual scheduling engine.
 
+#### Dynamic schedules
+
+Dynamic schedules are programmatically set on a running `resque-scheduler`.
+All [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler) options are supported
+when setting schedules.
+
+Dynamic schedules are not enabled by default. To be able to dynamically set schedules, you
+must pass the following to `resque-scheduler` initialization (see *Installation* above for a more complete example):
+
+```ruby
+Resque::Scheduler.dynamic = true
+```
+
+Dynamic schedules allow for greater flexibility than static schedules as they can be set,
+unset or changed without having to restart `resque-scheduler`. You can specify, if the schedule
+must survive a resque-scheduler restart or not. This is done by setting the `persist` configuration
+for the schedule: it is a boolean value, if set the schedule will persist a restart. By default,
+a schedule will not be persisted.
+
+The job to be scheduled must be a valid Resque job class.
+
+For example, suppose you have a SendEmail job which sends emails. The `perform` method of the
+job receives a string argument with the email subject. To run the SendEmail job every hour
+starting five minutes from now, you can do:
+
+```ruby
+name = 'send_emails'
+config = {}
+config[:class] = 'SendEmail'
+config[:args] = 'POC email subject'
+config[:every] = ['1h', {first_in: 5.minutes}]
+config[:persist] = true
+Resque.set_schedule(name, config)
+```
+
+Schedules can later be removed by passing their name to the `remove_schedule` method:
+
+```ruby
+name = 'send_emails'
+Resque.remove_schedule(name)
+```
+
+Schedule names are unique; i.e. two dynamic schedules cannot have the same name. If `set_schedule` is
+passed the name of an existing schedule, that schedule is updated. E.g. if after setting the above schedule
+ we want the job to run every day instead of every hour from now on, we can do:
+
+```ruby
+name = 'send_emails'
+config = {}
+config[:class] = 'SendEmail'
+config[:args] = 'POC email subject'
+config[:every] = '1d'
+Resque.set_schedule(name, config)
+```
 
 #### Time zones
 
@@ -295,7 +379,7 @@ And then a schedule:
 create_fake_leaderboards:
   cron: "30 6 * * 1"
   queue: scoring
-  custom_job_class: FakeLeaderboard
+  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"
@@ -413,24 +497,29 @@ worker is started.
 There are several options to toggle the way scheduler logs its actions. They
 are toggled by environment variables:
 
-  - `MUTE` will stop logging anything. Completely silent;
-  - `VERBOSE` opposite to 'mute' will log even debug information;
-  - `LOGFILE` specifies the file to write logs to. Default is standard output.
+  - `MUTE` will stop logging anything. Completely silent.
+  - `VERBOSE` opposite of 'mute'; will log even debug information
+  - `LOGFILE` specifies the file to write logs to. (default standard output)
+  - `LOGFORMAT` specifies either "text" or "json" output format
+    (default "text")
 
-All those variables are non-mandatory and default values are
+All of these variables are optional and will be given the following default
+values:
 
 ```ruby
-Resque::Scheduler.mute    = false
-Resque::Scheduler.verbose = false
-Resque::Scheduler.logfile = nil # that means, all messages go to STDOUT
+Resque::Scheduler.configure do |c|
+  c.mute = false
+  c.verbose = false
+  c.logfile = nil # meaning all messages go to $stdout
+  c.logformat = 'text'
+end
 ```
 
-
 ### Polling frequency
 
-You can pass a `RESQUE_SCHEDULER_INTERVAL` option which is an integer or float
-representing the polling frequency. The default is 5 seconds, but for a
-semi-active app you may want to use a smaller value.
+You can pass a `RESQUE_SCHEDULER_INTERVAL` option which is an integer or
+float representing the polling frequency. The default is 5 seconds, but
+for a semi-active app you may want to use a smaller value.
 
     $ RESQUE_SCHEDULER_INTERVAL=1 rake resque:scheduler
 
@@ -440,10 +529,10 @@ uses for its jobs.
 
 ### Plagiarism alert
 
-This was intended to be an extension to resque and so resulted in a lot of the
-code looking very similar to resque, particularly in resque-web and the views. I
-wanted it to be similar enough that someone familiar with resque could easily
-work on resque-scheduler.
+This was intended to be an extension to resque and so resulted in a lot
+of the code looking very similar to resque, particularly in resque-web
+and the views. I wanted it to be similar enough that someone familiar
+with resque could easily work on resque-scheduler.
 
 
 ### Contributing

data/ROADMAP.md

@@ -0,0 +1,10 @@
+TODO for v3.0.0
+===============
+
+- Clean up all RuboCop offences, breaking the API if necessary
+- Get to at least 95% test coverage
+
+TODO for v3.1.0
+===============
+
+- Compatibility with Resque 2

data/Rakefile

@@ -1,25 +1,13 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-$LOAD_PATH.unshift 'lib'
+task default: [:rubocop, :test]
 
-task :default => :test
-
-desc 'Run tests'
-task :test do
-  if RUBY_VERSION =~ /^1\.8/
-    unless ENV['SEED']
-      srand
-      ENV['SEED'] = (srand % 0xFFFF).to_s
-    end
-
-    $stdout.puts "Running with SEED=#{ENV['SEED']}"
-    srand Integer(ENV['SEED'])
-  elsif ENV['SEED']
-    ARGV += %W(--seed #{ENV['SEED']})
-  end
-  Dir['test/*_test.rb'].each do |f|
-    require File.expand_path(f)
-  end
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = ENV['PATTERN'] || 'test/*_test.rb'
+  t.verbose = !!ENV['VERBOSE']
+  t.options = "--seed #{ENV['SEED']}" if ENV['SEED']
 end
 
 desc 'Run rubocop'