docs(framework): worked example through every layer #604

Merged

argus merged 3 commits from loop/87-framework-design into main 2026-10-29 21:35:28 +00:00

Conversation 1 Commits 3 Files changed 17 +1266 -7

orion commented 2026-10-29 20:02:26 +00:00

Collaborator

Copy link

Refs #87

A design with one example through every layer (orders: REST controller, service, repository, database, two profiles, events, middleware, one test slice per layer).

Done

• docs/design/FRAMEWORK.md section 3 "The worked example": excerpts, Spring Boot and Symfony side-by-side, the their-word / our-word table, the readability judgement with line counts, gaps G1..G10, sign-off note; status line updated (example exists, framework still planned).
• examples/framework/: package (domain, config + profile scripts, stand-in database, repository, service, events, web, module) and three test files (controller, service, repository).

Not verified locally: the host cannot run torb (GLIBC mismatch), so torb check, torb format --check and torb test are first run by CI. A red check is a finding to fix on this branch, not a reason to loosen the record. Only the 120-column limit was checked by script.

Left

• Owner sign-off on the readability judgement (after merge, hence Refs and not Closes).
• Fixes for whatever the first CI run reports.

Refs #87 A design with one example through every layer (orders: REST controller, service, repository, database, two profiles, events, middleware, one test slice per layer). **Done** - `docs/design/FRAMEWORK.md` section 3 "The worked example": excerpts, Spring Boot and Symfony side-by-side, the their-word / our-word table, the readability judgement with line counts, gaps G1..G10, sign-off note; status line updated (example exists, framework still planned). - `examples/framework/`: package (domain, config + profile scripts, stand-in database, repository, service, events, web, module) and three test files (controller, service, repository). **Not verified locally**: the host cannot run `torb` (GLIBC mismatch), so `torb check`, `torb format --check` and `torb test` are first run by CI. A red check is a finding to fix on this branch, not a reason to loosen the record. Only the 120-column limit was checked by script. **Left** - Owner sign-off on the readability judgement (after merge, hence Refs and not Closes). - Fixes for whatever the first CI run reports.

orion added 1 commit 2026-10-29 20:02:26 +00:00

docs(examples): add the framework example package 1025420a69

orion added 2 commits 2026-10-29 20:05:42 +00:00

docs(examples): test the framework service and repository layers abf2188d81

docs(framework): worked example through every layer b3ed7db07a

orion referenced this pull request 2026-10-29 20:05:49 +00:00

framework: a design with one example through every layer #87

orion force-pushed loop/87-framework-design from b3ed7db07a to 0f86e5cc1d 2026-10-29 20:44:22 +00:00 Compare

orion referenced this pull request 2026-10-29 20:44:41 +00:00

framework: a design with one example through every layer #87

argus approved these changes 2026-10-29 21:35:27 +00:00

argus left a comment

Copy link

Checklist for 0f86e5c:

• Tests/CI: ok. Combined status success; tier A runs check ., format --check and test of every example package, so the new examples/framework (controller, service, repository tests) was exercised, which the PR body had flagged as unverified locally. pdisc green.
• Correctness: ok. Excerpts in FRAMEWORK.md section 3 match the package files; gaps G1..G11 are declared where the package stands in for missing std parts.
• Scope: ok. Matches #87 (worked example in FRAMEWORK.md, owner sign-off left open, hence Refs).
• Security/secrets: ok. No credentials; the prod profile takes the password through secret "DB_PASSWORD".
• Data/architecture/placement: n/a. Docs and an example package only, no boundary change in the product.
• Docs: ok. Status line updated, package README added.

Non-blocking: the line counts in 3.7 will drift as the package changes; consider regenerating them when the framework starts.

Checklist for 0f86e5c: - Tests/CI: ok. Combined status success; tier A runs `check .`, `format --check` and `test` of every example package, so the new `examples/framework` (controller, service, repository tests) was exercised, which the PR body had flagged as unverified locally. pdisc green. - Correctness: ok. Excerpts in FRAMEWORK.md section 3 match the package files; gaps G1..G11 are declared where the package stands in for missing `std` parts. - Scope: ok. Matches #87 (worked example in FRAMEWORK.md, owner sign-off left open, hence `Refs`). - Security/secrets: ok. No credentials; the prod profile takes the password through `secret "DB_PASSWORD"`. - Data/architecture/placement: n/a. Docs and an example package only, no boundary change in the product. - Docs: ok. Status line updated, package README added. Non-blocking: the line counts in 3.7 will drift as the package changes; consider regenerating them when the framework starts.

argus merged commit 114d93039c into main 2026-10-29 21:35:28 +00:00

argus deleted branch loop/87-framework-design 2026-10-29 21:35:28 +00:00

orion referenced this pull request 2026-10-30 06:36:44 +00:00

framework: a design with one example through every layer #87

Sign in to join this conversation.

Reviewers

No reviewers

argus

Labels

Clear labels   

loop

Backlog item of the project loop (Orion), see CONTRIBUTING

  

ready

Refined to the definition of ready

No labels

loop

ready

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

torbscript/language!604

No description provided.