verifyAll() returns how many checks it verified

[rasuvaeff]

Fixes #153

What

Understudy::verifyAll() now returns int<0, max> — how many checks it verified — instead of void, so a runner adapter can count real assertions instead of a flat one per test (understudy-phpunit's assertPostConditions() does addToAssertionCount(1) whether the test armed one expectation or fifteen).

One check, precisely

• an expectation carrying a claim (expect(), or times() on a stub);
• a plain stub under strictStubs, where its use is what is checked;
• an ordering constraint over expectations that declared one (per context);
• an armed protocol, whose completeness is checked here.

A failed check throws, so the number only ever counts checks that passed. Checks verify() made earlier are not part of it: those answered at their own call sites, and verifyAll() does not re-decide them.

Compatibility

void → int is source-compatible for every existing caller: the method answered nothing before, so no caller could have read the answer, and Understudy is final, so no override shadows it. composer bc-check -- --from=v1.0.1 agrees:

No backwards-incompatible changes detected

The compatibility policy in both READMEs previously said "retyping an existing public member is a major-version change", which would have made this a 2.0 for a change no caller can observe. The policy now says a return type may be widened in a minor release where no caller can observe the change (and the same reasoning admits a parameter widened to a supertype every existing argument already satisfies); narrowing is never minor. The paragraph quotes this very change as its first application.

Notes for reviewers

• checkOrdering() split into orderedExpectations() (the collector) + orderingFailure() (the renderer), because the count needs to know whether an ordering constraint existed without re-walking states. allVerified() keeps its behaviour: orderingFailure(orderedExpectations($state)).
• Counting happens where the checks happen — failuresIn() returns array{list<VerificationFailure>, int<0, max>} now — counted by what is checked, not what passed: a failed check throws before the number exists anyway.
• docs/src/api/** regenerated with make docs-api; the wide diff is the catch-up of version strings and satellite references from the already-committed docs/.api-workspace/composer.lock move, plus the real verifyAll() docblock change.
• Adapter PRs (understudy-phpunit counting max(1, n), understudy-testo metric +n) follow once this merges; the adapter contract suites in this repo's CI run against core HEAD either way.

[coderabbitai]

Important

• 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 2f473cc3-01ec-40d0-a692-1c8163e92610

---

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

---

_{Comment @coderabbitai help to get the list of available commands.}