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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
package parsers
import org.intellij.markdown.MarkdownElementTypes
import org.jetbrains.dokka.base.parsers.moduleAndPackage.*
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentation.Classifier.Module
import org.jetbrains.dokka.base.parsers.moduleAndPackage.ModuleAndPackageDocumentation.Classifier.Package
import org.jetbrains.dokka.model.doc.*
import org.jetbrains.dokka.utilities.DokkaLogger
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows
import org.junit.jupiter.api.io.TempDir
import java.nio.file.Path
class ParseModuleAndPackageDocumentationFragmentsTest {
private fun testBasicExample(lineSeperator: String = "\n") {
val source = source(
"""
# Module kotlin-demo
Module description
# Package org.jetbrains.kotlin.demo
Package demo description
## Level 2 heading
Heading 2\r\n
# Package org.jetbrains.kotlin.demo2
Package demo2 description
""".trimIndent().replace("\n", lineSeperator)
)
val fragments = parseModuleAndPackageDocumentationFragments(source)
assertEquals(
listOf(
ModuleAndPackageDocumentationFragment(
classifier = Module,
name = "kotlin-demo",
documentation = "Module description",
source = source
),
ModuleAndPackageDocumentationFragment(
classifier = Package,
name = "org.jetbrains.kotlin.demo",
documentation = "Package demo description${lineSeperator}## Level 2 heading${lineSeperator}Heading 2\\r\\n",
source = source
),
ModuleAndPackageDocumentationFragment(
classifier = Package,
name = "org.jetbrains.kotlin.demo2",
documentation = "Package demo2 description",
source = source
)
),
fragments
)
}
@Test
fun `basic example`() {
testBasicExample()
}
@Test
fun `CRLF line seperators`() {
testBasicExample("\r\n")
}
@Test
fun `no module name specified fails`() {
val exception = assertThrows<IllegalModuleAndPackageDocumentation> {
parseModuleAndPackageDocumentationFragments(
source(
"""
# Module
No module name given
""".trimIndent()
)
)
}
assertTrue(
"Missing Module name" in exception.message.orEmpty(),
"Expected 'Missing Module name' in error message"
)
}
@Test
fun `no package name specified does not fail`() {
val source = source(
"""
# Package
This is a root package
""".trimIndent()
)
val fragments = parseModuleAndPackageDocumentationFragments(source)
assertEquals(1, fragments.size, "Expected a single package fragment")
assertEquals(
ModuleAndPackageDocumentationFragment(
name = "",
classifier = Package,
documentation = "This is a root package",
source = source
),
fragments.single()
)
}
@Test
fun `white space in module name is supported`() {
val fragment = parseModuleAndPackageDocumentationFragments(
source(
"""
# Module My Module
Documentation for my module
""".trimIndent()
)
)
assertEquals(
Module, fragment.single().classifier,
"Expected module being parsec"
)
assertEquals(
"My Module", fragment.single().name,
"Expected module name with white spaces being parsed"
)
assertEquals(
"Documentation for my module", fragment.single().documentation,
"Expected documentation being available"
)
}
@Test
fun `white space in package name fails`() {
val exception = assertThrows<IllegalModuleAndPackageDocumentation> {
parseModuleAndPackageDocumentationFragments(
source(
"""
# Package my package
""".trimIndent()
)
)
}
assertTrue(
"Package my package" in exception.message.orEmpty(),
"Expected problematic statement in error message"
)
}
@Test
fun `multiple whitespaces are supported in first line`() {
val source = source(
"""
# Module my-module
My Module
# Package com.my.package
My Package
""".trimIndent()
)
val fragments = parseModuleAndPackageDocumentationFragments(source)
assertEquals(
listOf(
ModuleAndPackageDocumentationFragment(
classifier = Module,
name = "my-module",
documentation = "My Module",
source = source
),
ModuleAndPackageDocumentationFragment(
classifier = Package,
name = "com.my.package",
documentation = "My Package",
source = source
)
),
fragments
)
}
@Test
fun `parse from file`(@TempDir temporaryFolder: Path) {
val file = temporaryFolder.resolve("other.md").toFile()
file.writeText(
"""
# Module MyModule
D1
# Package com.sample
D2
""".trimIndent()
)
assertEquals(
listOf(
ModuleAndPackageDocumentationFragment(
classifier = Module,
name = "MyModule",
documentation = "D1",
source = ModuleAndPackageDocumentationFile(file)
),
ModuleAndPackageDocumentationFragment(
classifier = Package,
name = "com.sample",
documentation = "D2",
source = ModuleAndPackageDocumentationFile(file)
)
),
parseModuleAndPackageDocumentationFragments(file)
)
}
@Test
fun `at in code block is supported`() {
val fragment = parseModuleAndPackageDocumentationFragments(
source(
"""
# Module My Module
```
@Smth
```
@author Smb
""".trimIndent()
)
)
assertEquals(
"```\n" +
"@Smth\n" +
"```\n" +
"@author Smb", fragment.single().documentation,
"Expected documentation being available"
)
val parsingContext = ModuleAndPackageDocumentationParsingContext(object : DokkaLogger {
override var warningsCount: Int = 0
override var errorsCount: Int = 0
override fun debug(message: String) {}
override fun info(message: String) {}
override fun progress(message: String) {}
override fun warn(message: String) {}
override fun error(message: String) {}
})
val parsedFragment = parseModuleAndPackageDocumentation(parsingContext, fragment.single())
val expectedDocumentationNode = DocumentationNode(
listOf(
Description(
CustomDocTag(
listOf(
CodeBlock(
listOf(
Text("@Smth")
)
)
), name = MarkdownElementTypes.MARKDOWN_FILE.name
)
),
Author(
CustomDocTag(
listOf(
P(listOf(Text("Smb")))
), name = MarkdownElementTypes.MARKDOWN_FILE.name
)
)
)
)
assertEquals(
expectedDocumentationNode, parsedFragment.documentation
)
}
private fun source(documentation: String): ModuleAndPackageDocumentationSource =
object : ModuleAndPackageDocumentationSource() {
override val sourceDescription: String = "inline test"
override val documentation: String = documentation
}
}
|
