rufus-scheduler 3.5.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: cc94e118313d64c54f5690f3c2a144c21f7b56c0719c36a0642982f468469750
-  data.tar.gz: 52f2bf8923744d67938cbf0dfa764d8e6304fab512188c916505cf342203ec54
+SHA1:
+  metadata.gz: 02a3bef52f292ce97e4918c53add3f0f6ba7a10c
+  data.tar.gz: '059fec2bf86103a66eb30be091fcd96f4b21abaf'
 SHA512:
-  metadata.gz: f02d8f20e5acaeaa27a8c9e0895e8c1fc5ba534c2c228e683ac36042e32f5306cade78225dc8335e38fab8f724a6edf23b0196d5506d53c989af0e88e65cdbef
-  data.tar.gz: 9aa6c0211441f60d3b326b6d35abde28dbe01558830288b3a4f7d2aed9523e6bf690345ca39656dafc976dec3a658b435735ea8f568cc02856861e074de2f226
+  metadata.gz: 8282e8998f735291b30a5dfd8fc0b03ce5b2a5f19a38d747b197ae46b2b8324076af6583eb3c29a49273a066899871d2edd61f1628d6b9df583144a969095afd
+  data.tar.gz: 0d272804d8de32ba93f96b25e9d7be1a6493166c33865a9bfe6ca38ea848db43a89266818d9c0fec3cc37e4a8e83623f88c56566bdb59f2afd85f6c484b0dea6

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 # CHANGELOG.md
 
 
+### rufus-scheduler 3.6.0 - released 2019-04-22
+
+* Let Scheduler#cron fail if the cron string is invalid, gh-289
+* Implement Job#next_times(count) for cron, every, and interval jobs
+* Implement Job#next_times(count) for at and in jobs
+* Stop fooling around and stick to https://semver.org
+
+
 ### rufus-scheduler 3.5.2 - released 2018-08-01
 
 * Use Fugit::Cron#rough_frequency

data/CREDITS.md

@@ -4,6 +4,10 @@
 
 ## Contributors
 
