Encapsulate forcing all artifacts of a dependency

Author: alexander-yevsyukov

buildSrc/src/main/kotlin/io/spine/dependency/Dependency.kt

@@ -26,6 +26,10 @@
 
 package io.spine.dependency
 
+import org.gradle.api.Project
+import org.gradle.api.artifacts.Configuration
+import org.gradle.api.artifacts.ResolutionStrategy
+
 /**
  * A dependency is a software component we use in a project.
  *
@@ -63,6 +67,19 @@ abstract class Dependency {
     fun artifact(module: String): String = artifacts[module] ?: error(
         "The dependency `${this::class.simpleName}` does not declare a module `$module`."
     )
+
+    /**
+     * Forces all artifacts of this dependency using the given resolution strategy.
+     *
+     * @param project The project in which the artifacts are forced. Used for logging.
+     * @param cfg The configuration for which the artifacts are forced.  Used for logging.
+     * @param rs The resolution strategy which forces the artifacts.
+     */
+    fun forceArtifacts(project: Project, cfg: Configuration, rs: ResolutionStrategy) {
+        artifacts.values.forEach {
+            rs.forceWithLogging(project, cfg, it)
+        }
+    }
 }
 
 /**
@@ -80,3 +97,30 @@ abstract class DependencyWithBom : Dependency() {
      */
     abstract val bom: String
 }
+
+/**
+ * Logs the result of the function using the project logger at `INFO` level.
+ */
+fun Project.log(message: () -> String) {
+    if (logger.isInfoEnabled) {
+        logger.info(message.invoke())
+    }
+}
+
+/**
+ * Returns the suffix of diagnostic messages for this configuration in the given project.
+ */
+fun Configuration.diagSuffix(project: Project): String =
+    "the configuration `$name` in the project: `${project.path}`."
+
+
+private fun ResolutionStrategy.forceWithLogging(
+    project: Project,
+    configuration: Configuration,
+    artifact: String
+) {
+    force(artifact)
+    project.log { "Forced the version of `$artifact` in " + configuration.diagSuffix(project) }
+}
+
+

buildSrc/src/main/kotlin/io/spine/dependency/boms/BomsPlugin.kt

@@ -27,6 +27,8 @@
 package io.spine.dependency.boms
 
 import io.gitlab.arturbosch.detekt.getSupportedKotlinVersion
+import io.spine.dependency.log
+import io.spine.dependency.diagSuffix
 import io.spine.dependency.DependencyWithBom
 import io.spine.dependency.kotlinx.Coroutines
 import io.spine.dependency.lib.Kotlin
@@ -103,9 +105,6 @@ class BomsPlugin : Plugin<Project>  {
     }
 }
 
-private fun Configuration.diagSuffix(project: Project): String =
-    "the configuration `$name` in the project: `${project.path}`."
-
 private fun Configuration.applyBoms(project: Project, deps: List<DependencyWithBom>) {
     deps.forEach { dep ->
         withDependencies {
@@ -134,12 +133,6 @@ private fun ConfigurationContainer.selectKotlinCompilerForDetekt() =
             }
         }
 
-private fun Project.log(message: () -> String) {
-    if (logger.isInfoEnabled) {
-        logger.info(message.invoke())
-    }
-}
-
 private fun isCompilationConfig(name: String) =
     name.contains("compile", ignoreCase = true) &&
             // `compileProtoPath` or `compileTestProtoPath`.
@@ -177,20 +170,14 @@ private fun supportsBom(name: String) =
 private fun Project.forceArtifacts() =
     configurations.all {
         resolutionStrategy {
-            fun forceWithLogging(artifact: String) {
-                force(artifact)
-                log { "Forced the version of `$artifact` in " + this@all.diagSuffix(project) }
-            }
-
-            fun forceAll(artifacts: Map<String, String>) = artifacts.values.forEach { artifact ->
-                forceWithLogging(artifact)
-            }
-
             if (!isDetekt) {
-                forceAll(Kotlin.artifacts)
-                forceAll(Kotlin.StdLib.artifacts)
-                forceAll(Coroutines.artifacts)
-                forceAll(JUnit.Jupiter.artifacts) /*
+                val rs = this@resolutionStrategy
+                val project = this@forceArtifacts
+                val cfg = this@all
+                Kotlin.forceArtifacts(project, cfg, rs)
+                Kotlin.StdLib.forceArtifacts(project, cfg, rs)
+                Coroutines.forceArtifacts(project, cfg, rs)
+                JUnit.Jupiter.forceArtifacts(project, cfg, rs) /*
                     for configurations like `testFixturesCompileProtoPath`.
                  */
             }

tests/build.gradle.kts

@@ -79,9 +79,9 @@ buildscript {
         val logging = io.spine.dependency.local.Logging
         all {
             resolutionStrategy {
-                io.spine.dependency.lib.Kotlin.StdLib.artifacts.values.forEach {
-                    force(it)
-                }
+                val cfg = this@all
+                val rs = this@resolutionStrategy
+                io.spine.dependency.lib.Kotlin.StdLib.forceArtifacts(project, cfg, rs)
                 force(
                     "io.spine:protodata:${protoData.version}",
                     io.spine.dependency.local.Reflect.lib,