Merge pull request #288 from ProjectMapK/ktlint

Update kotlinter and formatting

Author: k163377

build.gradle.kts

@@ -57,14 +57,6 @@ java {
 }
 
 tasks {
-    // For ported tests, they are excluded from the formatting because they are not new code.
-    lintKotlinTest {
-        exclude { it.path.contains("zPorted") }
-    }
-    formatKotlinTest {
-        exclude { it.path.contains("zPorted") }
-    }
-
     // Task to generate version file
     val generateKogeraVersion by registering(Copy::class) {
         val packageStr = "$groupStr.jackson.module.kogera"
@@ -93,6 +85,14 @@ public val kogeraVersion: Version = VersionUtil.parseVersion("$version", "$group
         dependsOn.add(generateKogeraVersion)
     }
 
+    // For ported tests, they are excluded from the formatting because they are not new code.
+    lintKotlinTest {
+        exclude { it.path.contains("zPorted") }
+    }
+    formatKotlinTest {
+        exclude { it.path.contains("zPorted") }
+    }
+
     compileKotlin {
         dependsOn.add(generateKogeraVersion)
         kotlinOptions.jvmTarget = "1.8"

gradle/libs.versions.toml

@@ -19,4 +19,4 @@ jackson-xml = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-xm
 jackson-jsr310 = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "jackson" }
 
 [plugins]
-kotlinter = { id = "org.jmailen.kotlinter", version = "4.4.1" }
+kotlinter = { id = "org.jmailen.kotlinter", version = "5.0.1" }

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/Converters.kt

@@ -33,8 +33,9 @@ internal class ValueClassUnboxConverter<T : Any>(val valueClass: Class<T>) : Std
     override fun convert(value: T): Any? = unboxMethod.invoke(value)
 
     override fun getInputType(typeFactory: TypeFactory): JavaType = typeFactory.constructType(valueClass)
-    override fun getOutputType(typeFactory: TypeFactory): JavaType =
-        typeFactory.constructType(unboxMethod.genericReturnType)
+    override fun getOutputType(
+        typeFactory: TypeFactory
+    ): JavaType = typeFactory.constructType(unboxMethod.genericReturnType)
 
     val delegatingSerializer: StdDelegatingSerializer by lazy { StdDelegatingSerializer(this) }
 }

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/Extensions.kt

@@ -35,23 +35,27 @@ public fun jsonMapper(initializer: JsonMapper.Builder.() -> Unit = {}): JsonMapp
 
 // region: JvmOverloads is set for bytecode compatibility for versions below 2.17.
 @JvmOverloads
-public fun jacksonObjectMapper(initializer: KotlinModule.Builder.() -> Unit = {}): ObjectMapper =
-    jsonMapper { addModule(kotlinModule(initializer)) }
+public fun jacksonObjectMapper(initializer: KotlinModule.Builder.() -> Unit = {}): ObjectMapper = jsonMapper {
+    addModule(kotlinModule(initializer))
+}
 
 @JvmOverloads
-public fun jacksonMapperBuilder(initializer: KotlinModule.Builder.() -> Unit = {}): JsonMapper.Builder =
-    JsonMapper.builder().addModule(kotlinModule(initializer))
+public fun jacksonMapperBuilder(initializer: KotlinModule.Builder.() -> Unit = {}): JsonMapper.Builder = JsonMapper
+    .builder()
+    .addModule(kotlinModule(initializer))
 
 @JvmOverloads
-public fun ObjectMapper.registerKotlinModule(initializer: KotlinModule.Builder.() -> Unit = {}): ObjectMapper =
-    this.registerModule(kotlinModule(initializer))
+public fun ObjectMapper.registerKotlinModule(
+    initializer: KotlinModule.Builder.() -> Unit = {}
+): ObjectMapper = this.registerModule(kotlinModule(initializer))
 // endregion
 
 public inline fun <reified T> jacksonTypeRef(): TypeReference<T> = object : TypeReference<T>() {}
 
 public inline fun <reified T> ObjectMapper.readValue(jp: JsonParser): T = readValue(jp, jacksonTypeRef<T>())
-public inline fun <reified T> ObjectMapper.readValues(jp: JsonParser): MappingIterator<T> =
-    readValues(jp, jacksonTypeRef<T>())
+public inline fun <reified T> ObjectMapper.readValues(
+    jp: JsonParser
+): MappingIterator<T> = readValues(jp, jacksonTypeRef<T>())
 
 public inline fun <reified T> ObjectMapper.readValue(src: File): T = readValue(src, jacksonTypeRef<T>())
 public inline fun <reified T> ObjectMapper.readValue(src: URL): T = readValue(src, jacksonTypeRef<T>())
@@ -60,20 +64,22 @@ public inline fun <reified T> ObjectMapper.readValue(src: Reader): T = readValue
 public inline fun <reified T> ObjectMapper.readValue(src: InputStream): T = readValue(src, jacksonTypeRef<T>())
 public inline fun <reified T> ObjectMapper.readValue(src: ByteArray): T = readValue(src, jacksonTypeRef<T>())
 
-public inline fun <reified T> ObjectMapper.treeToValue(n: TreeNode): T =
-    readValue(this.treeAsTokens(n), jacksonTypeRef<T>())
+public inline fun <reified T> ObjectMapper.treeToValue(n: TreeNode): T = readValue(treeAsTokens(n), jacksonTypeRef<T>())
 public inline fun <reified T> ObjectMapper.convertValue(from: Any?): T = convertValue(from, jacksonTypeRef<T>())
 
 public inline fun <reified T> ObjectReader.readValueTyped(jp: JsonParser): T = readValue(jp, jacksonTypeRef<T>())
-public inline fun <reified T> ObjectReader.readValuesTyped(jp: JsonParser): Iterator<T> =
-    readValues(jp, jacksonTypeRef<T>())
-public inline fun <reified T> ObjectReader.treeToValue(n: TreeNode): T? =
-    readValue(this.treeAsTokens(n), jacksonTypeRef<T>())
-
-public inline fun <reified T, reified U> ObjectMapper.addMixIn(): ObjectMapper =
-    this.addMixIn(T::class.java, U::class.java)
-public inline fun <reified T, reified U> JsonMapper.Builder.addMixIn(): JsonMapper.Builder =
-    this.addMixIn(T::class.java, U::class.java)
+public inline fun <reified T> ObjectReader.readValuesTyped(
+    jp: JsonParser
+): Iterator<T> = readValues(jp, jacksonTypeRef<T>())
+public inline fun <reified T> ObjectReader.treeToValue(
+    n: TreeNode
+): T? = readValue(treeAsTokens(n), jacksonTypeRef<T>())
+
+public inline fun <reified T, reified U> ObjectMapper.addMixIn(): ObjectMapper = addMixIn(T::class.java, U::class.java)
+public inline fun <reified T, reified U> JsonMapper.Builder.addMixIn(): JsonMapper.Builder = addMixIn(
+    T::class.java,
+    U::class.java
+)
 
 public operator fun ArrayNode.plus(element: Boolean) {
     add(element)

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/InternalCommons.kt

@@ -54,11 +54,15 @@ internal fun Array<Class<*>>.toDescBuilder(): StringBuilder = this
     .fold(StringBuilder("(")) { acc, cur -> acc.appendDescriptor(cur) }
     .append(')')
 
-internal fun Constructor<*>.toSignature(): JvmMethodSignature =
-    JvmMethodSignature("<init>", parameterTypes.toDescBuilder().append('V').toString())
+internal fun Constructor<*>.toSignature(): JvmMethodSignature = JvmMethodSignature(
+    "<init>",
+    parameterTypes.toDescBuilder().append('V').toString()
+)
 
-internal fun Method.toSignature(): JvmMethodSignature =
-    JvmMethodSignature(this.name, parameterTypes.toDescBuilder().appendDescriptor(this.returnType).toString())
+internal fun Method.toSignature(): JvmMethodSignature = JvmMethodSignature(
+    this.name,
+    parameterTypes.toDescBuilder().appendDescriptor(this.returnType).toString()
+)
 
 internal val defaultConstructorMarker: Class<*> by lazy {
     Class.forName("kotlin.jvm.internal.DefaultConstructorMarker")
@@ -84,8 +88,7 @@ internal fun String.reconstructClass(): Class<*> {
 }
 
 internal fun KmType.reconstructClassOrNull(): Class<*>? = (classifier as? KmClassifier.Class)?.reconstructClassOrNull()
-internal fun KmClassifier.Class.reconstructClassOrNull(): Class<*>? =
-    runCatching { name.reconstructClass() }.getOrNull()
+internal fun KmClassifier.Class.reconstructClassOrNull(): Class<*>? = runCatching { name.reconstructClass() }.getOrNull()
 
 internal fun AnnotatedElement.hasCreatorAnnotation(): Boolean = getAnnotation(JSON_CREATOR_CLASS)
     ?.let { it.mode != JsonCreator.Mode.DISABLED }

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/KotlinModule.kt

@@ -166,16 +166,13 @@ public class KotlinModule private constructor(
             bitSet.andNot(feature.bitSet)
         }
 
-        public fun configure(feature: KotlinFeature, enabled: Boolean): Builder =
-            when {
-                enabled -> enable(feature)
-                else -> disable(feature)
-            }
+        public fun configure(feature: KotlinFeature, enabled: Boolean): Builder = when {
+            enabled -> enable(feature)
+            else -> disable(feature)
+        }
 
-        public fun isEnabled(feature: KotlinFeature): Boolean =
-            bitSet.intersects(feature.bitSet)
+        public fun isEnabled(feature: KotlinFeature): Boolean = bitSet.intersects(feature.bitSet)
 
-        public fun build(): KotlinModule =
-            KotlinModule(this)
+        public fun build(): KotlinModule = KotlinModule(this)
     }
 }

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/ReflectionCache.kt

@@ -22,8 +22,8 @@ internal class ReflectionCache(initialCacheSize: Int, maxCacheSize: Int) : Seria
 
         // The comparison was implemented directly because the decompiled results showed subtle efficiency.
 
-        final override fun equals(other: Any?): Boolean =
-            (other as? OtherCacheKey<*, *>)?.let { it::class == this::class && it.key == key } ?: false
+        final override fun equals(other: Any?): Boolean = (other as? OtherCacheKey<*, *>)
+            ?.let { it::class == this::class && it.key == key } == true
 
         // If the hashCode matches the raw key, the search efficiency is reduced, so it is displaced.
         final override fun hashCode(): Int = key.hashCode() * 31

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/SpreadWrapperDelegates.kt

@@ -6,7 +6,7 @@ import java.lang.reflect.Method
 internal fun <T> Constructor<T>.call(args: Array<*>): T = SpreadWrapper.newInstance(this, args)
 internal fun Method.call(instance: Any?, args: Array<*>): Any? = SpreadWrapper.invoke(this, instance, args)
 
-internal fun <T> Class<T>.getDeclaredConstructorBy(parameterTypes: Array<Class<*>>): Constructor<T> =
-    SpreadWrapper.getDeclaredConstructor(this, parameterTypes)
-internal fun Class<*>.getDeclaredMethodBy(name: String, parameterTypes: Array<Class<*>>): Method =
-    SpreadWrapper.getDeclaredMethod(this, name, parameterTypes)
+internal fun <T> Class<T>.getDeclaredConstructorBy(parameterTypes: Array<Class<*>>): Constructor<T> = SpreadWrapper
+    .getDeclaredConstructor(this, parameterTypes)
+internal fun Class<*>.getDeclaredMethodBy(name: String, parameterTypes: Array<Class<*>>): Method = SpreadWrapper
+    .getDeclaredMethod(this, name, parameterTypes)

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/annotationIntrospector/KotlinFallbackAnnotationIntrospector.kt

@@ -38,21 +38,22 @@ internal class KotlinFallbackAnnotationIntrospector(
     private val useJavaDurationConversion: Boolean,
     private val cache: ReflectionCache
 ) : NopAnnotationIntrospector() {
-    private fun findKotlinParameter(param: AnnotatedParameter): JmValueParameter? =
-        when (val owner = param.owner.member) {
-            is Constructor<*> -> cache.getJmClass(param.declaringClass)?.findJmConstructor(owner)?.valueParameters
-            is Method -> if (Modifier.isStatic(owner.modifiers)) {
-                cache.getJmClass(param.declaringClass)
-                    ?.companion
-                    ?.let { it.findFunctionByMethod(owner)?.valueParameters }
-            } else {
-                null
-            }
-            else -> null
-        }?.let { it[param.index] }
+    private fun findKotlinParameter(
+        param: AnnotatedParameter
+    ): JmValueParameter? = when (val owner = param.owner.member) {
+        is Constructor<*> -> cache.getJmClass(param.declaringClass)?.findJmConstructor(owner)?.valueParameters
+        is Method -> if (Modifier.isStatic(owner.modifiers)) {
+            cache.getJmClass(param.declaringClass)
+                ?.companion
+                ?.let { it.findFunctionByMethod(owner)?.valueParameters }
+        } else {
+            null
+        }
+        else -> null
+    }?.let { it[param.index] }
 
-    private fun findKotlinParameter(param: Annotated): JmValueParameter? =
-        (param as? AnnotatedParameter)?.let { findKotlinParameter(it) }
+    private fun findKotlinParameter(param: Annotated): JmValueParameter? = (param as? AnnotatedParameter)
+        ?.let { findKotlinParameter(it) }
 
     // since 2.4
     override fun findImplicitPropertyName(member: AnnotatedMember): String? = when (member) {
@@ -65,13 +66,16 @@ internal class KotlinFallbackAnnotationIntrospector(
         else -> null
     }
 
-    override fun refineDeserializationType(config: MapperConfig<*>, a: Annotated, baseType: JavaType): JavaType =
-        findKotlinParameter(a)?.let { param ->
-            val rawType = a.rawType
-            param.reconstructedClassOrNull
-                ?.takeIf { it.isUnboxableValueClass() && it != rawType }
-                ?.let { config.constructType(it) }
-        } ?: baseType
+    override fun refineDeserializationType(
+        config: MapperConfig<*>,
+        a: Annotated,
+        baseType: JavaType
+    ): JavaType = findKotlinParameter(a)?.let { param ->
+        val rawType = a.rawType
+        param.reconstructedClassOrNull
+            ?.takeIf { it.isUnboxableValueClass() && it != rawType }
+            ?.let { config.constructType(it) }
+    } ?: baseType
 
     override fun findSerializationConverter(a: Annotated): Converter<*, *>? = when (a) {
         // Find a converter to handle the case where the getter returns an unboxed value from the value class.
@@ -163,9 +167,10 @@ private fun JmValueParameter.isNullishTypeAt(index: Int): Boolean = arguments.ge
     it === KmTypeProjection.STAR || it.type!!.isNullable
 } != false // If a type argument cannot be taken, treat it as nullable to avoid unexpected failure.
 
-private fun JmValueParameter.requireStrictNullCheck(type: JavaType): Boolean =
-    ((type.isArrayType || type.isCollectionLikeType) && !this.isNullishTypeAt(0)) ||
-        (type.isMapLikeType && !this.isNullishTypeAt(1))
+private fun JmValueParameter.requireStrictNullCheck(
+    type: JavaType
+): Boolean = ((type.isArrayType || type.isCollectionLikeType) && !this.isNullishTypeAt(0)) ||
+    (type.isMapLikeType && !this.isNullishTypeAt(1))
 
 private fun JmClass.primarilyConstructor() = constructors.find { !it.isSecondary } ?: constructors.singleOrNull()
 

src/main/kotlin/io/github/projectmapk/jackson/module/kogera/annotationIntrospector/KotlinPrimaryAnnotationIntrospector.kt

@@ -44,8 +44,8 @@ internal class KotlinPrimaryAnnotationIntrospector(
 
     // Functions that call this may return incorrect results for value classes whose value type is Collection or Map,
     // but this is a rare case and difficult to handle, so it is not supported.
-    private fun JavaType.hasDefaultEmptyValue() =
-        (nullToEmptyCollection && isCollectionLikeType) || (nullToEmptyMap && isMapLikeType)
+    private fun JavaType.hasDefaultEmptyValue() = (nullToEmptyCollection && isCollectionLikeType) ||
+        (nullToEmptyMap && isMapLikeType)
 
     // The nullToEmpty option also affects serialization,
     // but deserialization is preferred because there is currently no way to distinguish between contexts.
@@ -63,19 +63,20 @@ internal class KotlinPrimaryAnnotationIntrospector(
 
     private fun JmProperty.isRequiredByNullability(): Boolean = !this.returnType.isNullable
 
-    private fun AnnotatedMethod.getRequiredMarkerFromCorrespondingAccessor(jmClass: JmClass): Boolean? =
-        when (parameterCount) {
-            0 -> jmClass.findPropertyByGetter(member)?.isRequiredByNullability()
-            1 -> {
-                if (this.getParameter(0).type.hasDefaultEmptyValue()) {
-                    false
-                } else {
-                    val memberSignature = member.toSignature()
-                    jmClass.properties.find { it.setterSignature == memberSignature }?.isRequiredByNullability()
-                }
+    private fun AnnotatedMethod.getRequiredMarkerFromCorrespondingAccessor(
+        jmClass: JmClass
+    ): Boolean? = when (parameterCount) {
+        0 -> jmClass.findPropertyByGetter(member)?.isRequiredByNullability()
+        1 -> {
+            if (this.getParameter(0).type.hasDefaultEmptyValue()) {
+                false
+            } else {
+                val memberSignature = member.toSignature()
+                jmClass.properties.find { it.setterSignature == memberSignature }?.isRequiredByNullability()
             }
-            else -> null
         }
+        else -> null
+    }
 
     private fun AnnotatedParameter.hasRequiredMarker(jmClass: JmClass): Boolean? {
         val paramDef = when (val member = member) {