Rename new annotation to Poko.Skip

drewhamilton · Dec 12, 2024 · 9f99ea1 · 9f99ea1
1 parent 3d5e80f
commit 9f99ea1
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 37 deletions.
diff --git a/build-support/src/main/java/dev/drewhamilton/poko/build/PokoBuildPlugin.kt b/build-support/src/main/java/dev/drewhamilton/poko/build/PokoBuildPlugin.kt
@@ -109,7 +109,7 @@ class PokoBuildPlugin : Plugin<Project> {
                 buildConfigField("COMPILER_PLUGIN_ARTIFACT", "poko-compiler-plugin")
                 buildConfigField("DEFAULT_POKO_ENABLED", true)
                 buildConfigField("DEFAULT_POKO_ANNOTATION", "dev/drewhamilton/poko/Poko")
-                buildConfigField("SKIPPED_ANNOTATION", "dev/drewhamilton/poko/Skipped")
+                buildConfigField("SKIP_ANNOTATION_SHORT_NAME", "Skip")
             }
         }
     }

diff --git a/poko-annotations/api/poko-annotations.api b/poko-annotations/api/poko-annotations.api
@@ -7,9 +7,9 @@ public abstract interface annotation class dev/drewhamilton/poko/ArrayContentSup
 public abstract interface annotation class dev/drewhamilton/poko/Poko : java/lang/annotation/Annotation {
 }
 
