Replace arrays of primitive types on std arrays (#2051)

1 files changed, 199 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/filter/KotlinArrayDocumentableReplacerTest.kt b/plugins/base/src/test/kotlin/filter/KotlinArrayDocumentableReplacerTest.kt
new file mode 100644
index 00000000..b9b1dc1e
--- /dev/null
+++ b/plugins/base/src/test/kotlin/filter/KotlinArrayDocumentableReplacerTest.kt
@@ -0,0 +1,199 @@
+package filter
+
+import com.jetbrains.rd.util.firstOrNull
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.*
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Test
+
+class KotlinArrayDocumentableReplacerTest : BaseAbstractTest() {
+    private val configuration = dokkaConfiguration {
+        sourceSets {
+            sourceSet {
+                sourceRoots = listOf("src/main/kotlin/basic/Test.kt")
+            }
+        }
+    }
+
+    @Test
+    fun `function with array type params`() {
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |fun testFunction(param1: Array<Int>, param2: Array<Boolean>,
+            |                 param3: Array<Float>, param4: Array<Double>,
+            |                 param5: Array<Long>, param6: Array<Short>,
+            |                 param7: Array<Char>, param8: Array<Byte>) { }
+            |
+            |
+            |
+        """.trimMargin(),
+            configuration
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val params = it.firstOrNull()?.packages?.firstOrNull()?.functions?.firstOrNull()?.parameters
+
+                val typeArrayNames = listOf("IntArray", "BooleanArray", "FloatArray", "DoubleArray", "LongArray", "ShortArray",
+                    "CharArray", "ByteArray")
+
+                Assertions.assertEquals(typeArrayNames.size, params?.size)
+                params?.forEachIndexed{ i, param ->
+                    Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin", typeArrayNames[i]), emptyList()),
+                        param.type)
+                }
+            }
+        }
+    }
+    @Test
+    fun `function with specific parameters of array type`() {
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |fun testFunction(param1: Array<Array<Int>>, param2: (Array<Int>) -> Array<Int>) { }
+            |
+            |
+            |
+        """.trimMargin(),
+            configuration
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val params = it.firstOrNull()?.packages?.firstOrNull()?.functions?.firstOrNull()?.parameters
+                Assertions.assertEquals(
+                    Invariance(GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList())),
+                    (params?.firstOrNull()?.type as? GenericTypeConstructor)?.projections?.firstOrNull())
+                Assertions.assertEquals(
+                    Invariance(GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList())),
+                    (params?.get(1)?.type as? FunctionalTypeConstructor)?.projections?.get(0))
+                Assertions.assertEquals(
+                    Invariance(GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList())),
+                    (params?.get(1)?.type as? FunctionalTypeConstructor)?.projections?.get(1))
+            }
+        }
+    }
+    @Test
+    fun `property with array type`() {
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |class MyTest { 
+            |   val isEmpty: Array<Boolean>
+            |       get() = emptyList
+            |       set(value) {
+            |           field = value
+            |        }
+            |}
+            |
+            |
+        """.trimMargin(),
+            configuration
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val myTestClass = it.firstOrNull()?.packages?.firstOrNull()?.classlikes?.firstOrNull()
+                val property = myTestClass?.properties?.firstOrNull()
+
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin", "BooleanArray"), emptyList()),
+                    property?.type)
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin", "BooleanArray"), emptyList()),
+                    property?.getter?.type)
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin", "BooleanArray"), emptyList()),
+                    property?.setter?.parameters?.firstOrNull()?.type)
+            }
+        }
+    }
+    @Test
+    fun `typealias with array type`() {
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |typealias arr = Array<Int>
+            |
+            |
+        """.trimMargin(),
+            configuration
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val arrTypealias = it.firstOrNull()?.packages?.firstOrNull()?.typealiases?.firstOrNull()
+
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList()),
+                    arrTypealias?.underlyingType?.firstOrNull()?.value)
+            }
+        }
+    }
+    @Test
+    fun `generic fun and class`() {
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |fun<T : Array<Int>> testFunction() { }
+            |class<T : Array<Int>> myTestClass{ }
+            |
+            |
+        """.trimMargin(),
+            configuration
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val testFun = it.firstOrNull()?.packages?.firstOrNull()?.functions?.firstOrNull()
+                val myTestClass = it.firstOrNull()?.packages?.firstOrNull()?.classlikes?.firstOrNull() as? DClass
+
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin","IntArray"), emptyList()),
+                    testFun?.generics?.firstOrNull()?.bounds?.firstOrNull())
+                Assertions.assertEquals(GenericTypeConstructor(DRI("kotlin","IntArray"), emptyList()),
+                    myTestClass?.generics?.firstOrNull()?.bounds?.firstOrNull())
+            }
+        }
+    }
+    @Test
+    fun `no jvm source set`() {
+        val configurationWithNoJVM = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/basic/Test.kt")
+                    analysisPlatform = "jvm"
+                }
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/basic/TestJS.kt")
+                    analysisPlatform = "js"
+                }
+            }
+        }
+
+        testInline(
+            """
+            |/src/main/kotlin/basic/Test.kt
+            |package example
+            |
+            |fun testFunction(param: Array<Int>)
+            |
+            |
+            |/src/main/kotlin/basic/TestJS.kt
+            |package example
+            |
+            |fun testFunction(param: Array<Int>)
+        """.trimMargin(),
+            configurationWithNoJVM
+        ) {
+            preMergeDocumentablesTransformationStage = {
+                val paramsJS = it[1].packages.firstOrNull()?.functions?.firstOrNull()?.parameters
+                Assertions.assertNotEquals(
+                    GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList()),
+                    paramsJS?.firstOrNull()?.type)
+
+                val paramsJVM = it.firstOrNull()?.packages?.firstOrNull()?.functions?.firstOrNull()?.parameters
+                Assertions.assertEquals(
+                    GenericTypeConstructor(DRI("kotlin", "IntArray"), emptyList()),
+                    paramsJVM?.firstOrNull()?.type)
+            }
+        }
+    }
+}
\ No newline at end of file