rufus-scheduler 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aadc34a3585ec0563a43eeecee75009ac311490f
-  data.tar.gz: ea9e07f929da453a7fe63711bd80c75457444f6d
+  metadata.gz: ad34820fe55c8eccd3edf74096abc62679e1469b
+  data.tar.gz: d571059ae2153fc7b6c8db515b4b37ffe965d091
 SHA512:
-  metadata.gz: f43b61128d67c893d88a1a796dbf029c3d18577a80d4f8874c25d8272318252c96da6f499c561e5bafa25349c228d0c950a937db12b492ef2f348667b2ba700d
-  data.tar.gz: c01cbfd377824b64f148f515e65db781f5433eaab1d574fd46c45210139bf1fbbb3ec5b8208f371044bdde909bb7917d38955d5e3dd8fcd3bdff79ef4f52d450
+  metadata.gz: 9524bfda419a72978d51f135243394d2af6b3805003681e6732f3270c49d14237b03943378f69171c62f40d2f0c379e2f3e971243015970d6d21341ef00f9379
+  data.tar.gz: d9320d55f5a4e9c43ffdb1e4b270bcf62c547386bec3ccd781a5f4e171ad8f92dc4cccba3a89f5ecb4412fc3f61fb23a34931ba40353c884069cbdfffd429d34

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-scheduler CHANGELOG.txt
 
 
+== rufus-scheduler - 3.4.0    released 2017-03-23
+
+- Stop supporting Ruby < 1.9
+- Drop ZoTime for et-orbi's Etorbi::EoTime, gh-240
+- Fix for ZooKeeper example, thanks to @djrodgerspryor, gh-238
+
+
 == rufus-scheduler - 3.3.4    released 2017-02-16
 
 - More detailed "cannot determine timezone from nil" message, gh-237

data/CREDITS.txt

@@ -4,6 +4,9 @@
 
 == Contributors
 
+- Benjamin Fleischer (https://github.com/bf4) - ZoTime#subtract
+- Sam Rowe (https://github.com/riddley) - gh-240 timezone for Debian
+- Daniel Rodgers-Pryor (https://github.com/djrodgerspryor) - gh-238 fix ZooKeeper example
 - Cody Cutrer (https://github.com/ccutrer) - gh-232 is_a?(Fixnum) replacement
 - Dominik Sander (https://github.com/dsander) - gh-225, gh-226
 - Piavka (https://github.com/piavka) - Job#trigger_off_schedule, gh-214
@@ -53,6 +56,7 @@
 
 == Feedback
 
+- Vito Laurenza - https://github.com/veetow - help debugging tz issues - gh-240
 - Yoshimi Keiji - https://githuc.com/walf443 - v.3.3.3 mislabelling
 - Alexander Deeb - https://github.com/adeeb1 - gh-230
 - Sofia Bravo - http://stackoverflow.com/users/1123850/sofia-bravo - gh-231

data/README.md

@@ -439,7 +439,7 @@ job.first_at = Time.now + 10
 job.first_at = Rufus::Scheduler.parse('2029-12-12')
 ```
 
-The first argument (in all its flavours) accepts a :now or :immediately value. That schedules the first occurence for immediate triggering. Consider:
+The first argument (in all its flavours) accepts a :now or :immediately value. That schedules the first occurrence for immediate triggering. Consider:
 
 ```ruby
 require 'rufus-scheduler'
@@ -847,7 +847,7 @@ Every jobs use a time duration between each start of their execution, while inte
 
 ### frequency
 
-It returns the shortest interval of time between two potential occurences of the job.
+It returns the shortest interval of time between two potential occurrences of the job.
 
 For instance:
 ```ruby
@@ -1282,7 +1282,7 @@ end
 
 This uses a [zookeeper](http://zookeeper.apache.org/) to make sure only one scheduler in a group of distributed schedulers runs.
 
-The methods #lock and #unlock are overriden and #confirm_lock is provided,
+The methods #lock and #unlock are overridden and #confirm_lock is provided,
 to make sure that the lock is still valid.
 
 The #confirm_lock method is called right before a job triggers (if it is provided). The more generic callback #on_pre_trigger is called right after #confirm_lock.
@@ -1449,7 +1449,7 @@ rufus-scheduler/lib/rufus/scheduler/zotime.rb:41:
 	...
 ```
 
-It may happen on Windows or on systems that poorly hints to Ruby on which timezone to use. It should be solved by setting explicitely the `ENV['TZ']` before the scheduler instantiation:
+It may happen on Windows or on systems that poorly hints to Ruby on which timezone to use. It should be solved by setting explicitly the `ENV['TZ']` before the scheduler instantiation:
 ```ruby
 ENV['TZ'] = 'Asia/Shanghai'
 scheduler = Rufus::Scheduler.new

data/lib/rufus/scheduler.rb

@@ -1,46 +1,26 @@
-#--
-# Copyright (c) 2006-2017, 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
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
 
+require 'set'
 require 'date' if RUBY_VERSION < '1.9.0'
 require 'time'
 require 'thread'
-require 'tzinfo'
+
+require 'et-orbi'
 
 
 module Rufus
 
   class Scheduler
 
+    VERSION = '3.4.0'
+
+    EoTime = ::EtOrbi::EoTime
+
     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.3.4'
-
     #
     # A common error class for rufus-scheduler
     #
@@ -104,7 +84,7 @@ module Rufus
       @trigger_lock = opts[:trigger_lock] || Rufus::Scheduler::NullLock.new
 
       # If we can't grab the @scheduler_lock, don't run.
-      @scheduler_lock.lock || return
+      lock || return
 
       start
     end
@@ -154,12 +134,12 @@ module Rufus
 
     def uptime
 
-      @started_at ? Rufus::Scheduler::ZoTime.now - @started_at : nil
+      @started_at ? EoTime.now - @started_at : nil
     end
 
     def uptime_s
 
-      self.class.to_duration(uptime)
+      uptime ? self.class.to_duration(uptime) : ''
     end
 
     def join
@@ -409,7 +389,7 @@ module Rufus
     # Accepts a query option, which can be set to:
     # * :all (default), returns all the threads that are work threads
     #   or are currently running a job
-    # * :active, returns all threads that are currenly running a job
+    # * :active, returns all threads that are currently running a job
     # * :vacant, returns the threads that are not running a job
     #
     # If, thanks to :blocking => true, a job is scheduled to monopolize the
@@ -478,7 +458,9 @@ module Rufus
       stderr.puts("  #{pre}   tz:")
       stderr.puts("  #{pre}     ENV['TZ']: #{ENV['TZ']}")
       stderr.puts("  #{pre}     Time.now: #{Time.now}")
-      stderr.puts("  #{pre}     local_tzone: #{Rufus::Scheduler::ZoTime.local_tzone.inspect}")
+      stderr.puts("  #{pre}     local_tzone: #{EoTime.local_tzone.inspect}")
+      stderr.puts("  #{pre}   et-orbi:")
+      stderr.puts("  #{pre}     #{EoTime.platform_info}")
       stderr.puts("  #{pre}   scheduler:")
       stderr.puts("  #{pre}     object_id: #{object_id}")
       stderr.puts("  #{pre}     opts:")
@@ -558,7 +540,7 @@ module Rufus
 
     def start
 
-      @started_at = Rufus::Scheduler::ZoTime.now
+      @started_at = EoTime.now
 
       @thread =
         Thread.new do
@@ -585,7 +567,7 @@ module Rufus
 
     def trigger_jobs
 
-      now = Rufus::Scheduler::ZoTime.now
+      now = EoTime.now
 
       @jobs.each(now) do |job|
 
@@ -604,9 +586,9 @@ module Rufus
         next unless job && to && ts
           # thread might just have become inactive (job -> nil)
 
-        to = ts + to unless to.is_a?(Rufus::Scheduler::ZoTime)
+        to = ts + to unless to.is_a?(EoTime)
 
-        next if to > Rufus::Scheduler::ZoTime.now
+        next if to > EoTime.now
 
         t.raise(Rufus::Scheduler::TimeoutError)
       end

data/lib/rufus/scheduler/cronline.rb

@@ -1,28 +1,3 @@
-#--
-# Copyright (c) 2006-2017, 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
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
-
-require 'set'
 
 
 class Rufus::Scheduler
@@ -63,10 +38,10 @@ class Rufus::Scheduler
 
       items = line.split
 
-      if @timezone = ZoTime.get_tzone(items.last)
+      if @timezone = EoTime.get_tzone(items.last)
         @original_timezone = items.pop
       else
-        @timezone = ZoTime.get_tzone(:current)
+        @timezone = EoTime.local_tzone
       end
 
       fail ArgumentError.new(
@@ -99,10 +74,10 @@ class Rufus::Scheduler
     #
     def matches?(time)
 
-        # FIXME Don't create a new ZoTime if time is already a ZoTime in same
+        # FIXME Don't create a new EoTime if time is already a EoTime in same
         #       zone ...
         #       Wait, this seems only used in specs...
-      t = ZoTime.new(time.to_f, @timezone)
+      t = EoTime.new(time.to_f, @timezone)
 
       return false unless sub_match?(t, :sec, @seconds)
       return false unless sub_match?(t, :min, @minutes)
@@ -138,10 +113,10 @@ class Rufus::Scheduler
     #
     # (Thanks to K Liu for the note and the examples)
     #
-    def next_time(from=ZoTime.now)
+    def next_time(from=EoTime.now)
 
       nt = nil
-      zt = ZoTime.new(from.to_i + 1, @timezone)
+      zt = EoTime.new(from.to_i + 1, @timezone)
       maxy = from.year + NEXT_TIME_MAX_YEARS
 
       loop do
@@ -179,10 +154,10 @@ class Rufus::Scheduler
     # Returns the previous time the cronline matched. It's like next_time, but
     # for the past.
     #
-    def previous_time(from=ZoTime.now)
+    def previous_time(from=EoTime.now)
 
       pt = nil
-      zt = ZoTime.new(from.to_i - 1, @timezone)
+      zt = EoTime.new(from.to_i - 1, @timezone)
       miny = from.year - NEXT_TIME_MAX_YEARS
 
       loop do
@@ -195,19 +170,19 @@ class Rufus::Scheduler
         ) if pt.year < miny
 
         unless date_match?(pt)
-          zt.substract(pt.hour * 3600 + pt.min * 60 + pt.sec + 1)
+          zt.subtract(pt.hour * 3600 + pt.min * 60 + pt.sec + 1)
           next
         end
         unless sub_match?(pt, :hour, @hours)
-          zt.substract(pt.min * 60 + pt.sec + 1)
+          zt.subtract(pt.min * 60 + pt.sec + 1)
           next
         end
         unless sub_match?(pt, :min, @minutes)
-          zt.substract(pt.sec + 1)
+          zt.subtract(pt.sec + 1)
           next
         end
         unless sub_match?(pt, :sec, @seconds)
-          zt.substract(prev_second(pt))
+          zt.subtract(prev_second(pt))
           next
         end
 
@@ -259,7 +234,7 @@ class Rufus::Scheduler
     #
     @cache = {}; class << self; attr_reader :cache; end
 
-    # Returns the shortest delta between two potential occurences of the
+    # Returns the shortest delta between two potential occurrences of the
     # schedule described by this cronline.
     #
     # .

data/lib/rufus/scheduler/job_array.rb

@@ -1,27 +1,3 @@
-#--
-# Copyright (c) 2006-2017, 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
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
-
 
 module Rufus
 

data/lib/rufus/scheduler/jobs.rb

@@ -1,27 +1,3 @@
-#--
-# Copyright (c) 2006-2017, 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
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# Made in Japan.
-#++
-
 
 module Rufus
 
@@ -86,7 +62,7 @@ module Rufus
             nil
           end
 
-        @scheduled_at = Rufus::Scheduler::ZoTime.now
+        @scheduled_at = EoTime.now
         @unscheduled_at = nil
         @last_time = nil
 
@@ -132,14 +108,14 @@ module Rufus
       # Done in collaboration with Piavka in
       # https://github.com/jmettraux/rufus-scheduler/issues/214
       #
-      def trigger_off_schedule(time=Rufus::Scheduler::ZoTime.now)
+      def trigger_off_schedule(time=EoTime.now)
 
         do_trigger(time)
       end
 
       def unschedule
 
-        @unscheduled_at = Rufus::Scheduler::ZoTime.now
+        @unscheduled_at = EoTime.now
       end
 
       def threads
@@ -199,7 +175,7 @@ module Rufus
       #
       def call(do_rescue=false)
 
-        do_call(Rufus::Scheduler::ZoTime.now, do_rescue)
+        do_call(EoTime.now, do_rescue)
       end
 
       protected
@@ -266,7 +242,7 @@ module Rufus
 
       def trigger_now(time)
 
-        t = Rufus::Scheduler::ZoTime.now
+        t = EoTime.now
           # if there are mutexes, t might be really bigger than time
 
         Thread.current[:rufus_scheduler_job] = self
@@ -280,7 +256,7 @@ module Rufus
       ensure
 
         @last_work_time =
-          Rufus::Scheduler::ZoTime.now - Thread.current[:rufus_scheduler_time]
+          EoTime.now - Thread.current[:rufus_scheduler_time]
         @mean_work_time =
           ((@count - 1) * @mean_work_time + @last_work_time) / @count
 
@@ -440,12 +416,13 @@ module Rufus
 
         return (@first_at = nil) if first == nil
 
-        n0 = Rufus::Scheduler::ZoTime.now
+        n0 = EoTime.now
         n1 = n0 + 0.003
 
         first = n0 if first == :now || first == :immediately || first == 0
+        fdur = Rufus::Scheduler.parse_duration(first, no_error: true)
 
-        @first_at = ZoTime.make(first)
+        @first_at = (fdur && (EoTime.now + fdur)) || EoTime.make(first)
         @first_at = n1 if @first_at >= n0 && @first_at < n1
 
         fail ArgumentError.new(
@@ -458,13 +435,18 @@ module Rufus
 
       def last_at=(last)
 
-        #@last_at = last ? Rufus::Scheduler.parse_to_time(last) : nil
-        @last_at = last ? ZoTime.make(last) : nil
+        @last_at =
+          if last
+            ldur = Rufus::Scheduler.parse_duration(last, no_error: true)
+            (ldur && (EoTime.now + ldur)) || EoTime.make(last)
+          else
+            nil
+          end
 
         fail ArgumentError.new(
           "cannot set last[_at|_in] in the past: " +
           "#{last.inspect} -> #{@last_at.inspect}"
-        ) if last && @last_at < Rufus::Scheduler::ZoTime.now
+        ) if last && @last_at < EoTime.now
 
         @last_at
       end
@@ -485,7 +467,7 @@ module Rufus
 
       def pause
 
-        @paused_at = Rufus::Scheduler::ZoTime.now
+        @paused_at = EoTime.now
       end
 
       def resume
@@ -564,7 +546,7 @@ module Rufus
 
         return if is_post
 
-        n = Rufus::Scheduler::ZoTime.now
+        n = EoTime.now
 
         @next_time =
           if @first_at && (trigger_time == nil || @first_at > n)
@@ -604,10 +586,10 @@ module Rufus
 
         @next_time =
           if is_post
-            Rufus::Scheduler::ZoTime.now + @interval
+            EoTime.now + @interval
           elsif trigger_time.nil?
             if @first_at == nil || @first_at < Time.now
-              Rufus::Scheduler::ZoTime.now + @interval
+              EoTime.now + @interval
             else
               @first_at
             end