periodoxical 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b67da50d1bba17e1d25babaa937440ccad41bf152d1df8d3adb50ff8c9199b3
-  data.tar.gz: 954c91d5da06a9d4955fdb35576b11f1e209a8ab152825c3f09657e891787a5d
+  metadata.gz: c9f062ec6b1b65c56a01d48386370fe8f1e12b91f0426228ca625bac03272d1b
+  data.tar.gz: 101efa2d001ca56deb4ff3d5cef552f4aeaa98e6cecbe043ea1f990b38b8bc36
 SHA512:
-  metadata.gz: ab9f0eb8538ea18407171b2d9dc435935821370f3f3d229f59d718e3e11f3eba6b6f926129274f33c5100b22a70d937ba6f9693d714f52abaf0f2a7be4965d28
-  data.tar.gz: 64503a74a1879ae8d0cda934ad511530ff6c22e5f1aeb9fe331f0dda99ccf8d7b81c735e2d10a9c6ce468010ea64674c1d8bc86a24fa8f18aa5382cfd29facdd
+  metadata.gz: 7f0a45cb869fd3ec84bd097f0c793f1f0561ce292f48a3bc2521ad714685cd3cc1582956cc572fc4b23c045ea2fe853706467dcbb39fc328254d5855fcf4da2e
+  data.tar.gz: 4ab479448dbfc960996e8535f962cefd58392452f32f9e116d6faf1a373767c6062949e2959f9d64844fe0168c0e92b3edf313a9b5a3499e4c29771c6b0bd4bd

data/Gemfile.lock

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

data/README.md

