reprise 0.1.1-aarch64-linux → 0.1.2-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3864b68e8660a3701c8ec042dbcda81a40d0d05deba495308ae6e16b1d049c90
-  data.tar.gz: '095ce9dd6f4377afa53cfe3cbe761717c7277926a69fee3a5fd182edf4d40fc1'
+  metadata.gz: 4a69d48df9d09168a3c9ba4d91f9a709f6cad74841e5628ab21ab707deba61af
+  data.tar.gz: adb7398bb31fc0be975bfcc614631578d3ca3a26a21735399c9b165d8545a9b3
 SHA512:
-  metadata.gz: 3cb472f6fe20c116ebb042c8e6f245b42be1e9666b961c93e40853502c4fc71035d5d1d9850102ddb40a1c91775796214dd48f49593a412edd267dc18807ac5e
-  data.tar.gz: 2799a8d4bf5ab39d6d5a58ddd03ab81ddf3e626fabce24615262485d52c31ea1cc53f5c4bcd90625fb6f8ecc5f2e761aa8f3a13e72bd4b920bb3daa163e92aa4
+  metadata.gz: f538123b3aa37e0c8798304e76307d8594c6290e7d756bc8b907497b2078d371e67724f8d8be9aeb390fc799029dcce7e80f643f3bb4805bacc83287dbe90e03
+  data.tar.gz: 801ca2f18ca8edeed59b98aacadde6297659c6bc9f6c4d5cd5ae22f2af7e147537145edac7a08e47c9139633e7ef2a57271658438615464c65760addf5936d04

data/Cargo.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # Reprise
 
