Merge pull request #67 from SpineEventEngine/new-validaation-settings

Add `RequiredIdOptionReaction` and `RequiredIdPatternCreation` from Validation

Author: alexander-yevsyukov

base/build.gradle.kts

@@ -63,7 +63,7 @@ dependencies {
     val apiDeps = arrayOf(
         Compiler.api,
         Compiler.jvm,
-        Validation.configuration,
+        Validation.context,
         ToolBase.classicCodegen,
         ToolBase.pluginBase,
         ToolBase.protobufSetupPlugins,
@@ -94,6 +94,9 @@ dependencies {
         // Expose using API level for the submodules.
         testFixturesApi(it)
     }
+    testFixturesImplementation(Validation.java)?.because(
+        "We apply `JavaValidationPlugin` before a plugin under a test in `PluginTestSetup`."
+    )
 
     testImplementation(TestLib.lib)
     testImplementation(gradleTestKit())

base/src/main/kotlin/io/spine/tools/core/jvm/field/RequiredIdReaction.kt

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2025, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.spine.tools.core.jvm.field
+
+import io.spine.option.OptionsProto
+import io.spine.server.event.NoReaction
+import io.spine.server.event.asA
+import io.spine.server.tuple.EitherOf2
+import io.spine.tools.compiler.ast.Field
+import io.spine.tools.compiler.ast.event.TypeDiscovered
+import io.spine.tools.compiler.ast.findOption
+import io.spine.tools.compiler.ast.ref
+import io.spine.tools.compiler.plugin.Reaction
+import io.spine.tools.validation.event.RequiredFieldDiscovered
+import io.spine.tools.validation.event.requiredFieldDiscovered
+import io.spine.tools.validation.option.required.RequiredFieldSupport.isSupported
+
+/**
+ * An abstract base for reactions that control whether an ID field
+ * should be implicitly validated as required.
+ *
+ * The ID of a signal message or an entity state is the first field
+ * declared in the type, disregarding the index of the proto field.
+ *
+ * The ID field is assumed as required for commands and entity states,
+ * unless it is specifically marked otherwise using the field options.
+ *
+ * Implementations define the ways of discovering signal and entity
+ * state messages.
+ */
+public abstract class RequiredIdReaction : Reaction<TypeDiscovered>() {
+
+    /**
+     * Controls whether the given ID [field] should be implicitly validated
+     * as required.
+     *
+     * The method emits [RequiredFieldDiscovered] event if the following
+     * conditions are met:
+     *
+     * 1. The field does not have the `(required)` option specified explicitly.
+     *   If it has, the field is handled by
+     *   `io.spine.tools.validation.option.required.RequiredReaction` of
+     *   the Validation Compiler.
+     *
+     * 2. The field type is supported by the option.
+     *
+     * The method emits [NoReaction] in case of violation of the above conditions.
+     *
+     * @param field The ID field.
+     * @param message The error message for the violation.
+     */
+    @Suppress("ReturnCount") // Prefer sooner exit and precise conditions.
+    protected fun withField(
+        field: Field,
+        message: String
+    ): EitherOf2<RequiredFieldDiscovered, NoReaction> {
+        val requiredOption = field.findOption(OptionsProto.required)
+        if (requiredOption != null) {
+            return ignore()
+        }
+
+        val fieldTypeUnsupported = field.type.isSupported().not()
+        if (fieldTypeUnsupported) {
+            return ignore()
+        }
+
+        return requiredFieldDiscovered {
+            id = field.ref
+            defaultErrorMessage = message
+            subject = field
+        }.asA()
+    }
+}

base/src/testFixtures/kotlin/io/spine/tools/core/java/PluginTestSetup.kt

@@ -47,6 +47,7 @@ import io.spine.format.Format
 import io.spine.tools.code.Java
 import io.spine.tools.code.SourceSetName
 import io.spine.tools.core.jvm.gradle.settings.CoreJvmCompilerSettings
+import io.spine.tools.validation.java.JavaValidationPlugin
 import io.spine.type.toJson
 import java.nio.file.Path
 import kotlin.io.path.exists
@@ -128,6 +129,9 @@ abstract class PluginTestSetup<S: Message>(
         val setup = byResources(
             params = params,
             plugins = listOf(
+                // Apply the Java Validation plugin first to ensure
+                // that custom validations are handled by the Validation backend.
+                JavaValidationPlugin(),
                 plugin,
                 // We want to be able to see the code in debug formatted for easier reading.
                 JavaCodeStyleFormatterPlugin()

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

@@ -36,7 +36,7 @@ object Validation {
     /**
      * The version of the Validation library artifacts.
      */
-    const val version = "2.0.0-SNAPSHOT.375"
+    const val version = "2.0.0-SNAPSHOT.378"
 
     /**
      * The last version of Validation compatible with ProtoData.
@@ -62,5 +62,5 @@ object Validation {
     const val model = "$group:$prefix-model:$version"
 
     const val configModule = "$group:$prefix-configuration"
-    const val configuration = "$configModule:$version"
+    const val context = "$group:$prefix-context:$version"
 }

buildSrc/src/main/kotlin/io/spine/gradle/publish/ProtoExts.kt

@@ -35,11 +35,15 @@ import org.gradle.api.file.SourceDirectorySet
 import org.gradle.api.tasks.bundling.Jar
 
 /**
- * Tells whether there are any Proto sources in "main" source set.
+ * Tells whether there are any Proto sources in the "main" source set.
  */
-internal fun Project.hasProto(): Boolean {
+fun Project.hasProto(): Boolean {
     val protoSources = protoSources()
-    val result = protoSources.any { it.exists() }
+    val result = protoSources.any {
+        it.exists()
+                && it.isDirectory
+                && it.listFiles()?.isNotEmpty() ?: false
+    }
     return result
 }
 

buildSrc/src/main/kotlin/io/spine/gradle/publish/PublishingExts.kt

@@ -36,6 +36,7 @@ import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.publish.PublicationContainer
 import org.gradle.api.publish.PublishingExtension
+import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.tasks.TaskContainer
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.bundling.Jar
@@ -231,7 +232,7 @@ fun TaskContainer.excludeGoogleProtoFromArtifacts() {
  * Java and Kotlin sources are default to `main` source set since it is created by `java` plugin.
  * For Proto sources to be included – [special treatment][protoSources] is needed.
  */
-internal fun Project.sourcesJar(): TaskProvider<Jar> = tasks.getOrCreate("sourcesJar") {
+fun Project.sourcesJar(): TaskProvider<Jar> = tasks.getOrCreate("sourcesJar") {
     dependOnGenerateProto()
     archiveClassifier.set("sources")
     from(sourceSets["main"].allSource) // Puts Java and Kotlin sources.
@@ -245,7 +246,7 @@ internal fun Project.sourcesJar(): TaskProvider<Jar> = tasks.getOrCreate("source
  * The output of this task is a `jar` archive. The archive contains only
  * [Proto sources][protoSources] from `main` source set.
  */
-internal fun Project.protoJar(): TaskProvider<Jar> = tasks.getOrCreate("protoJar") {
+fun Project.protoJar(): TaskProvider<Jar> = tasks.getOrCreate("protoJar") {
     dependOnGenerateProto()
     archiveClassifier.set("proto")
     from(protoSources())
@@ -317,3 +318,20 @@ internal fun Project.artifacts(jarFlags: JarFlags): Set<TaskProvider<Jar>> {
 
     return tasks
 }
+
+/**
+ * Adds the source code and documentation JARs to the publication.
+ */
+@Suppress("unused")
+fun MavenPublication.addSourceAndDocJars(project: Project) {
+    val tasks = mutableSetOf<TaskProvider<Jar>>()
+    tasks.add(project.sourcesJar())
+    tasks.add(project.javadocJar())
+    tasks.add(project.htmlDocsJar())
+    if (project.hasProto()) {
+        tasks.add(project.protoJar())
+    }
+    tasks.forEach {
+        artifact(it)
+    }
+}

buildSrc/src/main/kotlin/module.gradle.kts

@@ -195,7 +195,6 @@ fun Module.forceConfigurations() {
                         Validation.runtime,
                         Validation.java,
                         Validation.javaBundle,
-                        Validation.configuration
                     )
                 }
             }