periodoxical 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 566ebd2f1dcb17516ed1c3deae4b8a51639daa61709f3e850131b6524d158004
-  data.tar.gz: cb121164fc25bd1c975d8df101fbcf5f8b523b5e7f7ea421385fd80b9aaebf3d
+  metadata.gz: d5a035b48977603a07dc33634bd290fab82ccee9844056cea809ea7b1b6dcdd9
+  data.tar.gz: 397ac66e80143a549f8ebb51c0ada7cb1e275491d5c91d6444707f06f52a2d3d
 SHA512:
-  metadata.gz: f3b56cbc4e282596b4aa87572ba659711b7342f5413a8f5db293d44888abb0075a7c637cae99fabb7887428960900faba0fed66160fefd56d5c4f43f14c64892
-  data.tar.gz: 2015f24e0209d01e3fde60ee750ea2c9c7865bc07447a7c73514ea935ddc2e9024769f3e7201745e3ef09b3d47a569169de6898cb435f4ecd46f745eb94f0d36
+  metadata.gz: ed99e7495d51df3865bc8e555f4b8ccdd259b94a661dd6fe3f257d4fa1196d86c6775faf0fbe1adfb013dba31c2e1cbfd7f2d563ffce56febebc2b01d7077c7e
+  data.tar.gz: 1fb4a1626239919706784d2ba638c51d2e0316f69ac8baa4833d9a6a029d15fc6ad6b0f3c52c362655b88bc08f719199b98d03e6d03306f189947df0d941b907

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.1.1)
+    periodoxical (0.3.2)
       tzinfo (~> 2.0, >= 2.0.0)
 
 GEM
@@ -24,7 +24,7 @@ GEM
     pry-stack_explorer (0.6.1)
       binding_of_caller (~> 1.0)
       pry (~> 0.13)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -49,7 +49,7 @@ DEPENDENCIES
   periodoxical!
   pry-byebug (~> 3.10)
   pry-stack_explorer (~> 0.6)
-  rake (~> 10.0)
+  rake (~> 12.3.3)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -23,11 +23,18 @@ Or install it yourself as:
 
 ## Usage
 
-```rb
-# Generates 9:00AM - 10:30AM and 2:00PM - 2:30PM time blocks
-# 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="Screenshot 2024-05-28 at 10 55 45 PM" 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(
   time_zone: 'America/Los_Angeles',
   days_of_week: %w[mon wed thu],
@@ -42,27 +49,94 @@ Periodoxical.generate(
     }
   ],
   start_date: Date.parse('2024-05-23'),
-  end_date: Date.parse('2024-06-24')
+  end_date: Date.parse('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>
+ }
 ]
 ```
 
+##### 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[sun],
+  time_blocks: [
+    {
+      start_time: '9:00AM',
+      end_time: '10:30PM'
+    },
+    {
+      start_time: '2:00PM',
+      end_time: '2:30PM'
+    }
+  ],
+  start_date: Date.parse('2024-05-23'),
+  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 and 4:00PM on Wednesdays, and 2:30PM to 4:15PM on Thursdays.
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  start_date: Date.parse('2024-05-23'),
+  end_date: Date.parse('2024-06-12'),
+  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' }
+    ],
+  }
+)
+```
+
 ## 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.1.2"
+  VERSION = "0.3.2"
 end

data/lib/periodoxical.rb

@@ -17,13 +17,24 @@ module Periodoxical
     #   TZInfo::DataTimezone#name from the tzinfo gem (https://github.com/tzinfo/tzinfo)
     # @param [Date] start_date
     # @param [Date] end_date
+    # @param [Array<Hash>] time_blocks
+    #   Ex: [
+    #     {
+    #       start_time: '9:00AM',
+    #       end_time: '10:30PM'
+    #     },
+    #     {
+    #       start_time: '2:00PM',
+    #       end_time: '2:30PM'
+    #     }
+    #   ]
     # @param [Array<String>, nil] days_of_week
     #   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 [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'} ],
@@ -31,11 +42,11 @@ 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:, 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
+      @day_of_week_time_blocks = day_of_week_time_blocks
       @start_date = start_date
       @end_date = end_date
       @limit = limit
@@ -51,28 +62,70 @@ 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
-      times = []
+    def generate_when_different_time_blocks_between_days
+      times_output = []
       current_date = @start_date
-      while current_date <= @end_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
+      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 << {
+            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
+      times_output
     end
 
     def validate!
@@ -85,15 +138,20 @@ 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 && @start_time && @end_time) || (@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)
+        raise "Either `limit` or `end_date` must be provided"
       end
     end
 

data/periodoxical.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tzinfo', '~> 2.0', '>= 2.0.0'
 
   spec.add_development_dependency "bundler", "~> 2.4"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug", "~> 3.10"
   spec.add_development_dependency "pry-stack_explorer", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Steven Li
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement