periodoxical 0.4.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c80ef1e3008c4279f58b029a0790353aae3b346d809390c38961b719c635a9
-  data.tar.gz: 8531378c87459b8dc1945984da0c12b11238a6895668885751923779df3c1bd3
+  metadata.gz: fa1a430d11ca7fdd0cea524011b7164f926f87bad37a49c4848bdbca934bdc79
+  data.tar.gz: fea338a55f3b095b4ac6c1ff57f235e8490a9b6683ae48b9a573b0b1afba22f0
 SHA512:
-  metadata.gz: 899994a59c14f4c6dcf3e8534e7812496ebf53a8b902506e2efebd695d193abf9a93844ccd42389dc2be35c22f2ca829a0d19e3d1de44f7fa4b28d0f5baf3e79
-  data.tar.gz: fdc25739ed5cf90e3aa1a71617c927382ed56dcbf7b2b292844bc3c3bbd5f4688fc9bf6c03ccddc58e8e930435835833d9fd092c30a31cdef0a243d19c1ad19d
+  metadata.gz: 74ec882770d5567ad292ad26c020777d9075cbb0bf77259f37fa0713ab239772dea1dd52fadb2d415ceb8820a10cbc2572ee4847ac181ae208d81d6d759b0517
+  data.tar.gz: e2a7c7b00eec3522ce4d2bd15a999a7f86de8826245c464f0e0844b3f7cd42d7eb942d80e7cad2ecbc48d66399f4962fd9f7be7d8a9d4a025e51d79b477112e2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.4.2)
+    periodoxical (0.5.2)
       tzinfo (~> 2.0, >= 2.0.0)
 
 GEM

data/README.md

@@ -148,6 +148,43 @@ Periodoxical.generate(
 )
 ```
 
+#### Example 4 - Exclude time blocks using the `exclusion_dates` parameter
+As a Ruby dev, I want to generate slots for 8AM - 9AM on Mondays, except for the Monday of June 10, 2024.
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  start_date: '2024-06-3',
+  limit: 4,
+  exclusion_dates: %w(2024-06-10),
+  day_of_week_time_blocks: {
+    mon: [
+      { start_time: '8:00AM', end_time: '9:00AM' },
+    ],
+  }
+)
+# Returns all Monday 8AM - 9AM blocks except for the june on June 10, 2024
+# => 
+[
+    {
+      start: <#DateTime: 2024-06-03T08:00:00-0700>,
+      end: <#DateTime: 2024-06-03T09:00:00-0700>,
+    }
+    {
+      start: <#DateTime: 2024-06-17T08:00:00-0700>,
+      end: <#DateTime: 2024-06-17T09:00:00-0700>,
+    }
+    {
+      start: <#DateTime: 2024-06-24T08:00:00-0700>,
+      end: <#DateTime: 2024-06-24T09:00:00-0700>,
+    }
+    {
+      start: <#DateTime: 2024-07-01T08:00:00-0700>,
+      end: <#DateTime: 2024-07-01T09:00:00-0700>,
+    }
+]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/periodoxical/version.rb

@@ -1,3 +1,3 @@
 module Periodoxical
-  VERSION = "0.4.2"
+  VERSION = "0.5.2"
 end

data/lib/periodoxical.rb

@@ -34,6 +34,9 @@ module Periodoxical
     #   Ex: %w(mon tue wed sat)
     # @param [Integer] limit
     #   How many date times to generate.  To be used when `end_date` is nil.
+    # @param [Aray<String>] exclusion_dates
+    #   Dates to be excluded when generating the time blocks
+    #   Ex: ['2024-06-10', '2024-06-14']
     # @param [Hash<Hash>] day_of_week_time_blocks
     #   To be used when hours are different between days of the week
     #   Ex: {
@@ -42,7 +45,7 @@ module Periodoxical
     #     fri: { start_time: '7:00PM', end_time: '9:00PM' },
     #   }
     def initialize(time_zone: 'Etc/UTC', days_of_week: nil,
-                   start_date:, end_date: nil, time_blocks: nil, day_of_week_time_blocks: nil, limit: nil)
+                   start_date:, end_date: nil, time_blocks: nil, day_of_week_time_blocks: nil, limit: nil, exclusion_dates: nil)
       @time_zone = TZInfo::Timezone.get(time_zone)
       @days_of_week = days_of_week
       @time_blocks = time_blocks
@@ -50,6 +53,9 @@ module Periodoxical
       @start_date = start_date.is_a?(String) ? Date.parse(start_date) : start_date
       @end_date = end_date.is_a?(String) ? Date.parse(end_date) : end_date
       @limit = limit
+      @exclusion_dates = if exclusion_dates && !exclusion_dates.empty?
+                           exclusion_dates.map { |ed| Date.parse(ed) }
+                         end
       validate!
     end
 
@@ -77,7 +83,7 @@ module Periodoxical
       keep_generating = true
       while keep_generating
         day_of_week = day_of_week_long_to_short(current_date.strftime("%A"))
-        if @day_of_week_time_blocks[day_of_week.to_sym]
+        if @day_of_week_time_blocks[day_of_week.to_sym] && !excluded_date?(current_date)
           time_blocks = @day_of_week_time_blocks[day_of_week.to_sym]
           time_blocks.each do |tb|
             times_output << {
@@ -106,7 +112,7 @@ module Periodoxical
       keep_generating = true
       while keep_generating
         day_of_week = day_of_week_long_to_short(current_date.strftime("%A"))
-        if @days_of_week.include?(day_of_week)
+        if @days_of_week.include?(day_of_week) && !excluded_date?(current_date)
           @time_blocks.each do |tb|
             times_output << {
               start: time_str_to_object(current_date, tb[:start_time]),
@@ -182,5 +188,18 @@ module Periodoxical
       )
       @time_zone.local_to_utc(date_time).new_offset(@time_zone.current_period.offset.utc_total_offset)
     end
+
+    # @param [Date] current_date
+    # @return [Boolean]
+    #   Whether or not the date is excluded
+    def excluded_date?(current_date)
+      return false unless @exclusion_dates
+
+      @exclusion_dates.each do |ed|
+        return true if current_date == ed
+      end
+
+      false
+    end
   end
 end

metadata

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