feat(testkit-support): support exclusiveContent repositories.

Author: autonomousapps

testkit/gradle-testkit-support/src/main/kotlin/com/autonomousapps/kit/gradle/Repositories.kt

@@ -21,12 +21,19 @@ import com.autonomousapps.kit.render.Scribe
  *   maven(url = "https://repo.spring.io/release")
  * }
  * ```
+ *
+ * @see [Repository]
  */
 public class Repositories @JvmOverloads constructor(
-  public val repositories: MutableList<Repository> = mutableListOf(),
+  public val repositories: MutableList<out Element> = mutableListOf(),
 ) : Element.Block {
 
-  public constructor(vararg repositories: Repository) : this(repositories.toMutableList())
+  public interface Element {
+    // Duplicating Scribe's primary interface method
+    public fun render(scribe: Scribe): String
+  }
+
+  public constructor(vararg repositories: Element) : this(repositories.toMutableList())
 
   public val isEmpty: Boolean = repositories.isEmpty()
 

testkit/gradle-testkit-support/src/main/kotlin/com/autonomousapps/kit/gradle/Repository.kt

@@ -23,17 +23,56 @@ import com.autonomousapps.kit.render.escape
  * // 2
  * maven(url = "https://repo.spring.io/release")
  * mavenCentral()
+ *
+ * // 3
+ * exclusiveContent {
+ *   forRepository {
+ *     maven(url = "https://repo.spring.io/release")
+ *   }
+ *   filter {
+ *     includeGroup("...")
+ *   }
+ * }
  * ```
  */
-public sealed class Repository : Element.Line {
+public sealed class Repository : Repositories.Element {
+
+  public data class ExclusiveContent(
+    private val repo: Repository,
+    private val filters: List<String>,
+  ) : Repository(), Element.Block {
+
+    override val name: String = "exclusiveContent"
+
+    override fun render(scribe: Scribe): String {
+      return scribe.block(this) { s ->
+        s.block("forRepository") { s ->
+          repo.render(s)
+        }
+        s.block("filter") { s ->
+          filters.forEach { filter ->
+            s.line { it.append(filter) }
+          }
+        }
+      }
+    }
+  }
+
+  public data class FlatDir(private val repoUrl: String) : Repository(), Element.Line {
+    override fun render(scribe: Scribe): String = scribe.line { s ->
+      s.append("flatDir { ")
+      s.appendQuoted(repoUrl)
+      s.append(" }")
+    }
+  }
 
-  private data class Method(private val repoCall: String) : Repository() {
+  public data class Method(private val repoCall: String) : Repository(), Element.Line {
     override fun render(scribe: Scribe): String = scribe.line { s ->
       s.append(repoCall)
     }
   }
 
-  private data class Url(private val repoUrl: String) : Repository() {
+  public data class Url(private val repoUrl: String) : Repository(), Element.Line {
     override fun render(scribe: Scribe): String = when (scribe.dslKind) {
       DslKind.GROOVY -> renderGroovy(scribe)
       DslKind.KOTLIN -> renderKotlin(scribe)
@@ -52,14 +91,6 @@ public sealed class Repository : Element.Line {
     }
   }
 
-  private data class FlatDir(private val repoUrl: String) : Repository() {
-    override fun render(scribe: Scribe): String = scribe.line { s ->
-      s.append("flatDir { ")
-      s.appendQuoted(repoUrl)
-      s.append(" }")
-    }
-  }
-
   public companion object {
     @JvmField public val GOOGLE: Repository = Method("google()")
     @JvmField public val GRADLE_PLUGIN_PORTAL: Repository = Method("gradlePluginPortal()")

testkit/gradle-testkit-support/src/main/kotlin/com/autonomousapps/kit/render/Scribe.kt

@@ -88,18 +88,39 @@ public class Scribe @JvmOverloads constructor(
     return buffer.toString()
   }
 
+  /**
+   * This method is *not* indent-aware. If you want an indent, do something like this:
+   * ```
+   * scribe.line { it.append(obj) }
+   * ```
+   * @see [line]
+   */
   public fun append(obj: Any?): Scribe {
     buffer.append(obj.toString())
     return this
   }
 
+  /**
+   * This method is *not* indent-aware. If you want an indent, do something like this:
+   * ```
+   * scribe.line { it.appendQuoted(obj) }
+   * ```
+   * @see [line]
+   */
   public fun appendQuoted(obj: Any?): Scribe {
     append(quote())
     append(obj.toString())
     append(quote())
     return this
   }
 
+  /**
+   * This method is *not* indent-aware. If you want an indent, do something like this:
+   * ```
+   * scribe.line { it.appendLine() }
+   * ```
+   * @see [line]
+   */
   public fun appendLine(): Scribe {
     buffer.appendLine()
     return this

testkit/gradle-testkit-support/src/test/kotlin/com/autonomousapps/kit/render/ScribeTestGroovy.kt

@@ -33,10 +33,15 @@ internal class ScribeTestGroovy {
 
     @Test fun `can render repositories block`() {
       // Given
+      val exclusiveContentRepo = Repository.ExclusiveContent(
+        repo = Repository.ofMaven("https://repo.foo.bar/"),
+        filters = listOf("includeGroup('com.foo.bar')")
+      )
       val repositories = Repositories(
         Repository.GOOGLE,
         Repository.MAVEN_CENTRAL,
         Repository.SNAPSHOTS,
+        exclusiveContentRepo,
       )
 
       // When
@@ -49,6 +54,14 @@ internal class ScribeTestGroovy {
           google()
           mavenCentral()
           maven { url = 'https://central.sonatype.com/repository/maven-snapshots/' }
+          exclusiveContent {
+            forRepository {
+              maven { url = 'https://repo.foo.bar/' }
+            }
+            filter {
+              includeGroup('com.foo.bar')
+            }
+          }
         }
         
       """.trimIndent()

testkit/gradle-testkit-support/src/test/kotlin/com/autonomousapps/kit/render/ScribeTestKotlin.kt

@@ -33,10 +33,15 @@ internal class ScribeTestKotlin {
 
     @Test fun `can render repositories block`() {
       // Given
+      val exclusiveContentRepo = Repository.ExclusiveContent(
+        repo = Repository.ofMaven("https://repo.foo.bar/"),
+        filters = listOf("includeGroup(\"com.foo.bar\")")
+      )
       val repositories = Repositories(
         Repository.GOOGLE,
         Repository.MAVEN_CENTRAL,
         Repository.SNAPSHOTS,
+        exclusiveContentRepo,
       )
 
       // When
@@ -49,6 +54,14 @@ internal class ScribeTestKotlin {
           google()
           mavenCentral()
           maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
+          exclusiveContent {
+            forRepository {
+              maven(url = "https://repo.foo.bar/")
+            }
+            filter {
+              includeGroup("com.foo.bar")
+            }
+          }
         }
         
       """.trimIndent()