rufus-scheduler 3.2.0 → 3.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5efdaec8fd127103673241abfcb7a14d9135aef
+  data.tar.gz: 95b4b8f72eaea194b946e9b6738fa42b9086fc2a
+SHA512:
+  metadata.gz: d511d09f4a9c0deffd90a97005d0824b891a55a92236cf885fde676830960ebbaad407d1a4fd4817b81d20d0f7ef9a504ad35b96a58b7a195e30bae89eda0046
+  data.tar.gz: d4da5209b9d01d6a4c861ed022b36971377762ae31ec785d068c0070af3e098e0ff0f6939cd128a96f5752deb74c49daf798a074d6a7557fa80d125f4286dcd5

data/CHANGELOG.txt

@@ -2,6 +2,30 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.3.0    released 2016-11-28
+
+- Bring in Piavka's Job#trigger_off_schedule, gh-214
+- Reject "day 0" in cronlines, thanks to Ramon Tayag, https://github.com/ramontayag
+- Move away from ENV['TZ'], thanks to Akinori Musha, https://github.com/knu
+- Fix .parse_to_time vs Date issue, as reported by @nsatragno
+
+
+== rufus-scheduler - 3.2.2    released 2016-08-14
+
+- job opt hash preservation, as suggested in gh-212, by https://github.com/d-m-u
+- introduce Job#previous_time
+- countered ActiveRecord 3.2.22 on gh-210, by https://github.com/paulodelgado
+
+
+== rufus-scheduler - 3.2.1    released 2016-05-04
+
+- accept '* * * * 5L' (last friday) (equivalent to '* * * * 5#-1')
+- CronLine#to_a (#to_array aliasing to it)
+- simplify .parse_duration (and trim input)
+- raise on "*/0 * * * *", by https://github.com/simook
+- introduce "days to end of month" in cron strings
+
+
 == rufus-scheduler - 3.2.0    released 2015-12-28
 
 - cache CronLine#brute_frequency results, gh-188 and gh-89

data/CREDITS.txt

@@ -4,6 +4,11 @@
 
 == Contributors
 
