Move PokoBuilder to standalone annotation class

drewhamilton · Dec 23, 2024 · a72de0c · a72de0c
1 parent 82754ac
commit a72de0c
Show file tree

Hide file tree

Showing 12 changed files with 49 additions and 32 deletions.
diff --git a/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/PokoAnnotationNames.kt b/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/PokoAnnotationNames.kt
@@ -3,7 +3,6 @@ package dev.drewhamilton.poko
 import org.jetbrains.kotlin.name.Name
 
 internal object PokoAnnotationNames {
-    val Builder = Name.identifier("Builder")
     val ReadArrayContent = Name.identifier("ReadArrayContent")
     val Skip = Name.identifier("Skip")
 }
diff --git a/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/PokoCompilerPluginRegistrar.kt b/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/PokoCompilerPluginRegistrar.kt
@@ -38,7 +38,11 @@ public class PokoCompilerPluginRegistrar : CompilerPluginRegistrar() {
         IrGenerationExtension.registerExtension(GeneratedDeclarationsIrBodyFiller())
 
         FirExtensionRegistrarAdapter.registerExtension(
-            PokoFirExtensionRegistrar(pokoAnnotationClassId)
+            PokoFirExtensionRegistrar(
+                pokoAnnotation = pokoAnnotationClassId,
+                // TODO: Make this configurable
+                pokoBuilderAnnotation = ClassId.fromString("dev/drewhamilton/poko/PokoBuilder"),
+            )
         )
     }
 }
diff --git a/...src/main/kotlin/dev/drewhamilton/poko/builder/BuilderFirDeclarationGenerationExtension.kt b/...src/main/kotlin/dev/drewhamilton/poko/builder/BuilderFirDeclarationGenerationExtension.kt
@@ -1,6 +1,5 @@
 package dev.drewhamilton.poko.builder
 
-import dev.drewhamilton.poko.PokoAnnotationNames
 import dev.drewhamilton.poko.fir.constructorProperties
 import dev.drewhamilton.poko.fir.pokoFirExtensionSessionComponent
 import dev.drewhamilton.poko.unSpecial
@@ -63,7 +62,7 @@ internal class BuilderFirDeclarationGenerationExtension(
     private val pokoBuilderClasses by lazy {
         session.predicateBasedProvider.getSymbolsByPredicate(pokoBuilderAnnotationPredicate)
             .filterIsInstance<FirRegularClassSymbol>()
-            .associateBy { it.classId.createNestedClassId(PokoAnnotationNames.Builder) }
+            .associateBy { it.classId.createNestedClassId(BuilderClassName) }
     }
 
     override fun FirDeclarationPredicateRegistrar.registerPredicates() {
@@ -87,7 +86,7 @@ internal class BuilderFirDeclarationGenerationExtension(
         classSymbol: FirClassSymbol<*>,
         context: NestedClassGenerationContext,
     ): Set<Name> = when {
-        classSymbol in pokoBuilderClasses.values -> setOf(PokoAnnotationNames.Builder)
+        classSymbol in pokoBuilderClasses.values -> setOf(BuilderClassName)
         else -> emptySet()
     }
 
@@ -97,7 +96,7 @@ internal class BuilderFirDeclarationGenerationExtension(
         context: NestedClassGenerationContext,
     ): FirClassLikeSymbol<*>? {
         return when (name) {
-            PokoAnnotationNames.Builder -> {
+            BuilderClassName -> {
                 if (owner !in pokoBuilderClasses.values) return null
                 createNestedClass(
                     owner = owner,
@@ -227,6 +226,10 @@ internal class BuilderFirDeclarationGenerationExtension(
         return fir.declarations.constructorProperties()
     }
 
+    private companion object {
+        private val BuilderClassName = Name.identifier("Builder")
+    }
+
     internal object Key : GeneratedDeclarationKey() {
         override fun toString() = "Poko BuilderFirDeclarationGenerationExtension.Key"
     }

diff --git a/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirExtensionRegistrar.kt b/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirExtensionRegistrar.kt
@@ -6,9 +6,10 @@ import org.jetbrains.kotlin.name.ClassId
 
 internal class PokoFirExtensionRegistrar(
     private val pokoAnnotation: ClassId,
+    private val pokoBuilderAnnotation: ClassId,
 ) : FirExtensionRegistrar() {
     override fun ExtensionRegistrarContext.configurePlugin() {
-        +PokoFirExtensionSessionComponent.getFactory(pokoAnnotation)
+        +PokoFirExtensionSessionComponent.getFactory(pokoAnnotation, pokoBuilderAnnotation)
         +::PokoFirCheckersExtension
         +::BuilderFirDeclarationGenerationExtension
     }

diff --git a/...iler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirExtensionSessionComponent.kt b/...iler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirExtensionSessionComponent.kt
@@ -9,18 +9,19 @@ import org.jetbrains.kotlin.name.ClassId
 internal class PokoFirExtensionSessionComponent(
     session: FirSession,
     internal val pokoAnnotation: ClassId,
+    internal val pokoBuilderAnnotation: ClassId,
 ) : FirExtensionSessionComponent(session) {
 
-    internal val pokoBuilderAnnotation: ClassId =
-        pokoAnnotation.createNestedClassId(PokoAnnotationNames.Builder)
-
     internal val pokoSkipAnnotation: ClassId =
         pokoAnnotation.createNestedClassId(PokoAnnotationNames.Skip)
 
     internal companion object {
-        internal fun getFactory(pokoAnnotation: ClassId): Factory {
+        internal fun getFactory(
+            pokoAnnotation: ClassId,
+            pokoBuilderAnnotation: ClassId,
+        ): Factory {
             return Factory { session ->
-                PokoFirExtensionSessionComponent(session, pokoAnnotation)
+                PokoFirExtensionSessionComponent(session, pokoAnnotation, pokoBuilderAnnotation)
             }
         }
     }

diff --git a/poko-compiler-plugin/src/test/kotlin/dev/drewhamilton/poko/PokoCompilerPluginTest.kt b/poko-compiler-plugin/src/test/kotlin/dev/drewhamilton/poko/PokoCompilerPluginTest.kt
@@ -204,11 +204,11 @@ class PokoCompilerPluginTest(
         assumeTrue(k2) // FIR only works in K2
 
         testCompilation(
-            "api/Buildable", "api/MyData",
-            pokoAnnotationName = "api/MyData",
+            "api/Buildable",
+            "dev/drewhamilton/poko/PokoBuilder",
         ) { result ->
             assertThat(result.messages).all {
-                contains("Buildable.kt:3:1")
+                contains("Buildable.kt:5:1")
                 contains("The Poko Builder feature is incomplete, experimental, and private; your generated builder will not work")
             }
 

diff --git a/poko-compiler-plugin/src/test/resources/api/Buildable.kt b/poko-compiler-plugin/src/test/resources/api/Buildable.kt
@@ -1,6 +1,8 @@
 package api
 
-@MyData.Builder
-@MyData class Buildable(
+import dev.drewhamilton.poko.PokoBuilder
+
+@PokoBuilder
+class Buildable(
     val id: String,
 )
diff --git a/poko-compiler-plugin/src/test/resources/api/MyData.kt b/poko-compiler-plugin/src/test/resources/api/MyData.kt
diff --git a/poko-compiler-plugin/src/test/resources/dev/drewhamilton/poko/PokoBuilder.kt b/poko-compiler-plugin/src/test/resources/dev/drewhamilton/poko/PokoBuilder.kt
@@ -0,0 +1,9 @@
+package dev.drewhamilton.poko
+
+/**
+ * Temporary test class for builder generation.
+ */
+// TODO: Remove when real annotation is available.
+@Retention(AnnotationRetention.SOURCE)
+@Target(AnnotationTarget.CLASS)
+annotation class PokoBuilder
diff --git a/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/PokoBuilder.kt b/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/PokoBuilder.kt
@@ -0,0 +1,9 @@
+package dev.drewhamilton.poko
+
+/**
+ * For testing experimental builder generation.
+ */
+// TODO: Replace with custom annotation
+@Retention(AnnotationRetention.SOURCE)
+@Target(AnnotationTarget.CLASS)
+annotation class PokoBuilder
diff --git a/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/sample/jvm/MyData.kt b/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/sample/jvm/MyData.kt
@@ -5,8 +5,4 @@ package dev.drewhamilton.poko.sample.jvm
  */
 @Retention(AnnotationRetention.SOURCE)
 @Target(AnnotationTarget.CLASS)
-annotation class MyData {
-    @Retention(AnnotationRetention.SOURCE)
-    @Target(AnnotationTarget.CLASS)
-    annotation class Builder
-}
+annotation class MyData
diff --git a/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/sample/jvm/Sample.kt b/sample/jvm/src/main/kotlin/dev/drewhamilton/poko/sample/jvm/Sample.kt
@@ -1,7 +1,9 @@
 package dev.drewhamilton.poko.sample.jvm
 
+import dev.drewhamilton.poko.PokoBuilder
+
 @Suppress("unused")
-@MyData.Builder
+@PokoBuilder
 @MyData class Sample(
     val int: Int,
     val requiredString: String,