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
|
package enums
import matchers.content.*
import org.jetbrains.dokka.model.ConstructorValues
import org.jetbrains.dokka.model.DEnum
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
import org.junit.jupiter.api.Assertions.*
import org.junit.jupiter.api.Test
class EnumsTest : AbstractCoreTest() {
@Test
fun basicEnum() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/basic/Test.kt
|package enums
|
|enum class Test {
| E1,
| E2
|}
""".trimMargin(),
configuration
) {
pagesGenerationStage = {
val map = it.getClasslikeToMemberMap()
val test = map.filterKeys { it.name == "Test" }.values.firstOrNull()
assertTrue(test != null) { "Test not found" }
assertTrue(test!!.any { it.name == "E1" } && test.any { it.name == "E2" }) { "Enum entries missing in parent" }
}
}
}
@Test
fun enumWithCompanion() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/basic/Test.kt
|package enums
|
|enum class Test {
| E1,
| E2;
| companion object {}
|}
""".trimMargin(),
configuration
) {
documentablesTransformationStage = { m ->
m.packages.let { p ->
assertTrue(p.isNotEmpty(), "Package list cannot be empty")
p.first().classlikes.let { c ->
assertTrue(c.isNotEmpty(), "Classlikes list cannot be empty")
val enum = c.first() as DEnum
assertEquals(enum.name, "Test")
assertEquals(enum.entries.count(), 2)
assertNotNull(enum.companion)
}
}
}
pagesGenerationStage = { module ->
val map = module.getClasslikeToMemberMap()
val test = map.filterKeys { it.name == "Test" }.values.firstOrNull()
assertNotNull(test, "Test not found")
assertTrue(test!!.any { it.name == "E1" } && test.any { it.name == "E2" }) { "Enum entries missing in parent" }
}
}
}
@Test
fun enumWithConstructor() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/basic/Test.kt
|package enums
|
|
|enum class Test(name: String, index: Int, excluded: Boolean) {
| E1("e1", 1, true),
| E2("e2", 2, false);
|}
""".trimMargin(),
configuration
) {
documentablesTransformationStage = { m ->
m.packages.let { p ->
p.first().classlikes.let { c ->
val enum = c.first() as DEnum
val (first, second) = enum.entries
assertEquals(1, first.extra.allOfType<ConstructorValues>().size)
assertEquals(1, second.extra.allOfType<ConstructorValues>().size)
assertEquals(listOf("\"e1\"", "1", "true"), first.extra.allOfType<ConstructorValues>().first().values.values.first())
assertEquals(listOf("\"e2\"", "2", "false"), second.extra.allOfType<ConstructorValues>().first().values.values.first())
}
}
}
pagesGenerationStage = { module ->
val entryPage = module.dfs { it.name == "E1" } as ClasslikePageNode
val signaturePart = (entryPage.content.dfs {
it is ContentGroup && it.dci.toString() == "[enums/Test.E1///PointingToDeclaration/][Symbol]"
} as ContentGroup)
assertEquals("(\"e1\", 1, true)", signaturePart.constructorSignature())
}
}
}
@Test
fun enumWithMethods() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/basic/Test.kt
|package enums
|
|
|interface Sample {
| fun toBeImplemented(): String
|}
|
|enum class Test: Sample {
| E1 {
| override fun toBeImplemented(): String = "e1"
| }
|}
""".trimMargin(),
configuration
) {
documentablesTransformationStage = { m ->
m.packages.let { p ->
p.first().classlikes.let { c ->
val enum = c.first { it is DEnum } as DEnum
val first = enum.entries.first()
assertEquals(1, first.extra.allOfType<ConstructorValues>().size)
assertEquals(emptyList<String>(), first.extra.allOfType<ConstructorValues>().first().values.values.first())
assertNotNull(first.functions.find { it.name == "toBeImplemented" })
}
}
}
}
}
@Test
fun enumWithAnnotationsOnEntries(){
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
testInline(
"""
|/src/main/kotlin/basic/Test.kt
|package enums
|
|enum class Test {
| /**
| Sample docs for E1
| **/
| @SinceKotlin("1.3") // This annotation is transparent due to lack of @MustBeDocumented annotation
| E1
|}
""".trimMargin(),
configuration
) {
pagesTransformationStage = { m ->
val entryNode = m.children.first { it.name == "enums" }.children.first { it.name == "Test" }.children.first() as ClasslikePageNode
val signature = (entryNode.content as ContentGroup).dfs { it is ContentGroup && it.dci.toString() == "[enums/Test.E1///PointingToDeclaration/][Cover]" } as ContentGroup
signature.assertNode {
header(1) { +"E1" }
platformHinted {
group {
group {
+ "Sample docs for E1"
}
}
group {
group {
link { +"E1" }
+"()"
}
}
}
}
}
}
}
fun RootPageNode.getClasslikeToMemberMap() =
this.parentMap.filterValues { it is ClasslikePageNode }.entries.groupBy({ it.value }) { it.key }
private fun ContentGroup.constructorSignature(): String =
(children.single() as ContentGroup).children.drop(1).joinToString(separator = "") { (it as ContentText).text }
}
|