+- Piavka (https://github.com/piavka) - Job#trigger_off_schedule, gh-214
+- Paulo Delgado (https://github.com/paulodelgado) counter ActiveRecord, gh-210
+- Anjali Sharma (https://github.com/anjali-sharma) enhance job#last_time example
+- Kyle Simukka (https://github.com/simook) raise on "*/0 * * * *"
+- Ryan McGeary (https://github.com/rmm5t) svg badges for the readme
 - Balasankar C (https://github.com/balasankarc) fix CronJob spec vs December
 - Matthieu Rosinski (https://github.com/Korrigan) prevent "every" shifts
 - vivitar (https://github.com/vivitar) silenced a set of Ruby warnings
@@ -46,6 +51,13 @@
 
 == Feedback
 
+- Ramon Tayag - https://github.com/ramontayag - prevent day 0 in cronlines
+- Akinori Musha - https://github.com/knu - ENV['TZ'] setting is harmful
+- Nicolás Satragno - https://twitter.com/nsatragno - parse_to_time vs Date
+- d-m-u duhlmann - https://github.com/d-m-u - job opt hash preservation
+- Anjali Sharma - https://github.com/anjali-sharma - fix typographical error
+- Jonathan Campos - https://github.com/jonbcampos - negative cron day idea
+- Andrey Morskov - https://github.com/accessd - fix typographical error
 - Eduardo Maia - https://github.com/emaiax - rufus and the Rails console
 - Suisea - https://github.com/suisea - readme rewording
 - Radek - http://stackoverflow.com/users/250422 - gh-166

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2005-2015, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2005-2016, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -0,0 +1,23 @@
+
+NAME = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
+VERSION = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+
+
+gemspec_validate:
+	@echo "---"
+	ruby -e "s = eval(File.read(Dir['*.gemspec'].first)); p s.validate"
+	@echo "---"
+
+name: gemspec_validate
+	@echo "$(NAME) $(VERSION)"
+
+build: gemspec_validate
+	gem build $(NAME).gemspec
+	mkdir -p pkg
+	mv $(NAME)-$(VERSION).gem pkg/
+
+push: build
+	gem push pkg/$(NAME)-$(VERSION).gem
+

data/README.md

@@ -1,15 +1,19 @@
 
 # rufus-scheduler
 
-[![Build Status](https://secure.travis-ci.org/jmettraux/rufus-scheduler.png)](http://travis-ci.org/jmettraux/rufus-scheduler)
-[![Gem Version](https://badge.fury.io/rb/rufus-scheduler.png)](http://badge.fury.io/rb/rufus-scheduler)
+[![Build Status](https://secure.travis-ci.org/jmettraux/rufus-scheduler.svg)](http://travis-ci.org/jmettraux/rufus-scheduler)
+[![Gem Version](https://badge.fury.io/rb/rufus-scheduler.svg)](http://badge.fury.io/rb/rufus-scheduler)
 
 Job scheduler for Ruby (at, cron, in and every jobs).
 
+It uses threads.
+
 **Note**: maybe are you looking for the [README of rufus-scheduler 2.x](https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc)?
 
 Quickstart:
 ```ruby
+# quickstart.rb
+
 require 'rufus-scheduler'
 
 scheduler = Rufus::Scheduler.new
@@ -21,6 +25,7 @@ end
 scheduler.join
   # let the current thread join the scheduler thread
 ```
+(run with `ruby quickstart.rb`)
 
 Various forms of scheduling are supported:
 ```ruby
@@ -52,16 +57,19 @@ end
 
 ## non-features
 
-Rufus-scheduler (out of the box) is an in-process, in-memory scheduler.
+Rufus-scheduler (out of the box) is an in-process, in-memory scheduler. It uses threads.
 
 It does not persist your schedules. When the process is gone and the scheduler instance with it, the schedules are gone.
 
+A rufus-scheduler instance will go on scheduling while it is present among the object in a Ruby process. To make it stop scheduling you have to call its [`#shutdown` method](#schedulershutdown).
+
 
 ## related and similar gems
 
-* [whenever](https://github.com/javan/whenever) - let cron call back your Ruby code, trusted and reliable cron drives your schedule
-* [clockwork](https://github.com/tomykaira/clockwork) - rufus-scheduler inspired gem
-* [crono](https://github.com/plashchynski/crono) - an in-Rails cron scheduler
+* [Whenever](https://github.com/javan/whenever) - let cron call back your Ruby code, trusted and reliable cron drives your schedule
+* [Clockwork](https://github.com/tomykaira/clockwork) - rufus-scheduler inspired gem
+* [Crono](https://github.com/plashchynski/crono) - an in-Rails cron scheduler
+* [PerfectSched](https://github.com/treasure-data/perfectsched) - highly available distributed cron built on [Sequel](http://sequel.jeremyevans.net) and more
 
 (please note: rufus-scheduler is not a cron replacement)
 
@@ -101,12 +109,6 @@ Go read [how to report bugs effectively](http://www.chiark.greenend.org.uk/~sgta
 
 Update: [help_help.md](https://gist.github.com/jmettraux/310fed75f568fd731814) might help help you.
 
-### on StackOverflow
-
-Use this [form](http://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby). It'll create a question flagged "rufus-scheduler" and "ruby".
-
-Here are the [questions tagged rufus-scheduler](http://stackoverflow.com/questions/tagged/rufus-scheduler).
-
 ### on IRC
 
 I sometimes haunt #ruote on freenode.net. The channel is not dedicated to rufus-scheduler, so if you ask a question, first mention it's about rufus-scheduler.
@@ -123,7 +125,9 @@ Yes, issues can be reported in [rufus-scheduler issues](https://github.com/jmett
 * [I want a refund](http://blog.nodejitsu.com/getting-refunds-on-open-source-projects)
 * [Passenger and rufus-scheduler](http://stackoverflow.com/questions/18108719/debugging-rufus-scheduler/18156180#18156180)
 * [Passenger and rufus-scheduler (2)](http://stackoverflow.com/questions/21861387/rufus-cron-job-not-working-in-apache-passenger#answer-21868555)
-* [The scheduler comes up when running the Rails console](https://github.com/jmettraux/rufus-scheduler#avoid-scheduling-when-running-the-ruby-on-rails-console)
+* [Passenger in-depth spawn methods](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/)
+* [Passenger in-depth spawn methods (smart spawning)](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#smart-spawning-hooks)
+* [The scheduler comes up when running the Rails console or a Rake task](https://github.com/jmettraux/rufus-scheduler#avoid-scheduling-when-running-the-ruby-on-rails-console)
 * [I don't get any of this, I just want it to work in my Rails application](#so-rails)
 
 
@@ -181,6 +185,8 @@ Interval jobs, trigger, execute and then trigger again after the interval elapse
 
 Cron jobs are based on the venerable cron utility (```man 5 crontab```). They trigger following a pattern given in (almost) the same language cron uses.
 
+####
+
 ### #schedule_x vs #x
 
 schedule_in, schedule_at, schedule_cron, etc will return the new Job instance.
@@ -369,6 +375,8 @@ Since, by default, jobs are triggered in their own new thread, job instances mig
 
 To prevent overlap, one can set :overlap => false. Such a job will not trigger if one of its instance is already running.
 
+The `:overlap` option is considered before the `:mutex` option when the scheduler is reviewing jobs for triggering.
+
 ### :mutex => mutex_instance / mutex_name / array of mutexes
 
 When a job with a mutex triggers, the job's block is executed with the mutex around it, preventing other jobs with the same mutex to enter (it makes the other jobs wait until it exits the mutex).
@@ -381,6 +389,8 @@ Array of mutexes: original idea and implementation by [Rainux Luo](https://githu
 
 Warning: creating lots of different mutexes is OK. Rufus-scheduler will place them in its Scheduler#mutexes hash... And they won't get garbage collected.
 
+The `:overlap` option is considered before the `:mutex` option when the scheduler is reviewing jobs for triggering.
+
 ### :timeout => duration or point in time
 
 It's OK to specify a timeout when scheduling some work. After the time specified, it gets interrupted via a Rufus::Scheduler::TimeoutError.
@@ -639,12 +649,31 @@ job.scheduled_at
 ### last_time
 
 Returns the last time the job triggered (is usually nil for AtJob and InJob).
-k
 ```ruby
-job = scheduler.schedule_every('1d') do; end
-# ...
+job = scheduler.schedule_every('10s') do; end
+
 job.scheduled_at
   # => 2013-07-17 23:48:54 +0900
+job.last_time
+  # => nil (since we've just scheduled it)
+
+# after 10 seconds
+
+job.scheduled_at
+  # => 2013-07-17 23:48:54 +0900 (same as above)
+job.last_time
+  # => 2013-07-17 23:49:04 +0900
+```
+
+### previous_time
+
+Returns the previous `#next_time`
+```ruby
+scheduler.every('10s') do |job|
+  puts "job scheduled for #{job.previous_time} triggered at #{Time.now}"
+  puts "next time will be around #{job.next_time}"
+  puts "."
+end
 ```
 
 ### last_work_time, mean_work_time
@@ -1348,7 +1377,6 @@ Rufus::Scheduler.parse('* * * * mon#1').next_time
 L can be used in the "day" slot:
 
 In this example, the cronline is supposed to trigger every last day of the month at noon:
-
 ```ruby
 require 'rufus-scheduler'
 Time.now
@@ -1357,6 +1385,21 @@ Rufus::Scheduler.parse('00 12 L * *').next_time
   # => 2013-10-31 12:00:00 +0900
 ```
 
+#### negative day (x days before the end of the month)
+
+It's OK to pass negative values in the "day" slot:
+```ruby
+scheduler.cron '0 0 -5 * *' do
+  # do it at 00h00 5 days before the end of the month...
+end
+```
+
+Negative ranges (`-10--5-`: 10 days before the end of the month to 5 days before the end of the month) are OK, but mixed positive / negative ranges will raise an `ArgumentError`.
+
+Negative ranges with increments (`-10---2/2`) are accepted as well.
+
+Descending day ranges are not accepted (`10-8` or `-8--10` for example).
+
 
 ## a note about timezones
 
@@ -1433,7 +1476,7 @@ The rufus-scheduler singleton is instantiated in the ```config/initializers/sche
 
 (Written in reply to https://github.com/jmettraux/rufus-scheduler/issues/186 )
 
-If you don't want rufus-scheduler to kick in when running the Ruby on Rails console, you can wrap your initializer in a conditional:
+If you don't want rufus-scheduler to kick in when running the Ruby on Rails console or invoking a rake task, you can wrap your initializer in a conditional:
 
 ```ruby
 #
@@ -1444,8 +1487,10 @@ require 'rufus-scheduler'
 s = Rufus::Scheduler.singleton
 
 
-unless defined?(Rails::Console)
-  # only schedule when not running from the Rails on Rails console
+unless defined?(Rails::Console) || File.split($0).last == 'rake'
+
+  # only schedule when not running from the Ruby on Rails console
+  # or from a rake task
 
   s.every '1m' do
 

data/fail18.txt

@@ -0,0 +1,12 @@
+
+rspec ./spec/job_spec.rb:640 # Rufus::Scheduler::Job work time #mean_work_time gathers work times and computes the mean
+rspec ./spec/schedule_at_spec.rb:60 # Rufus::Scheduler#at triggers a job
+rspec ./spec/schedule_in_spec.rb:44 # Rufus::Scheduler#in removes the job after execution
+rspec ./spec/scheduler_spec.rb:83 # Rufus::Scheduler a schedule method passes the job to its block when it triggers
+rspec ./spec/scheduler_spec.rb:534 # Rufus::Scheduler#running_jobs(:tag/:tags => x) returns a list of running jobs filtered by tag
+rspec ./spec/scheduler_spec.rb:601 # Rufus::Scheduler#occurrences(time0, time1) respects :times for repeat jobs
+rspec ./spec/scheduler_spec.rb:1019 # Rufus::Scheduler#on_post_trigger is called right after a job triggers
+
+
+determine_id specs are slower... much slower...
+