-[![Tests](https://github.com/jordanhiltunen/reprise/actions/workflows/test.yml/badge.svg)](https://github.com/jordanhiltunen/reprise/actions/workflows/test.yml) | [![Test CRuby Gem Build](https://github.com/jordanhiltunen/reprise/actions/workflows/cruby-build-and-install.yml/badge.svg)](https://github.com/jordanhiltunen/reprise/actions/workflows/cruby-build-and-install.yml)
+[![Gem Version](https://badge.fury.io/rb/reprise.svg)](https://badge.fury.io/rb/reprise) | [![Tests](https://github.com/jordanhiltunen/reprise/actions/workflows/test.yml/badge.svg)](https://github.com/jordanhiltunen/reprise/actions/workflows/test.yml) | [![Test CRuby Gem Build](https://github.com/jordanhiltunen/reprise/actions/workflows/cruby-build-and-install.yml/badge.svg)](https://github.com/jordanhiltunen/reprise/actions/workflows/cruby-build-and-install.yml)
 
 Reprise is an experimental performance-first Ruby gem that provides support for defining event recurrence
 rules and generating & querying their future occurrences. Depending on your use case, 
@@ -21,9 +21,11 @@ gem "reprise"
 
 ## Usage
 
+_For a complete reference of all of the methods and options available, please [see our documentation](https://rubydoc.info/gems/reprise)._
+
 ### Initialize a new schedule
 
-All schedules need to be initialized with a `start_time` and `end_time`:
+All schedules need to be initialized with `starts_at` and `ends_at` time bookends:
 
 ```ruby
 may_26_2015_four_thirty_pm_in_rome = Time.parse("2015-05-26 10:30:45").in_time_zone("Rome")
@@ -64,8 +66,9 @@ started at as the local time for each future occurrence:
 
 ```ruby
 first_occurrence = schedule.occurrences.first
-# => <Reprise::Core::Occurrence start_time="2015-05-31T14:30:45+00:00" end_time="2015-05-31T14:45:45+00:00" label="nil">
-first_occurrence.start_time.in_time_zone("Rome")
+# => <Reprise::Core::Occurrence starts_at="2015-05-31T14:30:45+00:00" ends_at="2015-05-31T14:45:45+00:00" label="nil">
+
+first_occurrence.starts_at.in_time_zone("Rome")
 # => Sun, 31 May 2015 16:30:45.000000000 CEST +02:00 # <- 4:30 PM
 ```
 
@@ -75,8 +78,9 @@ either by passing an hour/minute/second hash to `time_of_day`:
 ```ruby
 schedule.repeat_weekly(:sunday, time_of_day: { hour: 9, minute: 30 }, duration_in_seconds: 60)
 first_occurrence = schedule.occurrences.first
-# => => <Reprise::Core::Occurrence start_time="2015-05-31T07:30:00+00:00" end_time="2015-05-31T07:31:00+00:00" label="nil">
-first_occurrence.start_time.in_time_zone("Rome")
+# => <Reprise::Core::Occurrence starts_at="2015-05-31T07:30:00+00:00" ends_at="2015-05-31T07:31:00+00:00" label="nil">
+
+first_occurrence.starts_at.in_time_zone("Rome")
 # => Sun, 31 May 2015 09:30:00.000000000 CEST +02:00
 ```
 
@@ -85,8 +89,9 @@ Or, by passing a `Time` object instead:
 ```ruby
 ten_forty_five_pm_in_rome = Time.parse("2015-05-27 04:45:00").in_time_zone("Rome")
 schedule.repeat_weekly(:tuesday, time_of_day: ten_forty_five_pm_in_rome, duration_in_seconds: 60)
-# => <Reprise::Core::Occurrence start_time="2015-06-02T08:45:00+00:00" end_time="2015-06-02T08:46:00+00:00" label="nil">
-first_occurrence.start_time.in_time_zone("Rome")
+# => <Reprise::Core::Occurrence starts_at="2015-06-02T08:45:00+00:00" ends_at="2015-06-02T08:46:00+00:00" label="nil">
+
+first_occurrence.starts_at.in_time_zone("Rome")
 # => Tue, 02 Jun 2015 10:45:00.000000000 CEST +02:00
 ```
 
@@ -102,9 +107,11 @@ schedule = Reprise::Schedule.new(
 
 schedule.repeat_weekly(:wednesday, time_of_day: { hour: 9, minute: 30 }, duration_in_seconds: 10.minutes)
 occurrences = schedule.occurrences
+
 puts occurrences.size
 # => 29
-puts (occurrences.last.start_time.to_date - occurrences.first.start_time.to_date).to_i
+
+puts (occurrences.last.starts_at.to_date - occurrences.first.starts_at.to_date).to_i
 # => 196 # days
 ```
 
@@ -121,18 +128,20 @@ schedule.repeat_weekly(
 occurrences = schedule.occurrences
 puts occurrences.size
 # => 8
-puts occurrences.first.start_time.in_time_zone("Rome")
+
+puts occurrences.first.starts_at.in_time_zone("Rome")
 # 2015-07-10 04:01:00 +0200
-puts occurrences.last.start_time.in_time_zone("Rome")
+
+puts occurrences.last.starts_at.in_time_zone("Rome")
 # 2015-08-28 04:01:00 +0200
-puts (occurrences.last.start_time.to_date - occurrences.first.start_time.to_date).to_i
+
+puts (occurrences.last.starts_at.to_date - occurrences.first.starts_at.to_date).to_i
 # => 49 # days
 ```
 
 There are many recurring series that you can create; `#repeat_minutely`, `#repeat_hourly`, 
-`#repeat_daily`, `#repeat_weekly`, `#repeat_monthly_by_day`, and `#repeat_monthly_by_nth_weekday`.
-
-For more information on each method, see the docs.
+`#repeat_daily`, `#repeat_weekly`, `#repeat_monthly_by_day`, `#repeat_monthly_by_nth_weekday`,
+and `#repeat_annually_by_day`.
 
 #### Adding labels to the occurrences of each series
 
@@ -142,14 +151,15 @@ you can add an optional label:
 ```ruby
 schedule.repeat_daily(label: "Coffee Time", time_of_day: { hour: 8 }, duration_in_seconds: 15.minutes)
 schedule.repeat_daily(label: "Tea Time", interval: 3, time_of_day: { hour: 9 }, duration_in_seconds: 10.minutes)
+
 schedule.occurrences.take(7).map { |o| puts o.inspect }
-# => <Reprise::Core::Occurrence label="Coffee Time" start_time="2015-05-27T06:00:00+00:00" end_time="2015-05-27T06:15:00+00:00">
-# => <Reprise::Core::Occurrence label="Tea Time" start_time="2015-05-27T07:00:00+00:00" end_time="2015-05-27T07:10:00+00:00">
-# => <Reprise::Core::Occurrence label="Coffee Time" start_time="2015-05-28T06:00:00+00:00" end_time="2015-05-28T06:15:00+00:00">
-# => <Reprise::Core::Occurrence label="Coffee Time" start_time="2015-05-29T06:00:00+00:00" end_time="2015-05-29T06:15:00+00:00">
-# => <Reprise::Core::Occurrence label="Coffee Time" start_time="2015-05-30T06:00:00+00:00" end_time="2015-05-30T06:15:00+00:00">
-# => <Reprise::Core::Occurrence label="Tea Time" start_time="2015-05-30T07:00:00+00:00" end_time="2015-05-30T07:10:00+00:00">
-# => <Reprise::Core::Occurrence label="Coffee Time" start_time="2015-05-31T06:00:00+00:00" end_time="2015-05-31T06:15:00+00:00">
+# => <Reprise::Core::Occurrence label="Coffee Time" starts_at="2015-05-27T06:00:00+00:00" ends_at="2015-05-27T06:15:00+00:00">
+# => <Reprise::Core::Occurrence label="Tea Time" starts_at="2015-05-27T07:00:00+00:00" ends_at="2015-05-27T07:10:00+00:00">
+# => <Reprise::Core::Occurrence label="Coffee Time" starts_at="2015-05-28T06:00:00+00:00" ends_at="2015-05-28T06:15:00+00:00">
+# => <Reprise::Core::Occurrence label="Coffee Time" starts_at="2015-05-29T06:00:00+00:00" ends_at="2015-05-29T06:15:00+00:00">
+# => <Reprise::Core::Occurrence label="Coffee Time" starts_at="2015-05-30T06:00:00+00:00" ends_at="2015-05-30T06:15:00+00:00">
+# => <Reprise::Core::Occurrence label="Tea Time" starts_at="2015-05-30T07:00:00+00:00" ends_at="2015-05-30T07:10:00+00:00">
+# => <Reprise::Core::Occurrence label="Coffee Time" starts_at="2015-05-31T06:00:00+00:00" ends_at="2015-05-31T06:15:00+00:00">
 ```
 
 #### Excluding time intervals from the schedule's occurrences
@@ -160,11 +170,11 @@ occurrences and need to be excluded, you can add exclusions to your schedule bef
 ```ruby
 schedule.repeat_daily(label: "Standing Meeting", ends_at: may_26_2015_four_thirty_pm_in_rome + 5.days, duration_in_seconds: 15.minutes)
 schedule.occurrences.map { |o| puts o.inspect }
-# => <Reprise::Core::Occurrence start_time="2015-05-26T14:30:45+00:00" end_time="2015-05-26T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-27T14:30:45+00:00" end_time="2015-05-27T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-28T14:30:45+00:00" end_time="2015-05-28T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-29T14:30:45+00:00" end_time="2015-05-29T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-30T14:30:45+00:00" end_time="2015-05-30T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-26T14:30:45+00:00" ends_at="2015-05-26T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-27T14:30:45+00:00" ends_at="2015-05-27T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-28T14:30:45+00:00" ends_at="2015-05-28T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-29T14:30:45+00:00" ends_at="2015-05-29T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-30T14:30:45+00:00" ends_at="2015-05-30T14:45:45+00:00" label="Standing Meeting">
 
 # You don't need to specify entire days; you can pass time intervals as narrow or wide as you like.
 schedule.add_exclusion(
@@ -174,10 +184,10 @@ schedule.add_exclusion(
 
 schedule.occurrences.map { |o| puts o.inspect }
 # N.B. The occurrence on 2015-05-28 is now excluded.
-# => <Reprise::Core::Occurrence start_time="2015-05-26T14:30:45+00:00" end_time="2015-05-26T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-27T14:30:45+00:00" end_time="2015-05-27T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-29T14:30:45+00:00" end_time="2015-05-29T14:45:45+00:00" label="Standing Meeting">
-# => <Reprise::Core::Occurrence start_time="2015-05-30T14:30:45+00:00" end_time="2015-05-30T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-26T14:30:45+00:00" ends_at="2015-05-26T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-27T14:30:45+00:00" ends_at="2015-05-27T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-29T14:30:45+00:00" ends_at="2015-05-29T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-30T14:30:45+00:00" ends_at="2015-05-30T14:45:45+00:00" label="Standing Meeting">
 ```
 
 #### Querying for occurrences within a given time interval
@@ -198,7 +208,7 @@ schedule.occurrences_between(
   may_26_2015_four_thirty_pm_in_rome + 2.days,
   may_26_2015_four_thirty_pm_in_rome + 3.days,
 ).map { |o| puts o.inspect }
-# => <Reprise::Core::Occurrence start_time="2015-05-28T14:30:45+00:00" end_time="2015-05-28T14:45:45+00:00" label="Standing Meeting">
+# => <Reprise::Core::Occurrence starts_at="2015-05-28T14:30:45+00:00" ends_at="2015-05-28T14:45:45+00:00" label="Standing Meeting">
 ```
 
 Both `#occurs_between?` and `#occurrences_between` also support an optional `include_overlapping`
@@ -235,6 +245,7 @@ A truism in the Ruby community is that "Ruby is slow, but that doesn't matter fo
 > speed, or throughput that Ruby chokes on. Or because the trade-offs are worth it: Often the
 > quicker development, cheaper development, faster time-to-market etc is worth the extra resources
 > (servers, hardware, SAAS) you must throw at your app to keep it performing acceptable.
+>
 > https://berk.es/2022/08/09/ruby-slow-database-slow/
 
 This is often delightfully true, until on the odd occasion Ruby's speed requires that a straightforward feature
@@ -305,7 +316,7 @@ and 3:30 - 4:30 PM.
 How do you filter out recurring series occurrences that conflict with other schedule entries that exist
 in your application?
 
-At time of writing, alternative gems' solutions to this problem are all unfortunately lacking:
+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.

data/lib/reprise/core/occurrence.rb

@@ -8,9 +8,9 @@ module Reprise
     # of adding documentation; it is defined dynamically within
     # the Rust extension.
     class Occurrence
-      # @!attribute [r] start_time
+      # @!attribute [r] starts_at
       #   @return [Time] The start time of the occurrence, given in the current system time zone.
-      # @!attribute [r] end_time
+      # @!attribute [r] ends_at
       #   @return [Time] The end time of the occurrence, given in the current system time zone.
       # @!attribute [r] label
       #   @return [String, nil] The label given to the recurring series from which the

data/lib/reprise/schedule.rb

@@ -81,7 +81,7 @@ module Reprise
 
     # @!macro [new] duration_in_seconds
     #   @param duration_in_seconds [Integer]
-    #     This determines the end time of each occurrence ({Reprise::Core::Occurrence#end_time}), and also
+    #     This determines the end time of each occurrence ({Reprise::Core::Occurrence#ends_at}), and also
     #     influences occurrence queries, and whether any added exclusions conflict with any of the schedule's
     #     occurrences.
 

data/lib/reprise/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reprise
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: aarch64-linux
 authors:
 - Jordan Hiltunen