fix: correct kuri-bind KDoc/test/message accuracy gaps#136
Open
OmarAlJarrah wants to merge 1 commit into
Open
Conversation
Fixes four small documentation and test accuracy issues found while reading through kuri-bind: - BuilderSink's interface KDoc and a BuilderSinkTest section header both described a "verbatim-join userinfo" path in UriBuilderSink that was never implemented; both sinks split-encode-then-join userinfo identically, and fragment encoding is a single shared interface default rather than a per-profile override. - KuriBind's "root not annotated" error message built the annotation name via profile.name.lowercase(), producing "@url"/"@uri" instead of the real PascalCase "@url"/"@uri" markers, which would send anyone debugging the message toward a symbol that doesn't exist. Two existing tests (KuriBindTest, IntegrationTest) asserted on the old lowercase text and are updated to match the corrected message. - JavaBean.java's fixture doc claimed it covers types kotlin-reflect exposes no memberProperties for; it actually exercises the opposite case (MemberScanner's getter-to-property annotation-merge branch), since kotlin-reflect does return a property for this bean, just with no annotations of its own. - BindOptionsTest's maxDepth range test asserted both rejection boundaries (0, 513) but never confirmed the accepted upper bound (512) actually constructs, leaving a narrowing off-by-one regression undetected. Closes #118, #119, #125, #126
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
BuilderSink's interface KDoc and aBuilderSinkTestsection header both described a "verbatim-join userinfo" path inUriBuilderSinkthat was never implemented; both sinks actually split-encode-then-join userinfo identically, and fragment encoding is a single shared interface default rather than a per-profile override.KuriBind's "root not annotated" error message built the annotation name viaprofile.name.lowercase(), producing@url/@uriinstead of the real PascalCase@Url/@Urimarkers — anyone debugging the message would be pointed at a symbol that doesn't exist. Two existing tests asserted on the old lowercase text and are updated to match the corrected message.JavaBean.java's fixture doc claimed it covers types kotlin-reflect exposes nomemberPropertiesfor; it actually exercises the opposite case —MemberScanner's getter-to-property annotation-merge branch — since kotlin-reflect does return a property for this bean, just with no annotations of its own.BindOptionsTest's maxDepth range test asserted both rejection boundaries (0, 513) but never confirmed the accepted upper bound (512) actually constructs, leaving a narrowing off-by-one regression undetected.Test plan
./gradlew :kuri-bind:jvmTest :kuri-bind:ktlintCheck :kuri-bind:detekt :kuri-bind:apiCheck— all greenjsNodeTest/wasmJsNodeTestdo not applyapiDumpwas not neededCloses #118
Closes #119
Closes #125
Closes #126