Skip to content

Provide the record runtime through RustQ modules; release 0.5.1 - #5

Merged
dannote merged 4 commits into
masterfrom
provides
Oct 25, 2026
Merged

dannote merged 4 commits into
masterfrom
provides

Conversation

@dannote

@dannote dannote commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

RustQ code that works with records names KiwiCodec.RustlerGenerator.Records through alias (RustQ 1.0.0-rc.16) instead of reading deps/kiwi_codec/.../records_runtime.rs. The record runtime and atom cache are templates/records.rs and templates/atom_cache.rs, which their modules provide; AtomCache's duplicate kiwi_atom declaration is gone. Requires RustQ ~> 1.0.0-rc.16.

Summary by CodeRabbit

  • New Features
    • RustQ code can access the record runtime through KiwiCodec.RustlerGenerator.Records, using an alias and Records.kiwi_record() in specs.
  • Documentation
    • Updated setup guidance and examples for the record runtime and atom cache.
    • RustQ usage now requires version 1.0.0-rc.16 or later within the documented compatibility range.
  • Release
    • Updated KiwiCodec to version 0.5.1.

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e7ac4549-5652-4454-9724-282a8d414874
Commits

Reviewing files that changed from the base of the PR and between 1b69118 and 0de1253.

Files ignored due to path filters: 1
  • mix.lock is excluded by !**/*.lock
Files selected for processing: 9
  • CHANGELOG.md
  • README.md
  • codegen/kiwi_codec/rustler_generator/atom_cache.ex
  • codegen/kiwi_codec/rustler_generator/records.ex
  • codegen/kiwi_codec/rustler_generator/templates/records.rs
  • guides/internals.md
  • guides/native-decoders.md
  • integration/generator_consumer/mix.exs
  • mix.exs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The generator now obtains record and atom-cache runtime items through RustQ. The project and integration dependency constraints move to RustQ 1.0.0-rc.16, and the project version moves to 0.5.1.

Changes: RustQ Runtime Integration and Release

Layer / File(s) Summary
RustQ runtime generation
mix.exs, integration/generator_consumer/mix.exs, README.md, guides/native-decoders.md, codegen/kiwi_codec/rustler_generator/*, guides/internals.md
The RustQ constraints change to ~> 1.0.0-rc.16. Records and AtomCache now return RustQ-provided items instead of constructing runtime fragments from template files. The documentation describes module-based runtime references.
0.5.1 release metadata
mix.exs, README.md, CHANGELOG.md
The project version and documented KiwiCodec constraint change to 0.5.1. The changelog records the runtime usage and RustQ requirement.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Refactor

Possibly related PRs

Merge Risk: Minimal · up to 0de12

No actionable regression was established in the runtime integration or release metadata; the change is mergeable with normal validation.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 4 files. (4 skipped: 4… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the two main changes: the record runtime is now provided through RustQ modules, and the release is 0.5.1. The changeset supports both. The records module now uses RustQ.Meta and combin…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the two main changes: the record runtime is now provided through RustQ modules, and the release is 0.5.1. The changeset supports both. The records module now uses RustQ.Meta and combines rustq_items() for its fragments, the atom cache follows the same pattern, and the mix.exs, CHANGELOG.md, and README.md changes set version 0.5.1. The title is short, specific, and matches the PR objectives. It does not mention the removed kiwi_atom declaration, but it does not need to cover every detail.

Full details: Docstring Coverage

Explanation

Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 4 files. (4 skipped: 4 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • 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

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

@dannote
dannote merged commit 2d15d81 into master Oct 25, 2026
5 checks passed
@dannote
dannote deleted the provides branch October 25, 2026 10:36
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