solid_objects 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +2 -1
- data/docs/compare/good-job.md +1 -1
- data/docs/compare/solid-queue.md +1 -1
- data/docs/comparisons.md +1 -1
- data/docs/maintenance.md +65 -0
- data/docs/versioning.md +2 -2
- data/lib/solid_objects/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5c108526a0dc45b006b197305e8d29a6450c4f41129f39add918648ee94befe0
|
|
4
|
+
data.tar.gz: 62c99e41f07ee81893bb814ce9928fe5710dc0b92d65bb44d1f769d9782e7da8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c212e8c7e68dd6c5e2c4b3852cf572929aa428016abe92caa5868accea4c2c142bc4f3a9d4ac123cf4b2505b76a82e5b35948524302a58794cd7629ec392e5ab
|
|
7
|
+
data.tar.gz: 80c08919638856ca1869de348042e98c96a54785f5bab0eb9b9057c6a2c2a033e76651fa523e0e293d0b9f5f0eb56763500589f2dd82a0afed0814158bdb5756
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.0.3 - 2026-10-18
|
|
4
|
+
|
|
5
|
+
- Add `docs/maintenance.md`. It tells you who maintains the gem, how CI checks
|
|
6
|
+
each change, how a release is published, what you keep if maintenance
|
|
7
|
+
stops, and how to become a maintainer. The README and the comparison pages
|
|
8
|
+
now link to this page. They and `docs/versioning.md` no longer state a count
|
|
9
|
+
of maintainers. A new test fails when a page states one.
|
|
10
|
+
|
|
3
11
|
## 1.0.2 - 2026-10-15
|
|
4
12
|
|
|
5
13
|
- Add two comparison pages in `docs/compare/`: Solid Queue
|
data/README.md
CHANGED
|
@@ -13,7 +13,7 @@ model and when to use it.
|
|
|
13
13
|
|
|
14
14
|
**Status.** Version 1.0: the public API follows semantic versioning and does
|
|
15
15
|
not break before 2.0. [Versioning](docs/versioning.md) gives the limits of the
|
|
16
|
-
promise. First public release: August 6, 2026.
|
|
16
|
+
promise. First public release: August 6, 2026.
|
|
17
17
|
|
|
18
18
|
**Production use.** One first-party application with more than 100,000 users
|
|
19
19
|
runs it in production. That is a count of users, not a measure of load. No
|
|
@@ -199,6 +199,7 @@ every claim in [`test/guides/`](test/guides/):
|
|
|
199
199
|
- [Reminders](docs/reminders.md)
|
|
200
200
|
- [Reactive ERB](docs/realtime.md)
|
|
201
201
|
- [Detailed architecture](docs/architecture.md)
|
|
202
|
+
- [Maintenance and continuity](docs/maintenance.md)
|
|
202
203
|
- [Detailed documentation](docs/)
|
|
203
204
|
|
|
204
205
|
The dashboard, benchmarks, migration cookbook, schema, and exhaustive API
|
data/docs/compare/good-job.md
CHANGED
|
@@ -210,7 +210,7 @@ How it works:
|
|
|
210
210
|
|
|
211
211
|
- First public release: August 6, 2026.
|
|
212
212
|
- Version 1.0.0: October 13, 2026. The public API follows [semantic versioning](../versioning.md).
|
|
213
|
-
-
|
|
213
|
+
- [Maintenance and continuity](../maintenance.md) tells you who maintains the project and how a release is made.
|
|
214
214
|
- One first-party application with more than 100,000 users runs it in production. That is a count of users, not a measure of load. No production use by other people is known.
|
|
215
215
|
- The [benchmarks](../benchmarks.md) are development measurements. Longer soak tests are open work.
|
|
216
216
|
|
data/docs/compare/solid-queue.md
CHANGED
|
@@ -205,7 +205,7 @@ How it works:
|
|
|
205
205
|
|
|
206
206
|
- First public release: August 6, 2026.
|
|
207
207
|
- Version 1.0.0: October 13, 2026. The public API follows [semantic versioning](../versioning.md).
|
|
208
|
-
-
|
|
208
|
+
- [Maintenance and continuity](../maintenance.md) tells you who maintains the project and how a release is made.
|
|
209
209
|
- One first-party application with more than 100,000 users runs it in production. That is a count of users, not a measure of load. No production use by other people is known.
|
|
210
210
|
- The [benchmarks](../benchmarks.md) are development measurements. Longer soak tests are open work.
|
|
211
211
|
|
data/docs/comparisons.md
CHANGED
|
@@ -23,4 +23,4 @@ The problem guides start from the same choices:
|
|
|
23
23
|
|
|
24
24
|
## Status
|
|
25
25
|
|
|
26
|
-
Solid Objects 1.0.0 shipped on October 13, 2026. The first public release was on August 6, 2026.
|
|
26
|
+
Solid Objects 1.0.0 shipped on October 13, 2026. The first public release was on August 6, 2026. One first-party application with more than 100,000 users runs it in production. That is a count of users, not a measure of load. No production use by other people is known. See [versioning](versioning.md) and [maintenance and continuity](maintenance.md).
|
data/docs/maintenance.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Maintenance and continuity
|
|
2
|
+
|
|
3
|
+
This page tells you who maintains Solid Objects, how a release is made, and
|
|
4
|
+
what you keep if maintenance stops. It also tells you how to help maintain the
|
|
5
|
+
project.
|
|
6
|
+
|
|
7
|
+
## Who maintains it
|
|
8
|
+
|
|
9
|
+
Lucas Carlson ([@cardmagic](https://github.com/cardmagic)) is the lead
|
|
10
|
+
maintainer of the Ruby gem `solid_objects` and of the npm package
|
|
11
|
+
[`solid-objects`](https://github.com/cardmagic/solid-objects-js). The two
|
|
12
|
+
packages use the same model and the same correctness contract. A change to the
|
|
13
|
+
model goes into both packages, and the
|
|
14
|
+
[parity ledger](https://github.com/cardmagic/solid-objects-js/blob/main/docs/parity.md)
|
|
15
|
+
records each difference between them.
|
|
16
|
+
|
|
17
|
+
The same maintainer sells [Solid Objects Pro](https://solidobjects.pro), a
|
|
18
|
+
commercial package that batches operations at scale. Pro depends on this gem.
|
|
19
|
+
This gem does not depend on Pro, and it needs no account, license key, or
|
|
20
|
+
service from the maintainer.
|
|
21
|
+
|
|
22
|
+
## How a change is checked
|
|
23
|
+
|
|
24
|
+
CI runs on each push and each pull request:
|
|
25
|
+
|
|
26
|
+
- The full test suite on SQLite, on each pair of Ruby 3.3, 3.4, or 4.0 and
|
|
27
|
+
Rails 7.1, 7.2, 8.0, or 8.1.
|
|
28
|
+
- The full test suite on PostgreSQL and on MySQL, with both MySQL clients.
|
|
29
|
+
- Standard, RuboCop, RBS, Steep, and Brakeman.
|
|
30
|
+
|
|
31
|
+
[Compatibility and maturity](virtual-actors.md#compatibility-and-maturity)
|
|
32
|
+
lists the supported versions. The [correctness contract](correctness.md) lists
|
|
33
|
+
the guarantees that the tests check.
|
|
34
|
+
|
|
35
|
+
## How a release is made
|
|
36
|
+
|
|
37
|
+
1. The maintainer pushes a version tag, for example `v1.0.3`.
|
|
38
|
+
2. GitHub Actions runs all test jobs again on that tag.
|
|
39
|
+
3. If all test jobs pass, GitHub Actions builds the gem and pushes it to
|
|
40
|
+
RubyGems with trusted publishing. The repository keeps no RubyGems key.
|
|
41
|
+
4. The same job makes a GitHub release and attaches the gem file.
|
|
42
|
+
|
|
43
|
+
[Versioning](versioning.md) tells you what a release can change.
|
|
44
|
+
`CHANGELOG.md` lists each release.
|
|
45
|
+
|
|
46
|
+
## What you keep if maintenance stops
|
|
47
|
+
|
|
48
|
+
- **Your data.** Actor state, mailboxes, reminders, and effects are rows in
|
|
49
|
+
your application's database. [Database schema](database-schema.md) describes
|
|
50
|
+
each table. No service of the maintainer holds your data.
|
|
51
|
+
- **The code.** The [MIT License](../MIT-LICENSE) lets anyone use, change,
|
|
52
|
+
fork, and publish the code.
|
|
53
|
+
- **The checks.** The tests and the CI configuration are in this repository. A
|
|
54
|
+
fork can check its changes with the same suite.
|
|
55
|
+
|
|
56
|
+
## Help maintain Solid Objects
|
|
57
|
+
|
|
58
|
+
The project wants more maintainers. Experience with Rails, with locks and
|
|
59
|
+
transactions in PostgreSQL or MySQL, or with TypeScript and Node.js helps.
|
|
60
|
+
|
|
61
|
+
1. Read [CONTRIBUTING.md](../CONTRIBUTING.md).
|
|
62
|
+
2. Send a small pull request: a fix, a test, or a correction to a guide.
|
|
63
|
+
3. After some of your pull requests are merged, open an
|
|
64
|
+
[issue](https://github.com/cardmagic/solid-objects-ruby/issues) to ask to
|
|
65
|
+
become a maintainer.
|
data/docs/versioning.md
CHANGED
|
@@ -41,8 +41,8 @@ lists the current minimum versions.
|
|
|
41
41
|
|
|
42
42
|
Version 1.0 is a promise about the API. It is not a claim of measured scale.
|
|
43
43
|
The [benchmarks](benchmarks.md) are development measurements and do not
|
|
44
|
-
guarantee capacity. Longer soak tests are open work.
|
|
45
|
-
|
|
44
|
+
guarantee capacity. Longer soak tests are open work. No production use by
|
|
45
|
+
other people is known.
|
|
46
46
|
|
|
47
47
|
## Releases before 1.0
|
|
48
48
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: solid_objects
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Lucas Carlson
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: actioncable
|
|
@@ -372,6 +372,7 @@ files:
|
|
|
372
372
|
- docs/guides/transactional-outbox.md
|
|
373
373
|
- docs/implementation-plan.md
|
|
374
374
|
- docs/local-testing.md
|
|
375
|
+
- docs/maintenance.md
|
|
375
376
|
- docs/migrating-existing-state.md
|
|
376
377
|
- docs/observability.md
|
|
377
378
|
- docs/operations.md
|