rufus-scheduler 3.1.4 → 3.8.2

data/lib/rufus/scheduler/util.rb

@@ -1,101 +1,56 @@
-#--
-# 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
-# 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
-
-  class Scheduler
+
+class Rufus::Scheduler
+
+  class << self
 
     #--
     # time and string methods
     #++
 
-    def self.parse(o, opts={})
+    def parse(o, opts={})
 
       opts[:no_error] = true
 
       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.inspect} (#{o.class})"))
     end
 
-    def self.parse_in(o, opts={})
+    def parse_cron(o, opts={})
 
-      o.is_a?(String) ? parse_duration(o, opts) : o
+      opts[:no_error] ?
+        Fugit.parse_cron(o) :
+        Fugit.do_parse_cron(o)
     end
 
-    def self.parse_at(o, opts={})
-
-      Rufus::Scheduler::ZoTime.parse(o, opts).time
+    def parse_in(o, opts={})
 
-    rescue StandardError => se
+      #o.is_a?(String) ? parse_duration(o, opts) : o
 
-      return nil if opts[:no_error]
-      raise se
-    end
+      return parse_duration(o, opts) if o.is_a?(String)
+      return o if o.is_a?(Numeric)
 
-    def self.parse_cron(o, opts)
-
-      CronLine.new(o)
+      fail ArgumentError.new("couldn't parse time point in #{o.inspect}")
 
     rescue ArgumentError => ae
 
       return nil if opts[:no_error]
-      raise ae
+      fail ae
     end
 
-    def self.parse_to_time(o)
+    def parse_at(o, opts={})
 
-      t = o
-      t = parse(t) if t.is_a?(String)
-      t = Time.now + t if t.is_a?(Numeric)
+      return o if o.is_a?(EoTime)
+      return EoTime.make(o) if o.is_a?(Time)
+      EoTime.parse(o, opts)
 
-      raise ArgumentError.new(
-        "cannot turn #{o.inspect} to a point in time, doesn't make sense"
-      ) unless t.is_a?(Time)
+    rescue StandardError => se
 
-      t
+      return nil if opts[:no_error]
+      fail se
     end
 
-    DURATIONS2M = [
-      [ 'y', 365 * 24 * 3600 ],
-      [ 'M', 30 * 24 * 3600 ],
-      [ 'w', 7 * 24 * 3600 ],
-      [ 'd', 24 * 3600 ],
-      [ 'h', 3600 ],
-      [ 'm', 60 ],
-      [ 's', 1 ]
-    ]
-    DURATIONS2 = DURATIONS2M.dup
-    DURATIONS2.delete_at(1)
-
-    DURATIONS = DURATIONS2M.inject({}) { |r, (k, v)| r[k] = v; r }
-    DURATION_LETTERS = DURATIONS.keys.join
-
-    DU_KEYS = DURATIONS2M.collect { |k, v| k.to_sym }
-
     # Turns a string like '1m10s' into a float like '70.0', more formally,
     # turns a time duration expressed as a string into a Float instance
     # (millisecond count).
@@ -123,53 +78,17 @@ module Rufus
     #   Rufus::Scheduler.parse_duration "-0.5"   # => -0.5
     #   Rufus::Scheduler.parse_duration "-1h"    # => -3600.0
     #
-    def self.parse_duration(string, opts={})
-
-      string = string.to_s
-
-      return 0.0 if string == ''
-
-      m = string.match(/^(-?)([\d\.#{DURATION_LETTERS}]+)$/)
-
-      return nil if m.nil? && opts[:no_error]
-      raise ArgumentError.new("cannot parse '#{string}'") if m.nil?
-
-      mod = m[1] == '-' ? -1.0 : 1.0
-      val = 0.0
-
-      s = m[2]
-
-      while s.length > 0
-        m = nil
-        if m = s.match(/^(\d+|\d+\.\d*|\d*\.\d+)([#{DURATION_LETTERS}])(.*)$/)
-          val += m[1].to_f * DURATIONS[m[2]]
-        elsif s.match(/^\d+$/)
-          val += s.to_i
-        elsif s.match(/^\d*\.\d*$/)
-          val += s.to_f
-        elsif opts[:no_error]
-          return nil
-        else
-          raise ArgumentError.new(
-            "cannot parse '#{string}' (especially '#{s}')"
-          )
-        end
-        break unless m && m[3]
-        s = m[3]
-      end
-
-      mod * val
-    end
+    def parse_duration(str, opts={})
 
-    class << self
-      #-
-      # for compatibility with rufus-scheduler 2.x
-      #+
-      alias parse_duration_string parse_duration
-      alias parse_time_string parse_duration
+      d =
+        opts[:no_error] ?
+        Fugit::Duration.parse(str, opts) :
+        Fugit::Duration.do_parse(str, opts)
+      d ?
+        d.to_sec :
+        nil
     end
 
-
     # Turns a number of seconds into a a time string
     #
     #   Rufus.to_duration 0                    # => '0s'
@@ -199,45 +118,27 @@ module Rufus
     #
     # * :months, if set to true, months (M) of 30 days will be taken into
     #   account when building up the result
-    # * :drop_seconds, if set to true, seconds and milliseconds will be trimmed
-    #   from the result
+    # * :drop_seconds, if set to true, seconds and milliseconds will be
+    #   trimmed from the result
     #
-    def self.to_duration(seconds, options={})
-
-      h = to_duration_hash(seconds, options)
+    def to_duration(seconds, options={})
 
-      return (options[:drop_seconds] ? '0m' : '0s') if h.empty?
+      #d = Fugit::Duration.parse(seconds, options).deflate
+      #d = d.drop_seconds if options[:drop_seconds]
+      #d = d.deflate(:month => options[:months]) if options[:months]
+      #d.to_rufus_s
 
-      s =
-        DU_KEYS.inject('') { |r, key|
-          count = h[key]
-          count = nil if count == 0
-          r << "#{count}#{key}" if count
-          r
-        }
-
-      ms = h[:ms]
-      s << ms.to_s if ms
-
-      s
-    end
-
-    class << self
-      #-
-      # for compatibility with rufus-scheduler 2.x
-      #+
-      alias to_duration_string to_duration
-      alias to_time_string to_duration
+      to_fugit_duration(seconds, options).to_rufus_s
     end
 
     # Turns a number of seconds (integer or Float) into a hash like in :
     #
     #   Rufus.to_duration_hash 0.051
-    #     # => { :ms => "51" }
+    #     # => { :s => 0.051 }
     #   Rufus.to_duration_hash 7.051
-    #     # => { :s => 7, :ms => "51" }
+    #     # => { :s => 7.051 }
     #   Rufus.to_duration_hash 0.120 + 30 * 24 * 3600 + 1
-    #     # => { :w => 4, :d => 2, :s => 1, :ms => "120" }
+    #     # => { :w => 4, :d => 2, :s => 1.120 }
     #
     # This method is used by to_duration behind the scenes.
     #
@@ -245,62 +146,71 @@ module Rufus
     #
     # * :months, if set to true, months (M) of 30 days will be taken into
     #   account when building up the result
-    # * :drop_seconds, if set to true, seconds and milliseconds will be trimmed
-    #   from the result
+    # * :drop_seconds, if set to true, seconds and milliseconds will be
+    #   trimmed from the result
     #
-    def self.to_duration_hash(seconds, options={})
-
-      h = {}
+    def to_duration_hash(seconds, options={})
 
-      if seconds.is_a?(Float)
-        h[:ms] = (seconds % 1 * 1000).to_i
-        seconds = seconds.to_i
-      end
-
-      if options[:drop_seconds]
-        h.delete(:ms)
-        seconds = (seconds - seconds % 60)
-      end
+      to_fugit_duration(seconds, options).to_rufus_h
+    end
 
-      durations = options[:months] ? DURATIONS2M : DURATIONS2
+    # Used by both .to_duration and .to_duration_hash
+    #
+    def to_fugit_duration(seconds, options={})
 
-      durations.each do |key, duration|
+      d = Fugit::Duration
+        .parse(seconds, options)
+        .deflate
 
-        count = seconds / duration
-        seconds = seconds % duration
+      d = d.drop_seconds if options[:drop_seconds]
+      d = d.deflate(:month => options[:months]) if options[:months]
 
-        h[key.to_sym] = count if count > 0
-      end
-
-      h
+      d
     end
 
     #--
     # misc
     #++
 
-    # Produces the UTC string representation of a Time instance
-    #
-    # like "2009/11/23 11:11:50.947109 UTC"
-    #
-    def self.utc_to_s(t=Time.now)
+    if RUBY_VERSION > '1.9.9'
 
-      "#{t.utc.strftime('%Y-%m-%d %H:%M:%S')}.#{sprintf('%06d', t.usec)} UTC"
-    end
+      # Produces the UTC string representation of a Time instance
+      #
+      # like "2009/11/23 11:11:50.947109 UTC"
+      #
+      def utc_to_s(t=Time.now)
+        "#{t.dup.utc.strftime('%F %T.%6N')} UTC"
+      end
 
-    # Produces a hour/min/sec/milli string representation of Time instance
-    #
-    def self.h_to_s(t=Time.now)
+      # Produces a hour/min/sec/milli string representation of Time instance
+      #
+      def h_to_s(t=Time.now)
+        t.strftime('%T.%6N')
+      end
+    else
 
-      "#{t.strftime('%H:%M:%S')}.#{sprintf('%06d', t.usec)}"
+      def utc_to_s(t=Time.now)
+        "#{t.utc.strftime('%Y-%m-%d %H:%M:%S')}.#{sprintf('%06d', t.usec)} UTC"
+      end
+      def h_to_s(t=Time.now)
+        "#{t.strftime('%H:%M:%S')}.#{sprintf('%06d', t.usec)}"
+      end
     end
 
-    # Debugging tools...
-    #
-    class D
-
-      def self.h_to_s(t=Time.now); Rufus::Scheduler.h_to_s(t); end
+    if defined?(Process::CLOCK_MONOTONIC)
+      def monow; Process.clock_gettime(Process::CLOCK_MONOTONIC); end
+    else
+      def monow; Time.now.to_f; end
     end
+
+    def ltstamp; Time.now.strftime('%FT%T.%3N'); end
+  end
+
+  # Debugging tools...
+  #
+  class D
+
+    def self.h_to_s(t=Time.now); Rufus::Scheduler.h_to_s(t); end
   end
 end