Merge branch 'release/0.2.3'

jangalinski · jangalinski · commit c4d4900898c6 · 2025-07-06T16:07:52.000+02:00
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 The one-stop lib for code generation for kotlin (jvm) and code generation testing. Based on [kotlin-poet](https://square.github.io/kotlinpoet/).
 
 [![incubating](https://img.shields.io/badge/lifecycle-INCUBATING-orange.svg)](https://github.com/holisticon#open-source-lifecycle)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.toolisticon.kotlin.generation/kotlin-code-generation/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.toolisticon.kotlin.generation/kotlin-code-generation)
+[![Maven Central Version](https://img.shields.io/maven-central/v/io.toolisticon.kotlin.generation/kotlin-code-generation)](https://central.sonatype.com/artifact/io.toolisticon.kotlin.generation/kotlin-code-generation)
 [![Build Status](https://github.com/toolisticon/kotlin-code-generation/workflows/Development%20branches/badge.svg)](https://github.com/toolisticon/kotlin-code-generation/actions)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/e493c246c3684b95a2ef097ae912d45a)](https://app.codacy.com/gh/toolisticon/kotlin-code-generation/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![codecov](https://codecov.io/gh/toolisticon/kotlin-code-generation/graph/badge.svg?token=kyJ82m5DAT)](https://codecov.io/gh/toolisticon/kotlin-code-generation)
-[![Kotlin](https://img.shields.io/badge/kotlin-2.1.10-blue.svg?logo=kotlin)](http://kotlinlang.org)
+[![Kotlin](https://img.shields.io/badge/kotlin-2.2.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
 [![sponsored](https://img.shields.io/badge/sponsoredBy-Holisticon-RED.svg)](https://holisticon.de/)
 [![javadoc](https://javadoc.io/badge2/io.toolisticon.kotlin.generation/kotlin-code-generation/javadoc.svg)](https://javadoc.io/doc/io.toolisticon.kotlin.generation/kotlin-code-generation)
 
diff --git a/_build/parent/pom.xml b/_build/parent/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-root</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 
diff --git a/_build/report-generator/pom.xml b/_build/report-generator/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-parent</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
diff --git a/_itest/builder-itest/pom.xml b/_itest/builder-itest/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-itest-root</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
   </parent>
 
   <groupId>io.toolisticon.kotlin.generation.itest</groupId>
diff --git a/_itest/pom.xml b/_itest/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-parent</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
     <relativePath>../_build/parent/pom.xml</relativePath>
   </parent>
 
diff --git a/_itest/spi-itest/pom.xml b/_itest/spi-itest/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-itest-root</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
   </parent>
 
   <groupId>io.toolisticon.kotlin.generation.itest</groupId>
diff --git a/kotlin-code-generation-bom/pom.xml b/kotlin-code-generation-bom/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-root</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
   </parent>
 
   <groupId>io.toolisticon.kotlin.generation</groupId>
diff --git a/kotlin-code-generation-test/pom.xml b/kotlin-code-generation-test/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-parent</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
     <relativePath>../_build/parent/pom.xml</relativePath>
   </parent>
 
diff --git a/kotlin-code-generation/pom.xml b/kotlin-code-generation/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.toolisticon.kotlin.generation._</groupId>
     <artifactId>kotlin-code-generation-parent</artifactId>
-    <version>0.2.2</version>
+    <version>0.2.3</version>
     <relativePath>../_build/parent/pom.xml</relativePath>
   </parent>
 
diff --git a/kotlin-code-generation/src/main/kotlin/_types.kt b/kotlin-code-generation/src/main/kotlin/_types.kt
@@ -2,6 +2,7 @@ package io.toolisticon.kotlin.generation
 
 import com.squareup.kotlinpoet.ClassName
 import java.util.function.Supplier
+import kotlin.reflect.KClass
 
 /**
  * Marks a type as capable of building a new product.
@@ -22,6 +23,22 @@ interface WithClassName {
   val className: ClassName
 }
 
+/**
+ * An implementing type can provide a generic value for a tag key.
+ * Behaves as [com.squareup.kotlinpoet.Taggable] but hides the implementation of the tg provider.
+ */
+interface WithTags {
+  /**
+   * @see [com.squareup.kotlinpoet.Taggable.tag]
+   */
+  fun <T : Any> tag(type: KClass<T>): T?
+}
+
+/**
+ * Reified access to [WithTags.tag].
+ */
+inline fun <reified T : Any> WithTags.tag(): T? = tag(T::class)
+
 /**
  * ClassName when used as a file name for fileSpec.
  */
diff --git a/kotlin-code-generation/src/main/kotlin/spec/KotlinFileSpec.kt b/kotlin-code-generation/src/main/kotlin/spec/KotlinFileSpec.kt
@@ -3,6 +3,7 @@ package io.toolisticon.kotlin.generation.spec
 import com.squareup.kotlinpoet.ClassName
 import com.squareup.kotlinpoet.FileSpec
 import io.toolisticon.kotlin.generation.WithClassName
+import io.toolisticon.kotlin.generation.WithTags
 import io.toolisticon.kotlin.generation.poet.FileSpecSupplier
 import kotlin.reflect.KClass
 
@@ -11,7 +12,7 @@ import kotlin.reflect.KClass
  */
 data class KotlinFileSpec(
   private val spec: FileSpec
-) : KotlinGeneratorSpec<KotlinFileSpec, FileSpec, FileSpecSupplier>, KotlinFileSpecSupplier, TaggableSpec, KotlinFileSpecIterable {
+) : KotlinGeneratorSpec<KotlinFileSpec, FileSpec, FileSpecSupplier>, KotlinFileSpecSupplier, WithTags, KotlinFileSpecIterable {
 
   val packageName: String = spec.packageName
   val rootName: String = spec.name
@@ -37,6 +38,7 @@ interface KotlinFileSpecSupplier : KotlinGeneratorSpecSupplier<KotlinFileSpec>,
  * List that contains multiple [KotlinFileSpec]s.
  */
 @JvmInline
+@Suppress("JavaDefaultMethodsNotOverriddenByDelegation")
 value class KotlinFileSpecList(private val fileSpecs: List<KotlinFileSpec>) : List<KotlinFileSpec> by fileSpecs, KotlinFileSpecIterable {
   companion object {
 
diff --git a/kotlin-code-generation/src/main/kotlin/spec/_types.kt b/kotlin-code-generation/src/main/kotlin/spec/_types.kt
@@ -6,25 +6,49 @@ import com.squareup.kotlinpoet.ExperimentalKotlinPoetApi
 import com.squareup.kotlinpoet.TypeSpec
 import io.toolisticon.kotlin.generation.KotlinCodeGeneration
 import io.toolisticon.kotlin.generation.WithClassName
-import io.toolisticon.kotlin.generation.poet.*
+import io.toolisticon.kotlin.generation.WithTags
+import io.toolisticon.kotlin.generation.poet.KDoc
+import io.toolisticon.kotlin.generation.poet.PoetSpec
+import io.toolisticon.kotlin.generation.poet.PoetSpecSupplier
+import io.toolisticon.kotlin.generation.poet.TypeSpecSupplier
 import io.toolisticon.kotlin.generation.support.SUPPRESS_UNUSED
-import kotlin.reflect.KClass
 
+/**
+ * A supplier for Kotlin generator specs, which can be used to provide a spec for code generation.
+ * This is typically used in conjunction with Kotlin generator specifications.
+ */
 interface KotlinGeneratorSpecSupplier<GENERATOR_SPEC> {
   fun spec(): GENERATOR_SPEC
 }
 
+/**
+ * A Kotlin generator specification that provides a code generation spec.
+ * It extends the [PoetSpecSupplier] interface to provide the underlying spec.
+ *
+ * @param SELF The type of the generator spec itself, used for fluent API.
+ * @param SPEC The type of the spec being generated.
+ * @param SUPPLIER The type of the supplier for the spec.
+ */
 sealed interface KotlinGeneratorSpec<SELF : KotlinGeneratorSpec<SELF, SPEC, SUPPLIER>, SPEC : PoetSpec, SUPPLIER : PoetSpecSupplier<SPEC>> : PoetSpecSupplier<SPEC>, KotlinGeneratorSpecSupplier<SELF> {
   override fun spec(): SELF
   val code: String get() = get().toString()
 }
 
+/**
+ * A Kotlin generator type specification that provides a type spec.
+ * It extends the [KotlinGeneratorSpec] interface to provide the underlying type spec.
+ *
+ * @param SELF The type of the generator spec itself, used for fluent API.
+ */
 sealed interface KotlinGeneratorTypeSpec<SELF : KotlinGeneratorTypeSpec<SELF>> : KotlinGeneratorSpec<SELF, TypeSpec, TypeSpecSupplier>, TypeSpecSupplier {
   override fun spec(): SELF
 }
 
+/**
+ * Marks a spec as documentable, meaning it can be documented with KDoc.
+ */
 @ExperimentalKotlinPoetApi
-sealed interface KotlinDocumentableSpec : TaggableSpec {
+sealed interface KotlinDocumentableSpec : WithTags {
   val kdoc: KDoc
 }
 
@@ -41,21 +65,6 @@ fun ToFileTypeSpecSupplier.toFileSpec() = KotlinCodeGeneration.buildFile(classNa
   addType(this@toFileSpec)
 }
 
-/**
- * Marks Spec as [com.squareup.kotlinpoet.Taggable].
- */
-sealed interface TaggableSpec {
-  /**
-   * @see [com.squareup.kotlinpoet.Taggable.tag]
-   */
-  fun <T : Any> tag(type: KClass<T>): T?
-}
-
-/**
- * Reified access to [TaggableSpec.tag].
- */
-inline fun <reified T : Any> TaggableSpec.tag(): T? = tag(T::class)
-
 /**
  * Tags a spec with extra type.
  */
diff --git a/kotlin-code-generation/src/main/kotlin/spi/KotlinCodeGenerationContext.kt b/kotlin-code-generation/src/main/kotlin/spi/KotlinCodeGenerationContext.kt
@@ -1,6 +1,7 @@
 package io.toolisticon.kotlin.generation.spi
 
 import com.squareup.kotlinpoet.ExperimentalKotlinPoetApi
+import io.toolisticon.kotlin.generation.WithTags
 import kotlin.reflect.KClass
 
 /**
@@ -13,7 +14,7 @@ import kotlin.reflect.KClass
  * Hint: for implementing a concrete context, use the [io.toolisticon.kotlin.generation.spi.context.KotlinCodeGenerationContextBase].
  */
 @ExperimentalKotlinPoetApi
-interface KotlinCodeGenerationContext<SELF : KotlinCodeGenerationContext<SELF>> {
+interface KotlinCodeGenerationContext<SELF : KotlinCodeGenerationContext<SELF>> : WithTags {
 
   /**
    * SELF type of the context implementation, used to verify against [io.toolisticon.kotlin.generation.spi.KotlinCodeGenerationSpi.contextType].
@@ -38,6 +39,8 @@ interface KotlinCodeGenerationContext<SELF : KotlinCodeGenerationContext<SELF>>
   fun <PROCESSOR : KotlinCodeGenerationProcessor<CONTEXT, INPUT, BUILDER>, CONTEXT : KotlinCodeGenerationContext<CONTEXT>, INPUT : Any, BUILDER : Any> processors(
     processorType: KClass<PROCESSOR>
   ): List<PROCESSOR> = registry.processors.filterIsInstance(processorType.java)
+
+  override fun <T : Any> tag(type: KClass<T>): T? = null
 }
 
 /**
diff --git a/kotlin-code-generation/src/main/kotlin/spi/KotlinCodeGenerationSpi.kt b/kotlin-code-generation/src/main/kotlin/spi/KotlinCodeGenerationSpi.kt
@@ -1,6 +1,7 @@
 package io.toolisticon.kotlin.generation.spi
 
 import com.squareup.kotlinpoet.ExperimentalKotlinPoetApi
+import io.toolisticon.kotlin.generation.WithTags
 import java.util.function.BiPredicate
 import kotlin.reflect.KClass
 import kotlin.reflect.full.isSubclassOf
@@ -14,7 +15,7 @@ import kotlin.reflect.full.isSubclassOf
  * * [KotlinCodeGenerationProcessor] - visitor pattern to modify spec builders before the spec is build.
  */
 @ExperimentalKotlinPoetApi
-sealed interface KotlinCodeGenerationSpi<CONTEXT : KotlinCodeGenerationContext<CONTEXT>, INPUT : Any> : Comparable<KotlinCodeGenerationSpi<*, *>>, BiPredicate<CONTEXT, Any> {
+sealed interface KotlinCodeGenerationSpi<CONTEXT : KotlinCodeGenerationContext<CONTEXT>, INPUT : Any> : Comparable<KotlinCodeGenerationSpi<*, *>>, BiPredicate<CONTEXT, Any>, WithTags {
   companion object {
     val metaInfServices = "META-INF/services/${KotlinCodeGenerationSpi::class.qualifiedName}"
     const val DEFAULT_ORDER = 0
@@ -57,4 +58,6 @@ sealed interface KotlinCodeGenerationSpi<CONTEXT : KotlinCodeGenerationContext<C
    * @return `true` when the spi shoud be applied.
    */
   override fun test(context: CONTEXT, input: Any): Boolean = context::class.isSubclassOf(contextType) && input::class.isSubclassOf(inputType)
+
+  override fun <T : Any> tag(type: KClass<T>): T? = null
 }
diff --git a/kotlin-code-generation/src/test/kotlin/_test/TestDeclarationFileStrategy.kt b/kotlin-code-generation/src/test/kotlin/_test/TestDeclarationFileStrategy.kt
@@ -1,4 +1,3 @@
-
 package io.toolisticon.kotlin.generation._test
 
 import com.squareup.kotlinpoet.ExperimentalKotlinPoetApi
diff --git a/kotlin-code-generation/src/test/kotlin/spi/KotlinCodeGenerationServiceRepositoryTest.kt b/kotlin-code-generation/src/test/kotlin/spi/KotlinCodeGenerationServiceRepositoryTest.kt
@@ -24,9 +24,7 @@ internal class KotlinCodeGenerationServiceRepositoryTest {
     contextType = TestContext::class,
     inputType = TestInput::class,
   ) {
-    override fun invoke(context: TestContext, input: TestInput): KotlinDataClassSpec {
-      TODO("Not yet implemented")
-    }
+    override fun invoke(context: TestContext, input: TestInput): KotlinDataClassSpec = TODO("Not yet implemented")
 
     override val specType: KClass<KotlinDataClassSpec> = KotlinDataClassSpec::class
 
diff --git a/kotlin-code-generation/src/test/kotlin/spi/KotlinCodeGenerationStrategyListTest.kt b/kotlin-code-generation/src/test/kotlin/spi/KotlinCodeGenerationStrategyListTest.kt
@@ -1,4 +1,3 @@
-
 package io.toolisticon.kotlin.generation.spi
 
 import com.squareup.kotlinpoet.ExperimentalKotlinPoetApi
@@ -16,6 +15,7 @@ import io.toolisticon.kotlin.generation.spi.strategy.executeAll
 import io.toolisticon.kotlin.generation.spi.strategy.executeSingle
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
+import kotlin.reflect.KClass
 
 @OptIn(ExperimentalKotlinPoetApi::class)
 class KotlinCodeGenerationStrategyListTest {
@@ -24,6 +24,8 @@ class KotlinCodeGenerationStrategyListTest {
     override fun invoke(context: EmptyContext, input: InputA): KotlinDataClassSpec = buildDataClass(input.className) {
       input.fields.map { (k, v) -> buildConstructorProperty(k, v) }.forEach(this::addConstructorProperty)
     }
+
+    override fun <T : Any> tag(type: KClass<T>): T? = TODO("Not yet implemented")
   }
 
   class BStrategy : DataClassBStrategy() {
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
 
   <groupId>io.toolisticon.kotlin.generation._</groupId>
   <artifactId>kotlin-code-generation-root</artifactId>
-  <version>0.2.2</version>
+  <version>0.2.3</version>
 
   <name>pom: kotlin-code-generation-root</name>
   <description>Root of kotlin-code-generation</description>
