Merge pull request #141 from SpineEventEngine/new-field-api

New `Field` API

Author: armiol

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

@@ -37,15 +37,15 @@ object ArtifactVersion {
      *
      * @see <a href="https://github.com/SpineEventEngine/base">spine-base</a>
      */
-    const val base = "2.0.0-SNAPSHOT.215"
-    const val baseForBuildScript = "2.0.0-SNAPSHOT.215"
+    const val base = "2.0.0-SNAPSHOT.217"
+    const val baseForBuildScript = "2.0.0-SNAPSHOT.217"
 
     /**
      * The version of [Spine.reflect].
      *
      * @see <a href="https://github.com/SpineEventEngine/reflect">spine-reflect</a>
      */
-    const val reflect = "2.0.0-SNAPSHOT.190"
+    const val reflect = "2.0.0-SNAPSHOT.191"
 
     /**
      * The version of [Logging].

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

@@ -33,7 +33,7 @@ package io.spine.dependency.local
  */
 @Suppress("ConstPropertyName", "unused")
 object Logging {
-    const val version = "2.0.0-SNAPSHOT.240"
+    const val version = "2.0.0-SNAPSHOT.242"
     const val group = Spine.group
     const val lib = "$group:spine-logging:$version"
     const val libJvm = "$group:spine-logging-jvm:$version"

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

@@ -47,7 +47,7 @@ object McJava {
     /**
      * The version to be used for integration tests.
      */
-    const val version = "2.0.0-SNAPSHOT.248"
+    const val version = "2.0.0-SNAPSHOT.251"
 
     /**
      * The ID of the Gradle plugin.

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

@@ -73,7 +73,7 @@ object ProtoData {
      * The version of ProtoData dependencies.
      */
     val version: String
-    private const val fallbackVersion = "0.64.0"
+    private const val fallbackVersion = "0.65.1"
 
     /**
      * The distinct version of ProtoData used by other build tools.
@@ -82,7 +82,7 @@ object ProtoData {
      * transitional dependencies, this is the version used to build the project itself.
      */
     val dogfoodingVersion: String
-    private const val fallbackDfVersion = "0.64.0"
+    private const val fallbackDfVersion = "0.61.8"
 
     /**
      * The artifact for the ProtoData Gradle plugin.

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

@@ -34,7 +34,7 @@ package io.spine.dependency.local
 @Suppress("ConstPropertyName", "unused")
 object ToolBase {
     const val group = Spine.toolsGroup
-    const val version = "2.0.0-SNAPSHOT.233"
+    const val version = "2.0.0-SNAPSHOT.234"
 
     const val lib = "$group:spine-tool-base:$version"
     const val pluginBase = "$group:spine-plugin-base:$version"

config

@@ -62,15 +62,4 @@ dependencies {
     testImplementation(Kotest.assertions)
 }
 
-// Uncomment the below block when remote debugging of code generation is needed.
-//
-//tasks.findByName("launchProtoData")?.apply {this as JavaExec
-//    debugOptions {
-//        // Set this option to `true` to enable remote debugging.
-//        enabled.set(true)
-//        port.set(5566)
-//        server.set(true)
-//        suspend.set(true)
-//    }
-//    System.err.println("Debug session for `:java-tests:consumer test` configured.")
-//}
+protoDataRemoteDebug(enabled = false)

dependencies.md

@@ -35,11 +35,4 @@ dependencies {
     testImplementation(Logging.lib)
 }
 
-tasks.findByName("launchTestProtoData")?.apply { this as JavaExec
-    debugOptions {
-        enabled.set(false) // Set this option to `true` to enable remote debugging.
-        port.set(5566)
-        server.set(true)
-        suspend.set(true)
-    }
-}
+testProtoDataRemoteDebug(enabled = false)

java-tests/consumer/build.gradle.kts

@@ -30,8 +30,11 @@ import com.google.common.collect.ImmutableList
 import com.google.common.reflect.TypeToken
 import com.squareup.javapoet.CodeBlock
 import io.spine.protodata.ast.Field
+import io.spine.protodata.ast.extractPrimitiveType
+import io.spine.protodata.ast.extractTypeName
 import io.spine.protodata.ast.isMap
-import io.spine.protodata.ast.messageOrEnumName
+import io.spine.protodata.ast.name
+import io.spine.protodata.ast.qualifiedName
 import io.spine.protodata.backend.SecureRandomString
 import io.spine.protodata.java.ClassOrEnumName
 import io.spine.protodata.java.Expression
@@ -101,11 +104,16 @@ internal class DistributingGenerator(
     }
 
     private fun typeName(): ClassOrEnumName {
-        val name = field.type.messageOrEnumName
+        val name = field.type.extractTypeName()
         val typeName = if (name != null) {
             ctx.typeConvention.declarationFor(name).name
         } else {
-            field.type.primitive.toClass()
+            val primitiveType = field.type.extractPrimitiveType()
+            check(primitiveType != null) {
+                "The field `${field.qualifiedName}` is not of" +
+                        " a primitive type (`${field.type.name}`)."
+            }
+            primitiveType.toClass()
         }
         return typeName
     }

java-tests/validation-gen/build.gradle.kts

@@ -27,7 +27,6 @@
 package io.spine.validation.java
 
 import com.google.protobuf.ByteString
-import io.spine.code.java.nameOfPackage
 import io.spine.protodata.ast.PrimitiveType
 import io.spine.protodata.ast.PrimitiveType.PT_UNKNOWN
 import io.spine.protodata.ast.PrimitiveType.TYPE_BOOL

java/src/main/kotlin/io/spine/validation/java/DistributingGenerator.kt

@@ -26,7 +26,7 @@
 
 package io.spine.validation.java
 
-import io.spine.protodata.ast.Field
+import io.spine.protodata.ast.Cardinality.CARDINALITY_SINGLE
 import io.spine.protodata.ast.OneofName
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.Literal
@@ -48,7 +48,7 @@ internal class RequiredOneofGenerator(
 
     override fun condition(): Expression {
         val casePropertyName = "${name.value}_case"
-        val pseudoField = ctx.msg.field(casePropertyName, Field.CardinalityCase.SINGLE)
+        val pseudoField = ctx.msg.field(casePropertyName, CARDINALITY_SINGLE)
         val getter = pseudoField.getter
         val numberGetter = getter.chain("getNumber")
         return Literal("$numberGetter != 0")

java/src/main/kotlin/io/spine/validation/java/PrimitiveTypeExtensions.kt

@@ -1,11 +1,11 @@
 /*
- * Copyright 2023, TeamDev. All rights reserved.
+ * Copyright 2024, 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
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
@@ -30,12 +30,15 @@ import com.squareup.javapoet.CodeBlock
 import io.spine.protodata.ast.Field
 import io.spine.protodata.ast.PrimitiveType.TYPE_BYTES
 import io.spine.protodata.ast.PrimitiveType.TYPE_STRING
-import io.spine.protodata.value.Value
+import io.spine.protodata.ast.Type
+import io.spine.protodata.ast.isList
+import io.spine.protodata.ast.isMap
 import io.spine.protodata.java.ClassName
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.Literal
 import io.spine.protodata.java.call
-import io.spine.protodata.ast.isRepeated
+import io.spine.protodata.value.Value
+import io.spine.string.shortly
 import io.spine.tools.java.codeBlock
 import io.spine.validation.ComparisonOperator.EQUAL
 import io.spine.validation.ComparisonOperator.GREATER_OR_EQUAL
@@ -48,6 +51,7 @@ import io.spine.validation.SimpleRule
 import io.spine.validation.SimpleRule.OperatorKindCase.CUSTOM_OPERATOR
 import io.spine.validation.SimpleRule.OperatorKindCase.OPERATOR
 import io.spine.validation.UnsetValue
+import io.spine.validation.extractType
 import kotlin.jvm.optionals.getOrNull
 
 /**
@@ -103,7 +107,7 @@ internal open class SimpleRuleGenerator(ctx: GenerationContext) : CodeGenerator(
     private fun defaultFieldValue(): Value? = with(ctx) {
         val field = simpleRuleField
         return if (isElement) {
-            UnsetValue.singular(field.type)
+            UnsetValue.singular(field.directOrElementType())
         } else {
             UnsetValue.forField(field)
         }.getOrNull()
@@ -120,17 +124,19 @@ internal open class SimpleRuleGenerator(ctx: GenerationContext) : CodeGenerator(
         checkNotNull(otherValue) {
             "Expected the rule to specify `simple.other_value`, but was: $rule"
         }
-        val type = field.type
+        val type = field.directOrElementType()
         val signs = selectSigns()
         val compare = signs[rule.operator] ?: error(
-            "Unsupported operation `${rule.operator}` for type `$type`."
+            "Unsupported operation `${rule.operator}` for the type `$type`."
         )
-        checkNotNull(ctx.fieldOrElement) { "There is no field value for rule: $rule" }
+        checkNotNull(ctx.fieldOrElement) {
+            "There is no field value for the rule: `${rule.shortly()}`."
+        }
         return Literal(compare(ctx.fieldOrElement!!.toCode(), otherValue.toCode()))
     }
 
     private fun fieldIsJavaObject(): Boolean =
-        !field.isJavaPrimitive() || (field.isRepeated && !ctx.isElement)
+        !field.refersToJavaPrimitive() || ((field.isList || field.isMap) && !ctx.isElement)
 
     private fun selectSigns() = if (fieldIsJavaObject()) {
         OBJECT_COMPARISON_OPS
@@ -154,7 +160,7 @@ internal open class SimpleRuleGenerator(ctx: GenerationContext) : CodeGenerator(
 internal fun generatorForSimple(ctx: GenerationContext): CodeGenerator {
     val distribute = ctx.rule.simple.distribute
     val field = ctx.simpleRuleField
-    return if (distribute && field.isRepeated) {
+    return if (distribute && (field.isList || field.isMap)) {
         DistributingGenerator(ctx) {
             generatorForSingular(it)
         }
@@ -172,12 +178,21 @@ private fun generatorForSingular(ctx: GenerationContext): CodeGenerator {
     }
 }
 
-private fun Field.isJavaPrimitive(): Boolean {
-    if (!type.hasPrimitive()) {
+@Suppress("ReturnCount")
+private fun Field.refersToJavaPrimitive(): Boolean {
+    if (type.isList) {
+        return type.list.isPrimitive
+    }
+    if (type.isMap) {
+        return type.map.valueType.isPrimitive
+    }
+    if (!type.isPrimitive) {
         return false
     }
     return when (type.primitive) {
         TYPE_STRING, TYPE_BYTES -> false
         else -> true
     }
 }
+
+private fun Field.directOrElementType(): Type = type.extractType()

java/src/main/kotlin/io/spine/validation/java/RequiredOneofGenerator.kt

@@ -27,18 +27,20 @@
 package io.spine.validation.java
 
 import com.squareup.javapoet.CodeBlock
-import io.spine.protodata.ast.Field
-import io.spine.protodata.ast.isAny
+import io.spine.protodata.ast.Cardinality.CARDINALITY_LIST
+import io.spine.protodata.ast.name
+import io.spine.protodata.ast.qualifiedName
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.Literal
 import io.spine.protodata.java.MessageReference
 import io.spine.protodata.java.MethodCall
-import io.spine.protodata.ast.qualifiedName
 import io.spine.string.titleCase
 import io.spine.tools.java.codeBlock
 import io.spine.validate.ConstraintViolation
 import io.spine.validate.Validate
 import io.spine.validate.ValidationError
+import io.spine.validation.refersToAny
+import io.spine.validation.refersToMessage
 import java.util.*
 
 /**
@@ -53,9 +55,9 @@ internal class ValidateGenerator(ctx: GenerationContext) : SimpleRuleGenerator(c
     init {
         val field = ctx.simpleRuleField
         val fieldType = field.type
-        check(fieldType.hasMessage()) {
+        check(fieldType.refersToMessage()) {
             "The `(validate)` option supports only `Message` types," +
-                    " but the field `${field.qualifiedName}` has the type `$fieldType`."
+                    " but the field `${field.qualifiedName}` has the type `${fieldType.name}`."
         }
     }
 
@@ -69,7 +71,7 @@ internal class ValidateGenerator(ctx: GenerationContext) : SimpleRuleGenerator(c
     }
 
     override fun prologue(): CodeBlock {
-        return if (field.type.isAny) {
+        return if (field.type.refersToAny()) {
             codeBlock {
                 add(unpackAndValidate())
                 add(wrapIntoError())
@@ -83,8 +85,8 @@ internal class ValidateGenerator(ctx: GenerationContext) : SimpleRuleGenerator(c
      * Generates the code obtaining an optional `ValidationError` by invoking Spine-generated
      * `.validate()` method of the validated field.
      *
-     * NOTE: such an approach won't work for the types which code was not generated by Spine, such
-     * as built-in Google Protobuf types.
+     * NOTE: such an approach will not work for the types which code was not generated by Spine,
+     * such as built-in Google Protobuf types.
      *
      * Sample output:
      * ```
@@ -161,7 +163,7 @@ internal class ValidateGenerator(ctx: GenerationContext) : SimpleRuleGenerator(c
     override fun createViolation(): CodeBlock {
         val validationError = MethodCall(validationErrorVar, "get")
         val violations = MessageReference(validationError.toCode())
-            .field("constraint_violation", Field.CardinalityCase.LIST)
+            .field("constraint_violation", CARDINALITY_LIST)
             .getter
         return error().createParentViolation(ctx, violations)
     }

java/src/main/kotlin/io/spine/validation/java/SimpleRuleGenerator.kt

@@ -40,7 +40,7 @@
 import io.spine.validation.event.SimpleRuleAdded;
 
 import static io.spine.protobuf.AnyPacker.unpack;
-import static io.spine.protodata.ast.Fields.isRepeated;
+import static io.spine.protodata.ast.FieldTypeExtsKt.isSingular;
 import static io.spine.protodata.ast.TypeNames.getQualifiedName;
 import static io.spine.util.Exceptions.newIllegalStateException;
 import static io.spine.validation.EventFieldNames.OPTION_NAME;
@@ -54,7 +54,10 @@
  */
 final class DistinctPolicy extends ValidationPolicy<FieldOptionDiscovered> {
 
-    @SuppressWarnings("DuplicateStringLiteralInspection") // Duplicates in generated code.
+    @SuppressWarnings({
+            "DuplicateStringLiteralInspection" /* Duplicates are in the generated code. */,
+            "RedundantSuppression" /* Suppress warning until the code is generated. */
+    })
     private static final String ERROR = "Collection must not contain duplicates.";
 
     @Override
@@ -83,7 +86,7 @@ protected EitherOf2<RuleAdded, NoReaction> whenever(
 
     private void checkCollection(FieldName fieldName, TypeName typeName, File file) {
         var field = findField(fieldName, typeName, file, this);
-        if (!isRepeated(field)) {
+        if (isSingular(field.getType())) {
             throw newIllegalStateException(
                     "The field `%s.%s` is neither a `repeated` nor a `map` and " +
                             "therefore cannot be `(distinct)`.",

java/src/main/kotlin/io/spine/validation/java/ValidateGenerator.kt

@@ -50,14 +50,17 @@ final class RequiredPolicy extends ValidationPolicy<FieldExited> {
     @Override
     @React
     protected EitherOf2<RuleAdded, NoReaction> whenever(@External FieldExited event) {
+        var declaringType = event.getType();
+        var fieldName = event.getField();
         var id = FieldId.newBuilder()
-                .setName(event.getField())
-                .setType(event.getType())
+                .setName(fieldName)
+                .setType(declaringType)
                 .build();
         var field = select(RequiredField.class).findById(id);
         if (field != null && field.getRequired()) {
-            var declaration = findField(event.getField(), event.getType(), event.getFile(), this);
-            return EitherOf2.withA(requiredRule(declaration, field));
+            var declaration = findField(fieldName, declaringType, event.getFile(), this);
+            var rule = requiredRule(declaration, field);
+            return EitherOf2.withA(rule);
         }
         return ignore();
     }