on_calendar 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a48fcb9c6e6836fd84408fcd7e650a355b0bd75b66e191ed9a3496ddb2ba63c5
-  data.tar.gz: 66abbea8914bedb82b8d8dc2e93cd768b2cc8dcc9880289159d83d060d9edc9a
+  metadata.gz: f0f1bc76c2e4b7726e431fd1966f3eeb249ac1d1a37a922d8d7faf146609e569
+  data.tar.gz: 80a788fc4eff681edca8761d07753d5a88a2254639a97682ab1cea150ca68b90
 SHA512:
-  metadata.gz: 36c626a4db17a5fba1af85e0065b419c8811bfe0415c416f8bef9f10ddf3f389f7ccc198090be4d060b5b90e38a6b522b1b1e2497b21fb0cc5ac600bff1c936d
-  data.tar.gz: 10319d969d600e2e1d8a2188e4cbbe641276a684180a76cc7d1cce81e79e0947bc9e56a3c8e3473a018a003a82bbc4593b0d57d496719846c098a7495ad97e26
+  metadata.gz: 8016805896b6eb2f46aae718954a1c5e7506e0473f6b34221b6f654434fdf3df6fec342a0c4167507da38a72679df756621a897ef44896657227252866544a38
+  data.tar.gz: e1b1b69f687f36f354ca69102ed2d4f8aba996ac8272bd850a03216c906e03d0caaa157b9b74730a87e80f70132043610e29cb4fca98cb8d78486f3c6054522b

data/lib/on_calendar/condition/base.rb

@@ -19,10 +19,15 @@ module OnCalendar
       end
 
       # Some subclasses need more context for RANGE
-      def range
+      def range(clamp: nil)
         self.class::RANGE
       end
 
+      # Provide min / max of range for validation
+      def self.range_bounds
+        self.const_get(:RANGE).minmax
+      end
+
       # Match this condition
       # - If wild card return true
       # No step:
@@ -70,7 +75,7 @@ module OnCalendar
         return 1 if wildcard
 
         # Build array to find needle_index
-        arr = range_args.nil? ? range.to_a : range(**range_args).to_a
+        arr = range(clamp: range_args).to_a
         needle_index = arr.index(current)
 
         return nil if needle_index.nil?
@@ -119,6 +124,13 @@ module OnCalendar
         end
         distance
       end
+
+      private
+
+      # Determine if change in DST between start/end of day 
+      def dst_day?(clamp:)
+        clamp.beginning_of_day.dst? != clamp.end_of_day.dst?
+      end
     end
   end
 end

data/lib/on_calendar/condition/day_of_month.rb

@@ -7,11 +7,11 @@ module OnCalendar
 
       # NOTE: by default we validate number in default range but this needs to be context aware
       # because not all months have the same number of days
-      def range(year: nil, month: nil)
-        if year.nil? || month.nil?
-          RANGE
+      def range(clamp: nil)
+        if clamp.present?
+          (RANGE.min..Time.days_in_month(clamp.month, clamp.year))
         else
-          (RANGE.min..Time.days_in_month(month, year))
+          RANGE
         end
       end
     end

data/lib/on_calendar/condition/day_of_week.rb

@@ -4,12 +4,6 @@ module OnCalendar
   module Condition
     class DayOfWeek < Base
       RANGE = (0..6)
-
-      # Utility function to pass our min,max range to the segment parser
-      # this helps dealing with when the parser comes back with 6..0
-      def self.range_bounds
-        RANGE.minmax
-      end
     end
   end
 end

data/lib/on_calendar/condition/hour.rb

@@ -4,6 +4,27 @@ module OnCalendar
   module Condition
     class Hour < Base
       RANGE = (0..23)
+
+      # NOTE: by default we validate number in default range but this needs to be context aware
+      # because not all days have all hours (ie: DST changes)
+      def range(clamp: nil)
+        # If we are dealing with DST
+        if clamp.present? and dst_day?(clamp: clamp)
+          hours = []
+          cursor = clamp.beginning_of_day
+          day = clamp.day
+          zone = clamp.zone
+          # Record each hour of the day until we change day || zone
+          loop do
+            hours << cursor.hour
+            cursor = cursor + 1.hour
+            break if cursor.day != day or clamp.zone != zone
+          end
+          hours
+        else
+          RANGE
+        end
+      end
     end
   end
 end

data/lib/on_calendar/condition/minute.rb

@@ -4,6 +4,29 @@ module OnCalendar
   module Condition
     class Minute < Base
       RANGE = (0..59)
+
+      # NOTE: by default we validate number in default range but this needs to be context aware
+      # because not all days have all minutes (ie: DST changes with 30 mins)
+      # NOTE: With Condition::Hour we check dst_day? I haven't been able to work out how to check for DST change within an hour without jumping boundaries of DST. Therefore we check the entire day. This might have a small performance impact but we generally aren't looping over each hour when checking conditions.
+      def range(clamp: nil)
+        # If we are dealing with DST
+        if clamp.present? and dst_day?(clamp: clamp)
+          mins = []
+          # NOTE: We can't use Time.beginning_of_hour because we may jump across DST boundary
+          cursor = clamp.end_of_hour
+          hour = clamp.hour
+          zone = clamp.zone
+          # Record each minute of the hour until we change hour || zone
+          loop do
+            mins << cursor.min
+            cursor = cursor - 1.minute
+            break if cursor.hour != hour or cursor.zone != zone
+          end
+          mins.reverse
+        else
+          RANGE
+        end
+      end
     end
   end
 end

