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
151
152
153
154
155
156
157
158
159
160
161
|
package linkableContent
import org.jetbrains.dokka.SourceLinkDefinitionImpl
import org.jetbrains.dokka.base.transformers.pages.samples.DefaultSamplesTransformer
import org.jetbrains.dokka.base.transformers.pages.sourcelinks.SourceLinksTransformer
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
import org.jetbrains.kotlin.utils.addToStdlib.safeAs
import org.junit.jupiter.api.Assertions
import org.junit.jupiter.api.Test
class LinkableContentTest : AbstractCoreTest() {
@Test
fun `Include module and package documentation`() {
val testDataDir = getTestDataDir("multiplatform/basicMultiplatformTest").toAbsolutePath()
val includesDir = getTestDataDir("linkable/includes").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
targets = listOf("js")
sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map {
"$testDataDir/$it/kotlin"
}
includes = listOf("$includesDir/include2.md")
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
targets = listOf("jvm")
sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map {
"$testDataDir/$it/kotlin"
}
includes = listOf("$includesDir/include1.md")
}
}
}
testFromData(configuration) {
documentablesMergingStage = {
Assertions.assertEquals(2, it.documentation.size)
Assertions.assertEquals(2, it.packages.size)
Assertions.assertEquals(1, it.packages.first().documentation.size)
Assertions.assertEquals(1, it.packages.last().documentation.size)
}
}
}
@Test
fun `Sources multiplatform class documentation`() {
val testDataDir = getTestDataDir("linkable/sources").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
targets = listOf("js")
sourceRoots = listOf("$testDataDir/jsMain/kotlin")
sourceLinks = listOf(
SourceLinkDefinitionImpl(
path = "jsMain/kotlin",
url = "https://github.com/user/repo/tree/master/src/jsMain/kotlin",
lineSuffix = "#L"
)
)
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
targets = listOf("jvm")
sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
sourceLinks = listOf(
SourceLinkDefinitionImpl(
path = "jvmMain/kotlin",
url = "https://github.com/user/repo/tree/master/src/jvmMain/kotlin",
lineSuffix = "#L"
)
)
}
}
}
testFromData(configuration) {
renderingStage = { rootPageNode, dokkaContext ->
val newRoot = SourceLinksTransformer(dokkaContext).invoke(rootPageNode)
val moduleChildren = newRoot.children
Assertions.assertEquals(1, moduleChildren.size)
val packageChildren = moduleChildren.first().children
Assertions.assertEquals(2, packageChildren.size)
packageChildren.forEach {
val name = it.name.substringBefore("Class")
val crl = it.safeAs<ClasslikePageNode>()?.content?.safeAs<ContentGroup>()?.children?.last()
?.safeAs<PlatformHintedContent>()?.children?.singleOrNull().safeAs<ContentResolvedLink>()
Assertions.assertEquals(
"https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3",
crl?.address
)
}
}
}
}
@Test
fun `Samples multiplatform documentation`() {
val testDataDir = getTestDataDir("linkable/samples").toAbsolutePath()
val configuration = dokkaConfiguration {
passes {
pass {
moduleName = "example"
analysisPlatform = "js"
targets = listOf("js")
sourceRoots = listOf("$testDataDir/jsMain/kotlin")
samples = listOf("$testDataDir/jsMain/resources/Samples.kt")
}
pass {
moduleName = "example"
analysisPlatform = "jvm"
targets = listOf("jvm")
sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
samples = listOf("$testDataDir/jvmMain/resources/Samples.kt")
}
}
}
testFromData(configuration) {
renderingStage = { rootPageNode, dokkaContext ->
val newRoot = DefaultSamplesTransformer(dokkaContext).invoke(rootPageNode)
val moduleChildren = newRoot.children
Assertions.assertEquals(1, moduleChildren.size)
val packageChildren = moduleChildren.first().children
Assertions.assertEquals(2, packageChildren.size)
packageChildren.forEach {
val name = it.name.substringBefore("Class")
val classChildren = it.children
Assertions.assertEquals(2, classChildren.size)
val function = classChildren.find { it.name == "printWithExclamation" }
val text = function.safeAs<MemberPageNode>()?.content?.safeAs<ContentGroup>()?.children?.last()
?.safeAs<PlatformHintedContent>()?.children?.singleOrNull()
?.safeAs<ContentGroup>()?.children?.singleOrNull()?.safeAs<ContentGroup>()?.children?.last()
?.safeAs<ContentGroup>()?.children?.singleOrNull()
?.safeAs<ContentCode>()?.children?.singleOrNull()?.safeAs<ContentText>()?.text
Assertions.assertEquals(
"${name}Class().printWithExclamation(\"Hi, $name\")",
text
)
}
}
}
}
}
|
