periodoxical 0.4.2 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95c80ef1e3008c4279f58b029a0790353aae3b346d809390c38961b719c635a9
-  data.tar.gz: 8531378c87459b8dc1945984da0c12b11238a6895668885751923779df3c1bd3
+  metadata.gz: 1c90e3908492b944735cc23b5da95746309133de5b54413495d4ed49e0d2dce3
+  data.tar.gz: 7fa63855a49e2c6feb9955007361aa6d8c9262f847e6fc0fc159c47f95ed1db5
 SHA512:
-  metadata.gz: 899994a59c14f4c6dcf3e8534e7812496ebf53a8b902506e2efebd695d193abf9a93844ccd42389dc2be35c22f2ca829a0d19e3d1de44f7fa4b28d0f5baf3e79
-  data.tar.gz: fdc25739ed5cf90e3aa1a71617c927382ed56dcbf7b2b292844bc3c3bbd5f4688fc9bf6c03ccddc58e8e930435835833d9fd092c30a31cdef0a243d19c1ad19d
+  metadata.gz: 36ba01fb5173e0fae2dea0eeba563145b373860989891f2640b468ee688b0cdd5d78b7f5b44e7d52f8d137cd80940ebe8e9b75b997dc144d0d159982bd15aa87
+  data.tar.gz: 5e678e7218811a7d5f0e779a2b766e2099742554414ee007078af87b0fc10f196900672c5fe0daa58b978ce1c4e31f9f08bfc21c0573f257f48823c211acdd74

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.4.2)
+    periodoxical (0.6.2)
       tzinfo (~> 2.0, >= 2.0.0)
+      week_of_month (= 1.2.6)
 
 GEM
   remote: https://rubygems.org/
@@ -40,6 +41,7 @@ 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

@@ -30,7 +30,43 @@ Or install it yourself as:
 ## Usage
 
 #### Example 1
-As a Ruby dev, I want to generate all the datetimes blocks of **9:00AM - 10:30AM** and **2:00PM - 2:30PM**, on **Mondays**, **Wednesdays**, and **Thursdays**, between the dates of **May 23, 2024** and **June 12, 2024**, inclusive. This can be represented visually as:
+As a Ruby dev, I want to generate all the datetime blocks of **9:00AM - 10:30AM**for all days from May 23, 2024 to May 26, 2024 inclusive.
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  time_blocks: [
+    {
+      start_time: '9:00AM',
+      end_time: '10:30AM'
+    },
+  ],
+  start_date: '2024-05-23',
+  end_date: '2024-05-27',
+)
+#=> 
+[
+    {
+     start_time: #<DateTime: 2024-05-23T09:00:00-0700>,
+     end_time: #<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_time: #<DateTime: 2024-05-25T09:00:00-0700>,
+     end_time: #<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>,
+    }
+]
+```
+
+#### Example 2
+As a Ruby dev, I want to generate all the datetime blocks of **9:00AM - 10:30AM** and **2:00PM - 2:30PM**, on **Mondays**, **Wednesdays**, and **Thursdays**, between the dates of **May 23, 2024** and **June 12, 2024**, inclusive. This can be represented visually as:
 
 <div align="center">
   <img width="558" alt="calendar_image_1" src="https://github.com/StevenJL/periodoxical/assets/2191808/e92fc6ff-03fd-44ed-a955-d3a0dd0f5d0a">
@@ -79,7 +115,7 @@ Periodoxical.generate(
 ]
 ```
 
-#### Example 2 - using the `limit` key.
+#### Example 3 - using the `limit` key.
 
 As a ruby dev, I want to generate the next 3 datetime blocks of **9:00AM - 10:30AM** and **2:00PM - 2:30PM** on **Sundays**, after **May 23, 2024** using the `limit` key.
 
@@ -117,7 +153,7 @@ Periodoxical.generate(
 ]
 ```
 
-#### Example 3 - when time blocks vary between days
+#### Example 4 - when time blocks vary between days
 
 As a ruby dev, I want to generate all the timeblocks between **May 23, 2024** and **June 12, 2024** where the time should be **8AM-9AM** on **Mondays**, but **10:45AM-12:00PM** and **2:00PM-4:00PM** on **Wednesdays**, and **2:30PM-4:15PM** on **Thursdays**.
 
@@ -148,6 +184,109 @@ Periodoxical.generate(
 )
 ```
 
