Merge branch 'dev-0.11.0'

1 files changed, 150 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/transformerBuilders/PageTransformerBuilderTest.kt b/plugins/base/src/test/kotlin/transformerBuilders/PageTransformerBuilderTest.kt
new file mode 100644
index 00000000..d8e057da
--- /dev/null
+++ b/plugins/base/src/test/kotlin/transformerBuilders/PageTransformerBuilderTest.kt
@@ -0,0 +1,150 @@
+package transformerBuilders;
+
+import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.pages.PageNode
+import org.jetbrains.dokka.pages.RendererSpecificResourcePage
+import org.jetbrains.dokka.pages.RenderingStrategy
+import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
+import org.jetbrains.dokka.transformers.pages.PageTransformer
+import org.jetbrains.dokka.transformers.pages.pageMapper
+import org.jetbrains.dokka.transformers.pages.pageScanner
+import org.jetbrains.dokka.transformers.pages.pageStructureTransformer
+import org.junit.jupiter.api.Test
+
+class PageTransformerBuilderTest : AbstractCoreTest() {
+
+    class ProxyPlugin(transformer: PageTransformer) : DokkaPlugin() {
+        val pageTransformer by extending { CoreExtensions.pageTransformer with transformer }
+    }
+
+    @Test
+    fun scannerTest() {
+        val configuration = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/transformerBuilder/Test.kt")
+                }
+            }
+        }
+        val list = mutableListOf<String>()
+
+        var orig: PageNode? = null
+
+        testInline(
+            """
+            |/src/main/kotlin/transformerBuilder/Test.kt
+            |package transformerBuilder
+            |
+            |object Test {
+            |   fun test2(str: String): Unit {println(str)}
+            |}
+        """.trimMargin(),
+            configuration,
+            pluginOverrides = listOf(ProxyPlugin(pageScanner {
+                list += name
+            }))
+        ) {
+            pagesGenerationStage = {
+                orig = it
+            }
+            pagesTransformationStage = { root ->
+                list.assertCount(4, "Page list: ")
+                orig?.let { root.assertTransform(it) }
+            }
+        }
+    }
+
+    @Test
+    fun mapperTest() {
+        val configuration = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/transformerBuilder/Test.kt")
+                }
+            }
+        }
+
+        var orig: PageNode? = null
+
+        testInline(
+            """
+            |/src/main/kotlin/transformerBuilder/Test.kt
+            |package transformerBuilder
+            |
+            |object Test {
+            |   fun test2(str: String): Unit {println(str)}
+            |}
+        """.trimMargin(),
+            configuration,
+            pluginOverrides = listOf(ProxyPlugin(pageMapper {
+                modified(name = name + "2")
+            }))
+        ) {
+            pagesGenerationStage = {
+                orig = it
+            }
+            pagesTransformationStage = {
+                it.let { root ->
+                    root.name.assertEqual("root2", "Root name: ")
+                    orig?.let {
+                        root.assertTransform(it) { node -> node.modified(name = node.name + "2") }
+                    }
+                }
+            }
+        }
+    }
+
+    @Test
+    fun structureTransformerTest() {
+        val configuration = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/transformerBuilder/Test.kt")
+                }
+            }
+        }
+
+        testInline(
+            """
+            |/src/main/kotlin/transformerBuilder/Test.kt
+            |package transformerBuilder
+            |
+            |object Test {
+            |   fun test2(str: String): Unit {println(str)}
+            |}
+        """.trimMargin(),
+            configuration,
+            pluginOverrides = listOf(ProxyPlugin(pageStructureTransformer {
+                val ch = children.first()
+                modified(
+                    children = listOf(
+                        ch,
+                        RendererSpecificResourcePage("test", emptyList(), RenderingStrategy.DoNothing)
+                    )
+                )
+            }))
+        ) {
+            pagesTransformationStage = { root ->
+                root.children.assertCount(2, "Root children: ")
+                root.children.first().name.assertEqual("transformerBuilder")
+                root.children[1].name.assertEqual("test")
+            }
+        }
+    }
+
+    private fun <T> Collection<T>.assertCount(n: Int, prefix: String = "") =
+        assert(count() == n) { "${prefix}Expected $n, got ${count()}" }
+
+    private fun <T> T.assertEqual(expected: T, prefix: String = "") = assert(this == expected) {
+        "${prefix}Expected $expected, got $this"
+    }
+
+    private fun PageNode.assertTransform(expected: PageNode, block: (PageNode) -> PageNode = { it }): Unit = this.let {
+        it.name.assertEqual(block(expected).name)
+        it.children.zip(expected.children).forEach { (g, e) ->
+            g.name.assertEqual(block(e).name)
+            g.assertTransform(e, block)
+        }
+    }
+}