fugit 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abef59b5a960f5a9ed236dc1395bc3fd7b0d0a2e
-  data.tar.gz: d67e8a8c23cf0a7d61f26826e390a0bbf5a0e184
+  metadata.gz: 23a78b668f05dc4bbe20ff46e0596a1211767f8a
+  data.tar.gz: a93498a901fa05952adf0afa0362ca5621a24b3b
 SHA512:
-  metadata.gz: e3f6589fbb9f41615f1826cd823f286f5f274f85784ba287f9898de93a94152f4fdf627b493043b45b4745d5cc13995b9e82bf8109d8b7b2a686cda28d65b19d
-  data.tar.gz: 3bc24d23a8a5f1b0e9bd5e115e27c9b30a7f0f49c9ecfef1f9116269c19f97226f56832e5e7ac9e469a2a2e7167a98c7495c74f2c6ed27895b1d83832aa7b2d7
+  metadata.gz: a059da28856f3695800f15449b2245c844a3927170a2df6f9b09081570dfaa7239c4e240dca42d518828a615bc9ad73331d34e83948e352bd7eda18aa8edbb77
+  data.tar.gz: 7588ef1425a8c11e3663ea2ec5de69d1f9ff76ff947a2871f9cc33b4479f7595c340a1058fb3b5f287a29b589d4ec30404167f4926b02efc41508642d9106130

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+# fugit CHANGELOG.md
+
+
+## fugit 0.9.0  released 2017-01-03
+
+* Initial release
+

data/CREDITS.md

@@ -0,0 +1,7 @@
+
+# fugit credits
+
+Many thanks to all the rufus-scheduler contributors and people who gave feedback.
+
+https://github.com/jmettraux/rufus-scheduler/blob/master/CREDITS.txt
+

data/README.md

@@ -1,6 +1,46 @@
 
 # fugit
 
+[![Build Status](https://secure.travis-ci.org/floraison/fugit.svg)](http://travis-ci.org/floraison/fugit)
+[![Gem Version](https://badge.fury.io/rb/fugit.svg)](http://badge.fury.io/rb/fugit)
+
+Time tools for [flor](https://github.com/floraison/flor) and the floraison project.
+
+## `Fugit::Cron`
+
+```ruby
+require 'fugit'
+
+c = Fugit::Cron.parse('0 0 * *  sun')
+
+p Time.now # => 2017-01-03 09:53:27 +0900
+
+p c.next_time # => 2017-01-08 00:00:00 +0900
+```
+
+Example of cron strings understood by fugit:
+```ruby
+'5 0 * * *'         # 5 minutes after midnight, every day
+'15 14 1 * *'       # at 1415 on the 1st of every month
+'0 22 * * 1-5'      # at 2200 on weekdays
+'0 22 * * mon-fri'  # idem
+'23 0-23/2 * * *'   # 23 minutes after 00:00, 02:00, 04:00, ...
+
+'@yearly'    # turns into '0 0 1 1 *'
+'@monthly'   # turns into '0 0 1 * *'
+'@weekly'    # turns into '0 0 * * 0'
+'@daily'     # turns into '0 0 * * *'
+'@midnight'  # turns into '0 0 * * *'
+'@hourly'    # turns into '0 * * * *'
+
+'0 0 L * *'     # last day of month at 00:00
+'0 0 last * *'  # idem
+'0 0 -7-L * *'  # from the seventh to last to the last day of month at 00:00
+
+# and more...
+```
+
 ## LICENSE
 
 MIT, see [LICENSE.txt](LICENSE.txt)
+

data/fugit.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |s|
   s.email = [ 'jmettraux+flor@gmail.com' ]
   s.homepage = 'http://github.com/floraison/fugit'
   s.license = 'MIT'
-  s.summary = 'time oriented utils for flor'
+  s.summary = 'time tools for flor'
 
   s.description = %{
-time oriented utilities for flor and the floraison project
+Time tools for flor and the floraison project. Cron parsing and occurence computing. Timestamps and more.
   }.strip
 
   #s.files = `git ls-files`.split("\n")
@@ -26,7 +26,7 @@ time oriented utilities for flor and the floraison project
   ]
 
   #s.add_runtime_dependency 'tzinfo'
-  s.add_runtime_dependency 'raabro', '>= 1.1.2'
+  s.add_runtime_dependency 'raabro', '>= 1.1.3'
 
   s.add_development_dependency 'rspec', '~> 3.4'
 

data/lib/fugit.rb

@@ -25,6 +25,13 @@
 
 module Fugit
 
-  VERSION = '0.1.0'
+  VERSION = '0.9.0'
 end
 
+require 'time'
+
+require 'raabro'
+
+require 'fugit/misc'
+require 'fugit/cron'
+

data/lib/fugit/cron.rb

@@ -0,0 +1,440 @@
+#--
+# Copyright (c) 2017-2017, John Mettraux, jmettraux+flor@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 Fugit
+
+  class Cron
+
+    SPECIALS = {
+      '@reboot' => :reboot,
+      '@yearly' => '0 0 1 1 *',
+      '@annually' => '0 0 1 1 *',
+      '@monthly' => '0 0 1 * *',
+      '@weekly' => '0 0 * * 0',
+      '@daily' => '0 0 * * *',
+      '@midnight' => '0 0 * * *',
+      '@hourly' => '0 * * * *',
+    }
+
+    attr_reader :original
+
+    attr_reader :minutes, :hours, :monthdays, :months, :weekdays
+
+    def self.new(original)
+
+      parse(original)
+    end
+
+    def to_cron_s
+
+      @cron_s ||=
+        [
+          (@minutes || [ '*' ]).join(','),
+          (@hours || [ '*' ]).join(','),
+          (@monthdays || [ '*' ]).join(','),
+          (@months || [ '*' ]).join(','),
+          (@weekdays || [ [ '*' ] ]).map { |d| d.compact.join('#') }.join(',')
+        ].join(' ')
+    end
+
+    def self.parse(s)
+
+      original = s
+      s = SPECIALS[s] || s
+
+#p s; Raabro.pp(Parser.parse(s, debug: 3))
+      h = Parser.parse(s)
+
+      fail ArgumentError.new(
+        "couldn't parse #{original.inspect}"
+      ) unless h
+
+      self.allocate.send(:init, s, h)
+    end
+
+    class NextTime # TODO at some point, use ZoTime
+
+      def initialize(t)
+        @t = t.is_a?(NextTime) ? t.time : t
+      end
+
+      def time; @t; end
+
+      %w[ year month day wday hour min sec ]
+        .collect(&:to_sym).each { |k| define_method(k) { @t.send(k) } }
+
+      def inc(i)
+        u = @t.utc?
+        @t = ::Time.at(@t.to_i + i)
+        @t = @t.utc if u
+        self
+      end
+      def dec(i); inc(-i); end
+
+      def inc_month
+        y = @t.year
+        m = @t.month + 1
+        if m == 13; m = 1; y += 1; end
+        @t = Time.send((@t.utc? ? :utc : :local), y, m)
+        self
+      end
+      def inc_day; inc((24 - @t.hour) * 3600 - @t.min * 60 - @t.sec); end
+      def inc_hour; inc((60 - @t.min) * 60 - @t.sec); end
+      def inc_min; inc(60 - @t.sec); end
+
+      def dec_month
+        dec(@t.day * 24 * 3600 + @t.hour * 3600 + @t.min * 60 + @t.sec + 1)
+      end
+      def dec_day; dec(@t.hour * 3600 + @t.min * 60 + @t.sec + 1); end
+      def dec_hour; dec(@t.min * 60 + @t.sec + 1); end
+      def dec_min; dec(@t.sec + 1); end
+      def dec_sec; dec(@t.sec); end
+
+      def count_weeks(inc)
+        c = 0
+        t = @t
+        until t.month != @t.month
+          c += 1
+          t += inc * (7 * 24 * 3600)
+        end
+        c
+      end
+
+      def wday_in_month
+        [ count_weeks(-1), - count_weeks(1) ]
+      end
+    end
+
+    def month_match?(nt); ( ! @months) || @months.include?(nt.month); end
+    def hour_match?(nt); ( ! @hours) || @hours.include?(nt.hour); end
+    def min_match?(nt); ( ! @minutes) || @minutes.include?(nt.min); end
+
+    def weekday_match?(nt)
+
+#p @weekdays
+#p [ nt.day, nt.wday ]
+      return true if @weekdays.nil?
+
+      wd, hsh = @weekdays.find { |wd, hsh| wd == nt.wday }
+
+      return false unless wd
+      return true if hsh.nil?
+
+      phsh, nhsh = nt.wday_in_month
+
+      if hsh > 0
+        hsh == phsh # positive wday, from the beginning of the month
+      else
+        hsh == nhsh # negative wday, from the end of the month, -1 == last
+      end
+    end
+
+    def monthday_match?(nt)
+
+      return true if @monthdays.nil?
+
+      last = (NextTime.new(nt).inc_month.time - 24 * 3600).day + 1
+
+      @monthdays
+        .collect { |d| d < 1 ? last + d : d }
+        .include?(nt.day)
+    end
+
+    def day_match?(nt)
+
+      return weekday_match?(nt) || monthday_match?(nt) \
+        if @weekdays && @monthdays
+
+      return false unless weekday_match?(nt)
+      return false unless monthday_match?(nt)
+
+      true
+    end
+
+    def match?(t)
+
+      t = NextTime.new(t)
+
+      month_match?(t) && day_match?(t) && hour_match?(t) && min_match?(t)
+    end
+
+    def next_time(from=Time.now)
+
+      nt = NextTime.new(from)
+
+      loop do
+#p Fugit.time_to_s(nt.time)
+        month_match?(nt) || (nt.inc_month; next)
+        day_match?(nt) || (nt.inc_day; next)
+        hour_match?(nt) || (nt.inc_hour; next)
+        min_match?(nt) || (nt.inc_min; next)
+        break
+      end
+
+      nt.time
+    end
+
+    def previous_time(from=Time.now)
+
+      nt = NextTime.new(from)
+
+      loop do
+#p Fugit.time_to_s(nt.time)
+        month_match?(nt) || (nt.dec_month; next)
+        day_match?(nt) || (nt.dec_day; next)
+        hour_match?(nt) || (nt.dec_hour; next)
+        min_match?(nt) || (nt.dec_min; next)
+        nt.dec_sec
+        break
+      end
+
+      nt.time
+    end
+
+    # Returns [ min delta, max delta, occurence count ]
+    # Computes for a non leap year (2017).
+    #
+    def frequency(year=2017)
+
+      FREQUENCY_CACHE["#{to_cron_s}|#{year}"] ||=
+        begin
+          deltas = []
+
+          t0 = nil
+          loop do
+            t1 = next_time(t0 || Time.parse("#{year}-01-01"))
+            deltas << (t1 - t0).to_i + 60 if t0
+            break if t1.year > year
+            t0 = t1 + 60
+          end
+
+          [ deltas.min, deltas.max, deltas.size ]
+        end
+    end
+
+    protected
+
+    FREQUENCY_CACHE = {}
+
+    def init(original, h)
+
+      @original = original
+
+      determine_minutes(h[:min])
+      determine_hours(h[:hou])
+      determine_monthdays(h[:dom])
+      determine_months(h[:mon])
+      determine_weekdays(h[:dow])
+
+      self
+    end
+
+    def expand(min, max, r)
+
+      sta, edn, sla = r
+
+      sla = nil if sla == 1 # don't get fooled by /1
+
+      return [ nil ] if sta.nil? && edn.nil? && sla.nil?
+      return [ sta ] if sta && edn.nil?
+
+      sla = 1 if sla == nil
+      sta = min if sta == nil
+      edn = max if edn == nil
+      sta, edn = edn, sta if sta > edn
+
+      (sta..edn).step(sla).to_a
+    end
+
+    def compact(key)
+
+      arr = instance_variable_get(key)
+
+      return instance_variable_set(key, nil) if arr.include?(nil)
+        # reductio ad astrum
+
+      arr.uniq!
+      arr.sort!
+    end
+
+    def determine_minutes(mins)
+      @minutes = mins.inject([]) { |a, r| a.concat(expand(0, 59, r)) }
+      compact(:@minutes)
+    end
+
+    def determine_hours(hous)
+      @hours = hous.inject([]) { |a, r| a.concat(expand(0, 23, r)) }
+      @hours = @hours.collect { |h| h == 24 ? 0 : h }
+      compact(:@hours)
+    end
+
+    def determine_monthdays(doms)
+      @monthdays = doms.inject([]) { |a, r| a.concat(expand(1, 31, r)) }
+      compact(:@monthdays)
+    end
+
+    def determine_months(mons)
+      @months = mons.inject([]) { |a, r| a.concat(expand(1, 12, r)) }
+      compact(:@months)
+    end
+
+    def determine_weekdays(dows)
+
+      @weekdays = dows.inject([]) { |a, r|
+        aa = expand(0, 7, r)
+        if hsh = r[3]
+          a.concat([ [ aa.first, hsh ] ])
+        else
+          a.concat(aa.collect { |i| [ i, nil ] })
+        end
+      }
+
+      @weekdays =
+        if @weekdays.include?([ nil, nil ])
+          nil
+        else
+          @weekdays
+            .collect { |d, h| [ d == 7 ? 0 : d, h ] }
+            .uniq { |d| d.join('#') }
+            .sort_by { |d| d.join('#') }
+        end
+    end
+
+    module Parser include Raabro
+
+      WEEKDAYS = %w[ sun mon tue wed thu fri sat ]
+      MONTHS = %w[ - jan feb mar apr may jun jul aug sep oct nov dec ]
+
+      def s(i); rex(:s, i, /[ \t]+/); end
+      def star(i); str(:star, i, '*'); end
+      def hyphen(i); str(nil, i, '-'); end
+      def comma(i); str(nil, i, ','); end
+
+      def slash(i); rex(:slash, i, /\/\d\d?/); end
+
+      def core_min(i); rex(:min, i, /[0-5]?\d/); end
+      def core_hou(i); rex(:hou, i, /(2[0-4]|[01]?[0-9])/); end
+      def core_dom(i); rex(:dom, i, /(-?(3[01]|[012]?[0-9])|last|l)/i); end
+      def core_mon(i); rex(:mon, i, /(1[0-2]|0?[0-9]|#{MONTHS[1..-1].join('|')})/i); end
+      def core_dow(i); rex(:dow, i, /([0-7]|#{WEEKDAYS.join('|')})/i); end
+
+      def dow_hash(i); rex(:hash, i, /#(-?[1-5]|last|l)/i); end
+
+      def min(i); core_min(i); end
+      def hou(i); core_hou(i); end
+      def dom(i); core_dom(i); end
+      def mon(i); core_mon(i); end
+      def dow(i); core_dow(i); end
+
+      def _min(i); seq(nil, i, :hyphen, :min); end
+      def _hou(i); seq(nil, i, :hyphen, :hou); end
+      def _dom(i); seq(nil, i, :hyphen, :dom); end
+      def _mon(i); seq(nil, i, :hyphen, :mon); end
+      def _dow(i); seq(nil, i, :hyphen, :dow); end
+
+      # r: range
+      def r_min(i); seq(nil, i, :min, :_min, '?'); end
+      def r_hou(i); seq(nil, i, :hou, :_hou, '?'); end
+      def r_dom(i); seq(nil, i, :dom, :_dom, '?'); end
+      def r_mon(i); seq(nil, i, :mon, :_mon, '?'); end
+      def r_dow(i); seq(nil, i, :dow, :_dow, '?'); end
+
+      # sor: star or range
+      def sor_min(i); alt(nil, i, :star, :r_min); end
+      def sor_hou(i); alt(nil, i, :star, :r_hou); end
+      def sor_dom(i); alt(nil, i, :star, :r_dom); end
+      def sor_mon(i); alt(nil, i, :star, :r_mon); end
+      def sor_dow(i); alt(nil, i, :star, :r_dow); end
+
+      # sorws: star or range with[out] slash
+      def sorws_min(i); seq(nil, i, :sor_min, :slash, '?'); end
+      def sorws_hou(i); seq(nil, i, :sor_hou, :slash, '?'); end
+      def sorws_dom(i); seq(nil, i, :sor_dom, :slash, '?'); end
+      def sorws_mon(i); seq(nil, i, :sor_mon, :slash, '?'); end
+      def sorws_dow(i); seq(nil, i, :sor_dow, :slash, '?'); end
+
+      def h_dow(i); seq(nil, i, :core_dow, :dow_hash); end
+
+      def _sorws_dow(i); alt(nil, i, :h_dow, :sorws_dow); end
+
+      def list_min(i); jseq(:min, i, :sorws_min, :comma); end
+      def list_hou(i); jseq(:hou, i, :sorws_hou, :comma); end
+      def list_dom(i); jseq(:dom, i, :sorws_dom, :comma); end
+      def list_mon(i); jseq(:mon, i, :sorws_mon, :comma); end
+      def list_dow(i); jseq(:dow, i, :_sorws_dow, :comma); end
+
+      def lmin_(i); seq(nil, i, :list_min, :s); end
+      def lhou_(i); seq(nil, i, :list_hou, :s); end
+      def ldom_(i); seq(nil, i, :list_dom, :s); end
+      def lmon_(i); seq(nil, i, :list_mon, :s); end
+      alias ldow list_dow
+
+      def cron(i); seq(:cron, i, :lmin_, :lhou_, :ldom_, :lmon_, :ldow); end
+
+      def to_i(k, t)
+
+        s = t.string.downcase
+
+        (k == :mon && MONTHS.index(s)) ||
+        (k == :dow && WEEKDAYS.index(s)) ||
+        (k == :dom && s[0, 1] == 'l' && -1) || # L, l, last
+        s.to_i
+      end
+
+      def rewrite_entry(t)
+
+        k = t.name
+
+        t.children.select { |ct| ct.children.any? }.inject([]) { |a, ct|
+
+          xts = ct.gather(k)
+#xts.each { |xt| Raabro.pp(xt) }
+          range = xts.any? ? xts.collect { |xt| to_i(k, xt) } : []
+          while range.size < 2; range << nil; end
+
+          st = ct.lookup(:slash)
+          range << (st ? st.string[1..-1].to_i : nil)
+
+          if k == :dow && ht = ct.lookup(:hash)
+            hs = ht.string.downcase
+            range << ((hs[1, 1] == 'l') ? -1 : hs[1..-1].to_i)
+          end
+
+          a << range
+
+          a
+        }
+      end
+
+      SYMS = %w[ min hou dom mon dow ].collect(&:to_sym)
+
+      def rewrite_cron(t)
+
+        SYMS.inject({}) { |h, k| h[k] = rewrite_entry(t.lookup(k)); h }
+      end
+    end
+  end
+end
+

data/lib/fugit/misc.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2017-2017, John Mettraux, jmettraux+flor@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 Fugit
+
+  def self.isostamp(show_date, show_time, show_usec, time)
+
+    t = time || Time.now
+    s = StringIO.new
+
+    s << t.strftime('%Y-%m-%d') if show_date
+    s << t.strftime('T%H:%M:%S') if show_time
+    s << sprintf('.%06d', t.usec) if show_time && show_usec
+    s << 'Z' if show_time && time.utc?
+
+    s.string
+  end
+
+  def self.time_to_s(t)
+
+    isostamp(true, true, false, t)
+  end
+
+  def self.time_to_plain_s(t=Time.now)
+
+    s = StringIO.new
+
+    s << t.strftime('%Y-%m-%d %H:%M:%S')
+    s << ' Z' if t.utc?
+
+    s.string
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fugit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raabro
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
-description: time oriented utilities for flor and the floraison project
+description: Time tools for flor and the floraison project. Cron parsing and occurence
+  computing. Timestamps and more.
 email:
 - jmettraux+flor@gmail.com
 executables: []
@@ -46,9 +47,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Makefile
+- lib/fugit/cron.rb
+- lib/fugit/misc.rb
 - lib/fugit.rb
 - fugit.gemspec
 - LICENSE.txt
+- CHANGELOG.md
+- CREDITS.md
 - README.md
 homepage: http://github.com/floraison/fugit
 licenses:
@@ -73,5 +78,5 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: time oriented utils for flor
+summary: time tools for flor
 test_files: []