rufus-scheduler 3.1.9 → 3.2.0

data/CHANGELOG.txt

@@ -2,6 +2,20 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.2.0    released 2015-12-28
+
+- cache CronLine#brute_frequency results, gh-188 and gh-89
+- "every" shift prevention by https://github.com/Korrigan
+- Ruby warnings silenced by https://github.com/vivitar
+
+
+== rufus-scheduler - 3.1.10    released 2015-11-18
+
+- allow for :first_in => 0, gh-179 by https://github.com/JonMcPherson
+  for https://github.com/Shopify/dashing/commit/ea3730fa4
+- stop shipping specs in gem
+
+
 == rufus-scheduler - 3.1.9    released 2015-11-12
 
 - fix potential RuntimeError in CronLine#prev_second,

data/CREDITS.txt

@@ -4,6 +4,10 @@
 
 == Contributors
 
+- 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
+- Jon McPherson (https://github.com/JonMcPherson) :first_in => 0 back
 - Calinoiu Alexandru Nicolae (https://github.com/alexandru-calinoiu) CronLine#prev_second fix
 - Alyssa Pohahau (https://github.com/alyssa) out of DST transition specs
 - Claude Vessaz (https://github.com/claudeatsafe) ack #unscheduled_at in #scheduled?
@@ -42,6 +46,7 @@
 
 == Feedback
 
+- 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
 - Patrik Ragnarsson - https://github.com/dentarg - timeout vs nil, gh-156

data/README.md

@@ -123,7 +123,8 @@ 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)
-* [Unicorn and rufus-scheduler](https://jkraemer.net/running-rufus-scheduler-in-a-unicorn-rails-app)
+* [The scheduler comes up when running the Rails console](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)
 
 
 ## scheduling
@@ -1428,6 +1429,34 @@ The rufus-scheduler singleton is instantiated in the ```config/initializers/sche
 
 *Warning*: this works well with single-process Ruby servers like Webrick and Thin. Using rufus-scheduler with Passenger or Unicorn requires a bit more knowledge and tuning, gently provided by a bit of googling and reading, see [Faq](#faq) above.
 
+### avoid scheduling when running the Ruby on Rails console
+
+(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:
+
+```ruby
+#
+# config/initializers/scheduler.rb
+
+require 'rufus-scheduler'
+
+s = Rufus::Scheduler.singleton
+
+
+unless defined?(Rails::Console)
+  # only schedule when not running from the Rails on Rails console
+
+  s.every '1m' do
+
+    Rails.logger.info "hello, it's #{Time.now}"
+    Rails.logger.flush
+  end
+end
+```
+
+It should work for Ruby on Rails 3 and 4.
+
 ### rails server -d
 
 (Written in reply to https://github.com/jmettraux/rufus-scheduler/issues/165 )

data/lib/rufus/scheduler/cronline.rb

@@ -42,13 +42,13 @@ class Rufus::Scheduler
     attr_reader :hours
     attr_reader :days
     attr_reader :months
+    #attr_reader :monthdays # reader defined below
     attr_reader :weekdays
-    attr_reader :monthdays
     attr_reader :timezone
 
     def initialize(line)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "not a string: #{line.inspect}"
       ) unless line.is_a?(String)
 
@@ -58,7 +58,7 @@ class Rufus::Scheduler
 
       @timezone = items.pop if ZoTime.is_timezone?(items.last)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "not a valid cronline : '#{line}'"
       ) unless items.length == 5 or items.length == 6
 
@@ -73,7 +73,7 @@ class Rufus::Scheduler
 
       [ @seconds, @minutes, @hours, @months ].each do |es|
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "invalid cronline: '#{line}'"
         ) if es && es.find { |e| ! e.is_a?(Fixnum) }
       end
@@ -223,6 +223,10 @@ class Rufus::Scheduler
       }[1]
     end
 
+    # Caching facility. Currently only used for brute frequencies.
+    #
+    @cache = {}; class << self; attr_reader :cache; end
+
     # Returns the shortest delta between two potential occurences of the
     # schedule described by this cronline.
     #
@@ -239,16 +243,13 @@ class Rufus::Scheduler
     # Of course, this method can get VERY slow if you call on it a second-
     # based cronline...
     #
-    # Since it's a rarely used method, I haven't taken the time to make it
-    # smarter/faster.
-    #
-    # One obvious improvement would be to cache the result once computed...
-    #
-    # See https://github.com/jmettraux/rufus-scheduler/issues/89
-    # for a discussion about this method.
-    #
     def brute_frequency
 
+      key = "brute_frequency:#{@original}"
+
+      delta = self.class.cache[key]
+      return delta if delta
+
       delta = 366 * DAY_S
 
       t0 = previous_time(Time.local(2000, 1, 1))
@@ -268,7 +269,7 @@ class Rufus::Scheduler
         t0 = t1
       end
 
-      delta
+      self.class.cache[key] = delta
     end
 
     def next_second(time)
@@ -327,7 +328,7 @@ class Rufus::Scheduler
 
         if m = it.match(/^(.+)#(l|-?[12345])$/)
 
-          raise ArgumentError.new(
+          fail ArgumentError.new(
             "ranges are not supported for monthdays (#{it})"
           ) if m[1].index('-')
 
@@ -340,7 +341,7 @@ class Rufus::Scheduler
           expr = it.dup
           WEEKDAYS.each_with_index { |a, i| expr.gsub!(/#{a}/, i.to_s) }
 
-          raise ArgumentError.new(
+          fail ArgumentError.new(
             "invalid weekday expression (#{it})"
           ) if expr !~ /^0*[0-7](-0*[0-7])?$/
 
@@ -362,7 +363,7 @@ class Rufus::Scheduler
 
       r = item.split(',').map { |i| parse_range(i.strip, min, max) }.flatten
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "found duplicates in #{item.inspect}"
       ) if r.uniq.size < r.size
 
@@ -377,11 +378,11 @@ class Rufus::Scheduler
 
       return %w[ L ] if item == 'L'
 
-      item = '*' + item if item.match(/^\//)
+      item = '*' + item if item[0, 1] == '/'
 
       m = item.match(RANGE_REGEX)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "cannot parse #{item.inspect}"
       ) unless m
 
@@ -395,7 +396,7 @@ class Rufus::Scheduler
       inc = m[3]
       inc = inc ? inc.to_i : 1
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "#{item.inspect} is not in range #{min}..#{max}"
       ) if sta < min || edn > max
 

data/lib/rufus/scheduler/jobs.rb

@@ -91,7 +91,7 @@ module Rufus
 
         @id = determine_id
 
-        raise(
+        fail(
           ArgumentError,
           'missing block or callable to schedule',
           caller[2..-1]
@@ -235,7 +235,7 @@ module Rufus
 
       rescue StandardError => se
 
-        raise se unless do_rescue
+        fail se unless do_rescue
 
         return if se.is_a?(KillSignal) # discard
 
@@ -391,7 +391,7 @@ module Rufus
       attr_reader :paused_at
 
       attr_reader :first_at
-      attr_accessor :last_at
+      attr_reader :last_at
       attr_accessor :times
 
       def initialize(scheduler, duration, opts, block)
@@ -402,7 +402,7 @@ module Rufus
 
         @times = opts[:times]
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "cannot accept :times => #{@times.inspect}, not nil or an int"
         ) unless @times == nil || @times.is_a?(Fixnum)
 
@@ -416,27 +416,34 @@ module Rufus
 
       def first_at=(first)
 
-        return @first_at = nil if first == nil
+        return (@first_at = nil) if first == nil
 
-        n = Time.now
-        first = n + 0.003 if first == :now || first == :immediately
+        n0 = Time.now
+        n1 = n0 + 0.003
+
+        first = n0 if first == :now || first == :immediately || first == 0
 
         @first_at = Rufus::Scheduler.parse_to_time(first)
+        @first_at = n1 if @first_at >= n0 && @first_at < n1
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "cannot set first[_at|_in] in the past: " +
           "#{first.inspect} -> #{@first_at.inspect}"
-        ) if first != 0 && @first_at < n
+        ) if @first_at < n0
+
+        @first_at
       end
 
       def last_at=(last)
 
         @last_at = last ? Rufus::Scheduler.parse_to_time(last) : nil
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "cannot set last[_at|_in] in the past: " +
           "#{last.inspect} -> #{@last_at.inspect}"
         ) if last && @last_at < Time.now
+
+        @last_at
       end
 
       def trigger(time)
@@ -522,7 +529,7 @@ module Rufus
 
         @frequency = Rufus::Scheduler.parse_in(@original)
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "cannot schedule #{self.class} with a frequency " +
           "of #{@frequency.inspect} (#{@original.inspect})"
         ) if @frequency <= 0
@@ -536,9 +543,12 @@ module Rufus
 
         return if is_post
 
+        n = Time.now
+
         @next_time =
-          if @first_at == nil || @first_at < Time.now
-            (trigger_time || Time.now) + @frequency
+          if @first_at == nil || @first_at < n
+            nt = (@next_time || trigger_time || n) + @frequency
+            nt > n ? nt : (trigger_time || n) + @frequency
           else
             @first_at
           end
@@ -560,7 +570,7 @@ module Rufus
 
         @interval = Rufus::Scheduler.parse_in(@original)
 
-        raise ArgumentError.new(
+        fail ArgumentError.new(
           "cannot schedule #{self.class} with an interval " +
           "of #{@interval.inspect} (#{@original.inspect})"
         ) if @interval <= 0

data/lib/rufus/scheduler/util.rb

@@ -38,7 +38,7 @@ module Rufus
       parse_cron(o, opts) ||
       parse_in(o, opts) || # covers 'every' schedule strings
       parse_at(o, opts) ||
-      raise(ArgumentError.new("couldn't parse \"#{o}\""))
+      fail(ArgumentError.new("couldn't parse \"#{o}\""))
     end
 
     def self.parse_in(o, opts={})
@@ -53,7 +53,7 @@ module Rufus
     rescue StandardError => se
 
       return nil if opts[:no_error]
-      raise se
+      fail se
     end
 
     def self.parse_cron(o, opts)
@@ -63,7 +63,7 @@ module Rufus
     rescue ArgumentError => ae
 
       return nil if opts[:no_error]
-      raise ae
+      fail ae
     end
 
     def self.parse_to_time(o)
@@ -72,7 +72,7 @@ module Rufus
       t = parse(t) if t.is_a?(String)
       t = Time.now + t if t.is_a?(Numeric)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "cannot turn #{o.inspect} to a point in time, doesn't make sense"
       ) unless t.is_a?(Time)
 
@@ -132,7 +132,7 @@ module Rufus
       m = string.match(/^(-?)([\d\.#{DURATION_LETTERS}]+)$/)
 
       return nil if m.nil? && opts[:no_error]
-      raise ArgumentError.new("cannot parse '#{string}'") if m.nil?
+      fail ArgumentError.new("cannot parse '#{string}'") if m.nil?
 
       mod = m[1] == '-' ? -1.0 : 1.0
       val = 0.0
@@ -150,9 +150,7 @@ module Rufus
         elsif opts[:no_error]
           return nil
         else
-          raise ArgumentError.new(
-            "cannot parse '#{string}' (especially '#{s}')"
-          )
+          fail ArgumentError.new("cannot parse '#{string}' (especially '#{s}')")
         end
         break unless m && m[3]
         s = m[3]

data/lib/rufus/scheduler/zotime.rb

@@ -101,7 +101,7 @@ class Rufus::Scheduler
       begin
         DateTime.parse(str)
       rescue
-        raise ArgumentError, "no time information in #{o.inspect}"
+        fail ArgumentError, "no time information in #{o.inspect}"
       end if RUBY_VERSION < '1.9.0'
 
       zone = nil

data/lib/rufus/scheduler.rb

@@ -39,7 +39,7 @@ module Rufus
     require 'rufus/scheduler/job_array'
     require 'rufus/scheduler/locks'
 
-    VERSION = '3.1.9'
+    VERSION = '3.2.0'
 
     #
     # A common error class for rufus-scheduler
@@ -385,7 +385,7 @@ module Rufus
     #
     def scheduled?(job_or_job_id)
 
-      job, job_id = fetch(job_or_job_id)
+      job, _ = fetch(job_or_job_id)
 
       !! (job && job.unscheduled_at.nil? && job.next_time != nil)
     end
@@ -441,7 +441,7 @@ module Rufus
       if format == :timeline
         a = []
         h.each { |j, ts| ts.each { |t| a << [ t, j ] } }
-        a.sort_by { |(t, j)| t }
+        a.sort_by { |(t, _)| t }
       else
         h
       end
@@ -629,7 +629,7 @@ module Rufus
 
       job = job_class.new(self, t, opts, block || callable)
 
-      raise ArgumentError.new(
+      fail ArgumentError.new(
         "job frequency (#{job.frequency}) is higher than " +
         "scheduler frequency (#{@frequency})"
       ) if job.respond_to?(:frequency) && job.frequency < @frequency

data/rufus-scheduler.gemspec

@@ -22,7 +22,7 @@ job scheduler for Ruby (at, cron, in and every jobs).
   #s.files = `git ls-files`.split("\n")
   s.files = Dir[
     'Rakefile',
-    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
     '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 

metadata

@@ -1,69 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: rufus-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.1.9
+  version: 3.2.0
+  prerelease: 
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: job scheduler for Ruby (at, cron, in and every jobs).
@@ -73,14 +82,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.txt
-- CREDITS.txt
-- LICENSE.txt
-- README.md
 - Rakefile
-- TODO.txt
-- lib/rufus-scheduler.rb
-- lib/rufus/scheduler.rb
 - lib/rufus/scheduler/cronline.rb
 - lib/rufus/scheduler/job_array.rb
 - lib/rufus/scheduler/jobs.rb
@@ -88,55 +90,37 @@ files:
 - lib/rufus/scheduler/util.rb
 - lib/rufus/scheduler/zones.rb
 - lib/rufus/scheduler/zotime.rb
+- lib/rufus/scheduler.rb
+- lib/rufus-scheduler.rb
 - rufus-scheduler.gemspec
-- spec/basics_spec.rb
-- spec/cronline_spec.rb
-- spec/error_spec.rb
-- spec/job_array_spec.rb
-- spec/job_at_spec.rb
-- spec/job_cron_spec.rb
-- spec/job_every_spec.rb
-- spec/job_in_spec.rb
-- spec/job_interval_spec.rb
-- spec/job_repeat_spec.rb
-- spec/job_spec.rb
-- spec/lock_custom_spec.rb
-- spec/lock_flock_spec.rb
-- spec/lock_lockfile_spec.rb
-- spec/lock_spec.rb
-- spec/parse_spec.rb
-- spec/schedule_at_spec.rb
-- spec/schedule_cron_spec.rb
-- spec/schedule_every_spec.rb
-- spec/schedule_in_spec.rb
-- spec/schedule_interval_spec.rb
-- spec/scheduler_spec.rb
-- spec/spec_helper.rb
-- spec/threads_spec.rb
-- spec/zotime_spec.rb
-- t.txt
+- CHANGELOG.txt
+- CREDITS.txt
+- LICENSE.txt
+- TODO.txt
+- README.md
 homepage: http://github.com/jmettraux/rufus-scheduler
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rufus
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: job scheduler for Ruby (at, cron, in and every jobs)
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 03122e92f3b47a4af3d12b06762f5f4caa604341
-  data.tar.gz: 8db6b1570347d1ffa1871fe9d90163729fbf7516
-SHA512:
-  metadata.gz: 0bf2d0ab22e975dc6832fc651dd415708a998960b4b9503865fe560c9b78284b54ac2b5957d8c912d1415776898e211eb6fe6a56c456613df85f5b4afcf35e0f
-  data.tar.gz: 52b001210ccea2c628e4a95e2bde023725cbb1ce9ee78bd635cfedddafcbed9851abda8eb0edb46e5816ba7ddc80e55dae256588a6caf079f9ebd126d5dbd3c7

data/spec/basics_spec.rb

@@ -1,54 +0,0 @@
-
-#
-# Specifying rufus-scheduler
-#
-# Sun Jun  1 05:52:24 JST 2014
-#
-
-require 'spec_helper'
-
-
-describe 'basics' do
-
-  def tts(time)
-
-    time.strftime('%Y-%m-%d %H:%M:%S %z') + (time.dst? ? ' dst' : '')
-  end
-
-  describe 'Time.new' do
-
-    it 'accepts a timezone final argument' do
-
-      if jruby? or ruby18?
-
-        expect(true).to be(true)
-
-      else
-
-        expect(
-          tts(Time.new(2014, 1, 1, 1, 0, 0, '+01:00'))
-        ).to eq('2014-01-01 01:00:00 +0100')
-        expect(
-          tts(Time.new(2014, 8, 1, 1, 0, 0, '+01:00'))
-        ).to eq('2014-08-01 01:00:00 +0100')
-        expect(
-          tts(Time.new(2014, 8, 1, 1, 0, 0, '+01:00'))
-        ).to eq('2014-08-01 01:00:00 +0100')
-      end
-    end
-  end
-
-  describe 'Time.local' do
-
-    it 'works as expected' do
-
-      expect(
-        tts(in_zone('Europe/Berlin') { Time.local(2014, 1, 1, 1, 0, 0) })
-      ).to eq('2014-01-01 01:00:00 +0100')
-      expect(
-        tts(in_zone('Europe/Berlin') { Time.local(2014, 8, 1, 1, 0, 0) })
-      ).to eq('2014-08-01 01:00:00 +0200 dst')
-    end
-  end
-end
-