Update to recent Kotlin naming conventions #90
Merged
Conversation
This file contains 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
- Rename "marshal"/"unmarshal" to "encode"/"decode" in all methods and classes - Standardize encoding/decoding methods to be named `encodeTo*` and `decodeFrom*`, similar to naming used in the standard libraries - Rename the low-level `marshal(MessageMarshaller)` and `unmarshal(MessageUnmarshaller)` methods to `encodeWith(MessageEncoder)` and `decodeWith(MessageDecoder)` Fixes #89
garyp
force-pushed
the
kotlin-naming-conventions
branch
from
6e4c0e7 to
962ce2b
Compare
Mehequanna
approved these changes
Sep 15, 2020
There was a problem hiding this comment.
Looks great. I'm happy to see the marshal and unmarshal language get updated. Thanks for doing this!
I saw a bunch of files needing a new line. I added comments on them, but maybe it should just be a TODO for us to run Kotlin lint on the codebase in the future? Feel free to take or leave the comments.
| companion object { | ||
| fun allocate(size: Int) = KotlinBinaryMessageEncoder(ByteArrayWireWriter.allocate(size)) | ||
| } | ||
| } |
There was a problem hiding this comment.
🔧 Need a new line after }
| data: String, | ||
| jsonConfig: JsonConfig = JsonConfig.DEFAULT | ||
| ): T = decodeWith(JsonMessageDecoder.fromString(data, jsonConfig)) |
There was a problem hiding this comment.
🔧 Needs new line at the end
| assertEquals((byteArrayOf(10, 12) + "Hello world!".map { it.toByte() }.toByteArray()).asList(), bytes.asList()) | ||
| assertEquals(foo, Foo.protoUnmarshal(bytes)) | ||
| assertEquals(foo, Foo.decodeFromByteArray(bytes)) | ||
| } | ||
| } |
|
|
||
| internal actual fun BinaryMessageEncoder.Companion.allocate(size: Int): ByteArrayMessageEncoder { | ||
| return ProtobufjsBinaryMessageEncoder.allocate(size) | ||
| } |
| companion object { | ||
| fun allocate(size: Int) = ProtobufjsBinaryMessageEncoder(Writer.create(), size) | ||
| } | ||
| } |
|
|
||
| internal fun BinaryMessageDecoder.Companion.fromByteBuffer(buffer: ByteBuffer): MessageDecoder { | ||
| return BinaryMessageDecoder(CodedStreamBinaryWireDecoder(CodedInputStream.newInstance(buffer))) | ||
| } |
|
|
||
| internal actual fun BinaryMessageEncoder.Companion.allocate(size: Int): ByteArrayMessageEncoder { | ||
| return ByteArrayCodedStreamBinaryMessageEncoder.allocate(size) | ||
| } |
|
|
||
| override fun toByteArray() = backingBytes | ||
|
|
||
| companion object { | ||
| fun allocate(size: Int) = ByteArrayCodedStreamBinaryMessageMarshaller(ByteArray(size)) | ||
| fun allocate(size: Int) = ByteArrayCodedStreamBinaryMessageEncoder(ByteArray(size)) | ||
| } | ||
| } |
| assertEquals(builtJavaObj, gendJavaObj) | ||
| assertEquals(builtKotlinObj, gendKotlinObj) | ||
|
|
||
| // Check that map-with-size | ||
| assertTrue(gendKotlinObj.map is MessageMap) | ||
| assertEquals(builtKotlinObj.protoSize, gendKotlinObj.protoSize) | ||
| assertEquals(builtKotlinBytes.toList(), gendKotlinObj.protoMarshal().toList()) | ||
| assertEquals(builtKotlinBytes.toList(), gendKotlinObj.encodeToByteArray().toList()) | ||
| } | ||
| } |
|
|
||
| internal actual fun BinaryMessageEncoder.Companion.allocate(size: Int): ByteArrayMessageEncoder { | ||
| return KotlinBinaryMessageEncoder.allocate(size) | ||
| } |
|
Hmm, yeah. We should probably add the |
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.
Kotlin is starting to standardize on some naming patterns in its standard library and related libraries (like kotlinx-serialization and kotlinx-coroutines). This change implements similar naming conventions so that pbandk's API feels more idiomatic and familiar to Kotlin developers.
Replace "marshal"/"unmarshal" terminology with "encode"/"decode" in all methods and classes
Standardize encoding/decoding methods to be named
encodeTo*anddecodeFrom*, similar to naming used in the standard librariesRename the low-level
marshal(MessageMarshaller)andunmarshal(MessageUnmarshaller)methods toencodeWith(MessageEncoder)anddecodeWith(MessageDecoder)Fixes #89