data/lib/on_calendar/condition/year.rb

@@ -8,14 +8,30 @@ module OnCalendar
       def initialize(base: nil, step: nil, wildcard: false)
         # Translate short year to long
         unless base.nil?
-          if (0..69).cover?(base)
-            base += 2000
-          elsif (70..99).cover?(base)
-            base += 1900
+          if base.is_a?(Range)
+            values = [
+              translate_short_year(base.begin),
+              translate_short_year(base.end)
+            ]
+            base = (values.min..values.max)
+          else
+            base = translate_short_year(base)
           end
         end
         super
       end
+
+      private
+
+      def translate_short_year(base)
+        if (0..69).cover?(base)
+          base += 2000
+        elsif (70..99).cover?(base)
+          base += 1900
+        else
+          base
+        end
+      end
     end
   end
 end

data/lib/on_calendar/parser.rb

@@ -28,7 +28,7 @@ module OnCalendar
       @expression = expression
     end
 
-    def next(count=1, clamp: timezone.now)
+    def next(count=1, clamp: timezone.now, debug: false)
       raise OnCalendar::Parser::Error, "Clamp must be instance of Time" unless clamp.is_a?(Time)
 
       # Translate to correct timezone and add 1.second to ensure
@@ -37,7 +37,7 @@ module OnCalendar
 
       results = []
       count.times do
-        result = iterate(clamp: clamp)
+        result = iterate(clamp: clamp, debug: debug)
         break if result.nil?
 
         clamp = result + 1.second
@@ -55,8 +55,9 @@ module OnCalendar
 
     private
 
-    def iterate(clamp:)
+    def iterate(clamp:, debug: false)
       iterations = 0
+      output = [["-", clamp.to_s, "", ""]] if debug
 
       while true
         # Fail safe
@@ -84,8 +85,7 @@ module OnCalendar
           days_of_month: {
             base_method: :day,
             changes: { hour: 0, min: 0, sec: 0 },
-            increment_method: :days,
-            range_args: ->(clamp) { { year: clamp.year, month: clamp.month } }
+            increment_method: :days
           },
           days_of_week: {
             base_method: :wday,
@@ -107,14 +107,18 @@ module OnCalendar
           # Do we miss all condition matches - thus increment
           next if matches_any_conditions?(field: field, base: clamp.send(values[:base_method]))
 
-          # Do we need any range arguments? If so calculate
-          range_args = values[:range_args].call(clamp) if values.key?(:range_args) || nil
           # Determine distances required to jump to next match
           distances = send(field).map do |condition|
-            condition.distance_to_next(clamp.send(values[:base_method]), range_args: range_args)
+            condition.distance_to_next(clamp.send(values[:base_method]), range_args: clamp)
           end.sort!
           # Check for only nil - if so impossible to compute bail
-          return nil if distances.compact.empty?
+          if distances.compact.empty?
+            if debug
+              output << [iterations, clamp.to_s, "impossible", ""]
+              debug_table(output)
+            end
+            return nil
+          end
 
           # Increment by field method
           method = values[:increment_method] || field
@@ -123,6 +127,13 @@ module OnCalendar
           clamp = clamp.change(**values[:changes]) if values.key?(:changes)
           # Force re-check everything by marking manipulation
           field_manipulation = true
+          # Debug
+          output << [
+            iterations,
+            clamp.to_s,
+            field.to_s,
+            distances.min
+          ] if debug
           break
         end
 
@@ -131,9 +142,20 @@ module OnCalendar
         field_manipulation ? next : break
       end
 
+      # Output debug table
+      debug_table(output) if debug
+
       clamp
     end
 
+    def debug_table(rows)
+      table = Terminal::Table.new do |t|
+        t.headings = ["Iteration", "Datetime", "Function", "Distance"]
+        t.rows = rows
+      end
+      puts table
+    end
+
     def parse(expression)
       raise OnCalendar::Parser::Error, "Expression must be a string" unless expression.is_a?(String)
       raise OnCalendar::Parser::Error, "Expression cannot be empty" if expression.empty?
@@ -236,7 +258,7 @@ module OnCalendar
         begin
           parsed = OnCalendar::Segment.parse(segments.shift, max: max, min: min)
           if parsed.nil?
-            # We are a wild card
+            # We are a wildcard
             conditions[idx] = [OnCalendar::Condition.const_get(klass).new(wildcard: true)]
           else
             # Lets build conditions with parsed

data/lib/on_calendar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnCalendar
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/on_calendar.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/all"
+require "terminal-table"
 
 module OnCalendar
   autoload :Version, "on_calendar/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: on_calendar
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ben Passmore
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 email:
 - contact@passbe.com
 executables: []