refactor: add extension method to retrieve stringified binary name for TypeElement (#7)

Author: LMLiam

gradle.properties

@@ -1,4 +1,4 @@
 kotlin.code.style=official
 group=io.github.eventhorizonlab
-baseVersion=0.1.19
+baseVersion=0.1.20
 org.gradle.jvmargs=-Xmx2g -Dfile.encoding=UTF-8

modules/processor/build.gradle

@@ -29,6 +29,7 @@ dependencies {
     testImplementation 'io.kotest:kotest-framework-engine:6.0.1'
     testImplementation 'io.kotest:kotest-assertions-core:6.0.1'
     testImplementation "dev.zacsweers.kctfork:core:0.8.0"
+    testImplementation "io.mockk:mockk:1.14.5"
 }
 
 var args = [

modules/processor/src/main/kotlin/com/github/eventhorizonlab/spi/ServiceSchemeProcessor.kt

@@ -1,5 +1,6 @@
 package com.github.eventhorizonlab.spi
 
+import com.github.eventhorizonlab.spi.extensions.getStringifiedBinaryName
 import com.google.auto.service.AutoService
 import java.lang.annotation.Repeatable
 import javax.annotation.processing.*
@@ -116,8 +117,8 @@ class ServiceSchemeProcessor : AbstractProcessor() {
 
     private fun addProvider(providerElement: TypeElement, contractElement: TypeElement) {
         val contractCanonical = contractElement.qualifiedName.toString()
-        val contractBinary = processingEnv.elementUtils.getBinaryName(contractElement).toString()
-        val providerBinary = processingEnv.elementUtils.getBinaryName(providerElement).toString()
+        val contractBinary = processingEnv.getStringifiedBinaryName(contractElement)
+        val providerBinary = processingEnv.getStringifiedBinaryName(providerElement)
 
         providers += ProviderInfo(contractCanonical, contractBinary, providerBinary)
     }

modules/processor/src/main/kotlin/com/github/eventhorizonlab/spi/extensions/ProcessingEnvironmentExtensions.kt

@@ -0,0 +1,7 @@
+package com.github.eventhorizonlab.spi.extensions
+
+import javax.annotation.processing.ProcessingEnvironment
+import javax.lang.model.element.TypeElement
+
+internal fun ProcessingEnvironment.getStringifiedBinaryName(type: TypeElement) =
+    elementUtils.getBinaryName(type).toString()

modules/processor/src/test/kotlin/com/github/eventhorizonlab/spi/extensions/ProcessingEnvironmentExtensionsTests.kt

@@ -0,0 +1,84 @@
+package com.github.eventhorizonlab.spi.extensions
+
+import com.tschuchort.compiletesting.KotlinCompilation
+import com.tschuchort.compiletesting.SourceFile
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.datatest.withData
+import io.kotest.matchers.shouldBe
+import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi
+import javax.annotation.processing.AbstractProcessor
+import javax.annotation.processing.ProcessingEnvironment
+import javax.annotation.processing.RoundEnvironment
+import javax.lang.model.element.TypeElement
+
+@OptIn(ExperimentalCompilerApi::class)
+class ProcessingEnvironmentExtensionsTests : FunSpec({
+
+    data class Case(
+        val description: String,
+        val source: SourceFile,
+        val fqName: String,
+        val expectedBinaryName: String
+    )
+
+    val cases = listOf(
+        Case(
+            "Top-level Kotlin class",
+            SourceFile.kotlin("TopLevel.kt", """
+                package com.test
+                class TopLevel
+            """.trimIndent()),
+            fqName = "com.test.TopLevel",
+            expectedBinaryName = "com.test.TopLevel"
+        ),
+        Case(
+            "Nested Kotlin class",
+            SourceFile.kotlin("Outer.kt", """
+                package com.test
+                class Outer {
+                    class Inner
+                }
+            """.trimIndent()),
+            fqName = "com.test.Outer.Inner",
+            expectedBinaryName = $$"com.test.Outer$Inner"
+        ),
+        Case(
+            "Inner (non-static) Java class",
+            SourceFile.java("OuterJava.java", """
+                package com.test;
+                public class OuterJava {
+                    public class InnerJava {}
+                }
+            """.trimIndent()),
+            fqName = "com.test.OuterJava.InnerJava",
+            expectedBinaryName = $$"com.test.OuterJava$InnerJava"
+        )
+    )
+
+    withData(nameFn = { it.description }, cases) { case ->
+        var actual: String? = null
+
+        val processor = object : AbstractProcessor() {
+            override fun init(processingEnv: ProcessingEnvironment) {
+                super.init(processingEnv)
+                val type = processingEnv.elementUtils.getTypeElement(case.fqName)
+                if (type != null) {
+                    actual = processingEnv.getStringifiedBinaryName(type)
+                }
+            }
+            override fun process(
+                annotations: MutableSet<out TypeElement>,
+                roundEnv: RoundEnvironment
+            ) = false
+        }
+
+        val result = KotlinCompilation().apply {
+            sources = listOf(case.source)
+            annotationProcessors = listOf(processor)
+            inheritClassPath = true
+        }.compile()
+
+        result.exitCode shouldBe KotlinCompilation.ExitCode.OK
+        actual shouldBe case.expectedBinaryName
+    }
+})