+* Darwin Wu https://github.com/dwaxe Rails initializer vs tests change
+* Mike Karolow https://github.com/mike-yesware update Travis target Rubies
+* Jack-Nie https://github.com/jack-nie gh-285 fix broken comment link
+* Yechiel Kalmenson (https://github.com/achasveachas) README link fix
 * Alex Coomans (https://github.com/drcapulet) gh-276 freq check pref improvement
 * Vais Salikhov (https://github.com/vais) many document clarifications
 * Wes McNamee (https://github.com/ghostsquad) let #schedule accept a CronLine

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2005-2017, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2005-2019, 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/README.md

@@ -1,8 +1,9 @@
 
 # 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)
+[![Build Status](https://secure.travis-ci.org/jmettraux/rufus-scheduler.svg)](https://travis-ci.org/jmettraux/rufus-scheduler)
+[![Gem Version](https://badge.fury.io/rb/rufus-scheduler.svg)](https://badge.fury.io/rb/rufus-scheduler)
+[![Join the chat at https://gitter.im/floraison/fugit](https://badges.gitter.im/floraison/fugit.svg)](https://gitter.im/floraison/fugit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Job scheduler for Ruby (at, cron, in and every jobs).
 
@@ -58,6 +59,8 @@ end
 # ...
 ```
 
+Rufus-scheduler uses [fugit](https://github.com/floraison/fugit) for parsing time strings, [et-orbi](https://github.com/floraison/et-orbi) for pairing time and [tzinfo](https://github.com/tzinfo/tzinfo) timezones.
+
 ## non-features
 
 Rufus-scheduler (out of the box) is an in-process, in-memory scheduler. It uses threads.
@@ -72,7 +75,7 @@ A rufus-scheduler instance will go on scheduling while it is present among the o
 * [Whenever](https://github.com/javan/whenever) - let cron call back your Ruby code, trusted and reliable cron drives your schedule
 * [Clockwork](https://github.com/Rykian/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
+* [PerfectSched](https://github.com/treasure-data/perfectsched) - highly available distributed cron built on [Sequel](https://sequel.jeremyevans.net) and more
 
 (please note: rufus-scheduler is not a cron replacement)
 
@@ -89,7 +92,7 @@ There is no EventMachine-based scheduler anymore.
 I'll drive you right to the [tracks](#so-rails).
 
 
-## Notable changes:
+## notable changes:
 
 * As said, no more EventMachine-based scheduler
 * ```scheduler.every('100') {``` will schedule every 100 seconds (previously, it would have been 0.1s). This aligns rufus-scheduler with Ruby's ```sleep(100)```
@@ -108,26 +111,26 @@ So you need help. People can help you, but first help them help you, and don't w
 
 "hello", "please" and "thanks" are not swear words.
 
-Go read [how to report bugs effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html), twice.
+Go read [how to report bugs effectively](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), twice.
 
 Update: [help_help.md](https://gist.github.com/jmettraux/310fed75f568fd731814) might help help you.
 
-### on IRC
+### on Gitter
 
-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.
+You can find help via chat over at [https://gitter.im/floraison/fugit](https://gitter.im/floraison/fugit). It's [fugit](https://github.com/floraison/fugit), [et-orbi](https://github.com/floraison/et-orbi), and rufus-scheduler combined chat room.
 
-Please note that I prefer helping over Stack Overflow because it's more searchable than the ruote IRC archive.
+Please be courteous.
 
 ### issues
 
-Yes, issues can be reported in [rufus-scheduler issues](https://github.com/jmettraux/rufus-scheduler/issues), I'd actually prefer bugs in there. If there is nothing wrong with rufus-scheduler, a [Stack Overflow question](http://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby) is better.
+Yes, issues can be reported in [rufus-scheduler issues](https://github.com/jmettraux/rufus-scheduler/issues), I'd actually prefer bugs in there. If there is nothing wrong with rufus-scheduler, a [Stack Overflow question](https://stackoverflow.com/questions/ask?tags=rufus-scheduler+ruby) is better.
 
 ### faq
 
-* [It doesn't work...](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
-* [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)
+* [It doesn't work...](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
+* [I want a refund](https://blog.nodejitsu.com/getting-refunds-on-open-source-projects)
+* [Passenger and rufus-scheduler](https://stackoverflow.com/questions/18108719/debugging-rufus-scheduler/18156180#18156180)
+* [Passenger and rufus-scheduler (2)](https://stackoverflow.com/questions/21861387/rufus-cron-job-not-working-in-apache-passenger#answer-21868555)
 * [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)
@@ -687,6 +690,12 @@ The job keeps track of how long its work was in the `last_work_time` attribute.
 
 The attribute `mean_work_time` contains a computed mean work time. It's recomputed after every run (if it's a repeat job).
 
+### next_times(n)
+
+Returns an array of `EtOrbi::EoTime` instances (Time instances with a designated time zone), listing the `n` next occurrences for this job.
+
+Please note that for "interval" jobs, a mean work time is computed each time and it's used by this `#next_times(n)` method to approximate the next times beyond the immediate next time.
+
 ### unschedule
 
 Unschedule the job, preventing it from firing again and removing it from the schedule. This doesn't prevent a running thread for this job to run until its end.
@@ -1231,7 +1240,7 @@ scheduler.max_work_threads += 10
 ## Rufus::Scheduler.singleton
 
 Do not want to store a reference to your rufus-scheduler instance?
-Then ```Rufus::Scheduler.singleton``` can help, it returns a singleon instance of the scheduler, initialized the first time this class method is called.
+Then ```Rufus::Scheduler.singleton``` can help, it returns a singleton instance of the scheduler, initialized the first time this class method is called.
 
 ```ruby
 Rufus::Scheduler.singleton.every '10s' { puts "hello, world!" }
@@ -1290,7 +1299,7 @@ class ZookeptScheduler < Rufus::Scheduler
 end
 ```
 
-This uses a [zookeeper](http://zookeeper.apache.org/) to make sure only one scheduler in a group of distributed schedulers runs.
+This uses a [zookeeper](https://zookeeper.apache.org/) to make sure only one scheduler in a group of distributed schedulers runs.
 
 The methods #lock and #unlock are overridden and #confirm_lock is provided,
 to make sure that the lock is still valid.
@@ -1314,6 +1323,8 @@ Warning: you may think you're heading towards "high availability" by using a tri
 
 ## parsing cronlines and time strings
 
+(Please note that [fugit](https://github.com/floraison/fugit) does the heavy-lifting parsing work for rufus-scheduler).
+
 Rufus::Scheduler provides a class method ```.parse``` to parse time durations and cron strings. It's what it's using when receiving schedules. One can use it directly (no need to instantiate a Scheduler).
 
 ```ruby
@@ -1550,9 +1561,9 @@ The rufus-scheduler singleton is instantiated in the ```config/initializers/sche
 
 ### avoid scheduling when running the Ruby on Rails console
 
-(Written in reply to https://github.com/jmettraux/rufus-scheduler/issues/186 )
+(Written in reply to [gh-186](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 or invoking a rake task, you can wrap your initializer in a conditional:
+If you don't want rufus-scheduler to trigger anything while running the Ruby on Rails console, running for tests/specs, or running from a Rake task, you can insert a conditional return statement before jobs are added to the scheduler instance:
 
 ```ruby
 #
@@ -1562,21 +1573,17 @@ require 'rufus-scheduler'
 
 s = Rufus::Scheduler.singleton
 
+return if defined?(Rails::Console) || Rails.env.test? || File.split($0).last == 'rake'
 
-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
+# do not schedule when Rails is run from its console, for a test/spec, or
+# from a Rake task
 
-  s.every '1m' do
-
-    Rails.logger.info "hello, it's #{Time.now}"
-    Rails.logger.flush
-  end
+s.every '1m' do
+  Rails.logger.info "hello, it's #{Time.now}"
+  Rails.logger.flush
 end
 ```
 
-It should work for Ruby on Rails 3 and 4.
 
 ### rails server -d
 
@@ -1588,8 +1595,8 @@ I avoid running `-d` in development mode and bother about daemonizing only for p
 
 These are two well crafted articles on process daemonization, please read them:
 
-* http://www.mikeperham.com/2014/09/22/dont-daemonize-your-daemons/
-* http://www.mikeperham.com/2014/07/07/use-runit/
+* https://www.mikeperham.com/2014/09/22/dont-daemonize-your-daemons/
+* https://www.mikeperham.com/2014/07/07/use-runit/
 
 If, anyway, you need something like `rails server -d`, why not try `bundle exec unicorn -D` instead? In my (limited) experience, it worked out of the box (well, had to add `gem 'unicorn'` to `Gemfile` first).
 

data/lib/rufus/scheduler.rb

@@ -11,7 +11,7 @@ module Rufus
 
   class Scheduler
 
-    VERSION = '3.5.2'
+    VERSION = '3.6.0'
 
     EoTime = ::EtOrbi::EoTime
 
@@ -115,7 +115,10 @@ module Rufus
       @started_at = nil
 
       #jobs.each { |j| j.unschedule }
-        # provokes https://github.com/jmettraux/rufus-scheduler/issue/98
+        #
+        # which provokes https://github.com/jmettraux/rufus-scheduler/issues/98
+        # using the following instead:
+        #
       @jobs.array.each { |j| j.unschedule }
 
       @work_queue.clear

data/lib/rufus/scheduler/jobs.rb

@@ -177,6 +177,11 @@ module Rufus
         #
         # might be necessary at some point
 
+      def next_times(count)
+
+        next_time ? [ next_time ] : []
+      end
+
       # Calls the callable (usually a block) wrapped in this Job instance.
       #
       # Warning: error rescueing is the responsibity of the caller.
@@ -520,6 +525,20 @@ module Rufus
 
         a
       end
+
+      # Starting from now, returns the {count} next occurences
+      # (EtOrbi::EoTime instances) for this job.
+      #
+      # Warning, for IntervalJob, the @mean_work_time is used since
+      # "interval" works from the end of a job to its next trigger
+      # (not from one trigger to the next, as for "cron" and "every").
+      #
+      def next_times(count)
+
+        (count - 1).times.inject([ next_time ]) { |a|
+          a << next_time_from(a.last)
+          a }
+      end
     end
 
     #
@@ -559,6 +578,11 @@ module Rufus
         ) if @frequency < @scheduler.frequency
       end
 
+      def next_time_from(time)
+
+        time + @frequency
+      end
+
       protected
 
       def set_next_time(trigger_time, is_post=false)
@@ -574,11 +598,6 @@ module Rufus
             (@next_time || n) + @frequency
           end
       end
-
-      def next_time_from(time)
-
-        time + @frequency
-      end
     end
 
     class IntervalJob < EvInJob
@@ -599,6 +618,11 @@ module Rufus
         set_next_time(nil)
       end
 
+      def next_time_from(time)
+
+        time + @mean_work_time + @interval
+      end
+
       protected
 
       def set_next_time(trigger_time, is_post=false)
@@ -616,11 +640,6 @@ module Rufus
             false
           end
       end
-
-      def next_time_from(time)
-
-        time + @mean_work_time + @interval
-      end
     end
 
     class CronJob < RepeatJob
@@ -631,7 +650,7 @@ module Rufus
 
         super(scheduler, cronline, opts, block)
 
-        @cron_line = opts[:_t] || ::Fugit::Cron.parse(cronline)
+        @cron_line = opts[:_t] || ::Fugit::Cron.do_parse(cronline)
 
         set_next_time(nil)
       end
@@ -661,13 +680,6 @@ module Rufus
         @cron_line.rough_frequency
       end
 
-      protected
-
-      def set_next_time(trigger_time, is_post=false)
-
-        @next_time = next_time_from(trigger_time || Time.now)
-      end
-
       def next_time_from(time)
 
         if @first_at == nil || @first_at <= time
@@ -676,6 +688,13 @@ module Rufus
           @first_at
         end
       end
+
+      protected
+
+      def set_next_time(trigger_time, is_post=false)
+
+        @next_time = next_time_from(trigger_time || Time.now)
+      end
     end
   end
 end

data/rufus-scheduler.gemspec

@@ -40,7 +40,7 @@ Job scheduler for Ruby (at, cron, in and every jobs). Not a replacement for cron
 
   s.required_ruby_version = '>= 1.9'
 
-  s.add_runtime_dependency 'fugit', '~> 1.1', '>= 1.1.5'
+  s.add_runtime_dependency 'fugit', '~> 1.1', '>= 1.1.6'
 
   s.add_development_dependency 'rspec', '~> 3.7'
   s.add_development_dependency 'chronic', '~> 0.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.6.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -19,7 +19,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rufus
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: job scheduler for Ruby (at, cron, in and every jobs)