com.autonomousapps.kit.gradle.Dependency.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-testkit-support Show documentation
A DSL for building test fixtures with Gradle TestKit
There is a newer version: 0.17
Show newest version
package com.autonomousapps.kit.gradle

import com.autonomousapps.kit.render.Element
import com.autonomousapps.kit.render.Scribe

public class Dependency @JvmOverloads constructor(
  public val configuration: String,
  private val dependency: String,
  private val ext: String? = null,
  private val capability: String? = null,
  private val isVersionCatalog: Boolean = false,
) : Element.Line {

  private val isProject = dependency.startsWith(":")

  public val identifier: String = if (isProject) dependency else dependency.substringBeforeLast(":")
  public val version: String? = if (isProject) null else dependency.substringAfterLast(":")

  override fun render(scribe: Scribe): String = scribe.line { s ->
    val text = when {
      // project dependency
      dependency.startsWith(':') -> "$configuration project('$dependency')"
      // function call
      dependency.endsWith("()") -> "$configuration $dependency"
      // Some kind of custom notation
      !dependency.contains(":") -> "$configuration $dependency"
      // version catalog reference
      isVersionCatalog -> "$configuration $dependency"

      // normal dependency
      else -> {
        // normal external dependencies
        if (ext == null) "$configuration '$dependency'"
        // flat dependencies, e.g. in a libs/ dir
        else "$configuration(name: '$dependency', ext: '$ext')"
      }
    }.let {
      when {
        // Note: 'testFixtures("...")' is a shorthand for 'requireCapabilities("...-test-fixtures")'
        capability == "test-fixtures" -> {
          it.replace("$configuration ", "$configuration testFixtures(") + ")"
        }

        capability != null -> {
          if (it.startsWith("$configuration ")) {
            it.replace("$configuration ", "$configuration(") +
              ") { capabilities { requireCapabilities('$capability') } }"
          } else {
            "$it { capabilities { requireCapabilities('$capability') } }"
          }
        }

        else -> it
      }
    }

    s.append(text)
  }

  override fun toString(): String {
    error("don't call toString()")
  }

  public companion object {

    @JvmStatic
    public fun annotationProcessor(dependency: String): Dependency {
      return Dependency("annotationProcessor", dependency)
    }

    @JvmStatic
    public fun api(dependency: String): Dependency {
      return Dependency("api", dependency)
    }

    @JvmStatic
    public fun classpath(dependency: String): Dependency {
      return Dependency("classpath", dependency)
    }

    @JvmStatic
    public fun compileOnly(dependency: String): Dependency {
      return Dependency("compileOnly", dependency)
    }

    @JvmStatic
    public fun compileOnlyApi(dependency: String): Dependency {
      return Dependency("compileOnlyApi", dependency)
    }

    @JvmStatic
    public fun implementation(dependency: String): Dependency {
      return Dependency("implementation", dependency)
    }

    @JvmStatic
    public fun runtimeOnly(dependency: String): Dependency {
      return Dependency("runtimeOnly", dependency)
    }

    @JvmStatic
    public fun testCompileOnly(dependency: String): Dependency {
      return Dependency("testCompileOnly", dependency)
    }

    @JvmStatic
    public fun testImplementation(dependency: String): Dependency {
      return Dependency("testImplementation", dependency)
    }

    @JvmStatic
    public fun testRuntimeOnly(dependency: String): Dependency {
      return Dependency("testRuntimeOnly", dependency)
    }

    @JvmStatic
    public fun project(configuration: String, path: String): Dependency {
      return Dependency(configuration, path)
    }

    @JvmStatic
    public fun project(configuration: String, path: String, capability: String): Dependency {
      return Dependency(configuration, path, capability = capability)
    }

    @JvmStatic
    public fun raw(configuration: String, dependency: String): Dependency {
      check(!dependency.contains(":")) { "Not meant for normal dependencies. Was '$dependency'." }
      return Dependency(configuration, dependency)
    }

    @JvmStatic
    public fun versionCatalog(configuration: String, ref: String): Dependency {
      return Dependency(
        configuration = configuration,
        dependency = ref,
        isVersionCatalog = true
      )
    }

    /*
     * Plugin classpaths
     */

    @JvmStatic
    public fun androidPlugin(version: String = "3.6.3"): Dependency {
      return Dependency("classpath", "com.android.tools.build:gradle:$version")
    }
  }
}