periodoxical 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e68e36720b518a871efe0ea34eb09f94b99880f5ebda37f5123469839b8a6b94
-  data.tar.gz: 7dd9b4f9e7439c6875dc689bd08fc4b3e145f81a886eaaa5b8f5c879f1839377
+  metadata.gz: 86a786f06e166368721d1f0f17d9c702bfc23950f66482f4c2da80fde583d9a5
+  data.tar.gz: 65bae069f30ee999ccc99353d03149db0e3414adbb1257b1c163e2d7cfaa5e01
 SHA512:
-  metadata.gz: 8f5fd0e511bc2363d7487247b4fe528b5c8bd2e8b05d590b35ecf3d0726cda68b673f6f69dcb5c1e9d66b27998fb702161f8925afbc474e00df19ac13c105d6f
-  data.tar.gz: f8fc94f6e17ddeba3815c6f5baf4dc1881dd4c0fd8cfd6bf1e5e756cc393499da79c8d11f72b37fd1f3797d18c9bd1e62b95699b2c62ba3b61de524ce91f3308
+  metadata.gz: e9f76a36b7a77e326ab999adbda7d59f24f84383f198c260e99b76cfb7c9fe069c10fa3ff46c61c53491e4d6b96f8c23b8378471cd7494cce21e78dbfface58e
+  data.tar.gz: 3ad7d053bb777bf3f3dbf403a787447dc77eeab162d185a6e3de79c21a68d468ac30365aa2ad3d5db65525a2678f78e3f0c5e50e728b22cc521c205445696056

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    periodoxical (0.1.0)
-      tzinfo (>= 2.0.0)
+    periodoxical (0.2.2)
+      tzinfo (~> 2.0, >= 2.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -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)
@@ -47,9 +47,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.4)
   periodoxical!
-  pry-byebug
-  pry-stack_explorer
-  rake (~> 10.0)
+  pry-byebug (~> 3.10)
+  pry-stack_explorer (~> 0.6)
+  rake (~> 12.3.3)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -23,11 +23,9 @@ 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
+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
 
+```rb
 Periodoxical.generate(
   time_zone: 'America/Los_Angeles',
   days_of_week: %w[mon wed thu],
@@ -47,24 +45,41 @@ Periodoxical.generate(
 # returns an array of hashes, each with a :start, :end
 #=> 
 [
+  {
+    start: #<DateTime: 2024-05-23T16:00:00+00:00>,
+    end:   #<DateTime: 2024-05-24T05:30:00+00:00>,
+  },
+  {
+    start: #<DateTime: 2024-05-23T21:00:00+00:00>,
+    end:   #<DateTime: 2024-05-23T21:30:00+00:00>,
+  },
+ {
+    start: #<DateTime: 2024-05-27T16:00:00+00:00>,
+    end:   #<DateTime: 2024-05-28T05:30:00+00:00>
+ },
+ ...
+]
+```
+
+Generate the next 10 datetime blocks of 3:00PM - 4:30PM, on Sundays, after May 30, 2024
+
+```rb
+Periodoxical.generate(
+  time_zone: 'America/Los_Angeles',
+  days_of_week: %w[mon wed thu],
+  time_blocks: [
     {
-        :start=>#<DateTime: 2024-05-23T16:00:00+00:00>,
-        :end=>#<DateTime: 2024-05-23T16:00:00+00:00>
-    },
-    {
-        :start=>#<DateTime: 2024-05-23T16:00:00+00:00>,
-        :end=>#<DateTime: 2024-05-23T16:00:00+00:00>
+      start_time: '9:00AM',
+      end_time: '10:30AM'
     },
     {
-        :start=>#<DateTime: 2024-05-30T16:00:00+00:00>,
-        :end=>#<DateTime: 2024-05-30T16:00:00+00:00>
-    },
-    {   :start=>#<DateTime: 2024-05-30T16:00:00+00:00>,
-        :end=>#<DateTime: 2024-05-30T16:00:00+00:00>
-    },
-
-    ...
-]
+      start_time: '2:00PM',
+      end_time: '2:30PM'
+    }
+  ],
+  start_date: Date.parse('2024-05-23'),
+  limit: 10
+)
 ```
 
 ## Development

data/lib/periodoxical/version.rb

@@ -1,3 +1,3 @@
 module Periodoxical
-  VERSION = "0.1.1"
+  VERSION = "0.2.2"
 end

data/lib/periodoxical.rb

@@ -17,6 +17,17 @@ 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.
@@ -31,7 +42,7 @@ 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_hours: nil, limit: nil)
       @time_zone = TZInfo::Timezone.get(time_zone)
       @days_of_week = days_of_week
       @time_blocks = time_blocks
@@ -58,21 +69,32 @@ module Periodoxical
     private
 
     def generate_from_days_of_week_time_blocks
-      times = []
+      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 @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_date])
+              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!
@@ -93,13 +115,24 @@ module Periodoxical
         end
       end
 
-      unless (@days_of_week && @start_time && @end_time) || (@day_of_week_hours)
+      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`"
+      end
+
+      unless( @limit || @end_date)
+        raise "Either `limit` or `end_date` must be provided"
       end
     end
 
     def day_of_week_long_to_short(dow)
       {
-        "Thursday" => "thu"
+        "Monday" => "mon",
+        "Tuesday" => "tue",
+        "Wednesday" => "wed",
+        "Thursday" => "thu",
+        "Friday" => "fri",
+        "Saturday" => "sat",
+        "Sunday" => "sun",
       }[dow]
     end
 
@@ -107,7 +140,7 @@ module Periodoxical
     #   Ex: '9:00AM'
     # @param [Date] date
     def time_str_to_object(date, time_str)
-      time = Time.strptime("9:00AM", "%I:%M%p")
+      time = Time.strptime(time_str, "%I:%M%p")
       date_time = DateTime.new(
         date.year,
         date.month,

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodoxical
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Steven Li
@@ -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