Merge remote-tracking branch 'FasterXML/2.19'

README.md

@@ -10,9 +10,10 @@ and those with secondary constructors or static factories are also supported.
 
 # Status
 
-* release `2.17.0` (for Jackson `2.17.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.16)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.17)
+* release `2.18.0` (for Jackson `2.18.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.18)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.18)
+* release `2.17.2` (for Jackson `2.17.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.17)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.17)
 * release `2.16.2` (for Jackson `2.16.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.16)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.16)
-* release `2.15.3` (for Jackson `2.15.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.15)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.15)
+* release `2.15.4` (for Jackson `2.15.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.15)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.15)
 * release `2.14.3` (for Jackson `2.14.x`) [![GitHub Actions build](https://github.com/FasterXML/jackson-module-kotlin/actions/workflows/main.yml/badge.svg?branch=2.14)](https://github.com/FasterXML/jackson-module-kotlin/actions?query=branch%3A2.14)
 
 Releases require that you have included Kotlin stdlib and reflect libraries already.

release-notes/CREDITS-2.x

@@ -15,7 +15,13 @@ Authors:
 
 Contributors:
 
-# 2.18.0 (not yet released)
+# 2.19.0 (not yet released)
+
+WrongWrong (@k163377)
+* #839: Remove useKotlinPropertyNameForGetter and unify with kotlinPropertyNameAsImplicitName
+* #835: Remove old SingletonSupport class and unified with KotlinFeature.SingletonSupport
+
+# 2.18.0 (26-Sep-2024)
 
 WrongWrong (@k163377)
 * #818: Optimize the search process for creators

release-notes/VERSION-2.x

@@ -18,7 +18,8 @@ Co-maintainers:
 
 2.19.0 (not yet released)
 
-- No changes since 2.18
+#839: Remove useKotlinPropertyNameForGetter and unify with kotlinPropertyNameAsImplicitName.
+#835: Remove old SingletonSupport class and unified with KotlinFeature.SingletonSupport.
 
 2.18.0 (26-Sep-2024)
 

src/main/kotlin/tools/jackson/module/kotlin/KotlinFeature.kt

@@ -30,7 +30,6 @@ enum class KotlinFeature(internal val enabledByDefault: Boolean) {
      * Deserializing a singleton overwrites the value of the single instance.
      *
      * See [jackson-module-kotlin#225]: keep Kotlin singletons as singletons.
-     * @see com.fasterxml.jackson.module.kotlin.SingletonSupport
      */
     SingletonSupport(enabledByDefault = false),
 

src/main/kotlin/tools/jackson/module/kotlin/KotlinModule.kt

@@ -1,6 +1,5 @@
 package tools.jackson.module.kotlin
 
-import kotlin.reflect.KClass
 import tools.jackson.databind.MapperFeature
 import tools.jackson.databind.module.SimpleModule
 import tools.jackson.module.kotlin.KotlinFeature.*
@@ -18,7 +17,10 @@ fun Class<*>.isKotlinClass(): Boolean = this.isAnnotationPresent(Metadata::class
  *  map object.
  * @property nullIsSameAsDefault     Default false.  Whether to treat null values as absent when deserializing, thereby
  *  using the default value provided in Kotlin.
- * @property enabledSingletonSupport        Default: false.  Whether to enable singleton handling.
+ * @property singletonSupport        Default: false.  Mode for singleton handling.
+ *  See [KotlinFeature.SingletonSupport]
+ * @property enabledSingletonSupport Default: false.  A temporary property that is maintained until the return value of `singletonSupport` is changed.
+ *  It will be removed in 2.21.
  * @property strictNullChecks        Default: false.  Whether to check deserialized collections.  With this disabled,
  *  the default, collections which are typed to disallow null members
  *  (e.g. List<String>) may contain null values after deserialization.  Enabling it
@@ -33,15 +35,15 @@ class KotlinModule private constructor(
     val nullToEmptyCollection: Boolean = NullToEmptyCollection.enabledByDefault,
     val nullToEmptyMap: Boolean = NullToEmptyMap.enabledByDefault,
     val nullIsSameAsDefault: Boolean = NullIsSameAsDefault.enabledByDefault,
-    val enabledSingletonSupport: Boolean = SingletonSupport.enabledByDefault,
+    val singletonSupport: Boolean = SingletonSupport.enabledByDefault,
     val strictNullChecks: Boolean = StrictNullChecks.enabledByDefault,
     val kotlinPropertyNameAsImplicitName: Boolean = KotlinPropertyNameAsImplicitName.enabledByDefault,
     val useJavaDurationConversion: Boolean = UseJavaDurationConversion.enabledByDefault,
 ) : SimpleModule(KotlinModule::class.java.name, PackageVersion.VERSION) {
 
     companion object {
         // Increment when option is added
-        private const val serialVersionUID = 2L
+        private const val serialVersionUID = 3L
     }
 
     @Deprecated(
@@ -72,7 +74,7 @@ class KotlinModule private constructor(
 
         context.addValueInstantiators(KotlinInstantiators(cache, nullToEmptyCollection, nullToEmptyMap, nullIsSameAsDefault, strictNullChecks))
 
-        if (enabledSingletonSupport) {
+        if (singletonSupport) {
             // [module-kotlin#225]: keep Kotlin singletons as singletons
             context.addDeserializerModifier(KotlinValueDeserializerModifier)
         }

src/main/kotlin/tools/jackson/module/kotlin/KotlinNamesAnnotationIntrospector.kt

@@ -22,7 +22,7 @@ import kotlin.reflect.jvm.javaType
 
 internal class KotlinNamesAnnotationIntrospector(
     private val cache: ReflectionCache,
-    private val useKotlinPropertyNameForGetter: Boolean
+    private val kotlinPropertyNameAsImplicitName: Boolean
 ) : NopAnnotationIntrospector() {
     private fun getterNameFromJava(member: AnnotatedMethod): String? {
         val name = member.name
@@ -62,7 +62,7 @@ internal class KotlinNamesAnnotationIntrospector(
 
         return when (member) {
             is AnnotatedMethod -> if (member.parameterCount == 0) {
-                if (useKotlinPropertyNameForGetter) {
+                if (kotlinPropertyNameAsImplicitName) {
                     // Fall back to default if it is a getter-like function
                     getterNameFromKotlin(member) ?: getterNameFromJava(member)
                 } else getterNameFromJava(member)

src/test/kotlin/tools/jackson/module/kotlin/DslTest.kt

@@ -43,7 +43,7 @@ class DslTest {
         assertTrue(module.nullToEmptyCollection)
         assertTrue(module.nullToEmptyMap)
         assertTrue(module.nullIsSameAsDefault)
-        assertTrue(module.enabledSingletonSupport)
+        assertTrue(module.singletonSupport)
         assertTrue(module.strictNullChecks)
     }
 

src/test/kotlin/tools/jackson/module/kotlin/KotlinModuleTest.kt

@@ -17,7 +17,7 @@ class KotlinModuleTest {
         assertFalse(module.nullToEmptyCollection)
         assertFalse(module.nullToEmptyMap)
         assertFalse(module.nullIsSameAsDefault)
-        assertFalse(module.enabledSingletonSupport)
+        assertFalse(module.singletonSupport)
         assertFalse(module.strictNullChecks)
         assertFalse(module.kotlinPropertyNameAsImplicitName)
         assertFalse(module.useJavaDurationConversion)
@@ -40,7 +40,7 @@ class KotlinModuleTest {
         assertTrue(module.nullToEmptyCollection)
         assertTrue(module.nullToEmptyMap)
         assertTrue(module.nullIsSameAsDefault)
-        assertTrue(module.enabledSingletonSupport)
+        assertTrue(module.singletonSupport)
         assertTrue(module.strictNullChecks)
         assertTrue(module.kotlinPropertyNameAsImplicitName)
         assertTrue(module.useJavaDurationConversion)
@@ -79,7 +79,7 @@ class KotlinModuleTest {
             enable(SingletonSupport)
         }.build()
 
-        assertTrue(module.enabledSingletonSupport)
+        assertTrue(module.singletonSupport)
     }
 
     @Test
@@ -110,7 +110,7 @@ class KotlinModuleTest {
         assertTrue(deserialized.nullToEmptyCollection)
         assertTrue(deserialized.nullToEmptyMap)
         assertTrue(deserialized.nullIsSameAsDefault)
-        assertTrue(deserialized.enabledSingletonSupport)
+        assertTrue(deserialized.singletonSupport)
         assertTrue(deserialized.strictNullChecks)
     }