fugit 1.9.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0099e4aa474e4886e99da33f4b76abd19f259d3a6eb64cd2bfe12f99f6256a23'
-  data.tar.gz: 38c3fbe7b620cc6460f1b7b7d3e96298400c82d7dec7ef9d4b543925dff6e74a
+  metadata.gz: da93feee9bdfd44a793ce2b45b81109c0f7cd08ff9a930d15629a29c6a381e07
+  data.tar.gz: 32d9b447734805d3b58ae64c70a6699b931ef4fb4e6a76d8f279e66d4b5cb7df
 SHA512:
-  metadata.gz: 75e41e393e779e06ec6280e6e2065877b4771fcca8b63307af13f7fe2407fc9a1fef75eca5a690fe9f3cec6b791deaa4c8b23c925326b24753c5ae8197d5a5bd
-  data.tar.gz: e9ac1c2b0412a9e2549257b1d73490f4319335c847a6faff212dd8c8a9cbaa52787617491d76648763efbd24caffc39a91e08f06910970905dc810ef9fec36cc
+  metadata.gz: e7ac7afec4cfdcfdac22e5d2113892a0c7cb1f790d205bc32ecaea75c30f6ceb73af811824712c6781b480831f2a09479a6344af0d9b3c0ee92ae5cff7ef6c38
+  data.tar.gz: d87ecc490a49f19680891a82979903987843b5853ecfdc9ebee57d0b047fa4dffa96dfbbde43ef5d3011dbd07d492ac8f7a151fa6354478050c18efae9b911e4

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 # CHANGELOG.md
 
 
+## fugit 1.11.1 released 2024-08-15
+
+* Prevent nat parsing chocking on long input (> 256 chars), gh-104
+
+
+## fugit 1.11.0 released 2024-04-24
+
+* Revert gh-86 ban on `every 27 hours` / `* */27 * * *` for gh-103
+
+
+## fugit 1.10.1 released 2024-02-29
+
+* Fix on Ruby 2.2.6 thanks to @aunghtain, gh-93
+
+
+## fugit 1.10.0 released 2024-02-22
+
+* Implement `Fugit::Cron#within(time_start, time_end)`
+* Implement `Fugit::Cron#within(time_range)`
+* Implement iterator-returning `Fugit::Cron#next` and `#prev`
+
+
 ## fugit 1.9.0 released 2023-10-24
 
 * Let nat parse "last", gh-88

data/CREDITS.md

@@ -1,7 +1,12 @@
 
 # fugit credits
 
-* Marcos Belluci, https://github.com/delbetu, gh-88 , 1st and last nat
+* https://github.com/personnumber3377, gh-104 Fugit.parse choke on long input
+* Michael Scrivo, https://github.com/mscrivo, gh-103
+* Benjamin Darcet, https://github.com/bdarcet gh-95 gh-96 et-orbi #rweek
+* https://github.com/franckduche gh-95 gh-96 et-orbi #rweek
+* https://hithub.com/aunghtain, gh-93, include oneliner vs Ruby 2.6.6
+* Marcos Belluci, https://github.com/delbetu, gh-88, 1st and last nat
 * Michael Reinsch, https://github.com/mreinsch, gh-84 and gh-85
 * Marc Anguera, https://github.com/markets, gh-70 and Sidekiq-Cron
 * ski-nine, https://github.com/ski-nine, gh-81

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2017-2023, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2017-2024, 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

data/README.md

@@ -26,17 +26,22 @@ The intersection of those two projects is where fugit is born:
 * [parse-cron](https://github.com/siebertm/parse-cron) - parses cron expressions and calculates the next occurrence after a given date
 * [ice_cube](https://github.com/seejohnrun/ice_cube) - Ruby date recurrence library
 * [ISO8601](https://github.com/arnau/ISO8601) - Ruby parser to work with ISO8601 dateTimes and durations
+* [chrono](https://github.com/r7kamura/chrono) - a chain of logics about chronology
+* [CronCalc](https://github.com/mizinsky/cron_calc) - calculates cron job occurrences
+* [Recurrence](https://github.com/fnando/recurrence) - a simple library to handle recurring events
 * ...
 
 ### Projects using fugit
 
 * [arask](https://github.com/Ebbe/arask) - "Automatic RAils taSKs" uses fugit to parse cron strings
-* [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron) - recent versions of Sidekiq-Cron use fugit to parse cron strings
-* [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) -
+* [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron) - uses fugit to parse cron strings since version 1.0.0, it was using rufus-scheduler previously
+* [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - as seen above
 * [flor](https://github.com/floraison/flor) - used in the [cron](https://github.com/floraison/flor/blob/master/doc/procedures/cron.md) procedure
 * [que-scheduler](https://github.com/hlascelles/que-scheduler) - a reliable job scheduler for [que](https://github.com/chanks/que)
 * [serial_scheduler](https://github.com/grosser/serial_scheduler) - ruby task scheduler without threading
 * [delayed_cron_job](https://github.com/codez/delayed_cron_job) - an extension to Delayed::Job that allows you to set cron expressions for your jobs
+* [GoodJob](https://github.com/bensheldon/good_job) - a multithreaded, Postgres-based, Active Job backend for Ruby on Rails
+* [Solid Queue](https://github.com/rails/solid_queue) - a DB-based queuing backend for Active Job, designed with simplicity and performance in mind
 * ...
 
 ## `Fugit.parse(s)`
@@ -92,7 +97,7 @@ As `Fugit.parse(s)` returns nil when it doesn't grok its input, and `Fugit.do_pa
 
 Sometimes you know a cron expression or an "every" natural expression will come in and you want to discard the rest.
 
-```
+```ruby
 require 'fugit'
 
 Fugit.parse_cronish('0 0 1 jan *').class             # ==> ::Fugit::Cron
@@ -122,8 +127,48 @@ c = Fugit::Cron.new('0 0 * *  sun')
 
 p Time.now  # => 2017-01-03 09:53:27 +0900
 
-p c.next_time      # => 2017-01-08 00:00:00 +0900
-p c.previous_time  # => 2017-01-01 00:00:00 +0900
+p c.next_time.to_s      # => 2017-01-08 00:00:00 +0900
+p c.previous_time.to_s  # => 2017-01-01 00:00:00 +0900
+
+p c.next_time(Time.parse('2024-06-01')).to_s
+  # => "2024-06-02 00:00:00 +0900"
+p c.previous_time(Time.parse('2024-06-01')).to_s
+  # => "2024-05-26 00:00:00 +0900"
+    #
+    # `Fugit::Cron#next_time` and `#previous_time` accept a "start time"
+
+c = Fugit.parse_cron('0 12 * * mon#2')
+
+  # `#next` and `#prev` return Enumerable instances
+  #
+  # These two methods are available since fugit 1.10.0.
+  #
+c.next(Time.parse('2024-02-16 12:00:00'))
+  .take(3)
+  .map(&:to_s)
+    # => [ '2024-03-11 12:00:00',
+    #      '2024-04-08 12:00:00',
+    #      '2024-05-13 12:00:00' ]
+c.prev(Time.parse('2024-02-16 12:00:00'))
+  .take(3)
+  .map(&:to_s)
+    # => [ '2024-02-12 12:00:00',
+    #      '2024-01-08 12:00:00',
+    #      '2023-12-11 12:00:00' ]
+
+  # `#within` accepts a time range and returns an array of Eo::EoTime
+  # instances that correspond to the occurrences of the cron within
+  # the time range
+  #
+  # This method is available since fugit 1.10.0.
+  #
+c.within(Time.parse('2024-02-16 12:00')..Time.parse('2024-08-01 12:00'))
+  .map(&:to_s)
+    # => [ '2024-03-11 12:00:00',
+    #      '2024-04-08 12:00:00',
+    #      '2024-05-13 12:00:00',
+    #      '2024-06-10 12:00:00',
+    #      '2024-07-08 12:00:00' ]
 
 p c.brute_frequency  # => [ 604800, 604800, 53 ]
                      #    [ delta min, delta max, occurrence count ]
@@ -211,6 +256,8 @@ p Fugit.parse_cron('59 6 1-7& * 2&').next_time('2020-03-15').to_s
 
 Fugit understands `0 5 * * 1#1` or `0 5 * * mon#1` as "each first Monday of the month, at 05:00".
 
+The hash extension can only be used in the day-of-week field.
+
 ```ruby
 '0 5 * * 1#1'    #
 '0 5 * * mon#1'  # the first Monday of the month at 05:00
@@ -233,6 +280,8 @@ Fugit understands `0 5 * * 1#1` or `0 5 * * mon#1` as "each first Monday of the
 
 Fugit, since 1.1.10, also understands cron strings like "`9 0 * * sun%2`" which can be read as "every other Sunday at 9am".
 
+The modulo extension can only be used in the day-of-week field.
+
 For odd Sundays, one can write `9 0 * * sun%2+1`.
 
 It can be combined, as in `9 0 * * sun%2,tue%3+2`
@@ -268,6 +317,18 @@ c.match?('2019-01-08')  # => false, since (rweek + 1) % 2 == 1
 `tue%x+y` matches if Tuesday and `current_date.rweek + y % x == 0`
 
 
+### the second extension
+
+Fugit accepts cron strings with five elements, `minute hour day-of-month month day-of-week`, the standard cron format or six elements `second minute hour day-of-month month day-of-week`.
+
+```ruby
+c = Fugit.parse('* * * * *') # every minute
+c = Fugit.parse('5 * * * *') # every hour at minute 5
+c = Fugit.parse('* * * * * *') # every second
+c = Fugit.parse('5 * * * * *') # every minute at second 5
+```
+
+
 ## `Fugit::Duration`
 
 A class `Fugit::Duration` to parse duration strings (vanilla [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) ones and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ones).
@@ -401,7 +462,8 @@ Fugit::Nat.parse('every day at 16:15 and 18:30', multi: true)
     # ==> [ '15 16 * * *', '30 18 * * *' ] (two Fugit::Cron instances)
 
 Fugit::Nat.parse('every day at 16:15 and 18:30', multi: :fail)
-  # ==> ArgumentError: multiple crons in "every day at 16:15 and 18:30" (15 16 * * * | 30 18 * * *)
+  # ==> ArgumentError: multiple crons in "every day at 16:15 and 18:30"
+  #     (15 16 * * * | 30 18 * * *)
 Fugit::Nat.parse('every day at 16:15 nada 18:30', multi: true)
   # ==> nil
 ```
@@ -412,6 +474,8 @@ Fugit::Nat.parse('every day at 16:15 nada 18:30', multi: true)
 
 `multi: false` is the default behaviour, return a single `Fugit::Cron` instance or nil when it cannot parse.
 
+Please note that "nat" input is limited to 256 characters (fugit 1.11.1).
+
 ### Nat Midnight
 
 `"Every day at midnight"` is supported, but `"Every monday at midnight"` will be interpreted (as of Fugit <= 1.4.x) as `"Every monday at 00:00"`. Sorry about that.

data/fugit.gemspec

@@ -41,7 +41,7 @@ Time tools for flor and the floraison project. Cron parsing and occurrence compu
     # this dependency appears in 'et-orbi'
 
   s.add_runtime_dependency 'raabro', '~> 1.4'
-  s.add_runtime_dependency 'et-orbi', '~> 1', '>= 1.2.7'
+  s.add_runtime_dependency 'et-orbi', '~> 1', '>= 1.2.11'
 
   s.add_development_dependency 'rspec', '~> 3.8'
   s.add_development_dependency 'chronic', '~> 0.10'

data/lib/fugit/cron.rb

@@ -46,7 +46,20 @@ module Fugit
       def do_parse(s)
 
         parse(s) ||
-        fail(ArgumentError.new("invalid cron string #{s.inspect}"))
+        fail(ArgumentError.new("invalid cron string #{trunc(s)}"))
+      end
+
+      protected
+
+      def trunc(s)
+
+        if s.is_a?(String)
+          r = s.length > 28 ? s[0, 28] + "... len #{s.length}" : s
+          r.inspect
+        else
+          r = s.inspect
+          r.length > 35 ? s[0, 35] + '...' : r
+        end
       end
     end
 
@@ -264,6 +277,8 @@ module Fugit
           "please fill an issue at https://git.io/fjJC9"
         ) if (i += 1) > MAX_ITERATION_COUNT
 
+#tt = t.time;
+#puts "  #{tt.strftime('%F %T %:z %A')} #{tt.rweek} #{tt.rweek % 2}"
         (ifrom == t.to_i) && (t.inc(1); next)
         month_match?(t) || (t.inc_month; next)
         day_match?(t) || (t.inc_day; next)
@@ -307,6 +322,8 @@ module Fugit
           "please fill an issue at https://git.io/fjJCQ"
         ) if (i += 1) > MAX_ITERATION_COUNT
 
+#tt = t.time;
+#puts "  #{tt.strftime('%F %T %:z %A')} #{tt.rweek} #{tt.rweek % 4}"
         month_match?(t) || (t.dec_month; next)
         day_match?(t) || (t.dec_day; next)
         hour_match?(t) || (t.dec_hour; next)
@@ -318,6 +335,60 @@ module Fugit
       t.time.translate(from.zone)
     end
 
+    # Used by Fugit::Cron#next and Fugit::Cron#prev
+    #
+    class CronIterator
+      include ::Enumerable
+
+      attr_reader :cron, :start, :current, :direction
+
+      def initialize(cron, direction, start)
+
+        @cron = cron
+        @start = start
+        @current = start.dup
+        @direction = direction
+      end
+
+      def each
+
+        loop do
+
+          yield(@current = @cron.send(@direction, @current))
+        end
+      end
+    end
+
+    # Returns an ::Enumerable instance that yields each "next time" in
+    # succession
+    #
+    def next(from=::EtOrbi::EoTime.now)
+
+      CronIterator.new(self, :next_time, from)
+    end
+
+    # Returns an ::Enumerable instance that yields each "previous time" in
+    # succession
+    #
+    def prev(from=::EtOrbi::EoTime.now)
+
+      CronIterator.new(self, :previous_time, from)
+    end
+
+    # Returns an array of EtOrbi::EoTime instances that correspond to
+    # the occurrences of the cron within the given time range
+    #
+    def within(time_range, time_end=nil)
+
+      sta, ned =
+        time_range.is_a?(::Range) ? [ time_range.begin, time_range.end ] :
+        [ ::EtOrbi.make_time(time_range), ::EtOrbi.make_time(time_end) ]
+
+      CronIterator
+        .new(self, :next_time, sta)
+        .take_while { |eot| eot.to_t < ned }
+    end
+
     # Mostly used as a #next_time sanity check.
     # Avoid for "business" use, it's slow.
     #
@@ -511,7 +582,10 @@ module Fugit
 
       sta, edn, sla = r
 
-      return false if sla && sla > max
+      #return false if sla && sla > max
+        #
+        # let it go, "* */24 * * *" and "* */27 * * *" are okay
+        # gh-86 and gh-103
 
       edn = max if sla && edn.nil?
 

data/lib/fugit/duration.rb

@@ -258,7 +258,7 @@ module Fugit
       when Numeric then add_numeric(a)
       when Fugit::Duration then add_duration(a)
       when String then add_duration(self.class.parse(a))
-      when ::Time, EtOrbi::EoTime then add_to_time(a)
+      when ::Time, ::EtOrbi::EoTime then add_to_time(a)
       else fail ArgumentError.new(
         "cannot add #{a.class} instance to a Fugit::Duration")
       end

data/lib/fugit/nat.rb

@@ -7,6 +7,8 @@ module Fugit
   #
   module Nat
 
+    MAX_INPUT_LENGTH = 256
+
     class << self
 
       def parse(s, opts={})
@@ -17,6 +19,16 @@ module Fugit
 
         s = s.strip
 
+        if s.length > MAX_INPUT_LENGTH
+
+          fail ArgumentError.new(
+            "input too long for a nat string, " +
+            "#{s.length} > #{MAX_INPUT_LENGTH}"
+          ) if opts[:do_parse]
+
+          return nil
+        end
+
 #p s; Raabro.pp(Parser.parse(s, debug: 3), colours: true)
 #(p s; Raabro.pp(Parser.parse(s, debug: 1), colours: true)) rescue nil
 
@@ -29,7 +41,7 @@ module Fugit
 
       def do_parse(s, opts={})
 
-        parse(s, opts) ||
+        parse(s, opts.merge(do_parse: true)) ||
         fail(ArgumentError.new("could not parse a nat #{s.inspect}"))
       end
     end

data/lib/fugit/parse.rb

@@ -20,17 +20,34 @@ module Fugit
 
       opts[:at] = opts[:in] if opts.has_key?(:in)
 
-      (opts[:cron] != false && parse_cron(s)) ||
-      (opts[:duration] != false && parse_duration(s)) ||
-      (opts[:nat] != false && parse_nat(s, opts)) ||
-      (opts[:at] != false && parse_at(s)) ||
+      (opts[:cron] != false && parse_cron(s)) || # 542ms 616ms
+      (opts[:duration] != false && parse_duration(s)) || # 645ms # 534ms
+      (opts[:nat] != false && parse_nat(s, opts)) || # 2s # 35s
+      (opts[:at] != false && parse_at(s)) || # 568ms 622ms
       nil
     end
 
     def do_parse(s, opts={})
 
-      parse(s, opts) ||
-      fail(ArgumentError.new("found no time information in #{s.inspect}"))
+      opts[:at] = opts[:in] if opts.has_key?(:in)
+
+      result = nil
+      errors = []
+
+      %i[ cron duration nat at ]
+        .each { |k|
+          begin
+            result ||= (opts[k] != false && self.send("do_parse_#{k}", s))
+          rescue => err
+            errors << err
+          end }
+
+      return result if result
+
+      raise(
+        errors.find { |r| r.class != ArgumentError } ||
+        errors.first ||
+        ArgumentError.new("found no time information in #{s.inspect}"))
     end
 
     def parse_cronish(s, opts={})

data/lib/fugit.rb

@@ -3,7 +3,7 @@
 
 module Fugit
 
-  VERSION = '1.9.0'
+  VERSION = '1.11.1'
 end
 
 require 'time'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fugit
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.1
 platform: ruby
 authors:
 - John Mettraux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raabro
@@ -33,7 +33,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: time tools for flor