@@ -47,20 +47,20 @@ Periodoxical.generate(
 #=> 
 [
     {
-     start_time: #<DateTime: 2024-05-23T09:00:00-0700>,
-     end_time: #<DateTime: 2024-05-23T10:30:00-0700>,
+     start: #<DateTime: 2024-05-23T09:00:00-0700>,
+     end: #<DateTime: 2024-05-23T10:30:00-0700>,
     },
     {
-     start_time: #<DateTime: 2024-05-24T09:00:00-0700>,
-     end_time: #<DateTime: 2024-05-24T10:30:00-0700>,
+     start: #<DateTime: 2024-05-24T09:00:00-0700>,
+     end: #<DateTime: 2024-05-24T10:30:00-0700>,
     },
     {
-     start_time: #<DateTime: 2024-05-25T09:00:00-0700>,
-     end_time: #<DateTime: 2024-05-25T10:30:00-0700>,
+     start: #<DateTime: 2024-05-25T09:00:00-0700>,
+     end: #<DateTime: 2024-05-25T10:30:00-0700>,
     },
     {
-     start_time: #<DateTime: 2024-05-26T09:00:00-0700>,
-     end_time: #<DateTime: 2024-05-26T10:30:00-0700>,
+     start: #<DateTime: 2024-05-26T09:00:00-0700>,
+     end: #<DateTime: 2024-05-26T10:30:00-0700>,
     }
 ]
 ```
@@ -474,6 +474,50 @@ Periodoxical.generate(
 ]
 ```
 
+### Use the `duration` key, to automatically partition the provided `time_blocks` into smaller chunks to the given duration.
+
+As a Ruby dev, I want to generate **30 minute** time blocks between **9:00AM - 1:00PM, and 2:00PM - 5:00PM**.  Because it is too tedious to generate all 14 of these time blocks, I prefer to pass in the `duration` key and have `periodoxical` generate them for me.
+
+N.B. If you provide a duration that conflicts with your time blocks, `periodoxical` will not return any time blocks.  For example, if you specify **9:00AM - 10:00AM** but set your **duration** as  90 minutes, no time blocks are generated since we can't fit 90 minutes into an hour!
+
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  time_blocks: [
+    {
+      start_time: '9:00AM',
+      end_time: '1:00PM'
+    },
+    {
+      start_time: '2:00PM',
+      end_time: '5:00PM'
+    },
+  ],
+  duration: 30, #(minutes)
+  starting_from: '2024-05-23',
+  ending_at: '2024-05-26',
+)
+# => [
+    {
+      start: #<DateTime: 2024-05-23T09:00:00--0700>
+      end: #<DateTime: 2024-05-23T09:30:00--0700>
+    },
+    {
+      start: #<DateTime: 2024-05-23T09:30:00--0700>
+      end: #<DateTime: 2024-05-23T10:00:00--0700>
+    },
+    {
+      start: #<DateTime: 2024-05-23T10:00:00--0700>
+      end: #<DateTime: 2024-05-23T10:30:00--0700>
+    },
+    {
+      start: #<DateTime: 2024-05-23T10:30:00--0700>
+      end: #<DateTime: 2024-05-23T11:00:00--0700>
+    }
+]
+```
+
 ### Having Some Fun
 
 Generate all the Friday the 13ths ever since May 1980 (when the first Friday the 13th film was released).

data/lib/periodoxical/version.rb

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

data/lib/periodoxical.rb

@@ -66,6 +66,12 @@ module Periodoxical
     #     tue: { start_time: '11:30PM', end_time: '12:00AM' },
     #     fri: { start_time: '7:00PM', end_time: '9:00PM' },
     #   }
+    # @param [Integer] duration
+    #   Splits the time_blocks into this duration (in minutes). For example, if time_block is 9:00AM - 10:00AM,
+    #   and duration is 20 minutes.  It creates 3 timeblocks of:
+    #     - 9:00AM - 9:20AM
+    #     - 9:20AM - 9:40AM
+    #     - 9:40AM - 10:00AM
     def initialize(
       starting_from:,
       ending_at: nil,
@@ -79,6 +85,7 @@ module Periodoxical
       nth_day_of_week_in_month: nil,
       days_of_month: nil,
       weeks_of_month: nil,
+      duration: nil,
       months: nil
     )
 
@@ -97,6 +104,14 @@ module Periodoxical
       @starting_from = date_object_from(starting_from)
       @ending_at = date_object_from(ending_at)
       @limit = limit
+
+      if duration
+        unless duration.is_a?(Integer)
+          raise "duration must be an integer"
+        else
+          @duration = duration
+        end
+      end
       @exclusion_dates = if exclusion_dates && !exclusion_dates.empty?
                            exclusion_dates.map { |ed| Date.parse(ed) }
                          end
@@ -201,19 +216,31 @@ module Periodoxical
       return if overlaps_with_an_excluded_time?(time_block)
       return if before_starting_from_or_after_ending_at?(time_block)
 
-      @output << {
-        start: time_str_to_object(@current_date, time_block[:start_time]),
-        end: time_str_to_object(@current_date, time_block[:end_time])
-      }
+      strtm = time_str_to_object(@current_date, time_block[:start_time])
+      endtm = time_str_to_object(@current_date, time_block[:end_time])
 
-      # increment count, if `limit` is used to stop generating
-      @current_count = @current_count + 1
-      if @limit && @current_count == @limit
-        @keep_generating = false
-        throw :done
+      if @duration
+        split_by_duration_and_append(strtm, endtm)
+      else
+        @output << {
+          start: strtm,
+          end: endtm 
+        }
+        increment_and_check_limit
       end
     end
 
+    # increment count, if `limit` is used to stop generating
+    def increment_and_check_limit
+      return unless @limit
+
+      @current_count += 1
+      return if @current_count < @limit
+
+      @keep_generating = false
+      throw :done
+    end
+
     def advance_current_date_and_check_if_reached_end_date
       @current_date = @current_date + 1
 
@@ -409,5 +436,20 @@ module Periodoxical
 
       false
     end
+
+    def split_by_duration_and_append(strtm, endtm)
+      delta = Rational(@duration, 24 * 60)
+      si = strtm
+      ei = strtm + delta
+      while ei <= endtm
+        @output << {
+          start: si,
+          end: ei
+        }
+        si += delta
+        ei += delta
+        increment_and_check_limit
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Steven Li
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo