Merge pull request #50 from SpineEventEngine/write-settings-task-dependencies

Set dependnecies on `WriteCompilerPluginsSettings` task

Author: alexander-yevsyukov

buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt

@@ -46,12 +46,12 @@ object CoreJvmCompiler {
     /**
      * The version used to in the build classpath.
      */
-    const val dogfoodingVersion = "2.0.0-SNAPSHOT.020"
+    const val dogfoodingVersion = "2.0.0-SNAPSHOT.021"
 
     /**
      * The version to be used for integration tests.
      */
-    const val version = "2.0.0-SNAPSHOT.020"
+    const val version = "2.0.0-SNAPSHOT.021"
 
     /**
      * The ID of the Gradle plugin.

dependencies.md

@@ -43,14 +43,16 @@ import io.spine.tools.core.jvm.gradle.coreJvmOptions
 import io.spine.tools.core.jvm.gradle.generatedGrpcDirName
 import io.spine.tools.core.jvm.gradle.generatedJavaDirName
 import io.spine.tools.core.jvm.gradle.plugins.CompilerConfigPlugin.Companion.VALIDATION_PLUGIN_CLASS
-import io.spine.tools.core.jvm.gradle.plugins.CompilerConfigPlugin.Companion.WRITE_COMPILER_SETTINGS
+import io.spine.tools.core.jvm.gradle.plugins.CompilerConfigPlugin.Companion.WRITE_COMPILER_PLUGINS_SETTINGS
 import io.spine.tools.core.jvm.gradle.settings.CoreJvmCompilerSettings
 import io.spine.tools.core.jvm.marker.MarkerPlugin
 import io.spine.tools.core.jvm.mgroup.MessageGroupPlugin
 import io.spine.tools.core.jvm.signal.SignalPlugin
 import io.spine.tools.core.jvm.signal.rejection.RThrowablePlugin
 import io.spine.tools.core.jvm.uuid.UuidPlugin
 import io.spine.tools.fs.DirectoryName
+import io.spine.tools.gradle.task.JavaTaskName.Companion.processResources
+import io.spine.tools.gradle.task.JavaTaskName.Companion.sourcesJar
 import io.spine.tools.meta.MavenArtifact
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -68,7 +70,7 @@ import io.spine.tools.compiler.plugin.Plugin as CompilerPlugin
  *   2. Configures the Compiler extension of the Gradle project, passing the compiler plugins,
  *      such as [JavaValidationPlugin][io.spine.validation.java.JavaValidationPlugin] and
  *      the plugins introduced by the modules of the CoreJvm Compiler modules.
- *   3. Creates a [WriteCompilerSettings] task for passing configuration to the Compiler, and
+ *   3. Creates a [WriteCompilerPluginsSettings] task for passing configuration to the Compiler, and
  *      links it to the [LaunchSpineCompiler] task.
  *   4. Adds required dependencies.
  */
@@ -93,9 +95,9 @@ internal class CompilerConfigPlugin : Plugin<Project> {
     companion object {
 
         /**
-         * The name of the task for writing the Compiler settings.
+         * The name of the task for writing the settings of CoreJvm Compiler plugins.
          */
-        const val WRITE_COMPILER_SETTINGS = "writeSpineCompilerSettings"
+        const val WRITE_COMPILER_PLUGINS_SETTINGS = "writeSpineCompilerPluginsSettings"
 
         /**
          * The name of the Validation plugin for ProtoData.
@@ -110,14 +112,19 @@ private fun Project.configureCompiler() {
     tasks.withType<LaunchSpineCompiler>().all { task ->
         task.apply {
             dependsOn(writeSettingsTask)
-            setStandardOutput(System.out)
-            setErrorOutput(System.err)
+            standardOutput = System.out
+            errorOutput = System.err
         }
     }
+    // Make `processResources` and `sourceJar` depend on `writeSpineCompilerPluginsSettings`
+    // as demanded by Gradle 9.x. The settings task does not produce resources or sources,
+    // but we want to avoid forcing users set the dependencies manually in their projects.
+    tasks.findByName(processResources.value())?.mustRunAfter(writeSettingsTask)
+    tasks.findByName(sourcesJar.value())?.mustRunAfter(writeSettingsTask)
 }
 
-private fun Project.createWriteSettingsTask(): Provider<WriteCompilerSettings> {
-    val result = tasks.register<WriteCompilerSettings>(WRITE_COMPILER_SETTINGS) {
+private fun Project.createWriteSettingsTask(): Provider<WriteCompilerPluginsSettings> {
+    val result = tasks.register<WriteCompilerPluginsSettings>(WRITE_COMPILER_PLUGINS_SETTINGS) {
         val workingDir = WorkingDirectory(compilerWorkingDir.asFile.toPath())
         val settingsDir = workingDir.settingsDirectory.path.toFile()
         val settingsDirProvider = project.layout.dir(provider { settingsDir })

gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/CompilerConfigPlugin.kt

@@ -40,8 +40,8 @@ import io.spine.tools.core.jvm.comparable.ComparablePlugin
 import io.spine.tools.core.jvm.entity.EntityPlugin
 import io.spine.tools.core.jvm.gradle.CoreJvmOptions
 import io.spine.tools.core.jvm.gradle.coreJvmOptions
-import io.spine.tools.core.jvm.gradle.plugins.WriteCompilerSettings.Companion.JAVA_CODE_STYLE_ID
-import io.spine.tools.core.jvm.gradle.plugins.WriteCompilerSettings.Companion.VALIDATION_SETTINGS_ID
+import io.spine.tools.core.jvm.gradle.plugins.WriteCompilerPluginsSettings.Companion.JAVA_CODE_STYLE_ID
+import io.spine.tools.core.jvm.gradle.plugins.WriteCompilerPluginsSettings.Companion.VALIDATION_SETTINGS_ID
 import io.spine.tools.core.jvm.mgroup.MessageGroupPlugin
 import io.spine.tools.core.jvm.settings.Combined
 import io.spine.tools.core.jvm.settings.signalSettings
@@ -58,15 +58,15 @@ import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
 
 /**
- * A task that writes settings for ProtoData.
+ * A task that writes settings for CoreJvm plugins of the Spine Compiler.
  *
  * The [settingsDir] property defines the directory where settings files for
- * ProtoData plugins are stored.
+ * the CoreJvm Compiler plugins are stored.
  *
- * This task writes settings files for ProtoData components.
+ * This task writes settings files for the CoreJvm plugins to the Compiler.
  */
 @Suppress("unused") // Gradle creates a subtype for this class.
-public abstract class WriteCompilerSettings : DefaultTask() {
+public abstract class WriteCompilerPluginsSettings : DefaultTask() {
 
     @get:OutputDirectory
     public abstract val settingsDir: DirectoryProperty
@@ -83,7 +83,7 @@ public abstract class WriteCompilerSettings : DefaultTask() {
 
     @TaskAction
     @Throws(IOException::class)
-    public fun writeFile() {
+    public fun writeFiles() {
         val dir = settingsDirectory()
         forValidationPlugin(dir)
         forAnnotationPlugin(dir)
@@ -111,9 +111,9 @@ public abstract class WriteCompilerSettings : DefaultTask() {
 
 /**
  * Obtains an instance of [SettingsDirectory] to be used for writing files which
- * points to the directory specified by the [WriteCompilerSettings.settingsDir] property.
+ * points to the directory specified by the [WriteCompilerPluginsSettings.settingsDir] property.
  */
-private fun WriteCompilerSettings.settingsDirectory(): SettingsDirectory {
+private fun WriteCompilerPluginsSettings.settingsDirectory(): SettingsDirectory {
     val dir = project.file(settingsDir)
     dir.mkdirs()
     val settings = SettingsDirectory(dir.toPath())
@@ -126,7 +126,7 @@ private fun WriteCompilerSettings.settingsDirectory(): SettingsDirectory {
  * The settings are taken from McJava extension object and converted to
  * [io.spine.validation.ValidationConfig], which is later written as JSON file.
  */
-private fun WriteCompilerSettings.forValidationPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forValidationPlugin(dir: SettingsDirectory) {
     val compilerSettings = compilerSettings
     val signalSettings = compilerSettings.signalSettings
     val markers = messageMarkers {
@@ -148,7 +148,7 @@ private fun WriteCompilerSettings.forValidationPlugin(dir: SettingsDirectory) {
 private fun Combined.entityOptionsNames(): Iterable<String> =
     entities.optionList.map { it.name }
 
-private fun WriteCompilerSettings.forAnnotationPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forAnnotationPlugin(dir: SettingsDirectory) {
     val annotation = options.annotation
     val proto = settings {
         val javaType = annotation.types
@@ -164,12 +164,12 @@ private fun WriteCompilerSettings.forAnnotationPlugin(dir: SettingsDirectory) {
     dir.write(ApiAnnotationsPlugin.SETTINGS_ID, proto)
 }
 
-private fun WriteCompilerSettings.forEntityPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forEntityPlugin(dir: SettingsDirectory) {
     val entitySettings = compilerSettings.entities
     dir.write(EntityPlugin.SETTINGS_ID, entitySettings)
 }
 
-private fun WriteCompilerSettings.forSignalPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forSignalPlugin(dir: SettingsDirectory) {
     val codegen = compilerSettings.signalSettings
     val signalSettings = signalSettings {
         commands = codegen.commands
@@ -179,22 +179,22 @@ private fun WriteCompilerSettings.forSignalPlugin(dir: SettingsDirectory) {
     dir.write(SignalPlugin.SETTINGS_ID, signalSettings)
 }
 
-private fun WriteCompilerSettings.forMessageGroupPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forMessageGroupPlugin(dir: SettingsDirectory) {
     val groupSettings = compilerSettings.groupSettings
     dir.write(MessageGroupPlugin.SETTINGS_ID, groupSettings)
 }
 
-private fun WriteCompilerSettings.forUuidPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forUuidPlugin(dir: SettingsDirectory) {
     val uuidSettings = compilerSettings.uuids
     dir.write(UuidPlugin.SETTINGS_ID, uuidSettings)
 }
 
-private fun WriteCompilerSettings.forComparablePlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forComparablePlugin(dir: SettingsDirectory) {
     val settings = compilerSettings.comparables
     dir.write(ComparablePlugin.SETTINGS_ID, settings)
 }
 
-private fun WriteCompilerSettings.forStyleFormattingPlugin(dir: SettingsDirectory) {
+private fun WriteCompilerPluginsSettings.forStyleFormattingPlugin(dir: SettingsDirectory) {
     val styleSettings = options.style.get()
     dir.write(JAVA_CODE_STYLE_ID, styleSettings)
 }

…/gradle/plugins/WriteCompilerSettings.kt …/plugins/WriteCompilerPluginsSettings.ktgradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/WriteCompilerSettings.kt renamed to gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/WriteCompilerPluginsSettings.kt gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/WriteCompilerSettings.kt renamed to gradle-plugins/src/main/kotlin/io/spine/tools/core/jvm/gradle/plugins/WriteCompilerPluginsSettings.kt

@@ -88,7 +88,7 @@ internal class CompilerConfigPluginSpec {
 
     @Test
     fun `add a task for passing configuration file`() {
-        val task = project.tasks.withType<WriteCompilerSettings>()
+        val task = project.tasks.withType<WriteCompilerPluginsSettings>()
         task shouldNotBe null
         task.shouldNotBeEmpty()
     }

gradle-plugins/src/test/kotlin/io/spine/tools/core/jvm/gradle/plugins/CompilerConfigPluginSpec.kt

@@ -10,7 +10,7 @@ all modules and does not describe the project structure per-subproject.
  -->
 <groupId>io.spine.tools</groupId>
 <artifactId>core-jvm-compiler</artifactId>
-<version>2.0.0-SNAPSHOT.021</version>
+<version>2.0.0-SNAPSHOT.022</version>
 
 <inceptionYear>2015</inceptionYear>
 
@@ -303,11 +303,6 @@ all modules and does not describe the project structure per-subproject.
     <artifactId>symbol-processing-api</artifactId>
     <version>2.3.0</version>
   </dependency>
-  <dependency>
-    <groupId>com.google.devtools.ksp</groupId>
-    <artifactId>symbol-processing-cmdline</artifactId>
-    <version>2.2.20-2.0.4</version>
-  </dependency>
   <dependency>
     <groupId>com.google.errorprone</groupId>
     <artifactId>error_prone_annotations</artifactId>
@@ -369,17 +364,17 @@ all modules and does not describe the project structure per-subproject.
   <dependency>
     <groupId>io.spine.tools</groupId>
     <artifactId>core-jvm-gradle-plugins</artifactId>
-    <version>2.0.0-SNAPSHOT.020</version>
+    <version>2.0.0-SNAPSHOT.021</version>
   </dependency>
   <dependency>
     <groupId>io.spine.tools</groupId>
     <artifactId>core-jvm-plugins</artifactId>
-    <version>2.0.0-SNAPSHOT.020</version>
+    <version>2.0.0-SNAPSHOT.021</version>
   </dependency>
   <dependency>
     <groupId>io.spine.tools</groupId>
     <artifactId>core-jvm-routing</artifactId>
-    <version>2.0.0-SNAPSHOT.020</version>
+    <version>2.0.0-SNAPSHOT.021</version>
   </dependency>
   <dependency>
     <groupId>io.spine.tools</groupId>

pom.xml

@@ -29,5 +29,5 @@
  *
  * Do not rename this property, as it is also used in the integration tests via its name.
  */
-val coreJvmCompilerVersion by extra("2.0.0-SNAPSHOT.021")
+val coreJvmCompilerVersion by extra("2.0.0-SNAPSHOT.022")
 val versionToPublish by extra(coreJvmCompilerVersion)