refactor: ReportingHandler.Config is an interface for Gradle reasons.

Author: autonomousapps

src/main/kotlin/com/autonomousapps/extension/ReportingHandler.kt

@@ -3,6 +3,7 @@ package com.autonomousapps.extension
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
+import org.gradle.kotlin.dsl.newInstance
 import org.gradle.kotlin.dsl.property
 import javax.inject.Inject
 
@@ -18,7 +19,7 @@ import javax.inject.Inject
  * }
  * ```
  */
-abstract class ReportingHandler @Inject constructor(objects: ObjectFactory) {
+abstract class ReportingHandler @Inject constructor(private val objects: ObjectFactory) {
 
   internal val onlyOnFailure: Property<Boolean> = objects.property<Boolean>().convention(false)
   internal val postscript: Property<String> = objects.property<String>().convention("")
@@ -39,33 +40,37 @@ abstract class ReportingHandler @Inject constructor(objects: ObjectFactory) {
     this.postscript.disallowChanges()
   }
 
-  internal fun config() = Config(
-    onlyOnFailure = onlyOnFailure,
-    postscript = postscript,
-  )
+  internal fun config(): Config {
+    val config = objects.newInstance<Config>()
+    config.onlyOnFailure.set(onlyOnFailure)
+    config.postscript.set(postscript)
+    return config
+  }
 
-  class Config(
-    @get:Input val onlyOnFailure: Property<Boolean>,
-    @get:Input val postscript: Property<String>,
-  ) {
+  interface Config {
 
-    /**
-     * Returns the supplied [postscript], or an empty string, depending on whether we've been configured to print
-     * [onlyOnFailure] and the actual [failure state][shouldFail] of the advice.
-     */
-    internal fun getEffectivePostscript(shouldFail: Boolean): String {
-      return if (shouldPrint(shouldFail)) postscript.get() else ""
-    }
+    @get:Input val onlyOnFailure: Property<Boolean>
+    @get:Input val postscript: Property<String>
+  }
+}
+
+/**
+ * Returns the supplied [postscript][ReportingHandler.Config.postscript], or an empty string, depending on whether we've
+ * been configured to print [onlyOnFailure][ReportingHandler.Config.onlyOnFailure] and the actual
+ * [failure state][shouldFail] of the advice.
+ */
+internal fun ReportingHandler.Config.getEffectivePostscript(shouldFail: Boolean): String {
+  return if (shouldPrint(shouldFail)) postscript.get() else ""
+}
 
-    /**
-     * Returns true if the [postscript] should be included in output, based on the combination of [onlyOnFailure] and
-     * the actual [failure state][shouldFail] of the advice.
-     */
-    private fun shouldPrint(shouldFail: Boolean): Boolean {
-      val onlyOnFailure = onlyOnFailure.get()
-      val alwaysPrint = !onlyOnFailure
+/**
+ * Returns true if the [postscript][ReportingHandler.Config.postscript] should be included in output, based on the
+ * combination of [onlyOnFailure][ReportingHandler.Config.onlyOnFailure] and the actual [failure state][shouldFail] of
+ * the advice.
+ */
+private fun ReportingHandler.Config.shouldPrint(shouldFail: Boolean): Boolean {
+  val onlyOnFailure = onlyOnFailure.get()
+  val alwaysPrint = !onlyOnFailure
 
-      return ((onlyOnFailure && shouldFail) || alwaysPrint)
-    }
-  }
+  return ((onlyOnFailure && shouldFail) || alwaysPrint)
 }

src/main/kotlin/com/autonomousapps/tasks/GenerateBuildHealthTask.kt

@@ -5,6 +5,7 @@ package com.autonomousapps.tasks
 import com.autonomousapps.DependencyAnalysisPlugin
 import com.autonomousapps.extension.DependenciesHandler.Companion.toLambda
 import com.autonomousapps.extension.ReportingHandler
+import com.autonomousapps.extension.getEffectivePostscript
 import com.autonomousapps.internal.advice.DslKind
 import com.autonomousapps.internal.advice.ProjectHealthConsoleReportBuilder
 import com.autonomousapps.internal.utils.Colors

src/main/kotlin/com/autonomousapps/tasks/GenerateProjectHealthReportTask.kt

@@ -6,6 +6,7 @@ package com.autonomousapps.tasks
 
 import com.autonomousapps.extension.DependenciesHandler.Companion.toLambda
 import com.autonomousapps.extension.ReportingHandler
+import com.autonomousapps.extension.getEffectivePostscript
 import com.autonomousapps.internal.advice.DslKind
 import com.autonomousapps.internal.advice.ProjectHealthConsoleReportBuilder
 import com.autonomousapps.internal.utils.fromJson
@@ -49,9 +50,7 @@ abstract class GenerateProjectHealthReportTask @Inject constructor(
   @TaskAction fun action() {
     workerExecutor.noIsolation().submit(ProjectHealthAction::class.java) {
       advice.set(this@GenerateProjectHealthReportTask.projectAdvice)
-      // reportingConfig.set(this@GenerateProjectHealthReportTask.reportingConfig)
-      onlyOnFailure.set(this@GenerateProjectHealthReportTask.reportingConfig.flatMap { it.onlyOnFailure })
-      postscript.set(this@GenerateProjectHealthReportTask.reportingConfig.flatMap { it.postscript })
+      reportingConfig.set(this@GenerateProjectHealthReportTask.reportingConfig)
       dslKind.set(this@GenerateProjectHealthReportTask.dslKind)
       dependencyMap.set(this@GenerateProjectHealthReportTask.dependencyMap)
       output.set(this@GenerateProjectHealthReportTask.output)
@@ -60,10 +59,7 @@ abstract class GenerateProjectHealthReportTask @Inject constructor(
 
   interface ProjectHealthParameters : WorkParameters {
     val advice: RegularFileProperty
-    // TODO(tsr): this is annoying that this doesn't work. Asked Gradle about it.
-    // val reportingConfig: Property<ReportingHandler.Config>
-    val onlyOnFailure: Property<Boolean>
-    val postscript: Property<String>
+    val reportingConfig: Property<ReportingHandler.Config>
     val dslKind: Property<DslKind>
     val dependencyMap: MapProperty<String, String>
     val output: RegularFileProperty
@@ -74,16 +70,10 @@ abstract class GenerateProjectHealthReportTask @Inject constructor(
     override fun execute() {
       val output = parameters.output.getAndDelete()
 
-      val reportingConfig = ReportingHandler.Config(
-        onlyOnFailure = parameters.onlyOnFailure,
-        postscript = parameters.postscript,
-      )
-
       val projectAdvice = parameters.advice.fromJson<ProjectAdvice>()
       val consoleText = ProjectHealthConsoleReportBuilder(
         projectAdvice = projectAdvice,
-        // postscript = parameters.reportingConfig.get().getEffectivePostscript(projectAdvice.shouldFail),
-        postscript = reportingConfig.getEffectivePostscript(projectAdvice.shouldFail),
+        postscript = parameters.reportingConfig.get().getEffectivePostscript(projectAdvice.shouldFail),
         dslKind = parameters.dslKind.get(),
         dependencyMap = parameters.dependencyMap.get().toLambda(),
       ).text