convert ktlint invocations from reflection to new method of using multiple compileOnly targets

create common abstraction for Lint errors and reporters

Author: wakingrufus

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+
+- Added ktlint 0.49.1 supprort [#667](https://github.com/JLLeitschuh/ktlint-gradle/pull/667)
+- Refactored multi-ktlint support to use multiple source sets with different compileOnly dependencies rather than reflection. [#667](https://github.com/JLLeitschuh/ktlint-gradle/pull/667)
+
 ## [11.3.2] - 2023-04-25
 
 ### Fixed

plugin/build.gradle.kts

@@ -61,6 +61,10 @@ sourceSets {
     val adapter34 by creating {
         compileClasspath += adapter.output
     }
+    val adapter34Test by creating {
+        compileClasspath += adapter.output + adapter34.output
+        runtimeClasspath += adapter.output + adapter34.output
+    }
     val adapter41 by creating {
         compileClasspath += adapter.output
     }
@@ -107,6 +111,14 @@ tasks.named<Jar>("shadowJar") {
     this.from(adapterSources.map { sourceSet -> sourceSet.map { it.output.classesDirs } })
 }
 
+val test34Task = tasks.register<Test>("test34") {
+    classpath = sourceSets.named("adapter34Test").get().runtimeClasspath
+    testClassesDirs = sourceSets.named("adapter34Test").get().output.classesDirs
+}
+tasks.named("test") {
+    dependsOn(test34Task)
+}
+
 dependencies {
     compileOnly(gradleApi())
     compileOnly(libs.ktlint.core)
@@ -119,12 +131,12 @@ dependencies {
     add("adapter46CompileOnly", "com.pinterest.ktlint:ktlint-core:0.46.1")
     add("adapter47CompileOnly", "com.pinterest.ktlint:ktlint-core:0.47.1")
     add("adapter48CompileOnly", "com.pinterest.ktlint:ktlint-core:0.48.2")
-  //  add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-rule-engine-core:0.49.0")
+    //  add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-rule-engine-core:0.49.0")
     add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-core:0.49.1")
     add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-cli-reporter:0.49.1")
     add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-rule-engine:0.49.1")
     add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-ruleset-standard:0.49.1")
-    add("adapter49CompileOnly","com.pinterest.ktlint:ktlint-reporter-baseline:0.49.1")
+    add("adapter49CompileOnly", "com.pinterest.ktlint:ktlint-reporter-baseline:0.49.1")
     compileOnly(libs.kotlin.gradle.plugin)
     compileOnly(libs.android.gradle.plugin)
     compileOnly(kotlin("stdlib-jdk8"))
@@ -146,6 +158,12 @@ dependencies {
     testImplementation(libs.kotlin.reflect)
     testImplementation(libs.ktlint.core)
     testImplementation(libs.archunit.junit5)
+
+    add("adapter34TestImplementation", "com.pinterest.ktlint:ktlint-core:0.34.0")
+    add("adapter34TestImplementation", gradleTestKit())
+    add("adapter34TestImplementation", libs.junit.jupiter)
+    add("adapter34TestImplementation", libs.assertj.core)
+    add("adapter34TestImplementation", libs.kotlin.reflect)
 }
 
 // Test tasks loods plugin from local maven repository

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/reporter/GenericReporterProvider.kt

@@ -1,6 +1,5 @@
 package org.jlleitschuh.gradle.ktlint.reporter
 
-import com.pinterest.ktlint.core.Reporter
 import java.io.PrintStream
 
 /**
@@ -10,6 +9,6 @@ interface GenericReporterProvider<T : GenericReporter<*>> {
     val id: String
     fun get(
         out: PrintStream,
-        opt: Map<String, String>,
+        opt: Map<String, String>
     ): T
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/reporter/LoadedProvider.kt plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/reporter/LoadedReporter.kt

@@ -1,36 +1,39 @@
 package org.jlleitschuh.gradle.ktlint.reporter
 
-import com.pinterest.ktlint.core.ReporterProvider
 import java.io.File
-import java.io.ObjectInputStream
 import java.io.Serializable
 
 /**
  * T is a ReporterProvider / ReporterProviderV2
+ * GR is a generic wrapper for the reporter
+ * GRP is the generic wrapper for the provider
  */
-interface ReportersLoaderAdapter<T : Serializable> {
-    fun loadAllReporterProviders(): List<ReporterProviderWrapper<T>>
+interface ReportersLoaderAdapter<
+    R,
+    RP : Serializable,
+    GR : GenericReporter<R>,
+    GRP : GenericReporterProvider<GR>> {
+    fun loadAllReporterProviders(): List<ReporterProviderWrapper<RP>>
     fun filterEnabledBuiltInProviders(
         enabledReporters: Set<ReporterType>,
-        allProviders: List<ReporterProviderWrapper<T>>
-    ): List<Pair<LoadedReporter, T>>
-
+        allProviders: List<ReporterProviderWrapper<RP>>
+    ): List<Pair<LoadedReporter, RP>>
 
     fun filterCustomProviders(
         customReporters: Set<CustomReporter>,
-        allProviders: List<T>
-    ): List<Pair<LoadedReporter, T>>
+        allProviders: List<RP>
+    ): List<Pair<LoadedReporter, RP>>
 
     fun allEnabledProviders(
         enabledReporters: Set<ReporterType>,
         customReporters: Set<CustomReporter>
-    ): List<Pair<LoadedReporter, T>> {
+    ): List<Pair<LoadedReporter, RP>> {
         val all = loadAllReporterProviders()
         return filterEnabledBuiltInProviders(enabledReporters, all)
             .plus(filterCustomProviders(customReporters, all.map { it.reporterProvider }))
     }
 
-    fun loadReporterProviders(
-        serializedReporterProviders: File
-    ): List<GenericReporterProvider<*>>
+    fun loadReporterProviders(serializedReporterProviders: File): List<GRP>
+
+    fun loadAllGenericReporterProviders(): List<GRP>
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/reporter/ReporterFactory.kt

@@ -1,7 +1,5 @@
 package org.jlleitschuh.gradle.ktlint.worker
 
-import com.pinterest.ktlint.core.LintError
-
 interface BaselineLoader {
     fun loadBaselineRules(path: String): Map<String, List<SerializableLintError>>
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/reporter/ReportersLoaderAdapter.kt

@@ -1,7 +1,5 @@
 package org.jlleitschuh.gradle.ktlint.worker
 
-import com.pinterest.ktlint.core.LintError
-
 interface BaselineReporterAdapter {
     fun onLintError(file: String, err: SerializableLintError, corrected: Boolean)
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/BaselineLoader.kt

@@ -20,8 +20,11 @@ data class LegacyLintErrorResult(
     }
 
     fun toNew(): LintErrorResult {
-        return LintErrorResult(lintedFile, lintErrors.map {
-            it.first.toSerializable() to it.second
-        })
+        return LintErrorResult(
+            lintedFile,
+            lintErrors.map {
+                it.first.toSerializable() to it.second
+            }
+        )
     }
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/BaselineReporterAdapter.kt

@@ -3,13 +3,9 @@ package org.jlleitschuh.gradle.ktlint.worker
 import com.pinterest.ktlint.core.LintError
 
 fun LintError.toSerializable(): SerializableLintError {
-    return SerializableLintError(
-        line, col, ruleId, detail, canBeAutoCorrected
-    )
+    return SerializableLintError(line, col, ruleId, detail, canBeAutoCorrected)
 }
 
 fun SerializableLintError.toCore(): LintError {
-    return LintError(
-        line, col, ruleId, detail, canBeAutoCorrected
-    )
+    return LintError(line, col, ruleId, detail, canBeAutoCorrected)
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/InvocationResult.kt

@@ -1,6 +1,5 @@
 package org.jlleitschuh.gradle.ktlint.worker
 
-import com.pinterest.ktlint.core.LintError
 import java.io.File
 import java.io.Serializable
 

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/LegacyLintErrorResult.kt

@@ -8,9 +8,6 @@ import org.jlleitschuh.gradle.ktlint.worker.toCore
  * implementation of GenericReporter for the Reporter ktlint class
  */
 class Ktlint34Reporter(val reporter: Reporter) : GenericReporter<Reporter> {
-    companion object Factory : ReporterFactory {
-        fun initialize(reporter: Reporter): Ktlint34Reporter = Ktlint34Reporter(reporter)
-    }
     override fun beforeAll() {
         reporter.beforeAll()
     }
@@ -30,5 +27,4 @@ class Ktlint34Reporter(val reporter: Reporter) : GenericReporter<Reporter> {
     override fun afterAll() {
         reporter.afterAll()
     }
-
 }

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/LintErrorExt.kt

@@ -4,12 +4,8 @@ import com.pinterest.ktlint.core.ReporterProvider
 import java.io.PrintStream
 
 class Ktlint34ReporterProvider(val reporterProvider: ReporterProvider) : GenericReporterProvider<Ktlint34Reporter> {
-    companion object Factory : ReporterProviderFactory {
-        fun initialize(reporterProvider: ReporterProvider): Ktlint34ReporterProvider =
-            Ktlint34ReporterProvider(reporterProvider)
-    }
     override fun get(out: PrintStream, opt: Map<String, String>): Ktlint34Reporter {
-    return    Ktlint34Reporter(reporterProvider.get(out, opt))
+        return Ktlint34Reporter(reporterProvider.get(out, opt))
     }
 
     override val id: String

plugin/src/adapter/kotlin/org/jlleitschuh/gradle/ktlint/worker/LintErrorResult.kt

@@ -1,28 +1,34 @@
 package org.jlleitschuh.gradle.ktlint.reporter
 
+import com.pinterest.ktlint.core.Reporter
 import com.pinterest.ktlint.core.ReporterProvider
-import org.jlleitschuh.gradle.ktlint.reporter.CustomReporter
-import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
 import java.io.File
 import java.io.ObjectInputStream
-import java.io.Serializable
-import java.lang.RuntimeException
 import java.util.ServiceLoader
 
-class SerializableReportersProviderLoader : ReportersLoaderAdapter<SerializableReporterProvider> {
+class SerializableReportersProviderLoader :
+    ReportersLoaderAdapter<Reporter, SerializableReporterProvider, Ktlint34Reporter, Ktlint34ReporterProvider> {
     override fun loadAllReporterProviders(): List<ReporterProviderWrapper<SerializableReporterProvider>> = ServiceLoader
         .load(ReporterProvider::class.java)
         .toList().map {
             ReporterProviderWrapper(it.id, SerializableReporterProvider(it))
         }
-    override fun loadReporterProviders(serializedReporterProviders: File): List<GenericReporterProvider<*>> {
+
+    override fun loadReporterProviders(serializedReporterProviders: File): List<Ktlint34ReporterProvider> {
         return ObjectInputStream(
             serializedReporterProviders.inputStream().buffered()
         ).use {
             @Suppress("UNCHECKED_CAST")
             it.readObject() as List<SerializableReporterProvider>
         }.map { Ktlint34ReporterProvider(it.reporterProvider) }
     }
+
+    override fun loadAllGenericReporterProviders(): List<Ktlint34ReporterProvider> = ServiceLoader
+        .load(ReporterProvider::class.java)
+        .toList().map {
+            Ktlint34ReporterProvider(it)
+        }
+
     override fun filterEnabledBuiltInProviders(
         enabledReporters: Set<ReporterType>,
         allProviders: List<ReporterProviderWrapper<SerializableReporterProvider>>

plugin/src/adapter34/kotlin/org/jlleitschuh/gradle/ktlint/reporter/Ktlint34Reporter.kt

@@ -0,0 +1,45 @@
+package org.jlleitschuh.gradle.ktlint.reporter
+
+import com.pinterest.ktlint.core.Reporter
+import com.pinterest.ktlint.core.ReporterProvider
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.io.TempDir
+import java.io.File
+import java.io.ObjectInputStream
+import java.io.ObjectOutputStream
+import java.io.PrintStream
+
+internal class SerializableReporterProviderTest {
+    @TempDir
+    lateinit var temporaryFolder: File
+
+    @Test
+    internal fun `Should correctly serialize and deserialize ReporterProvider`() {
+        val reporterProvider: ReporterProvider = TestReporterProvider()
+        val wrappedReporterProvider = SerializableReporterProvider(reporterProvider)
+        val serializeIntoFile = temporaryFolder.resolve("reporters.test")
+
+        ObjectOutputStream(serializeIntoFile.outputStream()).use {
+            it.writeObject(wrappedReporterProvider)
+        }
+
+        ObjectInputStream(serializeIntoFile.inputStream()).use {
+            val restoredWrappedReporterProvider = it.readObject() as SerializableReporterProvider
+            assertThat(restoredWrappedReporterProvider.reporterProvider).isInstanceOf(TestReporterProvider::class.java)
+            assertThat(restoredWrappedReporterProvider.reporterProvider.id)
+                .isEqualTo(reporterProvider.id)
+        }
+    }
+
+    private class TestReporterProvider : ReporterProvider {
+        override val id: String = "test-reporter-provider"
+
+        override fun get(
+            out: PrintStream,
+            opt: Map<String, String>
+        ): Reporter {
+            TODO("Not yet implemented")
+        }
+    }
+}

plugin/src/adapter34/kotlin/org/jlleitschuh/gradle/ktlint/reporter/Ktlint34ReporterProvider.kt

@@ -1,6 +1,5 @@
 package org.jlleitschuh.gradle.ktlint.reporter
 
-import com.pinterest.ktlint.core.LintError
 import com.pinterest.ktlint.core.Reporter
 import org.jlleitschuh.gradle.ktlint.worker.SerializableLintError
 import org.jlleitschuh.gradle.ktlint.worker.toCore
@@ -9,9 +8,6 @@ import org.jlleitschuh.gradle.ktlint.worker.toCore
  * implementation of GenericReporter for the Reporter ktlint class
  */
 class Ktlint41Reporter(val reporter: Reporter) : GenericReporter<Reporter> {
-    companion object Factory : ReporterFactory {
-        fun initialize(reporter: Reporter): Ktlint41Reporter = Ktlint41Reporter(reporter)
-    }
     override fun beforeAll() {
         reporter.beforeAll()
     }
@@ -31,5 +27,4 @@ class Ktlint41Reporter(val reporter: Reporter) : GenericReporter<Reporter> {
     override fun afterAll() {
         reporter.afterAll()
     }
-
 }

plugin/src/adapter34/kotlin/org/jlleitschuh/gradle/ktlint/reporter/SerializableReportersProviderLoader.kt

@@ -4,12 +4,8 @@ import com.pinterest.ktlint.core.ReporterProvider
 import java.io.PrintStream
 
 class Ktlint41ReporterProvider(val reporterProvider: ReporterProvider) : GenericReporterProvider<Ktlint41Reporter> {
-    companion object Factory : ReporterProviderFactory {
-        fun initialize(reporterProvider: ReporterProvider): Ktlint41ReporterProvider =
-            Ktlint41ReporterProvider(reporterProvider)
-    }
     override fun get(out: PrintStream, opt: Map<String, String>): Ktlint41Reporter {
-    return    Ktlint41Reporter(reporterProvider.get(out, opt))
+        return Ktlint41Reporter(reporterProvider.get(out, opt))
     }
 
     override val id: String

plugin/src/adapter34Test/kotlin/org/jlleitschuh/gradle/ktlint/reporter/SerializableReporterProviderTest.kt

@@ -1,22 +1,27 @@
 package org.jlleitschuh.gradle.ktlint.reporter
 
+import com.pinterest.ktlint.core.Reporter
 import com.pinterest.ktlint.core.ReporterProvider
-import org.jlleitschuh.gradle.ktlint.reporter.CustomReporter
-import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
 import java.io.File
 import java.io.ObjectInputStream
-import java.lang.RuntimeException
 import java.util.ServiceLoader
 
-class ReportersProviderLoader : ReportersLoaderAdapter<ReporterProvider> {
+class ReportersProviderLoader :
+    ReportersLoaderAdapter<Reporter, ReporterProvider, Ktlint41Reporter, Ktlint41ReporterProvider> {
     override fun loadAllReporterProviders(): List<ReporterProviderWrapper<ReporterProvider>> = ServiceLoader
         .load(ReporterProvider::class.java)
         .toList().map {
             ReporterProviderWrapper(it.id, it)
         }
 
-    override fun loadReporterProviders(serializedReporterProviders: File): List<GenericReporterProvider<*>> {
-       return ObjectInputStream(
+    override fun loadAllGenericReporterProviders(): List<Ktlint41ReporterProvider> = ServiceLoader
+        .load(ReporterProvider::class.java)
+        .toList().map {
+            Ktlint41ReporterProvider(it)
+        }
+
+    override fun loadReporterProviders(serializedReporterProviders: File): List<Ktlint41ReporterProvider> {
+        return ObjectInputStream(
             serializedReporterProviders.inputStream().buffered()
         ).use {
             @Suppress("UNCHECKED_CAST")