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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package transformers
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.analysis.kotlin.internal.ModuleAndPackageDocumentationReader
import org.jetbrains.dokka.analysis.markdown.jb.MARKDOWN_ELEMENT_FILE_NAME
import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationTransformer
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.DModule
import org.jetbrains.dokka.model.DPackage
import org.jetbrains.dokka.model.SourceSetDependent
import org.jetbrains.dokka.model.doc.CustomDocTag
import org.jetbrains.dokka.model.doc.Description
import org.jetbrains.dokka.model.doc.DocumentationNode
import org.jetbrains.dokka.model.doc.Text
import testApi.testRunner.dPackage
import testApi.testRunner.sourceSet
import kotlin.test.Test
import kotlin.test.assertEquals
class ModuleAndPackageDocumentationTransformerUnitTest {
@Test
fun `empty list of modules`() {
val transformer = ModuleAndPackageDocumentationTransformer(
object : ModuleAndPackageDocumentationReader {
override fun read(module: DModule): SourceSetDependent<DocumentationNode> = throw NotImplementedError()
override fun read(pkg: DPackage): SourceSetDependent<DocumentationNode> = throw NotImplementedError()
override fun read(module: DokkaConfiguration.DokkaModuleDescription): DocumentationNode = throw NotImplementedError()
}
)
assertEquals(
emptyList<DModule>(), transformer(emptyList()),
)
}
@Test
fun `single module documentation`() {
val transformer = ModuleAndPackageDocumentationTransformer(
object : ModuleAndPackageDocumentationReader {
override fun read(pkg: DPackage): SourceSetDependent<DocumentationNode> = throw NotImplementedError()
override fun read(module: DModule): SourceSetDependent<DocumentationNode> {
return module.sourceSets.associateWith { sourceSet ->
documentationNode("doc" + sourceSet.displayName)
}
}
override fun read(module: DokkaConfiguration.DokkaModuleDescription): DocumentationNode = throw NotImplementedError()
}
)
val result = transformer(
listOf(
DModule(
"ModuleName",
documentation = emptyMap(),
packages = emptyList(),
sourceSets = setOf(
sourceSet("A"),
sourceSet("B")
)
)
)
)
assertEquals(
DModule(
"ModuleName",
documentation = mapOf(
sourceSet("A") to documentationNode("docA"),
sourceSet("B") to documentationNode("docB")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B")),
packages = emptyList()
),
result.single()
)
}
@Test
fun `merges with already existing module documentation`() {
val transformer = ModuleAndPackageDocumentationTransformer(
object : ModuleAndPackageDocumentationReader {
override fun read(pkg: DPackage): SourceSetDependent<DocumentationNode> = throw NotImplementedError()
override fun read(module: DModule): SourceSetDependent<DocumentationNode> {
/* Only add documentation for first source set */
return module.sourceSets.take(1).associateWith { sourceSet ->
documentationNode("doc" + sourceSet.displayName)
}
}
override fun read(module: DokkaConfiguration.DokkaModuleDescription): DocumentationNode = throw NotImplementedError()
}
)
val result = transformer(
listOf(
DModule(
"MyModule",
documentation = mapOf(
sourceSet("A") to documentationNode("pre-existing:A"),
sourceSet("B") to documentationNode("pre-existing:B")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B")),
packages = emptyList()
)
)
)
assertEquals(
DModule(
"MyModule",
documentation = mapOf(
/* Expect previous documentation and newly attached one */
sourceSet("A") to documentationNode("pre-existing:A", "docA"),
/* Only first source set will get documentation attached */
sourceSet("B") to documentationNode("pre-existing:B")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B")),
packages = emptyList()
),
result.single()
)
}
@Test
fun `package documentation`() {
val transformer = ModuleAndPackageDocumentationTransformer(
object : ModuleAndPackageDocumentationReader {
override fun read(module: DModule): SourceSetDependent<DocumentationNode> = emptyMap()
override fun read(pkg: DPackage): SourceSetDependent<DocumentationNode> {
/* Only attach documentation to packages with 'attach' */
if ("attach" !in pkg.dri.packageName.orEmpty()) return emptyMap()
/* Only attach documentation to two source sets */
return pkg.sourceSets.take(2).associateWith { sourceSet ->
documentationNode("doc:${sourceSet.displayName}:${pkg.dri.packageName}")
}
}
override fun read(module: DokkaConfiguration.DokkaModuleDescription): DocumentationNode = throw NotImplementedError()
}
)
val result = transformer(
listOf(
DModule(
"MyModule",
documentation = emptyMap(),
sourceSets = emptySet(),
packages = listOf(
dPackage(
dri = DRI("com.sample"),
documentation = mapOf(
sourceSet("A") to documentationNode("pre-existing:A:com.sample")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
),
dPackage(
dri = DRI("com.attach"),
documentation = mapOf(
sourceSet("A") to documentationNode("pre-existing:A:com.attach")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C"))
),
dPackage(
dri = DRI("com.attach.sub"),
documentation = mapOf(
sourceSet("A") to documentationNode("pre-existing:A:com.attach.sub"),
sourceSet("B") to documentationNode("pre-existing:B:com.attach.sub"),
sourceSet("C") to documentationNode("pre-existing:C:com.attach.sub")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
)
)
)
)
)
result.single().packages.forEach { pkg ->
assertEquals(
setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")), pkg.sourceSets,
"Expected source sets A, B, C for package ${pkg.dri.packageName}"
)
}
val comSample = result.single().packages.single { it.dri.packageName == "com.sample" }
assertEquals(
mapOf(sourceSet("A") to documentationNode("pre-existing:A:com.sample")),
comSample.documentation,
"Expected no documentation added to package 'com.sample' because of wrong package"
)
val comAttach = result.single().packages.single { it.dri.packageName == "com.attach" }
assertEquals(
mapOf(
sourceSet("A") to documentationNode("pre-existing:A:com.attach", "doc:A:com.attach"),
sourceSet("B") to documentationNode("doc:B:com.attach")
),
comAttach.documentation,
"Expected documentation added to source sets A and B"
)
assertEquals(
DModule(
"MyModule",
documentation = emptyMap(),
sourceSets = emptySet(),
packages = listOf(
dPackage(
dri = DRI("com.sample"),
documentation = mapOf(
/* No documentation added, since in wrong package */
sourceSet("A") to documentationNode("pre-existing:A:com.sample")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
),
dPackage(
dri = DRI("com.attach"),
documentation = mapOf(
/* Documentation added */
sourceSet("A") to documentationNode("pre-existing:A:com.attach", "doc:A:com.attach"),
sourceSet("B") to documentationNode("doc:B:com.attach")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
),
dPackage(
dri = DRI("com.attach.sub"),
documentation = mapOf(
/* Documentation added */
sourceSet("A") to documentationNode(
"pre-existing:A:com.attach.sub",
"doc:A:com.attach.sub"
),
/* Documentation added */
sourceSet("B") to documentationNode(
"pre-existing:B:com.attach.sub",
"doc:B:com.attach.sub"
),
/* No documentation added, since in wrong source set */
sourceSet("C") to documentationNode("pre-existing:C:com.attach.sub")
),
sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
)
)
), result.single()
)
}
private fun documentationNode(vararg texts: String): DocumentationNode {
return DocumentationNode(
texts.toList()
.map { Description(CustomDocTag(listOf(Text(it)), name = MARKDOWN_ELEMENT_FILE_NAME)) })
}
}
|
