reprise 0.1.2-arm64-darwin → 0.1.3-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 674580f80b0490b539981b2d305d4126712a2d532b3548f12a30085a834fc5e6
-  data.tar.gz: 7854c6ec3b48f1a6c1ac0a6efc0bf54ad791b9bcccd0eb8868609e4966950bb5
+  metadata.gz: 2ef0e62d6f450e4e832d369e45b4ceab4376571357e7a6ec4c72c4dbb48dd378
+  data.tar.gz: eed8da52afed84dd86d0717342521782ab579263b1c10c26f592b3ee1830c27c
 SHA512:
-  metadata.gz: 34b75118bd172cc4a0127ec2a55f7c6eb6c24563bae9523f1113b80f04f3fe9afff12ec36a7a664911ce5bc853c315617d1efdd6aab5ea4edcd93501781e514c
-  data.tar.gz: b4f843a5d49e314e4b29d8564c0d9f65811178d564d1a48e99659ce94693fc6222a0e3981df01771f0ec867722c99ad17f7c09d0fd4bd687cbb0742361e0b99d
+  metadata.gz: 68f4527b37d039ee6d7bbc71fd17b6a88f77e03008d0d172a47c16f126fc0533279ac133ae0f5335bef868f67d8c43fdb8c02d51655c3070c61196f4b3fb61c5
+  data.tar.gz: f9f9f68dbf2e5c4a9c59068fceaa0347983522dbf359673638c217fb6911ad15912e835c47e93f2beb8b0b09e37010fefbb73c51eb3b2e012a1d1cb6575b44bf

data/Cargo.lock

@@ -594,7 +594,7 @@ checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b"
 
 [[package]]
 name = "reprise"
-version = "0.1.2"
+version = "0.1.3"
 dependencies = [
  "chrono",
  "chrono-tz",

data/README.md

@@ -229,7 +229,7 @@ you would probably be much better served by choosing one of those two gems inste
   the influence of Rust leaks into its Ruby API. Alternative gems offer much more flexible APIs that support a variety
   of more idiomatic calling conventions: they have better, more forgiving ergonomics. Reprise may invest more efforts
   here in the future, but not until we have landed on a feature-complete, performant core - our primary design goal. 
-  Until then, out API will remain sparse but sufficient.
+  Until then, our API will remain sparse but sufficient.
 - **Stability.** Reprise is still experimental; we do not yet have a `1.0.0` release or a public roadmap. Breaking changes
   may be frequent across releases. If you do not want to pin Reprise to a specific version and want a library that you can
   upgrade without reviewing the changelog, you may want to consider an alternative for now.
@@ -317,8 +317,6 @@ How do you filter out recurring series occurrences that conflict with other sche
 in your application?
 
 At time of writing, alternative gems' solutions to this problem are somewhat wanting:
-- **None**: It is entirely the responsibility of the client application to handle occurrence exclusions,
-  despite this logic being core to the domain of recurring schedule management.
 - **Date-based exclusion**: Client applications can pass specific dates when occurrences should be excluded.
   This is not sufficient except for in the most simple of circumstances. Again, consider our hypothetical
   Monday @ 12:30 PM recurring series: being able to exclude a specific _date_ from your recurrence rule still 

data/lib/reprise/schedule.rb

@@ -85,6 +85,12 @@ module Reprise
     #     influences occurrence queries, and whether any added exclusions conflict with any of the schedule's
     #     occurrences.
 
+    # @!macro [new] count
+    #   @param count [Integer, nil] An optional count limit to apply to the occurrences
+    #     of a series; once the schedule has generated the requested number of occurrences,
+    #     it will halt further expansion of that specific series. The count takes precedence
+    #     over the optional +ends_at+ param.
+
     # @!macro [new] label
     #   @param label [String, nil] An optional label to apply to all of the occurrences
     #     that are generated from the series. See {Reprise::Core::Occurrence#label}.
@@ -93,15 +99,17 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
-    def repeat_minutely(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_minutely(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_minutely(
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
         duration_in_seconds:,
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -110,15 +118,17 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
-    def repeat_hourly(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_hourly(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_hourly(
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
         duration_in_seconds:,
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -127,15 +137,17 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
-    def repeat_daily(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_daily(time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_daily(
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
         duration_in_seconds:,
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -145,6 +157,7 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
     # @example with a +time_of_day+ hash
@@ -152,7 +165,7 @@ module Reprise
     # @example with a local time for +time_of_day+
     #   local_time = Time.current.in_time_zone(my_current_time_zone)
     #   schedule.repeat_weekly(:monday, time_of_day: local_time, duration_in_seconds: 30)
-    def repeat_weekly(weekday, time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_weekly(weekday, time_of_day: nil, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_weekly(
         weekday,
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
@@ -160,6 +173,7 @@ module Reprise
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -169,11 +183,12 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
     # @example
     #   schedule.repeat_monthly_by_day(15, time_of_day: { hour: 9 }, duration_in_seconds: 30)
-    def repeat_monthly_by_day(day_number, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_monthly_by_day(day_number, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_monthly_by_day(
         day_number,
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
@@ -181,6 +196,7 @@ module Reprise
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -191,9 +207,10 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
-    def repeat_monthly_by_nth_weekday(weekday, nth_day, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_monthly_by_nth_weekday(weekday, nth_day, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_monthly_by_nth_weekday(
         weekday,
         nth_day,
@@ -202,6 +219,7 @@ module Reprise
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end
@@ -211,11 +229,12 @@ module Reprise
     # @!macro duration_in_seconds
     # @!macro interval
     # @!macro recurring_series_start_and_end_times
+    # @!macro count
     # @!macro label
     # @return [void]
     # @example
     #   schedule.repeat_annually_by_day(200, duration_in_seconds: 30)
-    def repeat_annually_by_day(day_number, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, label: nil)
+    def repeat_annually_by_day(day_number, time_of_day:, duration_in_seconds:, interval: 1, starts_at: nil, ends_at: nil, count: nil, label: nil)
       internal_schedule.repeat_annually_by_day(
         day_number,
         time_of_day: TimeOfDay.new(time_of_day || self.starts_at).to_h,
@@ -223,6 +242,7 @@ module Reprise
         interval:,
         starts_at_unix_timestamp: starts_at.presence&.to_i,
         ends_at_unix_timestamp: ends_at.presence&.to_i,
+        count:,
         label:
       )
     end

data/lib/reprise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reprise
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reprise
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: arm64-darwin
 authors:
 - Jordan Hiltunen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-20 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips