solid_objects 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11624a306bdeca71c5da082c39329f579c8d5d9b88945db2e49b534d2c317bc2
-  data.tar.gz: 7ac2b6c343b243169f92273179591db817a0e51c24e0312eaa59f8ee46c1e17f
+  metadata.gz: e6230f0722b011cd685875a291ba17f1435712928c4af1881b692045fbf6f3ab
+  data.tar.gz: edfbf33e568b2c0e921deea594feeb41152e3bf854271625ca7923b3a28da466
 SHA512:
-  metadata.gz: dbf6ea115998afb97d759724469a29d8dfffa832ca52a6713027cbc5822d56ce2e40b55213deadefc598636beddeaebb49777e3e59d61a20b344a6b8bba1c670
-  data.tar.gz: 29e113dbdb487e5eaf3d9061dc494c6e6aaa54e2bf5fc2eba1bcd0e4a9db7684a1a7bffb65efc69cd0436d07c2b5e9523ab9075d8652f0c005affe545fd3d52e
+  metadata.gz: f90a44f702083feb54a1679cb1ad25509275c7ffeea83ff09d45263031a49ca65078ce982405f4402361e6e668830a537b2a6e177cbed89ee0cc9ff9016b4738
+  data.tar.gz: d632f853b9031d30416b5ba74ecce82cc39822327896024b0cf25846063ad0bf0fb341f887de0fd9d6c232b8eafd8e335e3209b066a965a9fcffa2fe5571c6a6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.0.1 - 2026-10-14
+
+- Correct `docs/reminders.md`, which said that Solid Objects has no
+  `unschedule`. The gem has `unschedule` and `unschedule_all`, and the guide
+  now has a section on how to cancel a reminder. The agent guide shows the
+  cancel call. A new test fails when the reminder guide does not name a public
+  reminder method of an actor.
+
 ## 1.0.0 - 2026-10-13
 
 - Version 1.0 freezes the public API under semantic versioning.

data/docs/agents.md

@@ -169,6 +169,7 @@ Obey these rules in actor code:
 - Keep state in `attribute` values. State must be JSON-compatible.
 - Use `schedule(at:, key:)` for delayed work. A reminder is one named alarm
   for each actor and key. A new `schedule` with the same key moves the alarm.
+  `unschedule(:expire, key: buyer)` cancels it.
 - Use `reject(code, message)` for a business rule failure that must not retry.
   It takes a code and a message, for example
   `reject(:room_full, "The room is full")`.
@@ -191,6 +192,7 @@ Avoid these mistakes:
 | `schedule(at: deadline)` with no operation after it | `schedule(at: deadline, key: buyer).expire(buyer:)`. A `schedule` call with no operation after it fails the turn with `SolidObjects::ScheduleWithoutOperation` |
 | `reject "room full"` | `reject(:room_full, "The room is full")` |
 | `id` inside an actor | `actor_id`. An actor has no `id` method |
+| A guessed cancel method, such as `cancel_reminder` | `unschedule(:expire, key: buyer)`. `unschedule_all(:expire)` cancels every key of one operation |
 | `register_effect(:name) { \|context, arguments\| ... }` | `register_effect(:name) { \|arguments, context\| ... }`. The arguments come first |
 
 [Reminders](reminders.md) and the [architecture guide](architecture.md) give

data/docs/reminders.md

@@ -129,8 +129,35 @@ cannot strand an entry because the handler drains by time rather than by alarm.
 Prefer it when the queue is large and the items are interchangeable; prefer
 `key:` when an item needs its own alarm that can be moved on its own.
 
-Solid Objects has no `unschedule`. A reminder stops when its handler does not
-re-arm it, and destroying an actor removes its reminders.
+## Cancel a reminder
+
+`unschedule` cancels one reminder: by operation, by operation and key, or by
+the handle that the operation call on the `schedule` result returns.
+`unschedule_all` cancels every key of one operation.
+
+```ruby
+def confirm(buyer:)
+  self.holds = holds.except(buyer)
+  unschedule(:expire, key: buyer)
+end
+
+def close_sale
+  unschedule_all(:expire)
+end
+```
+
+A cancellation is staged like a schedule. It commits with the state change of
+the same turn, and a turn that raises cancels nothing. A cancellation of a
+reminder that does not exist is not an error. An unknown operation raises
+`UnknownMessage`. A cancellation cannot recall an occurrence that the scheduler
+already turned into a message.
+
+A reminder also stops when its handler does not re-arm it, and the destruction
+of an actor removes its reminders.
+
+`reminder` returns the status of one reminder, or `nil`. `reminders` lists
+every key of one operation. Both include the changes that the current turn
+staged.
 
 Self-scheduling actors should also have a low-frequency application reconciler.
 It may read `SolidObjects::Instance.states_for`, `.without_pending_work`, and

data/lib/solid_objects/version.rb

@@ -1,5 +1,5 @@
 # rbs_inline: enabled
 
 module SolidObjects
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_objects
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lucas Carlson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-13 00:00:00.000000000 Z
+date: 2026-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable