Ktoml Versions Save

Important

• Updated Kotlin to version 1.9.22 in https://github.com/akuleshov7/ktoml/pull/250

• A bunch of bug fixes, infra and logging enhancements.

• Enhanced Map decoding: Now, you can decode key-value pairs and tables to Map without prior knowledge of their names.

@Serializable
data class MyClass(
    val a: Map<String, Map<String, String>>
)

[a]
    [a.innerTable]
        d = 5
    [a.otherInnerTable]
        d = "String"

• Introduced encoding for value classes by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/238:

@Serializable
@JvmInline
value class Test(val myTest: Info)

• Added support for empty inline tables by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/240:

ACTIVITY_COMPOSE = {}

Enhancements

• Levenshtein distance calculation for the enhancement of the 'invalid enum' error by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/232
• Add trimming of the closing quote delimiter of multiline string by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/223
• Unify array of tables and primitive table by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/215
• Initial Support for Simple Map decoding with unnamed toml keys by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/246
• Support for nested and inlined maps (inside other maps) by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/252
• Postrelease: updating readme and deprecating legacy methods by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/222

Bugfixes

• Fixes #226 TomlTable.write() throws NoSuchElementException by @thomasgalvin in https://github.com/akuleshov7/ktoml/pull/227

Infra

• Infra and build updates by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/228
• Set distribution to zulu for all setup-java by @nulls in https://github.com/akuleshov7/ktoml/pull/241
• Update all github actions (major) by @renovate in https://github.com/akuleshov7/ktoml/pull/203
• Update actions/checkout action to v4.1.0 by @renovate in https://github.com/akuleshov7/ktoml/pull/242
• Diktat 2.0 support by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/251

New Contributors

• @thomasgalvin made their first contribution in https://github.com/akuleshov7/ktoml/pull/227

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.5.0...v0.5.1

Breaking changes

• In this release, we have made some changes to the library's API and removed old deprecated methods;
• For instance, we removed methods that used the deprecated TomlConfig and left only those that use TomlInputConfig or TomlOutputConfig;
• Additionally, we have started to stream data during decoding and parsing, which should improve performance;
• However, this may affect the way you use some ktoml methods.

Changes that deserve your attention

• A significant change for streaming data and a new module, ktoml-source, for custom data sources (via okio Source) by @bishiboosh in https://github.com/akuleshov7/ktoml/pull/117;
• We have finally added support for multiline strings, including both literal and basic strings and multiline arrays, by @BOOMeranGG and @NightEule5 (https://github.com/akuleshov7/ktoml/pull/184, https://github.com/akuleshov7/ktoml/pull/183);
• Support for Kotlin 1.8.21, Kotlinx.serialization 1.5.0, and Gradle 8;
• Backward compatibility support for Java 8 by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/202;

:heavy_exclamation_mark: Now toml-file is only one of the example for reading the data from source. For your particular case you can implement your own source provider based on okio.Source. For this purpose we have prepared toml-source module and implemented an example with java streams for JVM target.

// add com.akuleshov7:ktoml-source to your project
import com.akuleshov7.ktoml.source

val resultFromString = TomlFileReader.decodeFromSource<MyClass>(serializer(), /* your source */)
val resultFromList = TomlFileReader.partiallyDecodeFromSource<MyClass>(serializer(),  /* your source */, /* table name */)

What else is new

• We have added iosSimulatorArm64 target by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/186;
• Regexes have been replaced with functions to enhance performance and prevent input-related issues by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/19;
• Extra information has been added to errors and exceptions by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/212;

Infrastructure changes

• Test to check regression #189 by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/192
• Configure Renovate by @renovate in https://github.com/akuleshov7/ktoml/pull/194
• Customizations for the renovate bot by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/199
• Adding an action-script for an automated update of yarn.lock by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/206
• Update dependency gradle to v8.1.1 by @renovate in https://github.com/akuleshov7/ktoml/pull/211
• Adding a test to validate line numbers and fix for multiline strings by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/217

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.4.1...v0.5.0

What's Changed

• Lower JVM target to 1.8 by @saschpe in https://github.com/akuleshov7/ktoml/pull/182

New Contributors

• @saschpe made their first contribution in https://github.com/akuleshov7/ktoml/pull/182

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.4.0...v0.4.1

Functional changes

• Support for multi-line arrays by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/166
• Support for trailing comma in array by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/169
• Support of a new Char type in a Kotlin manner (as an extension to TOML) by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/176
• Support LocalTime by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/170
• Removing a Double restriction: float support by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/175
• Limitation for Long type finally removed: support for integer types by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/171
• Migration to a new 1.8 Kotlin by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/178

Fixes

• Support for "inf" and "nan" values by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/180
• Fix Double encoding on JS by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/158
• Support for special symbols with Char type by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/179
• Fix bug with inline comment by @BOOMeranGG in https://github.com/akuleshov7/ktoml/pull/168

Internals

• Add README encoding examples by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/159
• Classes that inherit sealed class should not be in a one file anymore by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/162
• Separate parsing from writing in node constructors by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/165
• Quick POC at non-Long numerics (encoding and decoding) by @aSemy in https://github.com/akuleshov7/ktoml/pull/164

New Contributors

• @BOOMeranGG made their first contribution in https://github.com/akuleshov7/ktoml/pull/168
• @aSemy made their first contribution in https://github.com/akuleshov7/ktoml/pull/164

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.3.0...v0.4.0

Awesome release with serialization, finally! 🤞 ❤️ Ktoml now supports it!

What's Changed

• Implement encoding by @NightEule5 in https://github.com/akuleshov7/ktoml/pull/153
• Adding test for required fields by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/152
• Upgraded version of kotlin and serialization by @nulls in https://github.com/akuleshov7/ktoml/pull/154

New Contributors

• @nulls made their first contribution in https://github.com/akuleshov7/ktoml/pull/154

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.2.13...v0.3.0

Minor release to add new targets and support new Kotlin version

What's Changed

• Added Ios and M1 targets by @Wavesonics in https://github.com/akuleshov7/ktoml/pull/148
• Updated Kotlin version to 1.7 by @akuleshov7 in https://github.com/akuleshov7/ktoml/pull/150

New Contributors

• @Wavesonics

Full Changelog: https://github.com/akuleshov7/ktoml/compare/v0.2.12...v0.2.13

Technical release with refactoring, new fundamental logic and library migrations

Main functional features

• Add date-time handling
• Support unicode symbols in strings
• Supporting the decoding of value (inline) classes
• Partial support for custom serializers
• Handle commas in string for arrays.

Main technical features

• Kotlin updated to 1.6.21
• New configuration mechanism introduced instead of TomlConfig (it's now deprecated)
• New fundamentals for serialization logic were added. Encoding will be introduced in future releases

@bishiboosh @akuleshov7 @NightEule5 thank you for this outstanding contribution!

Urgent hotfix release

• https://github.com/akuleshov7/ktoml/issues/112
• https://github.com/akuleshov7/ktoml/issues/103

Thanks to the @JakeWharton for the reported issue

What's done:

• Huge refactoring and base mechanisms for the serialization; d9537792f5d125c4f520b99fe302906d76320a07 cc6e05a5af8c93443a962e84807205b3204db9fd
• BREAKING: Renaming and deprecating several class, mostly focused on exceptions; cc6e05a5af8c93443a962e84807205b3204db9fd
• Adding the support for empty TOML; 2295a7499642e4a3231f01fc85b3e591102493ef
• Creating the parser and the support in AST for ArrayOfTables; 0bf142f0a09e86ae20df597e9a86cdb4ab269c91 a76f5e8878d66e179e34a52f24de42e41c765744
• Support for inline tables with several limitations (excluding nested inlining). 0ef414b3c7044a62452e8c97beee9e1c92508153
• Minor fixes and updates;

Contributors to this release: @NightEule5 @Peanuuutz @vitusortner @akuleshov7

What's done:

• Hotfixes for automated release process