Remove Closure-based DSL & migrate to Action<T> (#123)

This type can be automatically used as a lambda expressions & Closures.
This potentially allows for a cleaner integration with both Groovy
and the Kotlin DSL for Gradle.

At the same time, the obsolete Callable0 and Callable1<T> types
are deleted now. They weren’t even used anymore, and they originally
tried to achieve the same thing. Good riddance!

Author: Marcel Schnelle

android-junit5-tests/src/test/groovy/de/mannodermaus/gradle/plugins/junit5/CallableGroovyTests.groovy

@@ -15,6 +15,7 @@ import de.mannodermaus.gradle.plugins.junit5.util.junitPlatformOptions
 import de.mannodermaus.gradle.plugins.junit5.util.throws
 import de.mannodermaus.gradle.plugins.junit5.util.times
 import org.assertj.core.api.Assertions.assertThat
+import org.gradle.api.Action
 import org.gradle.api.ProjectConfigurationException
 import org.gradle.api.Task
 import org.gradle.api.internal.plugins.PluginApplicationException
@@ -62,9 +63,9 @@ class PluginSpec : Spek({
           .build()
 
       project.android.testOptions.junitPlatform {
-        filters("unknown") {
-          includeTags("doesnt-matter")
-        }
+        filters("unknown", Action {
+          it.includeTags("doesnt-matter")
+        })
       }
 
       it("doesn't have a filters extension point for an unknown build type") {
@@ -658,19 +659,19 @@ class PluginSpec : Spek({
               excludeTags("global-exclude-tag")
               includePattern("com.example.package1")
             }
-            filters("paid") {
-              includeEngines("paid-include-engine")
-              includePattern("com.example.paid")
-              excludePattern("com.example.package1")
-            }
-            filters("freeDebug") {
-              includeTags("freeDebug-include-tag")
-            }
-            filters("paidRelease") {
-              includeTags("paidRelease-include-tag")
-              includeTags("global-exclude-tag")
-              includePattern("com.example.paid.release")
-            }
+            filters("paid", Action {
+              it.includeEngines("paid-include-engine")
+              it.includePattern("com.example.paid")
+              it.excludePattern("com.example.package1")
+            })
+            filters("freeDebug", Action {
+              it.includeTags("freeDebug-include-tag")
+            })
+            filters("paidRelease", Action {
+              it.includeTags("paidRelease-include-tag")
+              it.includeTags("global-exclude-tag")
+              it.includePattern("com.example.paid.release")
+            })
           }
 
           project.evaluate()
@@ -748,18 +749,18 @@ class PluginSpec : Spek({
               includeEngines("global-include-engine")
               includePattern("pattern123")
             }
-            filters("debug") {
-              excludeTags("debug-exclude-tag")
-              excludeEngines("debug-exclude-engine")
-              excludePattern("pattern123")
-              excludePattern("debug-pattern")
-            }
-            filters("release") {
-              includeTags("rel-include-tag")
-              includeEngines("rel-include-engine")
-              excludeEngines("global-include-engine")
-              includePattern("release-pattern")
-            }
+            filters("debug", Action {
+              it.excludeTags("debug-exclude-tag")
+              it.excludeEngines("debug-exclude-engine")
+              it.excludePattern("pattern123")
+              it.excludePattern("debug-pattern")
+            })
+            filters("release", Action {
+              it.includeTags("rel-include-tag")
+              it.includeEngines("rel-include-engine")
+              it.excludeEngines("global-include-engine")
+              it.includePattern("release-pattern")
+            })
           }
 
           project.evaluate()

android-junit5-tests/src/test/kotlin/de/mannodermaus/gradle/plugins/junit5/CallableKotlinSpec.kt

@@ -9,7 +9,6 @@ import groovy.lang.GroovyObjectSupport
 import org.gradle.api.Action
 import org.gradle.api.Project
 import org.gradle.api.tasks.Input
-import org.gradle.util.ConfigureUtil
 import org.junit.platform.commons.util.Preconditions
 import java.io.File
 
@@ -59,11 +58,11 @@ internal fun evaluateDsl(project: Project) {
   val ju5 = project.android.testOptions
       .extensionByName<AndroidJUnitPlatformExtension>(EXTENSION_NAME)
 
-  ju5._filters.forEach { qualifier, configs ->
+  ju5._filters.forEach { qualifier, actions ->
     val extensionName = ju5.filtersExtensionName(qualifier)
     val extension = ju5.extensionByName<FiltersExtension>(extensionName)
-    configs.forEach { config ->
-      extension.config()
+    actions.forEach { action ->
+      action.execute(extension)
     }
   }
 }
@@ -97,11 +96,11 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
       // Support for filters() DSL called from Groovy
       val qualifier = name.substring(0, name.indexOf("Filters"))
       val closure = (args as Array<*>)[0] as Closure<*>
-      return this.filters(qualifier) {
-        closure.delegate = this
+      return this.filters(qualifier, Action {
+        closure.delegate = it
         closure.resolveStrategy = Closure.DELEGATE_FIRST
-        closure.call(this)
-      }
+        closure.call(it)
+      })
     }
 
     return null
@@ -133,7 +132,7 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
 
   /* Filters */
 
-  internal val _filters = mutableMapOf<String?, MutableList<FiltersExtension.() -> Unit>>()
+  internal val _filters = mutableMapOf<String?, MutableList<Action<FiltersExtension>>>()
 
   internal fun filtersExtensionName(qualifier: String? = null) = if (qualifier.isNullOrEmpty())
     FILTERS_EXTENSION_NAME
@@ -149,18 +148,8 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
   /**
    * Configure the {@link FiltersExtension}
    * for all executed tests, applied to all variants
-   * (Kotlin version)
-   */
-  fun filters(config: FiltersExtension.() -> Unit) {
-    filters(null, config)
-  }
-
-  /**
-   * Configure the {@link FiltersExtension}
-   * for all executed tests, applied to all variants
-   * (Groovy version)
    */
-  fun filters(action: Action<FiltersExtension>) = filters(null) { action.execute(this) }
+  fun filters(action: Action<FiltersExtension>) = filters(null, Action { action.execute(it) })
 
   /**
    * Return the {@link FiltersExtension}
@@ -174,22 +163,13 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
   /**
    * Configure the {@link FiltersExtension}
    * for tests that belong to the provided build variant
-   * (Kotlin version)
    */
-  fun filters(qualifier: String? = null, config: FiltersExtension.() -> Unit) {
-    val configs = _filters.getOrDefault(qualifier, mutableListOf())
-    configs += config
-    _filters[qualifier] = configs
+  fun filters(qualifier: String? = null, action: Action<FiltersExtension>) {
+    val actions = _filters.getOrDefault(qualifier, mutableListOf())
+    actions += action
+    _filters[qualifier] = actions
   }
 
-  /**
-   * Configure the {@link FiltersExtension}
-   * for tests that belong to the provided build variant
-   * (Groovy version)
-   */
-  fun filters(qualifier: String? = null, action: Action<FiltersExtension>) = filters(
-      qualifier) { action.execute(this) }
-
   /* Android Instrumentation Test support */
 
   /**
@@ -204,8 +184,8 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
    *
    * @since 1.0.22
    */
-  fun instrumentationTests(closure: Closure<InstrumentationTestOptions>) {
-    ConfigureUtil.configure(closure, instrumentationTests)
+  fun instrumentationTests(action: Action<InstrumentationTestOptions>) {
+    action.execute(instrumentationTests)
   }
 
   /* Jacoco Reporting Integration */
@@ -218,8 +198,8 @@ open class AndroidJUnitPlatformExtension(private val project: Project) : GroovyO
   /**
    * Options for controlling Jacoco reporting
    */
-  fun jacocoOptions(closure: Closure<JacocoOptions>) {
-    ConfigureUtil.configure(closure, jacocoOptions)
+  fun jacocoOptions(action: Action<JacocoOptions>) {
+    action.execute(jacocoOptions)
   }
 }
 
@@ -533,8 +513,8 @@ class JacocoOptions {
   /**
    * Options for controlling the HTML Report generated by Jacoco
    */
-  fun html(closure: Closure<Report>) {
-    ConfigureUtil.configure(closure, html)
+  fun html(action: Action<Report>) {
+    action.execute(html)
   }
 
   /**
@@ -545,8 +525,8 @@ class JacocoOptions {
   /**
    * Options for controlling the CSV Report generated by Jacoco
    */
-  fun csv(closure: Closure<Report>) {
-    ConfigureUtil.configure(closure, csv)
+  fun csv(action: Action<Report>) {
+    action.execute(csv)
   }
 
   /**
@@ -557,8 +537,8 @@ class JacocoOptions {
   /**
    * Options for controlling the XML Report generated by Jacoco
    */
-  fun xml(closure: Closure<Report>) {
-    ConfigureUtil.configure(closure, xml)
+  fun xml(action: Action<Report>) {
+    action.execute(xml)
   }
 
   /**

android-junit5-tests/src/test/kotlin/de/mannodermaus/gradle/plugins/junit5/PluginSpec.kt

@@ -37,55 +37,3 @@ class VariantTypeCompat {
     val UNIT_TEST_SUFFIX = GroovyInterop.variantType_unitTestSuffix()
   }
 }
-
-/**
- * Multi-language functional construct with no parameters,
- * mapped to Groovy's dynamic Closures as well as Kotlin's invoke syntax.
- *
- * A [Callable0] can be invoked with the short-hand
- * function syntax from both Kotlin & Groovy:
- *
- * <code><pre>
- *   val callable = Callable0 { 2 + 2 }
- *   val result = callable()  // result == 4
- * </pre></code>
- *
- * <code><pre>
- *   def callable = new Callable0({ 2 + 2 })
- *   def result = callable()  // result == 4
- * </pre></code>
- */
-@Suppress("unused")
-class Callable0<R>(private val body: () -> R) : Closure<R>(null) {
-  /** Kotlin's call syntax */
-  operator fun invoke(): R = body()
-
-  /** Groovy's call syntax */
-  fun doCall(): R = body()
-}
-
-/**
- * Multi-language functional construct with 1 parameter,
- * mapped to Groovy's dynamic Closures as well as Kotlin's invoke syntax.
- *
- * A [Callable1] can be invoked with the short-hand
- * function syntax from both Kotlin & Groovy:
- *
- * <code><pre>
- *   val callable = Callable1 { 2 + it }
- *   val result = callable(2)  // result == 4
- * </pre></code>
- *
- * <code><pre>
- *   def callable = new Callable1({ input ->  2 + input })
- *   def result = callable(2)  // result == 4
- * </pre></code>
- */
-@Suppress("unused")
-class Callable1<T : Any, out R : Any>(private val body: T.() -> R?) : Closure<T>(null) {
-  /** Kotlin's call syntax */
-  operator fun invoke(arg: T): R? = arg.body()
-
-  /** Groovy's call syntax */
-  fun doCall(arg: T): R? = arg.body()
-}