1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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 {
passes {
pass {
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 {
passes {
pass {
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 {
passes {
pass {
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)
}
}
}
|
