Merge pull request #303 from SpineEventEngine/migrate-to-template-string-from-base

Migrate to `TemplateString` from Spine Base

Author: alexander-yevsyukov

build.gradle.kts

@@ -129,6 +129,7 @@ allprojects {
                 Roaster.jdt,
                 Time.lib,
                 Time.javaExtensions,
+                Time.kotlinExtensions,
                 ToolBase.lib,
                 ToolBase.pluginBase,
                 Validation.javaBundle,

buildSrc/src/main/kotlin/PatchGeneratedTemplateString.kt

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2026, 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.
+ */
+
+import org.gradle.api.Project
+import org.gradle.api.Task
+import org.gradle.api.tasks.TaskProvider
+import org.gradle.kotlin.dsl.named
+import org.gradle.kotlin.dsl.register
+
+/**
+ * Registers a `patchGeneratedTemplateString` task in the project, which replaces
+ * references to the legacy `io.spine.validation.TemplateString` class (and its
+ * proto FQN `.spine.validation.TemplateString`) with `io.spine.string.TemplateString`
+ * in the `generated/` sources.
+ *
+ * The task is wired to run after [upstreamTask] (the task that produces the sources
+ * to be patched) and before `compileJava` and `kspKotlin`.
+ *
+ * @param upstreamTask the name of the task whose output should be patched
+ *   (e.g., `generateProto` or `launchSpineCompiler`).
+ */
+fun Project.patchGeneratedTemplateString(upstreamTask: String): TaskProvider<Task> {
+    val patchTask = tasks.register("patchGeneratedTemplateString") {
+        dependsOn(upstreamTask)
+
+        val generatedDir = layout.projectDirectory.dir("generated")
+        inputs.dir(generatedDir).withPropertyName("generatedSources")
+        outputs.dir(generatedDir).withPropertyName("patchedSources")
+
+        doLast {
+            val oldClassRef = "io.spine.validation.TemplateString"
+            val newClassRef = "io.spine.string.TemplateString"
+            val oldProtoRef = ".spine.validation.TemplateString"
+            val newProtoRef = ".spine.string.TemplateString"
+            generatedDir.asFile.walkTopDown()
+                .filter { it.isFile && (it.extension == "java" || it.extension == "kt") }
+                .forEach { file ->
+                    val original = file.readText()
+                    if (original.contains(oldClassRef) || original.contains(oldProtoRef)) {
+                        val patched = original
+                            .replace(oldClassRef, newClassRef)
+                            .replace(oldProtoRef, newProtoRef)
+                        file.writeText(patched)
+                    }
+                }
+        }
+    }
+
+    tasks.named("compileJava") {
+        dependsOn(patchTask)
+    }
+
+    afterEvaluate {
+        tasks.named("kspKotlin") {
+            dependsOn(patchTask)
+        }
+    }
+
+    return patchTask
+}

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

@@ -33,8 +33,8 @@ package io.spine.dependency.local
  */
 @Suppress("ConstPropertyName", "unused")
 object Base {
-    const val version = "2.0.0-SNAPSHOT.387"
-    const val versionForBuildScript = "2.0.0-SNAPSHOT.387"
+    const val version = "2.0.0-SNAPSHOT.389"
+    const val versionForBuildScript = "2.0.0-SNAPSHOT.389"
     const val group = Spine.group
     private const val prefix = "spine"
     const val libModule = "$prefix-base"

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

@@ -46,7 +46,7 @@ object CoreJvmCompiler {
     /**
      * The version used to in the build classpath.
      */
-    const val dogfoodingVersion = "2.0.0-SNAPSHOT.063"
+    const val dogfoodingVersion = "2.0.0-SNAPSHOT.064"
 
     /**
      * The version to be used for integration tests.

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

@@ -40,7 +40,7 @@ import io.spine.dependency.Dependency
 )
 object Time : Dependency() {
     override val group = Spine.group
-    override val version = "2.0.0-SNAPSHOT.238"
+    override val version = "2.0.0-SNAPSHOT.240"
     private const val infix = "spine-time"
 
     fun lib(version: String): String = "$group:$infix:$version"

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.415"
+    const val version = "2.0.0-SNAPSHOT.419"
 
     /**
      * The last version of Validation compatible with ProtoData.

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

@@ -170,6 +170,8 @@ fun Module.forceConfigurations() {
                     Base.environment,
                     Protobuf.compiler,
                     Time.lib,
+                    Time.javaExtensions,
+                    Time.kotlinExtensions,
                     TestLib.lib,
                     ToolBase.gradlePluginApi,
                     ToolBase.jvmTools,

context/build.gradle.kts

@@ -65,3 +65,5 @@ afterEvaluate {
     val launchSpineCompiler by tasks.getting
     kspKotlin.dependsOn(launchSpineCompiler)
 }
+
+patchGeneratedTemplateString(upstreamTask = "launchSpineCompiler")

context/src/main/kotlin/io/spine/tools/validation/ErrorPlaceholder.kt

@@ -34,8 +34,8 @@ import io.spine.tools.compiler.ast.OneofGroup
 import io.spine.tools.compiler.ast.Span
 import io.spine.tools.compiler.ast.qualifiedName
 import io.spine.tools.compiler.check
-import io.spine.validation.ErrorPlaceholder
-import io.spine.validation.extractPlaceholders
+import io.spine.string.Placeholder
+import io.spine.string.Placeholder.Companion.extractPlaceholders
 
 /**
  * Checks if this [String] contains placeholders that are not present in the given
@@ -47,7 +47,7 @@ import io.spine.validation.extractPlaceholders
  * @param option The name of the option with which the message template was specified.
  */
 internal fun String.checkPlaceholders(
-    supported: Set<ErrorPlaceholder>,
+    supported: Set<Placeholder>,
     message: MessageType,
     file: File,
     option: String
@@ -69,7 +69,7 @@ internal fun String.checkPlaceholders(
  * @param option The name of the option with which the message template was specified.
  */
 internal fun String.checkPlaceholders(
-    supported: Set<ErrorPlaceholder>,
+    supported: Set<Placeholder>,
     oneof: OneofGroup,
     file: File,
     option: String
@@ -91,7 +91,7 @@ internal fun String.checkPlaceholders(
  * @param option The name of the option with which the message template was specified.
  */
 public fun String.checkPlaceholders(
-    supported: Set<ErrorPlaceholder>,
+    supported: Set<Placeholder>,
     field: Field,
     file: File,
     option: String
@@ -108,7 +108,7 @@ public fun String.checkPlaceholders(
  * set of the [supported] placeholders, and reports a compilation error if so.
  */
 private fun String.checkPlaceholders(
-    supported: Set<ErrorPlaceholder>,
+    supported: Set<Placeholder>,
     declaration: String,
     span: Span,
     file: File,
@@ -119,7 +119,7 @@ private fun String.checkPlaceholders(
     Compilation.check(missing.isEmpty(), file, span) {
         "The $declaration specifies an error message for the `($option)` option using unsupported" +
                 " placeholders: `$missing`. Supported placeholders are the following:" +
-                " `${supported.map { it.value }}`."
+                " `${supported.map { it.name }}`."
     }
 }
 
@@ -132,13 +132,12 @@ private fun String.checkPlaceholders(
  */
 private fun missingPlaceholders(
     template: String,
-    placeholders: Set<ErrorPlaceholder>
-): Set<String> {
+    placeholders: Set<Placeholder>
+): Set<Placeholder> {
     val requested = extractPlaceholders(template)
-    val provided = placeholders.map { it.value }
-    val missing = mutableSetOf<String>()
+    val missing = mutableSetOf<Placeholder>()
     for (placeholder in requested) {
-        if (!provided.contains(placeholder)) {
+        if (!placeholders.contains(placeholder)) {
             missing.add(placeholder)
         }
     }