Parsing of JvmName (#1675)

* Parsing of JvmName

* Make JvmName processor run after KaJ

2 files changed, 157 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/content/annotations/ContentForAnnotationsTest.kt b/plugins/base/src/test/kotlin/content/annotations/ContentForAnnotationsTest.kt
index b90c7350..d88d9505 100644
--- a/plugins/base/src/test/kotlin/content/annotations/ContentForAnnotationsTest.kt
+++ b/plugins/base/src/test/kotlin/content/annotations/ContentForAnnotationsTest.kt
@@ -4,10 +4,16 @@ import matchers.content.*
 import org.jetbrains.dokka.pages.ContentPage
 import org.jetbrains.dokka.pages.PackagePageNode
 import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.Annotations
+import org.jetbrains.dokka.model.StringValue
+import org.jetbrains.kotlin.utils.addToStdlib.firstNotNullResult
 import org.junit.jupiter.api.Test
 import utils.ParamAttributes
 import utils.bareSignature
 import utils.propertySignature
+import kotlin.test.assertEquals
+import kotlin.test.assertFalse
 
 
 class ContentForAnnotationsTest : BaseAbstractTest() {
@@ -18,6 +24,7 @@ class ContentForAnnotationsTest : BaseAbstractTest() {
             sourceSet {
                 sourceRoots = listOf("src/")
                 analysisPlatform = "jvm"
+                classpath += jvmStdlibPath!!
             }
         }
     }
@@ -218,4 +225,43 @@ class ContentForAnnotationsTest : BaseAbstractTest() {
             }
         }
     }
+
+    @Test
+    fun `JvmName for property with setter and getter`(){
+        testInline(
+            """
+                |/src/main/kotlin/test/source.kt
+                |package test
+                |@get:JvmName("xd")
+                |@set:JvmName("asd")
+                |var property: String
+                |    get() = ""
+                |    set(value) {}
+            """.trimIndent(), testConfiguration) {
+            documentablesCreationStage = { modules ->
+                fun expectedAnnotation(name: String) = Annotations.Annotation(
+                    dri = DRI("kotlin.jvm", "JvmName"),
+                    params = mapOf("name" to StringValue(name)),
+                    scope = Annotations.AnnotationScope.DIRECT,
+                    mustBeDocumented = false
+                )
+
+                val property = modules.flatMap { it.packages }.flatMap { it.properties }.first()
+                val getterAnnotation = property.getter?.extra?.get(Annotations)?.let {
+                    it.directAnnotations.entries.firstNotNullResult { (_, annotations) -> annotations.firstOrNull() }
+                }
+                val setterAnnotation = property.getter?.extra?.get(Annotations)?.let {
+                    it.directAnnotations.entries.firstNotNullResult { (_, annotations) -> annotations.firstOrNull() }
+                }
+
+                assertEquals(expectedAnnotation("xd"), getterAnnotation)
+                assertFalse(getterAnnotation?.mustBeDocumented!!)
+                assertEquals(Annotations.AnnotationScope.DIRECT, getterAnnotation.scope)
+
+                assertEquals(expectedAnnotation("asd"), setterAnnotation)
+                assertFalse(setterAnnotation?.mustBeDocumented!!)
+                assertEquals(Annotations.AnnotationScope.DIRECT, setterAnnotation.scope)
+            }
+        }
+    }
 }
diff --git a/plugins/base/src/test/kotlin/content/annotations/FileLevelJvmNameTest.kt b/plugins/base/src/test/kotlin/content/annotations/FileLevelJvmNameTest.kt
new file mode 100644
index 00000000..f2fd518c
--- /dev/null
+++ b/plugins/base/src/test/kotlin/content/annotations/FileLevelJvmNameTest.kt
@@ -0,0 +1,111 @@
+package content.annotations
+
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.Annotations
+import org.jetbrains.dokka.model.StringValue
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.ValueSource
+import kotlin.test.assertEquals
+
+class FileLevelJvmNameTest : BaseAbstractTest() {
+    private val testConfiguration = dokkaConfiguration {
+        sourceSets {
+            sourceSet {
+                sourceRoots = listOf("src/")
+                analysisPlatform = "jvm"
+                classpath += jvmStdlibPath!!
+            }
+        }
+    }
+
+    companion object {
+        private const val functionTest =
+            """
+            |/src/main/kotlin/test/source.kt
+            |@file:JvmName("CustomJvmName")
+            |package test
+            |
+            |fun function(abc: String): String {
+            |    return "Hello, " + abc
+            |}
+        """
+
+        private const val extensionFunctionTest =
+            """
+            |/src/main/kotlin/test/source.kt
+            |@file:JvmName("CustomJvmName")
+            |package test
+            |
+            |fun String.function(abc: String): String {
+            |    return "Hello, " + abc
+            |}
+        """
+
+        private const val propertyTest =
+            """
+            |/src/main/kotlin/test/source.kt
+            |@file:JvmName("CustomJvmName")
+            |package test
+            |
+            |val property: String
+            |   get() = ""
+        """
+
+        private const val extensionPropertyTest =
+            """
+            |/src/main/kotlin/test/source.kt
+            |@file:JvmName("CustomJvmName")
+            |package test
+            |
+            |val String.property: String
+            |   get() = ""
+        """
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = [functionTest, extensionFunctionTest])
+    fun `jvm name should be included in functions extra`(query: String) {
+        testInline(
+            query.trimIndent(), testConfiguration
+        ) {
+            documentablesCreationStage = { modules ->
+                val expectedAnnotation = Annotations.Annotation(
+                    dri = DRI("kotlin.jvm", "JvmName"),
+                    params = mapOf("name" to StringValue("CustomJvmName")),
+                    scope = Annotations.AnnotationScope.FILE,
+                    mustBeDocumented = false
+                )
+                val function = modules.flatMap { it.packages }.first().functions.first()
+                val annotation = function.extra[Annotations]?.fileLevelAnnotations?.entries?.first()?.value?.single()
+                assertEquals(emptyMap(), function.extra[Annotations]?.directAnnotations)
+                assertEquals(expectedAnnotation, annotation)
+                assertEquals(expectedAnnotation.scope, annotation?.scope)
+                assertEquals(expectedAnnotation.mustBeDocumented, annotation?.mustBeDocumented)
+            }
+        }
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = [propertyTest, extensionPropertyTest])
+    fun `jvm name should be included in properties extra`(query: String) {
+        testInline(
+            query.trimIndent(), testConfiguration
+        ) {
+            documentablesCreationStage = { modules ->
+                val expectedAnnotation = Annotations.Annotation(
+                    dri = DRI("kotlin.jvm", "JvmName"),
+                    params = mapOf("name" to StringValue("CustomJvmName")),
+                    scope = Annotations.AnnotationScope.FILE,
+                    mustBeDocumented = false
+                )
+                val properties = modules.flatMap { it.packages }.first().properties.first()
+                val annotation = properties.extra[Annotations]?.fileLevelAnnotations?.entries?.first()?.value?.single()
+                assertEquals(emptyMap(), properties.extra[Annotations]?.directAnnotations)
+                assertEquals(expectedAnnotation, annotation)
+                assertEquals(expectedAnnotation.scope, annotation?.scope)
+                assertEquals(expectedAnnotation.mustBeDocumented, annotation?.mustBeDocumented)
+            }
+        }
+    }
+}
\ No newline at end of file