periodoxical 1.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b67da50d1bba17e1d25babaa937440ccad41bf152d1df8d3adb50ff8c9199b3
-  data.tar.gz: 954c91d5da06a9d4955fdb35576b11f1e209a8ab152825c3f09657e891787a5d
+  metadata.gz: ace9209a6c531a382b264e87513dc6e5075499fc90f1eba313404368d96e58ba
+  data.tar.gz: e1771a96128f204df520f39bfcb54d3a294c130da07d0c9f971b98908fe985ce
 SHA512:
-  metadata.gz: ab9f0eb8538ea18407171b2d9dc435935821370f3f3d229f59d718e3e11f3eba6b6f926129274f33c5100b22a70d937ba6f9693d714f52abaf0f2a7be4965d28
-  data.tar.gz: 64503a74a1879ae8d0cda934ad511530ff6c22e5f1aeb9fe331f0dda99ccf8d7b81c735e2d10a9c6ce468010ea64674c1d8bc86a24fa8f18aa5382cfd29facdd
+  metadata.gz: aaaf84f0c0af53ad1df2f595298a8327fc67574b7a35c08a27a921f0719ef6eea0990a7ee28423755f3baa0abe78d31e4bad7bcd42f82d1c9ebe6607b0fe0574
+  data.tar.gz: 8eed0bfd9236bb43084c0427a50ac6ce6b793411d30adffd1d12b303ae57d0cf8d5dc0281b1c654aa15584a436066dea7f1a39a5283bdc7ef398df9dde56ec5c

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    periodoxical (1.1.0)
+    periodoxical (2.2.0)
       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

@@ -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>,
     }
 ]
 ```
@@ -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,41 +240,6 @@ 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.
-
-```
-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.
 
@@ -474,6 +439,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 = "2.2.0"
 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
@@ -66,6 +65,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,
@@ -78,7 +83,7 @@ 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
     )
 
@@ -90,13 +95,20 @@ 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)
       @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 +213,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
 
@@ -240,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
@@ -409,5 +428,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

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.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Steven Li
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-17 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