periodoxical 1.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f062ec6b1b65c56a01d48386370fe8f1e12b91f0426228ca625bac03272d1b
-  data.tar.gz: 101efa2d001ca56deb4ff3d5cef552f4aeaa98e6cecbe043ea1f990b38b8bc36
+  metadata.gz: 9a17e3bd272fdd537b16689e871aa834c6388202d36d5ed5bf420150c0ff62bd
+  data.tar.gz: 8c08b584338f8d2e14cb8c0c8ce1ec4171d5fa4c946328911b25302aa621e92e
 SHA512:
-  metadata.gz: 7f0a45cb869fd3ec84bd097f0c793f1f0561ce292f48a3bc2521ad714685cd3cc1582956cc572fc4b23c045ea2fe853706467dcbb39fc328254d5855fcf4da2e
-  data.tar.gz: 4ab479448dbfc960996e8535f962cefd58392452f32f9e116d6faf1a373767c6062949e2959f9d64844fe0168c0e92b3edf313a9b5a3499e4c29771c6b0bd4bd
+  metadata.gz: 76df9351805289b310b079dd0a44587630db263101a18777ffa4612dacd5e846313fc56b8836ffa42fe7126926456d11273c218187dda0542d5b76c65a6a0451
+  data.tar.gz: afed95be8919055c47c5b118b6e01f944b03e16fc2c87046157ece131d35d0078c1dc5cbad804140afb9cdc975283c9d464536a4b65d7549181b5e0781afb628

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    periodoxical (1.2.0)
+    periodoxical (2.2.1)
       tzinfo (~> 2.0, >= 2.0.0)
-      week_of_month (= 1.2.6)
 
 GEM
   remote: https://rubygems.org/
@@ -41,7 +40,6 @@ GEM
     rspec-support (3.13.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    week_of_month (1.2.6)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -209,7 +209,7 @@ Periodoxical.generate(
 )
 ```
 
-### Specifying time blocks using rules for day-of-month and/or week-of-month and/or month.
+### Specifying time blocks using rules for month(s) and/or day-of-month.
 
 As a Ruby dev, I want to generate the next 3 timeblocks for **8AM - 9AM** for the **5th** and **10th** day of every month starting from **June**.  I can do this using the `days_of_month` parameter.
 
@@ -240,42 +240,8 @@ Periodoxical.generate(
 ]
 ```
 
-As a Ruby dev, I want to generate **4** timeblocks for **8AM - 9AM** on **Mondays** but only in the **first two weeks** in the months of **April, May, and June**.  I can do this using the `months` parameter.
+### Specify nth day-of-week in month (ie. first Monday of the Month, second Tuesday of the Month, last Friday of Month)
 
-```
-Periodoxical.generate(
-  time_zone: 'America/Los_Angeles',
-  starting_from: '2024-04-01',
-  limit: 4,
-  weeks_of_month: [1 2],
-  months: [4, 5, 6],
-  days_of_week: %w(mon),
-  time_blocks: [
-    { start_time: '8:00AM', end_time: '9:00AM' },
-  ],
-)
-#=> 
-[
-    {
-     start_time: #<DateTime: 2024-04-01T08:00:00-0700>,
-     end_time: #<DateTime: 2024-04-01T09:00:00-0700>,
-    },
-    {
-     start_time: #<DateTime: 2024-04-08T08:00:00-0700>,
-     end_time: #<DateTime: 2024-04-08T09:00:00-0700>,
-    },
-    {
-     start_time: #<DateTime: 2024-05-06T08:00:00-0700>,
-     end_time: #<DateTime: 2024-05-06T09:00:00-0700>,
-    },
-    {
-     start_time: #<DateTime: 2024-06-03T08:00:00-0700>,
-     end_time: #<DateTime: 2024-06-03T09:00:00-0700>,
-    },
-]
-```
-
-### Example 6 - Specify nth day-of-week in month (ie. first Monday of the Month, second Tuesday of the Month, last Friday of Month)
 As a Ruby dev, I want to generate timeblocks for **8AM - 9AM** on the **first and second Mondays**  and **last Fridays** of every month starting in June 2024.  I can do this with the `nth_day_of_week_in_month` param.
 
 ```rb
@@ -316,7 +282,7 @@ Periodoxical.generate(
 ]
 ```
 
-### Example 7 - Exclude time blocks using the `exclusion_dates` and `exclusion_times` parameters
+### Exclude time blocks using the `exclusion_dates` and `exclusion_times` parameters
 As a Ruby dev, I want to generate timeblocks for **8AM - 9AM** on **Mondays**, except for the **Monday of June 10, 2024**.  I can do this using the `exlcusion_dates` parameter.
 
 ```rb
@@ -402,7 +368,7 @@ Periodoxical.generate(
 ]
 ```
 
-### Example 8 - Every-other-nth day-of-week rules (ie. every other Tuesday, every 3rd Wednesday, every 10th Friday)
+### Every-other-nth day-of-week rules (ie. every other Tuesday, every 3rd Wednesday, every 10th Friday)
 
 As a Ruby dev, I want to generate timeblocks for **9AM- 10AM** on **every Monday**, but **every other Tuesday**, and **every other 3rd Wednesday**. I can do this using the `days_of_week` parameter with the `every` and `every_other_nth` keys to specify the every-other-nth-rules.
 

data/lib/periodoxical/helpers.rb

@@ -27,11 +27,14 @@ module Periodoxical
       tb_2_start = time_block_2[:start]
       tb_2_end = time_block_2[:end]
 
-      # Basicall overlap is when one starts before the other has ended
+      # Basically overlap is when one starts before the other has ended
       return true if tb_1_end > tb_2_start && tb_1_end < tb_2_end
       # By symmetry
       return true if tb_2_end > tb_1_start && tb_2_end < tb_1_end
 
+      # Handle the edge case where they start/end at the same time
+      return true if tb_1_start == tb_2_start || tb_1_end == tb_2_end
+
       false
     end
 

data/lib/periodoxical/version.rb

@@ -1,3 +1,3 @@
 module Periodoxical
-  VERSION = "1.2.0"
+  VERSION = "2.2.1"
 end

data/lib/periodoxical.rb

@@ -4,7 +4,6 @@ require "periodoxical/helpers"
 require "date"
 require "time"
 require "tzinfo"
-require "week_of_month"
 
 module Periodoxical
   class << self
@@ -84,7 +83,6 @@ module Periodoxical
       days_of_week: nil,
       nth_day_of_week_in_month: nil,
       days_of_month: nil,
-      weeks_of_month: nil,
       duration: nil,
       months: nil
     )
@@ -97,7 +95,6 @@ module Periodoxical
       end
       @nth_day_of_week_in_month = deep_symbolize_keys(nth_day_of_week_in_month)
       @days_of_month = days_of_month
-      @weeks_of_month = weeks_of_month
       @months = months
       @time_blocks = deep_symbolize_keys(time_blocks)
       @day_of_week_time_blocks = deep_symbolize_keys(day_of_week_time_blocks)
@@ -151,7 +148,7 @@ module Periodoxical
     #   Ex: '9:00AM'
     # @param [Date] date
     def time_str_to_object(date, time_str)
-      time = Time.strptime(time_str, "%I:%M%p")
+      time = Time.strptime(time_str, '%I:%M%p')
       date_time = DateTime.new(
         date.year,
         date.month,
@@ -212,19 +209,19 @@ module Periodoxical
     #  }
     #  Generates time block but also checks if we should stop generating
     def append_to_output_and_check_limit(time_block)
-      # Check if this particular time is conflicts with any times from `exclusion_times`.
-      return if overlaps_with_an_excluded_time?(time_block)
-      return if before_starting_from_or_after_ending_at?(time_block)
-
       strtm = time_str_to_object(@current_date, time_block[:start_time])
       endtm = time_str_to_object(@current_date, time_block[:end_time])
 
       if @duration
         split_by_duration_and_append(strtm, endtm)
       else
+        # Check if this particular time is conflicts with any times from `exclusion_times`.
+        return if before_starting_from_or_after_ending_at?(time_block)
+        return if overlaps_with_an_excluded_time?({ start: strtm, end: endtm })
+
         @output << {
           start: strtm,
-          end: endtm 
+          end: endtm
         }
         increment_and_check_limit
       end
@@ -267,11 +264,6 @@ module Periodoxical
         return false if @exclusion_dates.include?(@current_date)
       end
 
-      # If weeks_of_months are specified but not satisified, return false
-      if @weeks_of_month
-        return false unless @weeks_of_month.include?(@current_date.week_of_month)
-      end
-
       # If months are specified, but current_date does not satisfy months,
       # return false
       if @months
@@ -418,19 +410,22 @@ module Periodoxical
       false
     end
 
+    # @param [Hash] time_block
+    # Ex:
+    #   {
+    #     start: #<DateTime>,
+    #     end: #<DateTime>,
+    #   }
     # @return [Boolean]
     #   Whether or not the given `time_block` in the @current_date and
     #   @time_zone overlaps with the times in `exclusion_times`.
-    def overlaps_with_an_excluded_time?(time_block)
+    def overlaps_with_an_excluded_time?(tm_blck)
       return false unless @exclusion_times
 
       @exclusion_times.each do |exclusion_timeblock|
         return true if overlap?(
           exclusion_timeblock,
-          {
-            start: time_str_to_object(@current_date, time_block[:start_time]),
-            end: time_str_to_object(@current_date, time_block[:end_time]),
-          }
+          tm_blck
         )
       end
 
@@ -442,13 +437,15 @@ module Periodoxical
       si = strtm
       ei = strtm + delta
       while ei <= endtm
-        @output << {
-          start: si,
-          end: ei
-        }
+        unless overlaps_with_an_excluded_time?({ start: si, end: ei })
+          @output << {
+            start: si,
+            end: ei
+          }
+          increment_and_check_limit
+        end
         si += delta
         ei += delta
-        increment_and_check_limit
       end
     end
   end

data/periodoxical.gemspec

@@ -35,7 +35,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'tzinfo', '~> 2.0', '>= 2.0.0'
-  spec.add_dependency 'week_of_month', '1.2.6'
 
   spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "rake", "~> 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Steven Li
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -30,20 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: week_of_month
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement