Merge pull request #191 from ProjectMapK/develop

For release 2.16.0-beta8

Author: k163377

.github/workflows/release.yaml

@@ -0,0 +1,16 @@
+on:
+  workflow_dispatch:
+jobs:
+  gitPrRelease:
+    name: git-pr-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+      - name: git-pr-release
+        uses: bakunyo/git-pr-release-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GIT_PR_RELEASE_BRANCH_STAGING: ${{ github.ref_name }}
+          GIT_PR_RELEASE_BRANCH_PRODUCTION: main

.github/workflows/test-main.yml

@@ -35,17 +35,17 @@ jobs:
       fail-fast: false
       matrix:
         # LTS versions, latest version (if exists)
-        java-version: [ '8', '11', '17', '20' ]
+        java-version: [ '8', '11', '17', '21' ]
         # Minimum version, latest release version, latest pre-release version (if exists)
         kotlin:
           - name: '1.8.22'
             version: '1.8.22'
             k2: false
-          - name: '1.9.20'
-            version: '1.9.20'
+          - name: '1.9.21'
+            version: '1.9.21'
             k2: false
-          - name: '1.9.20 K2'
-            version: '1.9.20'
+          - name: '1.9.21 K2'
+            version: '1.9.21'
             k2: true
           - name: '2.0.0-Beta1'
             version: '2.0.0-Beta1'

.idea/kotlinc.xml

@@ -41,12 +41,13 @@ Details are summarized in [KogeraSpecificImplementations](./docs/KogeraSpecificI
 ## About compatibility checks
 Compatibility checks for `Java` and `Kotlin` are done by `CI` grid tests.
 
-The `Java` test covers all currently supported LTS versions and the latest versions.  
-Currently 8,11,17 and 20 are covered.
+The `Java` test covers all currently supported LTS versions and the latest versions.
 
 `Kotlin` is tested with the latest patch version and the latest `Beta` or `RC` version within each minor version after the minimum version.  
 The `Kotlin` version is the lowest version available with the latest `kotlinx-metadata-jvm`.
 
+See [Workflow](./.github/workflows/test-main.yml) for the currently tested versions.
+
 # Installation
 The package is temporarily published in `JitPack`.  
 Please refer to `jitpack.io` for the released version.
@@ -81,12 +82,10 @@ You can check if your project's dependencies include `jackson-module-kotlin` by
 If you find any problems, it would be appreciated if you could share them in an `issue`.
 
 # About the future
-Currently, this project is in `beta`.  
-I intend to develop the following
+I will not be treating this project as "stable".
 
-- Migration to more efficient reflection cache.
-- Resolve as many known bugs related to `value class` as possible.
-- Fixing other bugs.
+This project currently serves as a testing ground for all improvements to `jackson-module-kotlin`.  
+In prototyping, it is important to be willing to make disruptive changes.
 
 # About license
 This project is based on `jackson-module-kotlin`, so the license follows `jackson-module-kotlin`.  

.idea/misc.xml

@@ -1,40 +1,44 @@
 plugins {
     `maven-publish` // for JitPack
 
-    val kotlinVersion: String = System.getenv("KOTLIN_VERSION")?.takeIf { it.isNotEmpty() } ?: "1.8.22"
+    val kotlinVersion: String = System.getenv("KOTLIN_VERSION")?.takeIf { it.isNotEmpty() }
+        ?: libs.versions.kotlin.get()
+
     kotlin("jvm") version kotlinVersion
 
     java
-    id("org.jmailen.kotlinter") version "3.16.0"
+    alias(libs.plugins.kotlinter)
 }
 
 // Since group cannot be obtained by generateKogeraVersion, it is defined as a constant.
 val groupStr = "io.github.projectmapk"
-val jacksonVersion = "2.16.0"
+val jacksonVersion = libs.versions.jackson.get()
 val generatedSrcPath = "${layout.buildDirectory.get()}/generated/kotlin"
 
 group = groupStr
-version = "${jacksonVersion}-beta7"
+version = "${jacksonVersion}-beta8"
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    implementation(kotlin("stdlib"))
-    implementation("org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.7.0")
+    val kotlinVersion: String = System.getenv("KOTLIN_VERSION")?.takeIf { it.isNotEmpty() }
+        ?: libs.versions.kotlin.get()
+    implementation("${libs.kotlin.stdlib.get()}:${kotlinVersion}")
+    implementation(libs.kotlinx.metadata.jvm)
 
-    api("com.fasterxml.jackson.core:jackson-databind:${jacksonVersion}")
-    api("com.fasterxml.jackson.core:jackson-annotations:${jacksonVersion}")
+    api(libs.jackson.databind)
+    api(libs.jackson.annotations)
 
     // test libs
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.1")
-    testImplementation("org.junit.jupiter:junit-jupiter-params:5.10.1")
-    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
-    testImplementation("io.mockk:mockk:1.13.7")
+    testImplementation(libs.junit.api)
+    testImplementation(libs.junit.params)
+    testRuntimeOnly(libs.junit.engine)
+    testImplementation(libs.mockk)
 
-    testImplementation("com.fasterxml.jackson.dataformat:jackson-dataformat-xml")
-    testImplementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
+    testImplementation(libs.jackson.xml)
+    testImplementation(libs.jackson.jsr310)
 }
 
 kotlin {

README.md

@@ -1,25 +1,15 @@
 A list of issues that have not been resolved in `jackson-module-kotlin`, but have been or will be resolved in `kogera`.
 
 ## Fixed
-- [Update `KotlinModule` to override `AnnotationIntrospector.findCreatorAnnotation()` instead of `hasCreatorAnnotation()` · Issue \#200](https://github.com/FasterXML/jackson-module-kotlin/issues/200)
+- [Support for inline classes · Issue \#199](https://github.com/FasterXML/jackson-module-kotlin/issues/199)
 - [Getting MismatchedInputException instead of MissingKotlinParameterException · Issue \#234](https://github.com/FasterXML/jackson-module-kotlin/issues/234)
 - [Private getter with different return type hides property · Issue \#341](https://github.com/FasterXML/jackson-module-kotlin/issues/341)
 - [Remove \`kotlin\-reflect\` and replace it with \`kotlinx\-metadata\-jvm\` · Issue \#450](https://github.com/FasterXML/jackson-module-kotlin/issues/450)
-- [Remove deprecated method in KNAI · Issue \#508](https://github.com/FasterXML/jackson-module-kotlin/issues/508)
-- [Support JsonKey in value class · Issue \#536](https://github.com/FasterXML/jackson-module-kotlin/issues/536)
-- [Type Introspection: non\-nullable field with default is reported as required · Issue \#609](https://github.com/FasterXML/jackson-module-kotlin/issues/609)
-- [`JsonSerializer` is enabled when the value is an Object type with non\-null value and the property definition is nullable. · Issue \#618](https://github.com/FasterXML/jackson-module-kotlin/issues/618)
-- [About the problem that property names in \`Jackson\` and definitions in \`Kotlin\` are sometimes different\. · Issue \#630](https://github.com/FasterXML/jackson-module-kotlin/issues/630)
+- [Supports deserialization of \`value class\` \(\`inline class\`\)\. · Issue \#650](https://github.com/FasterXML/jackson-module-kotlin/issues/650)
 - [Annotation given to constructor parameters containing \`value class\` as argument does not work · Issue \#651](https://github.com/FasterXML/jackson-module-kotlin/issues/651)
 - [How to deserialize a kotlin\.ranges\.ClosedRange<T> with Jackson · Issue \#663](https://github.com/FasterXML/jackson-module-kotlin/issues/663)
 - [There are cases where \`isRequired\` specifications are not properly merged\. · Issue \#668](https://github.com/FasterXML/jackson-module-kotlin/issues/668)
 
-## Maybe fixed(verification required)
-- [@JsonProperty is ignored on data class properties with names starting with "is" · Issue \#237](https://github.com/FasterXML/jackson-module-kotlin/issues/237)
-
 ## Want to fix
-- [Support for inline classes · Issue \#199](https://github.com/FasterXML/jackson-module-kotlin/issues/199)
 - [There are some problems with KNAI\.hasCreatorAnnotation · Issue \#547](https://github.com/FasterXML/jackson-module-kotlin/issues/547)
 - [This module shouldn't bring kotlin\-reflect 1\.5 as a transitive dependency · Issue \#566](https://github.com/FasterXML/jackson-module-kotlin/issues/566)
-- [ReflectionCache takes a lot of memory · Issue \#584](https://github.com/FasterXML/jackson-module-kotlin/issues/584)
-- [Supports deserialization of \`value class\` \(\`inline class\`\)\. · Issue \#650](https://github.com/FasterXML/jackson-module-kotlin/issues/650)

build.gradle.kts

@@ -0,0 +1,23 @@
+[versions]
+kotlin = "1.8.22" # Mainly for CI, it can be rewritten by environment variable.
+jackson = "2.16.0"
+
+# test libs
+junit = "5.10.1"
+
+[libraries]
+kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib" }
+kotlinx-metadata-jvm = "org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.7.0"
+jackson-databind = { module = "com.fasterxml.jackson.core:jackson-databind", version.ref = "jackson" }
+jackson-annotations = { module = "com.fasterxml.jackson.core:jackson-annotations", version.ref = "jackson" }
+
+# test libs
+junit-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
+junit-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
+junit-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" }
+mockk = "io.mockk:mockk:1.13.7"
+jackson-xml = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-xml", version.ref = "jackson" }
+jackson-jsr310 = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "jackson" }
+
+[plugins]
+kotlinter = { id = "org.jmailen.kotlinter", version = "3.16.0" }

docs/FixedIssues.md

@@ -1,7 +1,6 @@
 package io.github.projectmapk.jackson.module.kogera
 
 import com.fasterxml.jackson.annotation.JsonCreator
-import kotlinx.metadata.Flag
 import kotlinx.metadata.KmClassifier
 import kotlinx.metadata.KmType
 import kotlinx.metadata.KmValueParameter
@@ -83,8 +82,6 @@ internal fun String.reconstructClass(): Class<*> {
 internal fun KmType.reconstructClassOrNull(): Class<*>? = (classifier as? KmClassifier.Class)
     ?.let { kotlin.runCatching { it.name.reconstructClass() }.getOrNull() }
 
-internal fun KmType.isNullable(): Boolean = Flag.Type.IS_NULLABLE(this.flags)
-
 internal fun AnnotatedElement.hasCreatorAnnotation(): Boolean = getAnnotation(JsonCreator::class.java)
     ?.let { it.mode != JsonCreator.Mode.DISABLED }
     ?: false

gradle/libs.versions.toml

@@ -75,7 +75,7 @@ internal sealed interface JmClass {
                 companionClass.getAnnotation(Metadata::class.java)!!.accept(this)
             }
 
-            override fun visitFunction(flags: Flags, name: String): KmFunctionVisitor? = KmFunction(flags, name)
+            override fun visitFunction(flags: Flags, name: String): KmFunctionVisitor = KmFunction(flags, name)
                 .apply { functions.add(this) }
         }
 
@@ -117,7 +117,7 @@ private class JmClassImpl(
     private val allPropsMap: MutableMap<String, KmProperty> = mutableMapOf()
 
     // Defined as non-lazy because it is always read in both serialization and deserialization
-    final override val properties: List<KmProperty>
+    override val properties: List<KmProperty>
 
     private var companionPropName: String? = null
     override var flags: Flags = flagsOf()
@@ -166,7 +166,7 @@ private class JmClassImpl(
 
         // Constructors always have the same name, so only desc is compared
         return constructors.find {
-            val targetDesc = it.signature?.desc
+            val targetDesc = it.signature?.descriptor
             targetDesc == desc || targetDesc == valueDesc
         }
     }