periodoxical 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bdfec5ba5930f743cc1c4197e0964631c8dde5be1bb14c79082fe363bf72e1
-  data.tar.gz: 6aaaf40f368acbdd78632455889298e6eb6ced8c0ee80f4ed9e96387e7d05536
+  metadata.gz: 63ed27b7ac9376b1cd35d505dbcf13c6637e47a8bee5983aa8697a389c2423ee
+  data.tar.gz: df71967f5be8771b0bda25c4b6352f922a82bac39a546f2f66e04247a41ea3cb
 SHA512:
-  metadata.gz: dc697912db1f3a5439ffd3cdf3371c4be7f4475bb2bbae1f01c2ac42887d6041c45763e1977eabf8f68e5f6ee7c7c0d728e80153796acd419d9741a7a3126d5f
-  data.tar.gz: 7a0c713a31ccca86c48b08bdcf1908056475a589c7adc0b93ed94dd13af0ebd35fe58151340fe2e88ff3da13d653673064c9c1d3500e9dbe61845528ecdbb207
+  metadata.gz: ce019309287e5c8d065e77ce9cdc31348c12d867ba9140a43cfb2da2a086a647dcfd0ef0e1a801c11b41f3794fb0b056d695a7f079ad87e5e77e75bae1646bc2
+  data.tar.gz: f8ae7b9cdc4e395618665f5b625624418bdc8d343fdc4e4dccd7aa8af9672671d2d02230d344193ac016ab1ada3468f3e9089b7fcc3b41a110f974d04c5f1486

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.6.2)
+    periodoxical (0.7.3)
       tzinfo (~> 2.0, >= 2.0.0)
       week_of_month (= 1.2.6)
 

data/lib/periodoxical/version.rb

@@ -1,3 +1,3 @@
 module Periodoxical
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

data/lib/periodoxical.rb

@@ -87,7 +87,11 @@ module Periodoxical
     #     {
     #       start: #<DateTime>,
     #       end: #<DateTime>,
-    #     }
+    #     },
+    #     {
+    #       start: #<DateTime>,
+    #       end: #<DateTime>,
+    #     },
     #   ]
     def generate
       initialize_looping_variables!
@@ -146,12 +150,8 @@ module Periodoxical
           end
       end
 
-      if @days_of_week && @nth_day_of_week_in_month
-        # If both `days_of_week` and `nth_day_of_week_in_month` are provided for the same days-of-the-week, then it is ambiguous.  (ie. I want this timeslot for every Monday, but also only for the first Mondays, well which one is it?)
-        overlapping_days = @days_of_week & @nth_day_of_week_in_month.keys.map(&:to_s)
-        unless overlapping_days.empty?
-          raise "#{overlapping_days} is specified in both `days_of_week` and also `nth_day_of_week_in_month`, which leads to ambiguity.  Pleasee look at the README for examples."
-        end
+      if @nth_day_of_week_in_month && (@days_of_week || @day_of_week_time_blocks)
+        raise "nth_day_of_week_in_month parameter cannot be used in combination with `days_of_week` or `day_of_week_time_blocks`.  Please look at the README for examples."
       end
 
       if @day_of_week_time_blocks
@@ -228,6 +228,7 @@ module Periodoxical
     def initialize_looping_variables!
       @output = []
       @current_date = @start_date
+      @current_day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
       @current_count = 0
       @keep_generating = true
     end
@@ -255,10 +256,19 @@ module Periodoxical
 
     def advance_current_date_and_check_if_reached_end_date
       @current_date = @current_date + 1
+      @current_day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
 
       if @end_date && (@current_date > @end_date)
         @keep_generating = false
       end
+
+      # kill switch to stop infinite loop when `limit` is used but
+      # there is bug, or poorly specified rules.  If @current_date goes into
+      # 1000 years in the future, but still no dates have been generated yet, this is
+      # most likely an infinite loop situation, and needs to be killed.
+      if @limit && ((@current_date - @start_date).to_i > 365000) && @output.empty?
+        raise "No end condition detected, causing infinite loop.  Please check rules/conditions or raise github issue for potential bug fixed"
+      end
     end
 
     # @return [Boolean]
@@ -286,17 +296,14 @@ module Periodoxical
         return false unless @days_of_month.include?(@current_date.day)
       end
 
-      # The following conditions depend on the day-of-week of current_date.
-      day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
-
       # If days of week are specified, but current_date does not satisfy it,
       # return false
       if @days_of_week
-        return false unless @days_of_week.include?(day_of_week)
+        return false unless @days_of_week.include?(@current_day_of_week)
       end
 
       if @day_of_week_time_blocks
-        dowtb = @day_of_week_time_blocks[day_of_week.to_sym]
+        dowtb = @day_of_week_time_blocks[@current_day_of_week.to_sym]
         return false if dowtb.nil?
         return false if dowtb.empty?
       end
@@ -304,30 +311,19 @@ module Periodoxical
       if @nth_day_of_week_in_month
         # If the day of week is specified in nth_day_of_week_in_month,
         # we need to investigate it whether or not to exclude it.
-        if @nth_day_of_week_in_month[day_of_week.to_sym]
+        if @nth_day_of_week_in_month[@current_day_of_week.to_sym]
           n_occurence_of_day_of_week_in_month = ((@current_date.day - 1) / 7) + 1
           # -1 is a special case and requires extra-math
-          if @nth_day_of_week_in_month[day_of_week.to_sym].include?(-1)
+          if @nth_day_of_week_in_month[@current_day_of_week.to_sym].include?(-1)
             # We basically want to convert the -1 into its 'positive-equivalent` in this month, and compare it with that.
             # For example, in June 2024, the Last Friday is also the 4th Friday.  So in that case, we convert the -1 into a 4.
-            positivized_indices = @nth_day_of_week_in_month[day_of_week.to_sym].map { |indx| positivize_index(indx, day_of_week) }
+            positivized_indices = @nth_day_of_week_in_month[@current_day_of_week.to_sym].map { |indx| positivize_index(indx, @current_day_of_week) }
             return positivized_indices.include?(n_occurence_of_day_of_week_in_month)
           else
-            return @nth_day_of_week_in_month[day_of_week.to_sym].include?(n_occurence_of_day_of_week_in_month)
+            return @nth_day_of_week_in_month[@current_day_of_week.to_sym].include?(n_occurence_of_day_of_week_in_month)
           end
         else
-          # if day-of-week was not specified in nth_day_of_week_in_month,
-          # it could have been specified in either `days_of_week` or `day_of_week_time_blocks and we unfortunately need to re-check those here. I cant think of a way to further DRY-it up.
-          return false unless @days_of_week && @day_of_week_time_blocks
-          if @day_of_week
-            return false unless @days_of_week.include?(day_of_week)
-          end
-
-          if @day_of_week_time_blocks
-            dowtb = @day_of_week_time_blocks[day_of_week.to_sym]
-            return false if dowtb.nil?
-            return false if dowtb.empty?
-          end
+          return false
         end
       end
 
@@ -337,8 +333,7 @@ module Periodoxical
 
     def add_time_blocks_from_current_date!
       if @day_of_week_time_blocks
-        day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
-        time_blocks = @day_of_week_time_blocks[day_of_week.to_sym]
+        time_blocks = @day_of_week_time_blocks[@current_day_of_week.to_sym]
         catch :done do
           time_blocks.each do |tb|
             append_to_output_and_check_limit(tb)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Steven Li