rufus-scheduler 3.0.9 → 3.1.0

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.1.0    released 2015/04/18
+
+- go without tzinfo (and its dependencies)
+- include @ketan's #next_time improvements
+- remove 2.x warning message on install
+
+
 == rufus-scheduler - 3.0.9    released 2014/08/30
 
 - fix TZ with underscores, thanks https://github.com/gnilrets

data/CREDITS.txt

@@ -4,6 +4,8 @@
 
 == Contributors
 
+- Ketan Padegaonkar (https://github.com/ketan) .brute_frequency improvement
+- Gabriel Gilder (https://github.com/ggilder) LA DST specs
 - Sterling Paramore (https://github.com/gnilrets) underscore TZ fix
 - ecin (https://github.com/ecin) new lock mecha
 - Adam Jonas (https://github.com/adamjonas) migrate specs to "expect"
@@ -33,6 +35,7 @@
 
 == Feedback
 
+- Michael Guymon - https://github.com/mguymon - #next_time vs :first_at
 - junhanamaki - https://github.com/junhanamaki - #next_time and dst ambiguities
 - kreynolds (tossrock) - inspiration for #occurrences
 - Matteo - https://github.com/m4ce - dst and cron issue

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2005-2014, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2005-2015, 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

@@ -61,6 +61,7 @@ It does not persist your schedules. When the process is gone and the scheduler i
 
 * [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
 
 (please note: rufus-scheduler is not a cron replacement)
 
@@ -72,6 +73,11 @@ It's a complete rewrite of rufus-scheduler.
 There is no EventMachine-based scheduler anymore.
 
 
+## I don't know what this Ruby thing is, where are my Rails?
+
+Sir, I'll drive you right to the [tracks](#so-rails).
+
+
 ## Notables changes:
 
 * As said, no more EventMachine-based scheduler
@@ -1370,19 +1376,6 @@ Rufus::Scheduler.parse("2013-12-12 14:00 Pacific/Saipan")
   # => 2013-12-12 04:00:00 UTC
 ```
 
-Behind the scenes, rufus-scheduler uses [tzinfo](http://tzinfo.github.io/) to deal with timezones.
-
-Here is a [list of timezones](misc/tz_all.txt) known to my Debian GNU/Linux 7. It was generated with this script:
-
-```ruby
-require 'tzinfo'
-TZInfo::Timezone.all.each { |tz| puts tz.name }
-```
-
-Unknown timezones, typos, will be rejected by tzinfo thus rufus-scheduler.
-
-On its own tzinfo derives the timezones from the system's information. On some system it needs some help, one can install the 'tzinfo-data' gem to provide the missing information.
-
 
 ## so Rails?
 

data/lib/rufus/scheduler.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2014, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2015, 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
@@ -25,7 +25,7 @@
 require 'date' if RUBY_VERSION < '1.9.0'
 require 'time'
 require 'thread'
-require 'tzinfo'
+#require 'tzinfo'
 
 
 module Rufus
@@ -33,12 +33,13 @@ module Rufus
   class Scheduler
 
     require 'rufus/scheduler/util'
+    require 'rufus/scheduler/zotime'
     require 'rufus/scheduler/jobs'
     require 'rufus/scheduler/cronline'
     require 'rufus/scheduler/job_array'
     require 'rufus/scheduler/locks'
 
-    VERSION = '3.0.9'
+    VERSION = '3.1.0'
 
     #
     # A common error class for rufus-scheduler

data/lib/rufus/scheduler/cronline.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2014, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2015, 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
@@ -22,6 +22,8 @@
 # Made in Japan.
 #++
 
+require 'set'
+
 
 class Rufus::Scheduler
 
@@ -54,8 +56,7 @@ class Rufus::Scheduler
 
       items = line.split
 
-      @timezone = (TZInfo::Timezone.get(items.last) rescue nil)
-      items.pop if @timezone
+      @timezone = items.pop if ZoTime.is_timezone?(items.last)
 
       raise ArgumentError.new(
         "not a valid cronline : '#{line}'"
@@ -82,9 +83,7 @@ class Rufus::Scheduler
     #
     def matches?(time)
 
-      time = Time.at(time) unless time.kind_of?(Time)
-
-      time = @timezone.utc_to_local(time.getutc) if @timezone
+      time = ZoTime.new(time.to_f, @timezone || ENV['TZ']).time
 
       return false unless sub_match?(time, :sec, @seconds)
       return false unless sub_match?(time, :min, @minutes)
@@ -122,37 +121,34 @@ class Rufus::Scheduler
     #
     def next_time(from=Time.now)
 
-      time = local_time(from)
-      time = round_to_seconds(time)
-
-      # start at the next second
-      time = time + 1
+      time = nil
+      zotime = ZoTime.new(from.to_i + 1, @timezone || ENV['TZ'])
 
       loop do
+
+        time = zotime.time
+
         unless date_match?(time)
-          dst = time.isdst
-          time += (24 - time.hour) * 3600 - time.min * 60 - time.sec
-          time -= 3600 if time.isdst != dst # not necessary for winter, but...
+          zotime.add((24 - time.hour) * 3600 - time.min * 60 - time.sec)
           next
         end
         unless sub_match?(time, :hour, @hours)
-          time += (60 - time.min) * 60 - time.sec; next
+          zotime.add((60 - time.min) * 60 - time.sec)
+          next
         end
         unless sub_match?(time, :min, @minutes)
-          time += 60 - time.sec; next
+          zotime.add(60 - time.sec)
+          next
         end
         unless sub_match?(time, :sec, @seconds)
-          time += 1; next
+          zotime.add(next_second(time))
+          next
         end
 
         break
       end
 
-      global_time(time, from.utc?)
-
-    rescue TZInfo::PeriodNotFound
-
-      next_time(from + 3600)
+      time
     end
 
     # Returns the previous time the cronline matched. It's like next_time, but
@@ -160,35 +156,48 @@ class Rufus::Scheduler
     #
     def previous_time(from=Time.now)
 
-      time = local_time(from)
-      time = round_to_seconds(time)
-
-      # start at the previous second
-      time = time - 1
+      time = nil
+      zotime = ZoTime.new(from.to_i - 1, @timezone || ENV['TZ'])
 
       loop do
+
+        time = zotime.time
+
         unless date_match?(time)
-          time -= time.hour * 3600 + time.min * 60 + time.sec + 1; next
+          zotime.substract(time.hour * 3600 + time.min * 60 + time.sec + 1)
+          next
         end
         unless sub_match?(time, :hour, @hours)
-          time -= time.min * 60 + time.sec + 1; next
+          zotime.substract(time.min * 60 + time.sec + 1)
+          next
         end
         unless sub_match?(time, :min, @minutes)
-          time -= time.sec + 1; next
+          zotime.substract(time.sec + 1)
+          next
         end
         unless sub_match?(time, :sec, @seconds)
-          time -= 1; next
+          zotime.substract(prev_second(time))
+          next
         end
 
         break
       end
 
-      global_time(time, from.utc?)
-
-    rescue TZInfo::PeriodNotFound
+      time
+    end
 
-      previous_time(time)
+    if RUBY_VERSION >= '1.9'
+      def toa(item)
+        item == nil ? nil : item.to_a
+      end
+    else
+      def toi(item); item.is_a?(String) ? item.hash.abs : item.to_i; end
+      protected :toi
+      def toa(item)
+        item.is_a?(Set) ? item.to_a.sort_by { |e| toi(e) } : item
+      end
     end
+    protected :toa
 
     # Returns an array of 6 arrays (seconds, minutes, hours, days,
     # months, weekdays).
@@ -197,14 +206,14 @@ class Rufus::Scheduler
     def to_array
 
       [
-        @seconds,
-        @minutes,
-        @hours,
-        @days,
-        @months,
-        @weekdays,
-        @monthdays,
-        @timezone ? @timezone.name : nil
+        toa(@seconds),
+        toa(@minutes),
+        toa(@hours),
+        toa(@days),
+        toa(@months),
+        toa(@weekdays),
+        toa(@monthdays),
+        @timezone
       ]
     end
 
@@ -212,7 +221,7 @@ class Rufus::Scheduler
     # cron line.
     #
     # #brute_frequency, on the other hand, will compute the frequency by
-    # examining a whole, that can take more than seconds for a seconds
+    # examining a whole year, that can take more than seconds for a seconds
     # level cron...
     #
     def frequency
@@ -220,9 +229,10 @@ class Rufus::Scheduler
       return brute_frequency unless @seconds && @seconds.length > 1
 
       delta = 60
-      prev = @seconds[0]
+      secs = toa(@seconds)
+      prev = secs[0]
 
-      @seconds[1..-1].each do |sec|
+      secs[1..-1].each do |sec|
         d = sec - prev
         delta = d if d < delta
       end
@@ -270,7 +280,7 @@ class Rufus::Scheduler
         delta = d if d < delta
 
         break if @months == nil && t1.month == 2
-        break if t1.year == 2001
+        break if t1.year >= 2001
 
         t0 = t1
       end
@@ -280,6 +290,26 @@ class Rufus::Scheduler
 
     protected
 
+    def next_second(time)
+
+      secs = @seconds.sort
+
+      return secs.last + 60 - time.sec if time.sec > secs.last
+
+      secs.shift while secs.first < time.sec
+
+      secs.first - time.sec
+    end
+
+    def prev_second(time)
+
+      secs = @seconds.sort
+
+      secs.pop while time.sec < secs.last
+
+      time.sec - secs.last
+    end
+
     WEEKDAYS = %w[ sun mon tue wed thu fri sat ]
     DAY_S = 24 * 3600
     WEEK_S = 7 * DAY_S
@@ -336,7 +366,7 @@ class Rufus::Scheduler
         "found duplicates in #{item.inspect}"
       ) if r.uniq.size < r.size
 
-      r
+      Set.new(r)
     end
 
     RANGE_REGEX = /^(\*|\d{1,2})(?:-(\d{1,2}))?(?:\/(\d{1,2}))?$/
@@ -435,32 +465,6 @@ class Rufus::Scheduler
 
       [ "#{WEEKDAYS[date.wday]}##{pos}", "#{WEEKDAYS[date.wday]}##{neg}" ]
     end
-
-    def local_time(time)
-
-      @timezone ? @timezone.utc_to_local(time.getutc) : time
-    end
-
-    def global_time(time, from_in_utc)
-
-      if @timezone
-        time =
-          begin
-            @timezone.local_to_utc(time)
-          rescue TZInfo::AmbiguousTime
-            @timezone.local_to_utc(time, time.isdst)
-          end
-        time = time.getlocal unless from_in_utc
-      end
-
-      time
-    end
-
-    def round_to_seconds(time)
-
-      # Ruby 1.8 doesn't have #round
-      time.respond_to?(:round) ? time.round : time - time.usec * 1e-6
-    end
   end
 end
 

data/lib/rufus/scheduler/job_array.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2014, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2015, 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
@@ -22,6 +22,7 @@
 # Made in Japan.
 #++
 
+
 module Rufus
 
   class Scheduler

data/lib/rufus/scheduler/jobs.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2014, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2006-2015, 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
@@ -340,7 +340,7 @@ module Rufus
 
       def occurrences(time0, time1)
 
-        time >= time0 && time <= time1 ? [ time ] : []
+        (time >= time0 && time <= time1) ? [ time ] : []
       end
 
       protected
@@ -409,15 +409,17 @@ module Rufus
         self.first_at =
           opts[:first] || opts[:first_time] ||
           opts[:first_at] || opts[:first_in] ||
-          0
+          nil
         self.last_at =
           opts[:last] || opts[:last_at] || opts[:last_in]
       end
 
       def first_at=(first)
 
+        return @first_at = nil if first == nil
+
         n = Time.now
-        first = n + 0.001 if first == :now || first == :immediately
+        first = n + 0.003 if first == :now || first == :immediately
 
         @first_at = Rufus::Scheduler.parse_to_time(first)
 
@@ -440,9 +442,6 @@ module Rufus
       def trigger(time)
 
         return if @paused_at
-        return if time < @first_at
-          #
-          # TODO: remove me when @first_at gets reworked
 
         return (@next_time = nil) if @times && @times < 1
         return (@next_time = nil) if @last_at && time >= @last_at
@@ -538,10 +537,8 @@ module Rufus
         return if is_post
 
         @next_time =
-          if trigger_time
-            trigger_time + @frequency
-          elsif @first_at < Time.now
-            Time.now + @frequency
+          if @first_at == nil || @first_at < Time.now
+            (trigger_time || Time.now) + @frequency
           else
             @first_at
           end
@@ -579,7 +576,7 @@ module Rufus
           if is_post
             Time.now + @interval
           elsif trigger_time.nil?
-            if @first_at < Time.now
+            if @first_at == nil || @first_at < Time.now
               Time.now + @interval
             else
               @first_at
@@ -602,7 +599,7 @@ module Rufus
         super(scheduler, cronline, opts, block)
 
         @cron_line = opts[:_t] || CronLine.new(cronline)
-        @next_time = @cron_line.next_time
+        set_next_time(nil)
       end
 
       def frequency
@@ -619,12 +616,16 @@ module Rufus
 
       def set_next_time(trigger_time, is_post=false)
 
-        @next_time = @cron_line.next_time
+        @next_time = next_time_from(trigger_time || Time.now)
       end
 
       def next_time_from(time)
 
-        @cron_line.next_time(time)
+        if @first_at == nil || @first_at < time
+          @cron_line.next_time(time)
+        else
+          @first_at
+        end
       end
     end
   end