forked from Kotlin/dokka
/
JavadocClasslikeTemplateMapTest.kt
358 lines (326 loc) · 13.4 KB
/
JavadocClasslikeTemplateMapTest.kt
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
package org.jetbrains.dokka.javadoc
import org.jetbrains.dokka.javadoc.pages.JavadocClasslikePageNode
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
import org.jetbrains.dokka.test.assertIsInstance
internal class JavadocClasslikeTemplateMapTest : AbstractJavadocTemplateMapTest() {
@Test
fun `empty class`() {
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
/**
* Documentation for TestClass
*/
class TestClass
""",
java =
"""
/src/com/test/package0/TestClass.java
package com.test.package0;
/**
* Documentation for TestClass
*/
public final class TestClass {}
"""
) {
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
assertEquals("TestClass", map["name"])
assertEquals("TestClass", map["title"])
assertEquals("com.test.package0", map["packageName"])
assertEquals("<p>Documentation for TestClass</p>", map["classlikeDocumentation"])
assertEquals("Documentation for TestClass", map["subtitle"])
assertEquals("public final class <a href=TestClass.html>TestClass</a>", map.signatureWithModifiers())
}
}
@Test
fun `single function`() {
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
/**
* Documentation for TestClass
*/
class TestClass {
/**
* Documentation for testFunction
*/
fun testFunction(): String = ""
}
""",
java =
"""
/src/com/test/package0/TestClass.java
package com.test.package0
/**
* Documentation for TestClass
*/
public final class TestClass {
/**
* Documentation for testFunction
*/
public final String testFunction() {
return "";
}
}
"""
) {
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
assertEquals("TestClass", map["name"])
assertEquals("TestClass", map["title"])
assertEquals("com.test.package0", map["packageName"])
assertEquals("<p>Documentation for TestClass</p>", map["classlikeDocumentation"])
assertEquals("Documentation for TestClass", map["subtitle"])
assertEquals("public final class", map.modifiers())
assertEquals("<a href=TestClass.html>TestClass</a>", map.signatureWithoutModifiers())
val methods = assertIsInstance<Map<Any, Any?>>(map["methods"])
val ownMethods = assertIsInstance<List<*>>(methods["own"])
assertEquals(1, ownMethods.size, "Expected only one method")
val method = assertIsInstance<Map<String, Any?>>(ownMethods.single())
assertEquals("Documentation for testFunction", method["brief"])
assertEquals("testFunction", method["name"])
assertEquals(
0, assertIsInstance<List<*>>(method["parameters"]).size,
"Expected no parameters"
)
assertEquals("final <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>String</a>", method.modifiers())
assertEquals("<a href=TestClass.html#testFunction()>testFunction</a>()", method.signatureWithoutModifiers())
}
}
@Test
fun `class with annotation`(){
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
@MustBeDocumented
annotation class Author(val name: String)
@Author(
name = "Benjamin Franklin"
)
class TestClass {`
@Author(
name = "Franklin D. Roosevelt"
)
fun testFunction(): String = ""
}
""",
java =
"""
/src/com/test/package0/Author.java
package com.test.package0
import java.lang.annotation.Documented;
@Documented
public @interface Author {
String name();
}
/src/com/test/package0/TestClass.java
package com.test.package0
@Author(
name = "Benjamin Franklin"
)
public final class TestClass {
@Author(
name = "Franklin D. Roosevelt"
)
public final String testFunction() {
return "";
}
}
"""
){
val map = allPagesOfType<JavadocClasslikePageNode>().first { it.name == "TestClass" }.templateMap
assertEquals("TestClass", map["name"])
val signature = assertIsInstance<Map<String, Any?>>(map["signature"])
assertEquals("@<a href=Author.html>Author</a>(name = "Benjamin Franklin")", signature["annotations"])
val methods = assertIsInstance<Map<Any, Any?>>(map["methods"])
val ownMethods = assertIsInstance<List<*>>(methods["own"])
val method = assertIsInstance<Map<String, Any?>>(ownMethods.single())
val methodSignature = assertIsInstance<Map<String, Any?>>(method["signature"])
assertEquals("@<a href=Author.html>Author</a>(name = "Franklin D. Roosevelt")", methodSignature["annotations"])
}
}
@Test
fun `simple enum`(){
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
enum class ClockDays {
/**
* Sample docs for first
*/
FIRST,
/**
* Sample docs for second
*/
SECOND
}
""",
java =
"""
/src/com/test/package0/TestClass.java
package com.test.package0;
public enum ClockDays {
/**
* Sample docs for first
*/
FIRST,
/**
* Sample docs for second
*/
SECOND
}
"""
){
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
assertEquals("ClockDays", map["name"])
assertEquals("enum", map["kind"])
val entries = assertIsInstance<List<Map<String, Any?>>>(map["entries"])
assertEquals(2, entries.size)
val (first, second) = entries.sortedBy { it["brief"] as String }
assertEquals("<p>Sample docs for first</p>", first["brief"])
assertEquals("<p>Sample docs for second</p>", second["brief"])
assertEquals("<a href=ClockDays.html#FIRST>FIRST</a>", first.signatureWithoutModifiers())
assertEquals("<a href=ClockDays.html#SECOND>SECOND</a>", second.signatureWithoutModifiers())
}
}
@Test
fun `documented function parameters`(){
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
class TestClass {
/**
* Simple parameters list to check out
* @param simple simple String parameter
* @param parameters simple Integer parameter
* @param list simple Boolean parameter
* @return just a String
*/
fun testFunction(simple: String?, parameters: Int?, list: Boolean?): String {
return ""
}
}
""",
java =
"""
/src/com/test/package0/TestClass.java
package com.test.package0;
public final class TestClass {
/**
* Simple parameters list to check out
* @param simple simple String parameter
* @param parameters simple Integer parameter
* @param list simple Boolean parameter
* @return just a String
*/
public final String testFunction(String simple, Integer parameters, Boolean list) {
return "";
}
}
"""
) {
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
assertEquals("TestClass", map["name"])
val methods = assertIsInstance<Map<String, Any?>>(map["methods"])
val testFunction = assertIsInstance<List<Map<String, Any?>>>(methods["own"]).single()
assertEquals("Simple parameters list to check out", testFunction["brief"])
val (first, second, third) = assertIsInstance<List<Map<String, Any?>>>(testFunction["parameters"])
assertParameterNode(
node = first,
expectedName = "simple",
expectedType = "<a href=https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>String</a>",
expectedDescription = "simple String parameter"
)
assertParameterNode(
node = second,
expectedName = "parameters",
expectedType = "<a href=https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html>Integer</a>",
expectedDescription = "simple Integer parameter"
)
assertParameterNode(
node = third,
expectedName = "list",
expectedType = "<a href=https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html>Boolean</a>",
expectedDescription = "simple Boolean parameter"
)
}
}
@Test
fun `with generic parameters`(){
dualTestTemplateMapInline(
kotlin =
"""
/src/source0.kt
package com.test.package0
import java.io.Serializable
class Generic<T : Serializable?> {
fun <D : T> sampleFunction(): D = TODO()
}
""",
java =
"""
/src/com/test/package0/Generic.java
package com.test.package0;
import java.io.Serializable;
public final class Generic<T extends Serializable> {
public final <D extends T> D sampleFunction(){
return null;
}
}
"""
) {
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
assertEquals("Generic", map["name"])
assertEquals(
"public final class <a href=Generic.html>Generic</a><T extends <a href=https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html>Serializable</a>>",
map.signatureWithModifiers()
)
val methods = assertIsInstance<Map<Any, Any?>>(map["methods"])
val ownMethods = assertIsInstance<List<*>>(methods["own"]).first()
val sampleFunction = assertIsInstance<Map<String, Any?>>(ownMethods)
assertEquals("final <D extends <a href=Generic.html>T</a>> <a href=Generic.html#sampleFunction()>D</a> <a href=Generic.html#sampleFunction()>sampleFunction</a>()", sampleFunction.signatureWithModifiers())
}
}
@Test
fun `class with top-level const`() {
dualTestTemplateMapInline(
kotlin =
"""
/src/Test.kt
package com.test.package0
const val TEST_VAL = "test"
""",
java =
"""
/src/com/test/package0/TestKt.java
package com.test.package0;
public final class TestKt {
public static final String TEST_VAL = "test";
}
"""
) {
val map = singlePageOfType<JavadocClasslikePageNode>().templateMap
val properties = assertIsInstance<List<*>>(map["properties"])
val property = assertIsInstance<Map<String, Any?>>(properties.first())
assertEquals("public final static <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>String</a> <a href=TestKt.html#TEST_VAL>TEST_VAL</a>", "${property["modifiers"]} ${property["signature"]}")
}
}
private fun assertParameterNode(node: Map<String, Any?>, expectedName: String, expectedType: String, expectedDescription: String){
assertEquals(expectedName, node["name"])
assertEquals(expectedType, node["type"])
assertEquals(expectedDescription, node["description"])
}
private fun Map<String, Any?>.signatureWithModifiers(): String = "${modifiers()} ${signatureWithoutModifiers()}"
private fun Map<String, Any?>.signatureWithoutModifiers(): String = (get("signature") as Map<String, Any?>)["signatureWithoutModifiers"] as String
private fun Map<String, Any?>.modifiers(): String = (get("signature") as Map<String, Any?>)["modifiers"] as String
}