+#### Example 5 - when specifying time blocks occur by day-of-month and/or and/or week-of-month and/or month.
+
+As a Ruby dev, I want to generate the next 3 slots for 8AM - 9AM for the 5th and 10th day of every month starting from June
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  start_date: '2024-06-1',
+  limit: 3,
+  days_of_month: [5, 10],
+  time_blocks: [
+    { start_time: '8:00AM', end_time: '9:00AM' },
+  ],
+)
+#=>
+[
+    {
+      start: #<DateTime: 2024-06-05 08:00:00 -0700>,
+      end: #<DateTime: 2024-06-05 09:00:00 -0700>,
+    },
+    {
+      start: #<DateTime: 2024-06-10 08:00:00 -0700>,
+      end: #<DateTime: 2024-06-10 09:00:00 -0700>,
+    },
+    {
+      start: #<DateTime: 2024-07-05 08:00:00 -0700>,
+      end: #<DateTime: 2024-07-05 09:00:00 -0700>,
+    },
+]
+```
+
+As a Ruby dev, I want to generate 4 slots for 8AM - 9AM on Mondays but only in the first two weeks in the months of April, May, June
+
+```
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  start_date: '2024-04-1',
+  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-01 08:00:00 -0700>,
+     end_time: #<DateTime: 2024-04-01 09:00:00 -0700>,
+    },
+    {
+     start_time: #<DateTime: 2024-04-08 08:00:00 -0700>,
+     end_time: #<DateTime: 2024-04-08 09:00:00 -0700>,
+    },
+    {
+     start_time: #<DateTime: 2024-05-06 08:00:00 -0700>,
+     end_time: #<DateTime: 2024-05-06 09:00:00 -0700>,
+    },
+    {
+     start_time: #<DateTime: 2024-06-03 08:00:00 -0700>,
+     end_time: #<DateTime: 2024-06-03 09:00:00 -0700>,
+    },
+]
+```
+
+#### Example 6 - 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 Monday 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.6.2"
 end

data/lib/periodoxical.rb

@@ -2,6 +2,7 @@ require "periodoxical/version"
 require "date"
 require "time"
 require "tzinfo"
+require "week_of_month"
 
 module Periodoxical
   class << self
@@ -32,24 +33,50 @@ module Periodoxical
     #   Days of the week to generate the times for, if nil, then times are generated
     #   for every day.
     #   Ex: %w(mon tue wed sat)
+    # @param [Array<Integer>, nil] days_of_month
+    #   Days of month to generate times for.
+    #   Ex: %w(5 10) - The 5th and 10th days of every month
+    # @param [Array<Integer>, nil] months
+    #   Months as integers, where 1 = Jan, 12 = Dec
     # @param [Integer] limit
     #   How many date times to generate.  To be used when `end_date` is nil.
-    # @param [Hash<Hash>] day_of_week_time_blocks
+    # @param [Aray<String>] exclusion_dates
+    #   Dates to be excluded when generating the time blocks
+    #   Ex: ['2024-06-10', '2024-06-14']
+    # @param [Hash<Array<Hash>>] day_of_week_time_blocks
     #   To be used when hours are different between days of the week
     #   Ex: {
     #     mon: [{ start_time: '10:15AM', end_time: '11:35AM' }, { start_time: '9:00AM' }, {end_time: '4:30PM'} ],
     #     tue: { start_time: '11:30PM', end_time: '12:00AM' },
     #     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)
+    def initialize(
+      start_date:,
+      end_date: nil,
+      time_blocks: nil,
+      day_of_week_time_blocks: nil,
+      limit: nil,
+      exclusion_dates: nil,
+      time_zone: 'Etc/UTC',
+      days_of_week: nil,
+      days_of_month: nil,
+      weeks_of_month: nil,
+      months: nil
+    )
+
       @time_zone = TZInfo::Timezone.get(time_zone)
       @days_of_week = days_of_week
+      @days_of_month = days_of_month
+      @weeks_of_month = weeks_of_month
+      @months = months
       @time_blocks = time_blocks
       @day_of_week_time_blocks = day_of_week_time_blocks
       @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
 
@@ -61,74 +88,31 @@ module Periodoxical
     #     }
     #   ]
     def generate
-      if @days_of_week && @time_blocks
-        generate_when_same_time_blocks_for_all_days
-      elsif @day_of_week_time_blocks
-        generate_when_different_time_blocks_between_days
+      initialize_looping_variables!
+      while @keep_generating
+        if should_add_time_blocks_from_current_date?
+          add_time_blocks_from_current_date!
+        end
+        advance_current_date_and_check_if_reached_end_date
       end
+      @output
     end
 
     private
 
-    def generate_when_different_time_blocks_between_days
-      times_output = []
-      current_date = @start_date
-      current_count = 0
-      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]
-          time_blocks = @day_of_week_time_blocks[day_of_week.to_sym]
-          time_blocks.each do |tb|
-            times_output << {
-              start: time_str_to_object(current_date, tb[:start_time]),
-              end: time_str_to_object(current_date, tb[:end_time])
-            }
-            current_count = current_count + 1
-            if @limit && current_count == @limit
-              keep_generating = false
-              break
-            end
-          end
-        end
-        current_date = current_date + 1
-        if @end_date && (current_date > @end_date)
-          keep_generating = false
-        end
+    def validate!
+      unless @day_of_week_time_blocks || @time_blocks
+        raise "`day_of_week_time_blocks` or `time_blocks` need to be provided"
       end
-      times_output
-    end
 
-    def generate_when_same_time_blocks_for_all_days 
-      times_output = []
-      current_date = @start_date
-      current_count = 0
-      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)
-          @time_blocks.each do |tb|
-            times_output << {
-              start: time_str_to_object(current_date, tb[:start_time]),
-              end: time_str_to_object(current_date, tb[:end_time])
-            }
-            current_count = current_count + 1
-            if @limit && current_count == @limit
-              keep_generating = false
-              break
-            end
+      if @weeks_of_month
+        @weeks_of_month.each do |wom|
+          unless wom.is_a?(Integer) && wom.between?(1, 5)
+            raise "weeks_of_month must be an array of integers between 1 and 5"
           end
         end
-        current_date = current_date + 1
-
-        if @end_date && (current_date > @end_date)
-          keep_generating = false
-        end
       end
-      times_output
-    end
 
-    def validate!
       # days of week are valid
       if @days_of_week
         @days_of_week.each do |day|
@@ -146,8 +130,20 @@ module Periodoxical
         end
       end
 
-      unless (@days_of_week && @time_blocks) || (@day_of_week_time_blocks)
-        raise "Need to provide either `days_of_week` and `time_blocks` or `day_of_week_time_blocks`"
+      if @days_of_month
+        @days_of_month.each do |dom|
+          unless dom.is_a?(Integer) && dom.between?(1,31)
+            raise 'days_of_months must be array of integers between 1 and 31'
+          end
+        end
+      end
+
+      if @months
+        @months.each do |mon|
+          unless mon.is_a?(Integer) && mon.between?(1, 12)
+            raise 'months must be array of integers between 1 and 12'
+          end
+        end
       end
 
       unless( @limit || @end_date)
@@ -182,5 +178,116 @@ module Periodoxical
       )
       @time_zone.local_to_utc(date_time).new_offset(@time_zone.current_period.offset.utc_total_offset)
     end
+
+    # @param [Date] date
+    # @return [Boolean]
+    #   Whether or not the date is excluded
+    def excluded_date?(date)
+      return false unless @exclusion_dates
+
+      @exclusion_dates.each do |ed|
+        return true if date == ed
+      end
+
+      false
+    end
+
+    # Variables which manage flow of looping through time and generating slots
+    def initialize_looping_variables!
+      @output = []
+      @current_date = @start_date
+      @current_count = 0
+      @keep_generating = true
+    end
+
+    # @param [Hash] time_block
+    #  Ex:
+    #  {
+    #    start_time: "9:00AM",
+    #    start_time: "10:00AM",
+    #  }
+    #  Generates time block but also checks if we should stop generating
+    def append_to_output_and_check_limit(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])
+      }
+
+      # increment count, if `limit` is used to stop generating
+      @current_count = @current_count + 1
+      if @limit && @current_count == @limit
+        @keep_generating = false
+        throw :done
+      end
+    end
+
+    def advance_current_date_and_check_if_reached_end_date
+      @current_date = @current_date + 1
+
+      if @end_date && (@current_date > @end_date)
+        @keep_generating = false
+      end
+    end
+
+    # @return [Boolean]
+    #   Should time blocks be added based on the current_date?
+    def should_add_time_blocks_from_current_date?
+      # return false if current_date is explicitly excluded
+      if @exclusion_dates
+        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
+        return false unless @months.include?(@current_date.month)
+      end
+
+      # If days of months are specified, but current_date does not satisfy it,
+      # return false
+      if @days_of_month
+        return false unless @days_of_month.include?(@current_date.day)
+      end
+
+      # If days of week are specified, but current_date does not satisfy it,
+      # return false
+      if @days_of_week
+        day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
+        return false unless @days_of_week.include?(day_of_week)
+      end
+
+      if @day_of_week_time_blocks
+        day_of_week = day_of_week_long_to_short(@current_date.strftime("%A"))
+        dowtb = @day_of_week_time_blocks[day_of_week.to_sym]
+        return false if dowtb.nil?
+        return false if dowtb.empty?
+      end
+
+      # Otherwise, return true
+      true
+    end
+
+    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]
+        catch :done do
+          time_blocks.each do |tb|
+            append_to_output_and_check_limit(tb)
+          end
+        end
+      elsif @time_blocks
+        catch :done do
+          @time_blocks.each do |tb|
+            append_to_output_and_check_limit(tb)
+          end
+        end
+      end
+    end
   end
 end

data/periodoxical.gemspec

@@ -35,6 +35,7 @@ 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.2
 platform: ruby
 authors:
 - Steven Li
@@ -30,6 +30,20 @@ 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