update to use new Configuration utils, and minor tidying

Author: aSemy

api/dev-publish-plugin.api

@@ -3,8 +3,9 @@ public final class dev/adamko/gradle/dev_publish/DevPublishPlugin : org/gradle/a
 	public static final field DEV_PUB__EXTENSION_NAME Ljava/lang/String;
 	public static final field DEV_PUB__MAVEN_REPO_DIR Ljava/lang/String;
 	public static final field DEV_PUB__MAVEN_REPO_NAME Ljava/lang/String;
-	public static final field DEV_PUB__PUBLICATION_INCOMING_DEPENDENCIES Ljava/lang/String;
-	public static final field DEV_PUB__PUBLICATION_PROVIDED_DEPENDENCIES Ljava/lang/String;
+	public static final field DEV_PUB__PUBLICATION_DEPENDENCIES Ljava/lang/String;
+	public static final field DEV_PUB__PUBLICATION_INCOMING Ljava/lang/String;
+	public static final field DEV_PUB__PUBLICATION_OUTGOING Ljava/lang/String;
 	public fun <init> (Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/file/FileSystemOperations;Lorg/gradle/api/model/ObjectFactory;)V
 	public synthetic fun apply (Ljava/lang/Object;)V
 	public fun apply (Lorg/gradle/api/Project;)V

src/main/kotlin/DevPublishPlugin.kt

@@ -209,7 +209,7 @@ class DevPublishPlugin @Inject constructor(
     }
   }
 
-  /** React to [MavenPublishPlugin], and configure the appropriate tasks */
+  /** React to [LifecycleBasePlugin], and configure the appropriate tasks */
   private fun configureBasePlugin(
     project: Project,
     devPubTasks: DevPublishTasksContainer,
@@ -234,7 +234,8 @@ class DevPublishPlugin @Inject constructor(
 
     const val DEV_PUB__MAVEN_REPO_DIR = "maven-dev"
 
-    const val DEV_PUB__PUBLICATION_INCOMING_DEPENDENCIES = "devPublication"
-    const val DEV_PUB__PUBLICATION_PROVIDED_DEPENDENCIES = "devPublicationElements"
+    const val DEV_PUB__PUBLICATION_DEPENDENCIES = "devPublication"
+    const val DEV_PUB__PUBLICATION_INCOMING = "devPublicationResolvableElements"
+    const val DEV_PUB__PUBLICATION_OUTGOING = "devPublicationConsumableElements"
   }
 }

src/main/kotlin/data/DevPubConfigurationsContainer.kt

@@ -1,10 +1,13 @@
 package dev.adamko.gradle.dev_publish.data
 
-import dev.adamko.gradle.dev_publish.DevPublishPlugin
-import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_PROVIDED_DEPENDENCIES
+import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_DEPENDENCIES
+import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_INCOMING
+import dev.adamko.gradle.dev_publish.DevPublishPlugin.Companion.DEV_PUB__PUBLICATION_OUTGOING
+import dev.adamko.gradle.dev_publish.data.DevPubConfigurationsContainer.Attributes.Companion.DEV_PUB_USAGE
 import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
 import dev.adamko.gradle.dev_publish.utils.asConsumer
 import dev.adamko.gradle.dev_publish.utils.asProvider
+import dev.adamko.gradle.dev_publish.utils.forDependencies
 import org.gradle.api.NamedDomainObjectProvider
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.ConfigurationContainer
@@ -28,31 +31,38 @@ abstract class DevPubConfigurationsContainer @Inject constructor(
 
   private val devPubAttributes: Attributes = objects.createConfigurationAttributes()
 
+  private val testMavenPublicationDependencies = configurations.registerPublicationsDependencies()
   val testMavenPublicationConsumer = configurations.registerPublicationsConsumer()
   val testMavenPublicationProvider = configurations.registerPublicationsProvider()
 
   private fun ObjectFactory.createConfigurationAttributes(): Attributes {
     // register the attribute for consuming/providing
-    dependencies.attributesSchema.attribute(Attributes.DEV_PUB_USAGE)
-
+    dependencies.attributesSchema.attribute(DEV_PUB_USAGE)
     return newInstance<Attributes>()
   }
 
-  private fun ConfigurationContainer.registerPublicationsConsumer(): NamedDomainObjectProvider<Configuration> {
-    return register(DevPublishPlugin.DEV_PUB__PUBLICATION_INCOMING_DEPENDENCIES) {
+  private fun ConfigurationContainer.registerPublicationsDependencies(): NamedDomainObjectProvider<Configuration> =
+    register(DEV_PUB__PUBLICATION_DEPENDENCIES) {
+      description = "Declare dependencies on test Maven Publications"
+      forDependencies()
+      attributes { attribute(DEV_PUB_USAGE, devPubAttributes.mavenRepoUsage) }
+    }
+
+  private fun ConfigurationContainer.registerPublicationsConsumer(): NamedDomainObjectProvider<Configuration> =
+    register(DEV_PUB__PUBLICATION_INCOMING) {
+      description = "Resolve test Maven Publications"
       asConsumer()
-      attributes { attribute(Attributes.DEV_PUB_USAGE, devPubAttributes.mavenRepoUsage) }
+      attributes { attribute(DEV_PUB_USAGE, devPubAttributes.mavenRepoUsage) }
+      extendsFrom(testMavenPublicationDependencies.get())
     }
-  }
 
-  private fun ConfigurationContainer.registerPublicationsProvider(): NamedDomainObjectProvider<Configuration> {
-    return register(DEV_PUB__PUBLICATION_PROVIDED_DEPENDENCIES) {
-      description = "Provide test Maven Publications to other subprojects"
+  private fun ConfigurationContainer.registerPublicationsProvider(): NamedDomainObjectProvider<Configuration> =
+    register(DEV_PUB__PUBLICATION_OUTGOING) {
+      description = "Provide test Maven Publications"
       asProvider()
-      extendsFrom(testMavenPublicationConsumer.get())
-      attributes { attribute(Attributes.DEV_PUB_USAGE, devPubAttributes.mavenRepoUsage) }
+      attributes { attribute(DEV_PUB_USAGE, devPubAttributes.mavenRepoUsage) }
+      extendsFrom(testMavenPublicationDependencies.get())
     }
-  }
 
   /**
    * Gradle [Configuration] Attributes for sharing files across subprojects.
@@ -61,11 +71,9 @@ abstract class DevPubConfigurationsContainer @Inject constructor(
    */
   @DevPublishInternalApi
   abstract class Attributes
-  @Inject
-  constructor(
+  @Inject constructor(
     objects: ObjectFactory,
   ) {
-
     /** Indicates a [Configuration] contains a Maven Repository */
     val mavenRepoUsage: MavenPublishTestUsage = objects.named("maven-repository")
 
@@ -76,8 +84,8 @@ abstract class DevPubConfigurationsContainer @Inject constructor(
     companion object {
       val DEV_PUB_USAGE = Attribute<MavenPublishTestUsage>("dev.adamko.gradle.dev_publish.usage")
 
-      private inline fun <reified T> Attribute(name: String): Attribute<T> =
-        Attribute.of(name, T::class.java)
+      /** Instantiate a new [Attribute] of type [T] */
+      private inline fun <reified T> Attribute(name: String): Attribute<T> = Attribute.of(name, T::class.java)
     }
   }
 

src/main/kotlin/services/DevPublishService.kt

@@ -15,7 +15,7 @@ import javax.inject.Inject
  * Utility service for managing [dev.adamko.gradle.dev_publish.DevPublishPlugin] operations.
  *
  * This service is primarily used to ensure that [org.gradle.api.publish.maven.tasks.PublishToMavenRepository] tasks
- * do not run concurrently (via [org.gradle.api.services.BuildServiceSpec.getMaxParallelUsages], allowing for published
+ * do not run concurrently (via [org.gradle.api.services.BuildServiceSpec.getMaxParallelUsages]), allowing for published
  * files to be accurately captured and synced to the maven-dev repository.
  */
 @DevPublishInternalApi

src/main/kotlin/tasks/DevPublishTasksContainer.kt

@@ -17,16 +17,19 @@ abstract class DevPublishTasksContainer @Inject constructor(
   private val objects: ObjectFactory,
 ) {
 
-  val publishAllToDevRepo = tasks.registerPublishAllToDevRepoTask(devPubExtension)
-  val generatePublicationChecksum = tasks.registerGeneratePublicationChecksumTask(devPubExtension)
-  val updateDevRepo = tasks.registerUpdateDevRepoTask(devPubExtension)
+  val publishAllToDevRepo: TaskProvider<BaseDevPublishTask> =
+    tasks.registerPublishAllToDevRepoTask(devPubExtension)
+  val generatePublicationChecksum: TaskProvider<GeneratePublicationDataChecksumTask> =
+    tasks.registerGeneratePublicationChecksumTask(devPubExtension)
+  val updateDevRepo: TaskProvider<UpdateDevRepoTask> =
+    tasks.registerUpdateDevRepoTask(devPubExtension)
 
   private fun TaskContainer.registerPublishAllToDevRepoTask(
     devPubExtension: DevPublishPluginExtension,
   ): TaskProvider<BaseDevPublishTask> =
     register<BaseDevPublishTask>(PUBLISH_ALL_TO_DEV_REPO_TASK_NAME) {
       description = "Publishes all Maven publications to the dev Maven repository. " +
-          "This is an internal task that should not typically be referenced or called."
+          "This is an internal task that should not typically be manually referenced or called."
 
       outputs.dir(devPubExtension.stagingDevMavenRepo)
 
@@ -43,7 +46,7 @@ abstract class DevPublishTasksContainer @Inject constructor(
   ): TaskProvider<GeneratePublicationDataChecksumTask> =
     register<GeneratePublicationDataChecksumTask>(GENERATE_PUBLICATION_CHECKSUM_TASK) {
       description = "Generates a checksum from a publication, used for up-to-date checks. " +
-          "This is an internal task that should not typically be referenced or called."
+          "This is an internal task that should not typically be manually referenced or called."
       outputDirectory.convention(devPubExtension.checksumsStore)
       tempDir.convention(objects.directoryProperty().fileValue(temporaryDir))
     }

src/main/kotlin/tasks/GeneratePublicationDataChecksumTask.kt

@@ -52,7 +52,7 @@ constructor(
       writeText(publicationsHash)
     }
 
-    logger.debug(
+    logger.info(
       "created publication data checksum {}: {}",
       file.relativeTo(rootDir),
       file.readText().lines().joinToString(" // ")

src/main/kotlin/utils/gradleUtils.kt

@@ -10,30 +10,53 @@ import org.gradle.api.file.RelativePath
  * ```
  * isCanBeResolved = false
  * isCanBeConsumed = true
+ * isCanBeDeclared = false
  * ```
  */
 internal fun Configuration.asProvider(
   visible: Boolean = true
 ) {
   isCanBeResolved = false
   isCanBeConsumed = true
+  isCanBeDeclared = false
   isVisible = visible
 }
 
 
 /**
- * Mark this [Configuration] as one that will consume artifacts from other subprojects (also known as 'resolving')
+ * Mark this [Configuration] as one that will fetch artifacts (also known as 'resolving').
  *
  * ```
  * isCanBeResolved = true
  * isCanBeConsumed = false
+ * isCanBeDeclared = false
  * ```
  * */
 internal fun Configuration.asConsumer(
   visible: Boolean = false
 ) {
   isCanBeResolved = true
   isCanBeConsumed = false
+  isCanBeDeclared = false
+  isVisible = visible
+}
+
+
+/**
+ * Mark this [Configuration] for declaring dependencies in the `dependencies {}` block.
+ *
+ * ```
+ * isCanBeResolved = false
+ * isCanBeConsumed = false
+ * isCanBeDeclared = true
+ * ```
+ * */
+internal fun Configuration.forDependencies(
+  visible: Boolean = false
+) {
+  isCanBeResolved = false
+  isCanBeConsumed = false
+  isCanBeDeclared = true
   isVisible = visible
 }
 

src/main/kotlin/utils/md5.kt

@@ -9,14 +9,7 @@ import java.math.BigInteger
 import java.security.DigestOutputStream
 import java.security.MessageDigest
 
-//import java.io.SequenceInputStream
-//import java.util.*
-
-
 internal fun File.md5(): String = if (exists()) inputStream().md5() else "missing"
-//internal fun ByteArray.md5(): String = inputStream().md5()
-//internal fun Iterable<File>.md5(): String =
-//  SequenceInputStream(toEnumeration { it.inputStream() }).md5()
 
 private fun InputStream.md5(): String {
   val md5 = messageDigestMd5()
@@ -37,13 +30,3 @@ private fun InputStream.md5(): String {
 }
 
 private fun messageDigestMd5(): MessageDigest = MessageDigest.getInstance("MD5")
-
-//private fun <T, R> Iterable<T>.toEnumeration(
-//  convert: (T) -> R,
-//): Enumeration<R> {
-//  val iterator = iterator()
-//  return object : Enumeration<R> {
-//    override fun hasMoreElements(): Boolean = iterator.hasNext()
-//    override fun nextElement(): R = convert(iterator.next())
-//  }
-//}