-public abstract interface annotation class dev/drewhamilton/poko/Skipped : java/lang/annotation/Annotation {
+public abstract interface annotation class dev/drewhamilton/poko/Poko$Skip : java/lang/annotation/Annotation {
 }
 
-public abstract interface annotation class dev/drewhamilton/poko/SkippedSupport : java/lang/annotation/Annotation {
+public abstract interface annotation class dev/drewhamilton/poko/SkipSupport : java/lang/annotation/Annotation {
 }
 
diff --git a/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Poko.kt b/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Poko.kt
@@ -22,4 +22,16 @@ package dev.drewhamilton.poko
  */
 @Retention(AnnotationRetention.SOURCE)
 @Target(AnnotationTarget.CLASS)
-public annotation class Poko
+public annotation class Poko {
+
+    /**
+     * Primary constructor properties marked with this annotation will be omitted from generated
+     * `equals`, `hashCode`, and `toString` functions, as if they were not properties.
+     *
+     * This annotation has no effect on properties declared outside the primary constructor.
+     */
+    @SkipSupport
+    @Retention(AnnotationRetention.SOURCE)
+    @Target(AnnotationTarget.PROPERTY)
+    public annotation class Skip
+}
diff --git a/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Skipped.kt b/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Skipped.kt
diff --git a/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/optInAnnotations.kt b/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/optInAnnotations.kt
@@ -1,11 +1,11 @@
 package dev.drewhamilton.poko
 
 /**
- * Denotes an experimental API that enables the ability to skip a Poko class primary constructor property when
- * generating Poko functions.
+ * Denotes an experimental API that enables the ability to skip a Poko class primary constructor
+ * property when generating Poko functions.
  */
 @RequiresOptIn
-public annotation class SkippedSupport
+public annotation class SkipSupport
 
 /**
  * Denotes an API that enables support for array content reading, which is experimental and may

diff --git a/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirCheckersExtension.kt b/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/fir/PokoFirCheckersExtension.kt
@@ -1,6 +1,5 @@
 package dev.drewhamilton.poko.fir
 
-import dev.drewhamilton.poko.BuildConfig.SKIPPED_ANNOTATION
 import org.jetbrains.kotlin.KtFakeSourceElementKind
 import org.jetbrains.kotlin.descriptors.ClassKind
 import org.jetbrains.kotlin.diagnostics.AbstractSourceElementPositioningStrategy
@@ -21,25 +20,21 @@ import org.jetbrains.kotlin.fir.analysis.checkers.hasModifier
 import org.jetbrains.kotlin.fir.analysis.extensions.FirAdditionalCheckersExtension
 import org.jetbrains.kotlin.fir.declarations.FirProperty
 import org.jetbrains.kotlin.fir.declarations.FirRegularClass
-import org.jetbrains.kotlin.fir.declarations.hasAnnotation
 import org.jetbrains.kotlin.fir.declarations.primaryConstructorIfAny
 import org.jetbrains.kotlin.fir.declarations.utils.isData
 import org.jetbrains.kotlin.fir.declarations.utils.isInner
 import org.jetbrains.kotlin.lexer.KtTokens
-import org.jetbrains.kotlin.name.ClassId
 
 internal class PokoFirCheckersExtension(
     session: FirSession,
 ) : FirAdditionalCheckersExtension(session) {
     override val declarationCheckers: DeclarationCheckers =
         object : DeclarationCheckers() {
             override val regularClassCheckers: Set<FirRegularClassChecker> =
-                setOf(PokoFirRegularClassChecker(session))
+                setOf(PokoFirRegularClassChecker)
         }
 
-    private class PokoFirRegularClassChecker(
-        private val session: FirSession,
-    ) : FirRegularClassChecker(
+    private object PokoFirRegularClassChecker : FirRegularClassChecker(
         mppKind = MppCheckerKind.Common,
     ) {
         override fun check(
@@ -73,7 +68,7 @@ internal class PokoFirCheckersExtension(
                     it.source?.kind is KtFakeSourceElementKind.PropertyFromParameter
                 }
                 .filter {
-                    !it.hasAnnotation(ClassId.fromString(SKIPPED_ANNOTATION), session)
+                    matcher.pokoSkipAnnotation(it) == null
                 }
             if (constructorProperties.isEmpty()) {
                 reporter.reportOn(

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
@@ -1,5 +1,6 @@
 package dev.drewhamilton.poko.fir
 
+import dev.drewhamilton.poko.BuildConfig.SKIP_ANNOTATION_SHORT_NAME
 import org.jetbrains.kotlin.fir.FirSession
 import org.jetbrains.kotlin.fir.declarations.FirDeclaration
 import org.jetbrains.kotlin.fir.expressions.FirAnnotation
@@ -8,6 +9,7 @@ import org.jetbrains.kotlin.fir.extensions.FirExtensionSessionComponent.Factory
 import org.jetbrains.kotlin.fir.types.classId
 import org.jetbrains.kotlin.fir.types.coneTypeOrNull
 import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.Name
 
 internal class PokoFirExtensionSessionComponent(
     session: FirSession,
@@ -19,6 +21,15 @@ internal class PokoFirExtensionSessionComponent(
         }
     }
 
+    fun pokoSkipAnnotation(declaration: FirDeclaration): FirAnnotation? {
+        val skipAnnotation = pokoAnnotation.createNestedClassId(
+            name = Name.identifier(SKIP_ANNOTATION_SHORT_NAME),
+        )
+        return declaration.annotations.firstOrNull { firAnnotation ->
+            firAnnotation.classId() == skipAnnotation
+        }
+    }
+
     private fun FirAnnotation.classId(): ClassId? {
         return annotationTypeRef.coneTypeOrNull?.classId
     }

diff --git a/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/ir/PokoMembersTransformer.kt b/poko-compiler-plugin/src/main/kotlin/dev/drewhamilton/poko/ir/PokoMembersTransformer.kt
@@ -1,6 +1,6 @@
 package dev.drewhamilton.poko.ir
 
-import dev.drewhamilton.poko.BuildConfig.SKIPPED_ANNOTATION
+import dev.drewhamilton.poko.BuildConfig.SKIP_ANNOTATION_SHORT_NAME
 import org.jetbrains.kotlin.KtFakeSourceElementKind
 import org.jetbrains.kotlin.backend.common.IrElementTransformerVoidWithContext
 import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
@@ -130,7 +130,11 @@ internal class PokoMembersTransformer(
                 }
             }
             .filter {
-                !it.hasAnnotation(ClassId.fromString(SKIPPED_ANNOTATION))
+                !it.hasAnnotation(
+                    classId = ClassId.fromString(
+                        string = "${pokoAnnotationName}.$SKIP_ANNOTATION_SHORT_NAME"
+                    ),
+                )
             }
         if (properties.isEmpty()) {
             messageCollector.log("No primary constructor properties")

diff --git a/poko-tests-without-k2/src/commonMain/kotlin/poko/SkippedProperty.kt b/poko-tests-without-k2/src/commonMain/kotlin/poko/SkippedProperty.kt
@@ -1,12 +1,11 @@
 package poko
 
 import dev.drewhamilton.poko.Poko
-import dev.drewhamilton.poko.Skipped
-import dev.drewhamilton.poko.SkippedSupport
+import dev.drewhamilton.poko.SkipSupport
 
-@OptIn(SkippedSupport::class)
+@OptIn(SkipSupport::class)
 @Suppress("Unused")
 @Poko class SkippedProperty(
     val id: String,
-    @Skipped val callback: () -> Unit,
+    @Poko.Skip val callback: () -> Unit,
 )
diff --git a/poko-tests/src/commonMain/kotlin/poko/SkippedProperty.kt b/poko-tests/src/commonMain/kotlin/poko/SkippedProperty.kt
@@ -1,12 +1,11 @@
 package poko
 
 import dev.drewhamilton.poko.Poko
-import dev.drewhamilton.poko.Skipped
-import dev.drewhamilton.poko.SkippedSupport
+import dev.drewhamilton.poko.SkipSupport
 
-@OptIn(SkippedSupport::class)
+@OptIn(SkipSupport::class)
 @Suppress("Unused")
 @Poko class SkippedProperty(
     val id: String,
-    @Skipped val callback: () -> Unit,
+    @Poko.Skip val callback: () -> Unit,
 )