reprise 0.1.1-x86_64-linux → 0.1.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58764adc8382f31a71a5d134fdbf70df7d3c630f011cd1c3890c318c3fa3a239
-  data.tar.gz: f2a39d0e1e22b8d84a1acc86df230a8e3e5ca2aa90480771412089177e3db640
+  metadata.gz: 7131c46eebe9117738a4876a8ab79f7724eba1e5ff2fef8c2ff4f216bbd54288
+  data.tar.gz: 323287de6d54b70f99d434599578414329f5286a903b1e05223afdef82d3eb3d
 SHA512:
-  metadata.gz: c17862e0d73980459a1b9e71c2eb78e285e17fae3afdb6e6bbe5c9ef2ae25f24941e874fd1cf8ce4f209a4c24ce0baa3b239493291920c7697281a6e7f0204df
-  data.tar.gz: 511cd7fa3b58f23df2594d84acb0c19b637114f082e9226e91202c665e921499909ea7677d08f4153c84deeb78f110c43d9fecd1ce5f6e6c93f601c2e133080d
+  metadata.gz: 07e227ef61e9133e3a6de73beaccf707fec8bf288b6a0fc5b9e1a6462cc75d0a2c5c64a85c633478f5b9c53226013e834a6dd23c8f7db0d5a107afab1c622f54
+  data.tar.gz: 77e4e5ea23b838d907f3f51f2ecc5a17141d901c2d40b3eae8203aa61fb5fcf9635972864d22fb8ef53b7a9b917cc0dbe1bb5a76e7001eb1d9224d6851cc1bfd

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: x86_64-linux
 authors:
 - Jordan Hiltunen