Skip to content

Document the shared Hyperclient lifecycle on master - #18

Merged
dblock merged 1 commit into
masterfrom
docs/shared-hyperclient-demo
Oct 27, 2026
Merged

dblock merged 1 commit into
masterfrom
docs/shared-hyperclient-demo

Conversation

@dblock

@dblock dblock commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Correct the main-first scope of #15: introduce the supported Hyperclient scenario on the default master branch first, then carry it consistently to both ORM branches.

Document one executable IRB sequence that creates a spline, updates it through its HAL self link, lists a freshly expanded paginated collection, and deletes only the created spline. Self links avoid assuming UUID, string-ID, or integer-ID formats. Keep Hyperclient’s default HAL encoding instead of replacing its middleware.

Explain the supported ActiveModel semantics explicitly: writes are nonpersistent, collection results are generated samples, and deleting the created resource does not remove generated samples. Add focused request coverage for the lifecycle and fresh collection expansion, using the same HAL encoding as the default HTTP client.

Follow-up branch-targeted PRs will port this exact code with only persistence-specific notes and assertions. No API implementation, dependencies, or CI changes.

AI-authored on behalf of @dblock.

Consistent branch ports

Review/merge this master-first baseline before its persistence-specific ports: #20 targets with-mongoid and #19 targets with-activerecord. All three READMEs contain byte-for-byte identical executable Ruby; only model-specific prose and persistence assertions differ.

The full five-combination matrix and lint passed on a8956ea: Tests, Rubocop.

Start the supported create/update/list/delete scenario on the default ActiveModel example, using HAL self links rather than branch-specific IDs. Exercise default HAL encoding, fresh collection expansion, and nonpersistent model semantics before porting the same scenario to the database branches.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dblock
dblock merged commit 49bc0c1 into master Oct 27, 2026
7 checks passed
@dblock
dblock deleted the docs/shared-hyperclient-demo branch October 27, 2026 17:36
dblock added a commit that referenced this pull request Oct 27, 2026
Carry the master-first scenario from PR #18 unchanged, adapting only persistence notes and assertions. Use default HAL encoding, update/delete through returned self links, and expand fresh paginated collections. Preserve the existing multiple-record MongoDB coverage.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dblock added a commit that referenced this pull request Oct 27, 2026
Carry the master-first scenario from PR #18 unchanged, adapting only persistence notes and assertions. Use default HAL encoding, update/delete through returned self links, and expand fresh paginated collections with PostgreSQL persistence checks.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant