periodoxical 0.3.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a035b48977603a07dc33634bd290fab82ccee9844056cea809ea7b1b6dcdd9
-  data.tar.gz: 397ac66e80143a549f8ebb51c0ada7cb1e275491d5c91d6444707f06f52a2d3d
+  metadata.gz: fa1a430d11ca7fdd0cea524011b7164f926f87bad37a49c4848bdbca934bdc79
+  data.tar.gz: fea338a55f3b095b4ac6c1ff57f235e8490a9b6683ae48b9a573b0b1afba22f0
 SHA512:
-  metadata.gz: ed99e7495d51df3865bc8e555f4b8ccdd259b94a661dd6fe3f257d4fa1196d86c6775faf0fbe1adfb013dba31c2e1cbfd7f2d563ffce56febebc2b01d7077c7e
-  data.tar.gz: 1fb4a1626239919706784d2ba638c51d2e0316f69ac8baa4833d9a6a029d15fc6ad6b0f3c52c362655b88bc08f719199b98d03e6d03306f189947df0d941b907
+  metadata.gz: 74ec882770d5567ad292ad26c020777d9075cbb0bf77259f37fa0713ab239772dea1dd52fadb2d415ceb8820a10cbc2572ee4847ac181ae208d81d6d759b0517
+  data.tar.gz: e2a7c7b00eec3522ce4d2bd15a999a7f86de8826245c464f0e0844b3f7cd42d7eb942d80e7cad2ecbc48d66399f4962fd9f7be7d8a9d4a025e51d79b477112e2

data/Gemfile.lock

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

data/README.md

@@ -2,8 +2,14 @@
 
 _"Up, and down, and in the end, it's only round and round and round..._" - Pink Floyd, "Us and Them"
 
-Generate periodic dates/times based on rules. Great for (but not limited to) calendar and scheduling applications. 
-See Usage for examples/details.
+<div align="center">
+  <img width="558" alt="pink_floyd_time" src="https://github.com/StevenJL/periodoxical/assets/2191808/8bab4a14-2df7-42d0-b6ae-f6b57a353500">
+    <p><i>(Image Courtesy of "Pink Floyd: Time," directed by Ian Eames , ©1973)</i></p>
+</div>
+
+<br>
+
+Generate periodic datetime blocks based on provided rules/conditions. Great for (but not limited to) calendar and scheduling applications. See Usage for detailed examples.
 
 ## Installation
 
@@ -23,15 +29,14 @@ 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:
+#### 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:
 
 <div align="center">
-  <img width="558" alt="Screenshot 2024-05-28 at 10 55 45 PM" src="https://github.com/StevenJL/periodoxical/assets/2191808/e92fc6ff-03fd-44ed-a955-d3a0dd0f5d0a">
+  <img width="558" alt="calendar_image_1" src="https://github.com/StevenJL/periodoxical/assets/2191808/e92fc6ff-03fd-44ed-a955-d3a0dd0f5d0a">
     <p><i>(image courtesy of Cal.com)</i></p>
 </div>
 
-
 <br>
 
 ```rb
@@ -48,8 +53,8 @@ Periodoxical.generate(
       end_time: '2:30PM'
     }
   ],
-  start_date: Date.parse('2024-05-23'),
-  end_date: Date.parse('2024-06-12')
+  start_date: '2024-05-23',
+  end_date: '2024-06-12',
 )
 # returns an array of hashes, each with :start and :end keys
 #=> 
@@ -74,10 +79,9 @@ Periodoxical.generate(
 ]
 ```
 
-##### Example 2 - using the `limit` key.
+#### Example 2 - 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.
+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.
 
 ```rb
 Periodoxical.generate(
@@ -93,7 +97,7 @@ Periodoxical.generate(
       end_time: '2:30PM'
     }
   ],
-  start_date: Date.parse('2024-05-23'),
+  start_date: Date.parse('2024-05-23'), # Can also pass in `Date` object.
   limit: 3
 )
 # =>
@@ -113,15 +117,22 @@ Periodoxical.generate(
 ]
 ```
 
-##### Example 3 - when time blocks vary between days
+#### Example 3 - 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**.
 
-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 and 4:00PM on Wednesdays, and 2:30PM to 4:15PM on Thursdays.
+<div align="center">
+  <img width="628" alt="calendar_image_2" src="https://github.com/StevenJL/periodoxical/assets/2191808/26d14824-08ff-481a-97e2-9b6b11beea29">
+  <p><i>(image courtesy of Cal.com)</i></p>
+</div>
+
+<br>
 
 ```rb
 Periodoxical.generate(
   time_zone: 'America/Los_Angeles',
-  start_date: Date.parse('2024-05-23'),
-  end_date: Date.parse('2024-06-12'),
+  start_date: Date.parse('2024-05-23'), # can also pass in Date objects
+  end_date: Date.parse('2024-06-12'), # can also pass in Date objects,
   day_of_week_time_blocks: {
     mon: [
       { start_time: '8:00AM', end_time: '9:00AM' },
@@ -137,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.3.2"
+  VERSION = "0.5.2"
 end

data/lib/periodoxical.rb

@@ -15,8 +15,8 @@ module Periodoxical
     # @param [String] time_zone
     #   Ex: 'America/Los_Angeles', 'America/Chicago',
     #   TZInfo::DataTimezone#name from the tzinfo gem (https://github.com/tzinfo/tzinfo)
-    # @param [Date] start_date
-    # @param [Date] end_date
+    # @param [Date, String] start_date
+    # @param [Date, String] end_date
     # @param [Array<Hash>] time_blocks
     #   Ex: [
     #     {
@@ -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,14 +45,17 @@ 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
       @day_of_week_time_blocks = day_of_week_time_blocks
-      @start_date = start_date
-      @end_date = end_date
+      @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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.2
 platform: ruby
 authors:
 - Steven Li
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo