periodoxical 0.2.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86a786f06e166368721d1f0f17d9c702bfc23950f66482f4c2da80fde583d9a5
-  data.tar.gz: 65bae069f30ee999ccc99353d03149db0e3414adbb1257b1c163e2d7cfaa5e01
+  metadata.gz: 95c80ef1e3008c4279f58b029a0790353aae3b346d809390c38961b719c635a9
+  data.tar.gz: 8531378c87459b8dc1945984da0c12b11238a6895668885751923779df3c1bd3
 SHA512:
-  metadata.gz: e9f76a36b7a77e326ab999adbda7d59f24f84383f198c260e99b76cfb7c9fe069c10fa3ff46c61c53491e4d6b96f8c23b8378471cd7494cce21e78dbfface58e
-  data.tar.gz: 3ad7d053bb777bf3f3dbf403a787447dc77eeab162d185a6e3de79c21a68d468ac30365aa2ad3d5db65525a2678f78e3f0c5e50e728b22cc521c205445696056
+  metadata.gz: 899994a59c14f4c6dcf3e8534e7812496ebf53a8b902506e2efebd695d193abf9a93844ccd42389dc2be35c22f2ca829a0d19e3d1de44f7fa4b28d0f5baf3e79
+  data.tar.gz: fdc25739ed5cf90e3aa1a71617c927382ed56dcbf7b2b292844bc3c3bbd5f4688fc9bf6c03ccddc58e8e930435835833d9fd092c30a31cdef0a243d19c1ad19d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.2.2)
+    periodoxical (0.4.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,7 +29,15 @@ Or install it yourself as:
 
 ## Usage
 
-Generates 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 24, 2024
+#### 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="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
 Periodoxical.generate(
@@ -39,46 +53,98 @@ Periodoxical.generate(
       end_time: '2:30PM'
     }
   ],
-  start_date: Date.parse('2024-05-23'),
-  end_date: Date.parse('2024-06-24')
+  start_date: '2024-05-23',
+  end_date: '2024-06-12',
 )
-# returns an array of hashes, each with a :start, :end
+# returns an array of hashes, each with :start and :end keys
 #=> 
 [
   {
-    start: #<DateTime: 2024-05-23T16:00:00+00:00>,
-    end:   #<DateTime: 2024-05-24T05:30:00+00:00>,
+    start: #<DateTime: 2024-05-23T09:00:00-0700">,
+    end:   #<DateTime: 2024-05-23T22:30:00-0700">,
   },
   {
-    start: #<DateTime: 2024-05-23T21:00:00+00:00>,
-    end:   #<DateTime: 2024-05-23T21:30:00+00:00>,
+    start: #<DateTime: 2024-05-23T14:00:00-0700>,
+    end:   #<DateTime: 2024-05-23T14:30:00-0700>,
   },
  {
-    start: #<DateTime: 2024-05-27T16:00:00+00:00>,
-    end:   #<DateTime: 2024-05-28T05:30:00+00:00>
+    start: #<DateTime: 2024-05-27T09:00:00-0700>,
+    end:   #<DateTime: 2024-05-27T22:30:00-0700>
  },
  ...
+ {
+    start: #<DateTime: 2024-06-12T14:00:00-0700>,
+    end:   #<DateTime: 2024-06-12T14:30:00-0700>
+ }
 ]
 ```
 
-Generate the next 10 datetime blocks of 3:00PM - 4:30PM, on Sundays, after May 30, 2024
+#### 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.
 
 ```rb
 Periodoxical.generate(
   time_zone: 'America/Los_Angeles',
-  days_of_week: %w[mon wed thu],
+  days_of_week: %w[sun],
   time_blocks: [
     {
       start_time: '9:00AM',
-      end_time: '10:30AM'
+      end_time: '10:30PM'
     },
     {
       start_time: '2:00PM',
       end_time: '2:30PM'
     }
   ],
-  start_date: Date.parse('2024-05-23'),
-  limit: 10
+  start_date: Date.parse('2024-05-23'), # Can also pass in `Date` object.
+  limit: 3
+)
+# =>
+[
+  {
+    start: #<DateTime: 2024-05-26T09:00:00-0700>,
+    end:   #<DateTime: 2024-05-26T22:30:00-0700>,
+  },
+  {
+    start: #<DateTime: 2024-05-26T14:00:00-0700>,
+    end:   #<DateTime: 2024-05-26T14:30:00-0700>,
+  },
+  {
+    start: #<DateTime: 2024-06-02T09:00:00-0700>,
+    end:   #<DateTime: 2024-06-02T22:30:00-0700>,
+  },
+]
+```
+
+#### 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**.
+
+<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'), # 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' },
+    ],
+    wed: [
+      { start_time: '10:45AM', end_time: '12:00PM' },
+      { start_time: '2:00PM', end_time: '4:00PM' },
+    ],
+    thu: [
+      { start_time: '2:30PM', end_time: '4:15PM' }
+    ],
+  }
 )
 ```
 

data/lib/periodoxical/version.rb

@@ -1,3 +1,3 @@
 module Periodoxical
-  VERSION = "0.2.2"
+  VERSION = "0.4.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,7 +34,7 @@ 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 [Hash<Hash>] day_of_week_hours
+    # @param [Hash<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'} ],
@@ -42,13 +42,13 @@ 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_hours: nil, limit: nil)
+                   start_date:, end_date: nil, time_blocks: nil, day_of_week_time_blocks: nil, limit: nil)
       @time_zone = TZInfo::Timezone.get(time_zone)
       @days_of_week = days_of_week
       @time_blocks = time_blocks
-      @day_of_week_hours = day_of_week_hours
-      @start_date = start_date
-      @end_date = end_date
+      @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
       validate!
     end
@@ -62,13 +62,44 @@ module Periodoxical
     #   ]
     def generate
       if @days_of_week && @time_blocks
-        generate_from_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
       end
     end
 
     private
 
-    def generate_from_days_of_week_time_blocks
+    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
+      end
+      times_output
+    end
+
+    def generate_when_same_time_blocks_for_all_days 
       times_output = []
       current_date = @start_date
       current_count = 0
@@ -107,16 +138,16 @@ module Periodoxical
         end
       end
 
-      if @day_of_week_hours
-        @day_of_week_hours.keys.each do |d|
-          unless VALID_DAYS_OF_WEEK.include?(d)
+      if @day_of_week_time_blocks
+        @day_of_week_time_blocks.keys.each do |d|
+          unless VALID_DAYS_OF_WEEK.include?(d.to_s)
             raise "#{d} is not a valid day of week format. Must be #{VALID_DAYS_OF_WEEK}"
           end
         end
       end
 
-      unless (@days_of_week && @time_blocks) || (@day_of_week_hours)
-        raise "Need to provide either `days_of_week` and `time_blocks` or `day_of_week_hours`"
+      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`"
       end
 
       unless( @limit || @end_date)

metadata

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