Rename MessageValidation to CompiledMessage

Author: yevhenii-nadtochii

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

@@ -42,7 +42,7 @@ import io.spine.validate.NonValidated
 import io.spine.validate.Validated
 import io.spine.validate.ValidationError
 import io.spine.validate.ValidationException
-import io.spine.validation.MessageValidation
+import io.spine.validation.CompiledMessage
 import io.spine.validation.java.ValidationCode.Companion.OPTIONAL_ERROR
 import io.spine.validation.java.ValidationCode.Companion.VALIDATE
 import io.spine.validation.java.point.BuildMethodReturnTypeAnnotation
@@ -84,18 +84,18 @@ public class JavaValidationRenderer : JavaRenderer() {
             return
         }
 
-        // `MessageValidation` is created for every message, no matter it has constraints or not.
-        val validations = select(MessageValidation::class.java).all()
+        val allCompiledMessages = select(CompiledMessage::class.java).all()
             .associateWith { sources.javaFileOf(it.type) }
 
         // Adds `validate()` and `implements ValidatableMessage`.
-        validations.forEach { (constraints, file) ->
-            file.addValidationCode(constraints)
+        allCompiledMessages.forEach { (message, file) ->
+            val validationCode = ValidationCode(renderer = this, message, file)
+            validationCode.generate()
         }
 
         // Annotates `build()` and `buildPartial()` methods.
         // Adds invocation of `validate()` in `build()`.
-        validations.values.distinct()
+        allCompiledMessages.values.distinct()
             .forEach {
                 // Though, it seems logical to do this along with adding `validate()`
                 // in the `forEach` above; we cannot do that. Insertion points used
@@ -118,12 +118,6 @@ public class JavaValidationRenderer : JavaRenderer() {
                 it.plugValidationIntoBuild()
             }
     }
-
-    private fun SourceFile<Java>.addValidationCode(validation: MessageValidation) {
-        val rendered = this@JavaValidationRenderer
-        val validationCode = ValidationCode(rendered, validation, this)
-        validationCode.generate()
-    }
 }
 
 private fun SourceFile<Java>.annotateBuildMethod() {
@@ -154,14 +148,14 @@ private fun SourceFile<Java>.plugValidationIntoBuild() {
 }
 
 /**
- * Java code to insert into [Message.Builder.build] method.
+ * Java code to insert into the end of [Message.Builder.build] method.
  *
- * The generated code invokes `validate()` assuming there is a variable called `result`.
- * The variable type is the type of the validated message, holding the value of
- * the message to validate.
+ * The generated code invokes `validate()` method. This code assumes there
+ * is a variable called `result`. The variable type is the type of the validated message,
+ * holding the instance of the message to validate.
  *
- * If the validation constraints do not pass, the generated code would throw
- * a [ValidationException][io.spine.validate.ValidationException].
+ * If one or more validation constraints do not pass, the generated code throws
+ * the [ValidationException][io.spine.validate.ValidationException].
  */
 private fun validateBeforeBuild(): ImmutableList<String> = codeBlock {
     val result = ReadVar<Message>("result")

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

@@ -41,23 +41,23 @@ import io.spine.tools.code.Java
 import io.spine.validate.ConstraintViolation
 import io.spine.validate.ValidatableMessage
 import io.spine.validate.ValidationError
-import io.spine.validation.MessageValidation
+import io.spine.validation.CompiledMessage
 import java.lang.System.lineSeparator
 import java.lang.reflect.Type
 import java.util.*
 
 /**
  * Generates validation code for a given message type specified via
- * [MessageValidation] instance.
+ * [CompiledMessage] instance.
  *
  * Serves as a method object for the [JavaValidationRenderer] passed to the constructor.
  */
 internal class ValidationCode(
     private val renderer: JavaValidationRenderer,
-    private val validation: MessageValidation,
+    private val message: CompiledMessage,
     private val sourceFile: SourceFile<Java>
 ) {
-    private val messageType: TypeName = validation.name
+    private val messageType: TypeName = message.name
 
     /**
      * Generates the code in the linked source file.
@@ -76,7 +76,7 @@ internal class ValidationCode(
 
     private fun handleConstraints() {
         classScope().apply {
-            val constraints = ValidationConstraintsCode.generate(renderer, validation)
+            val constraints = ValidationConstraintsCode.generate(renderer, message)
             add(validateMethod(constraints.codeBlock()))
             add(constraints.supportingMembersCode())
         }

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

@@ -33,7 +33,7 @@ import com.squareup.javapoet.CodeBlock
 import io.spine.protodata.ast.File
 import io.spine.protodata.ast.TypeName
 import io.spine.protodata.java.This
-import io.spine.validation.MessageValidation
+import io.spine.validation.CompiledMessage
 import io.spine.validation.Rule
 import io.spine.validation.java.ValidationCode.Companion.VIOLATIONS
 import java.lang.System.lineSeparator
@@ -49,20 +49,20 @@ internal class ValidationConstraintsCode private constructor(
     private val renderer: JavaValidationRenderer,
 
     /**
-     * The validation rule for which to generate the code.
+     * The compiled message to generate the code for.
      */
-    private val validation: MessageValidation
+    private val message: CompiledMessage
 ) {
 
     /**
      * The name of the message type for which to generate the code.
      */
-    private val messageType: TypeName = validation.name
+    private val messageType: TypeName = message.name
 
     /**
      * The file which declares the message type.
      */
-    private val declaringFile: File = validation.type.file
+    private val declaringFile: File = message.type.file
 
     /**
      * The expression for referencing the message in the code.
@@ -96,7 +96,7 @@ internal class ValidationConstraintsCode private constructor(
     }
 
     private fun generate() {
-        for (rule in validation.ruleList) {
+        for (rule in message.ruleList) {
             addRule(rule)
         }
     }
@@ -126,7 +126,7 @@ internal class ValidationConstraintsCode private constructor(
         /**
          * Creates a new instance with the generated validation constraints code.
          */
-        fun generate(r: JavaValidationRenderer, v: MessageValidation): ValidationConstraintsCode {
+        fun generate(r: JavaValidationRenderer, v: CompiledMessage): ValidationConstraintsCode {
             val result = ValidationConstraintsCode(r, v)
             result.generate()
             return result

java/src/main/kotlin/io/spine/validation/java/point/PrintValidationInsertionPoints.kt

@@ -32,7 +32,7 @@ import io.spine.tools.code.Java
 /**
  * An [InsertionPointPrinter] which adds the [ValidateBeforeReturn] point
  * to all the message types which have an associated
- * [MessageValidation][io.spine.validation.MessageValidation] view.
+ * [CompiledMessage][io.spine.validation.CompiledMessage] view.
  */
 @Suppress("unused") // Accessed via reflection by ProtoData API.
 public class PrintValidationInsertionPoints : InsertionPointPrinter<Java>(

…alidation/MessageValidationRepository.kt …/validation/CompiledMessageRepository.ktmodel/src/main/kotlin/io/spine/validation/MessageValidationRepository.kt renamed to model/src/main/kotlin/io/spine/validation/CompiledMessageRepository.kt model/src/main/kotlin/io/spine/validation/MessageValidationRepository.kt renamed to model/src/main/kotlin/io/spine/validation/CompiledMessageRepository.kt

@@ -32,12 +32,12 @@ import io.spine.protodata.plugin.ViewRepository
 import io.spine.server.route.EventRouting
 
 /**
- * A repository for the [MessageValidationView].
+ * A repository for the [CompiledMessageView].
  *
  * Routes the [TypeDiscovered] events to the view by the type name.
  */
-internal class MessageValidationRepository :
-    ViewRepository<TypeName, MessageValidationView, MessageValidation>() {
+internal class CompiledMessageRepository :
+    ViewRepository<TypeName, CompiledMessageView, CompiledMessage>() {
 
     override fun setupEventRouting(routing: EventRouting<TypeName>) {
         super.setupEventRouting(routing)

…pine/validation/MessageValidationView.kt …/spine/validation/CompiledMessageView.ktmodel/src/main/kotlin/io/spine/validation/MessageValidationView.kt renamed to model/src/main/kotlin/io/spine/validation/CompiledMessageView.kt model/src/main/kotlin/io/spine/validation/MessageValidationView.kt renamed to model/src/main/kotlin/io/spine/validation/CompiledMessageView.kt

@@ -37,18 +37,16 @@ import io.spine.validation.event.MessageWideRuleAdded
 import io.spine.validation.event.SimpleRuleAdded
 
 /**
- * A view which accumulates validation data for a message type.
+ * A view of messages compiled by the validation library.
  *
- * To add more rules to the message validation, emit [SimpleRuleAdded] or
- * [CompositeRuleAdded] events.
+ * This view provides information about the compiled messages and their
+ * validation constraints, if any.
  *
- * Please note, an instance of [MessageValidation] is created as long
- * as a new message is discovered. Thus, [MessageValidation] is always present
- * for all discovered types, even if the discovered type does not have any
- * validation constraints.
+ * To add one or more validation constraints to the message, emit [SimpleRuleAdded]
+ * or [CompositeRuleAdded] events.
  */
-internal class MessageValidationView :
-    View<TypeName, MessageValidation, MessageValidation.Builder>() {
+internal class CompiledMessageView :
+    View<TypeName, CompiledMessage, CompiledMessage.Builder>() {
 
     @Subscribe
     fun on(@External event: TypeDiscovered) = alter {

model/src/main/kotlin/io/spine/validation/ValidationPlugin.kt

@@ -41,7 +41,7 @@ public class ValidationPlugin : Plugin(
     renderers = listOf(),
     views = setOf(),
     viewRepositories = setOf<ViewRepository<*, *, *>>(
-        MessageValidationRepository(),
+        CompiledMessageRepository(),
         RequiredFieldRepository(),
         ValidatedFieldRepository(),
         SetOnceFieldRepository()

…pine/validation/message_validation.proto …/spine/validation/compiled_message.protoproto/context/src/main/proto/spine/validation/message_validation.proto renamed to proto/context/src/main/proto/spine/validation/compiled_message.proto proto/context/src/main/proto/spine/validation/message_validation.proto renamed to proto/context/src/main/proto/spine/validation/compiled_message.proto

@@ -32,17 +32,17 @@ import "spine/options.proto";
 
 option (type_url_prefix) = "type.spine.io";
 option java_package = "io.spine.validation";
-option java_outer_classname = "MessageValidationProto";
+option java_outer_classname = "CompiledMessageProto";
 option java_multiple_files = true;
 
 import "spine/protodata/ast.proto";
 import "spine/validation/rule.proto";
 
-// All the validation rules of a single message type.
-message MessageValidation {
+// A message compiled by the validation library with its validation constraints.
+message CompiledMessage {
     option (entity).kind = PROJECTION;
 
-    // The name of the message type for which validation rules are specified.
+    // The name of the message type.
     protodata.TypeName name = 1;
 
     // Partial information about the type.
@@ -55,7 +55,7 @@ message MessageValidation {
 
     // Validation rules.
     //
-    // All these rules must be met in order for a message to be regarded as valid.
+    // All these rules must be met in order for a message to be valid.
     //
     repeated Rule rule = 3;
 }