Introduce new StringProperties object that can encode and decode properties from a string #2303
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
hfhbd
reviewed
Jan 20, 2024
| @ExperimentalSerializationApi | ||
| public override fun <T> encodeToString(serializer: SerializationStrategy<T>, value: T): String { | ||
| val map = properties.encodeToMap(serializer, value) | ||
| val builder = StringBuilder() |
There was a problem hiding this comment.
I would extract the actual output renderer into another function taking a map overload to encode a giving String map to a Properties file
@ExperimentalSerializationApi
public fun encodeToString(map: Map<String, String>): String {
hfhbd
reviewed
Jan 20, 2024
|
|
||
| result[parsedLine.substring(0, keyEnd)] = parsedLine.substring(valueBegin) | ||
| } | ||
| return properties.decodeFromStringMap(deserializer, result) |
There was a problem hiding this comment.
Same here, I would add an overload to get the input string as Map<String, String too.
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.
Introduce a new StringProperties object that can encode and decode properties from a string format. This new object is heavily based on the existing kotlinx.serialization
Propertiesobject.Propertiesand them formats that string map to a properties file. Some parameters can be passed to customise the encoding format, such as key/value separator, number of spaces before and after the key/value separator, and line separator.Properties. The parsers handles comments, whitespaces, escapes, natural lines vs logical lines. The intent is to support the same format as the Java Properties API (doc). For now, unicode characters are not implemented.The implementation has been inspired a lot from the gist made by https://github.com/RaphaelTarita linked in this issue. I have added many unit tests that show how it is used and how it behaves.
This PR should fix #1152 and KT-42716.