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
|
package renderers.html
import org.jetbrains.dokka.base.renderers.html.NavigationNodeIcon
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jsoup.nodes.Element
import org.junit.jupiter.api.Test
import utils.TestOutputWriterPlugin
import kotlin.test.assertEquals
import utils.navigationHtml
class NavigationTest : BaseAbstractTest() {
private val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
}
}
}
@Test
fun `should have expandable classlikes`() {
val writerPlugin = TestOutputWriterPlugin()
testInline(
"""
|/src/main/kotlin/com/example/WithInner.kt
|package com.example
|
|class WithInner {
| // in-class functions should not be in navigation
| fun a() {}
| fun b() {}
| fun c() {}
|
| class InnerClass {}
| interface InnerInterface {}
| enum class InnerEnum {}
| object InnerObject {}
| annotation class InnerAnnotation {}
| companion object CompanionObject {}
|}
""".trimIndent(),
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
assertEquals(9, content.size)
// Navigation menu should be the following, sorted by name:
// - root
// - com.example
// - WithInner
// - CompanionObject
// - InnerAnnotation
// - InnerClass
// - InnerEnum
// - InnerInterface
// - InnerObject
content[0].assertNavigationLink(
id = "root-nav-submenu",
text = "root",
address = "index.html",
)
content[1].assertNavigationLink(
id = "root-nav-submenu-0",
text = "com.example",
address = "root/com.example/index.html",
)
content[2].assertNavigationLink(
id = "root-nav-submenu-0-0",
text = "WithInner",
address = "root/com.example/-with-inner/index.html",
icon = NavigationNodeIcon.CLASS_KT
)
content[3].assertNavigationLink(
id = "root-nav-submenu-0-0-0",
text = "CompanionObject",
address = "root/com.example/-with-inner/-companion-object/index.html",
icon = NavigationNodeIcon.OBJECT
)
content[4].assertNavigationLink(
id = "root-nav-submenu-0-0-1",
text = "InnerAnnotation",
address = "root/com.example/-with-inner/-inner-annotation/index.html",
icon = NavigationNodeIcon.ANNOTATION_CLASS_KT
)
content[5].assertNavigationLink(
id = "root-nav-submenu-0-0-2",
text = "InnerClass",
address = "root/com.example/-with-inner/-inner-class/index.html",
icon = NavigationNodeIcon.CLASS_KT
)
content[6].assertNavigationLink(
id = "root-nav-submenu-0-0-3",
text = "InnerEnum",
address = "root/com.example/-with-inner/-inner-enum/index.html",
icon = NavigationNodeIcon.ENUM_CLASS_KT
)
content[7].assertNavigationLink(
id = "root-nav-submenu-0-0-4",
text = "InnerInterface",
address = "root/com.example/-with-inner/-inner-interface/index.html",
icon = NavigationNodeIcon.INTERFACE_KT
)
content[8].assertNavigationLink(
id = "root-nav-submenu-0-0-5",
text = "InnerObject",
address = "root/com.example/-with-inner/-inner-object/index.html",
icon = NavigationNodeIcon.OBJECT
)
}
}
}
@Test
fun `should be able to have deeply nested classlikes`() {
val writerPlugin = TestOutputWriterPlugin()
testInline(
"""
|/src/main/kotlin/com/example/DeeplyNested.kt
|package com.example
|
|class DeeplyNested {
| class FirstLevelClass {
| interface SecondLevelInterface {
| object ThirdLevelObject {
| annotation class FourthLevelAnnotation {}
| }
| }
| }
|}
""".trimIndent(),
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
assertEquals(7, content.size)
// Navigation menu should be the following
// - root
// - com.example
// - DeeplyNested
// - FirstLevelClass
// - SecondLevelInterface
// - ThirdLevelObject
// - FourthLevelAnnotation
content[0].assertNavigationLink(
id = "root-nav-submenu",
text = "root",
address = "index.html",
)
content[1].assertNavigationLink(
id = "root-nav-submenu-0",
text = "com.example",
address = "root/com.example/index.html",
)
content[2].assertNavigationLink(
id = "root-nav-submenu-0-0",
text = "DeeplyNested",
address = "root/com.example/-deeply-nested/index.html",
icon = NavigationNodeIcon.CLASS_KT
)
content[3].assertNavigationLink(
id = "root-nav-submenu-0-0-0",
text = "FirstLevelClass",
address = "root/com.example/-deeply-nested/-first-level-class/index.html",
icon = NavigationNodeIcon.CLASS_KT
)
content[4].assertNavigationLink(
id = "root-nav-submenu-0-0-0-0",
text = "SecondLevelInterface",
address = "root/com.example/-deeply-nested/-first-level-class/-second-level-interface/index.html",
icon = NavigationNodeIcon.INTERFACE_KT
)
content[5].assertNavigationLink(
id = "root-nav-submenu-0-0-0-0-0",
text = "ThirdLevelObject",
address = "root/com.example/-deeply-nested/-first-level-class/-second-level-interface/" +
"-third-level-object/index.html",
icon = NavigationNodeIcon.OBJECT
)
content[6].assertNavigationLink(
id = "root-nav-submenu-0-0-0-0-0-0",
text = "FourthLevelAnnotation",
address = "root/com.example/-deeply-nested/-first-level-class/-second-level-interface/" +
"-third-level-object/-fourth-level-annotation/index.html",
icon = NavigationNodeIcon.ANNOTATION_CLASS_KT
)
}
}
}
private fun Element.assertNavigationLink(
id: String, text: String, address: String, icon: NavigationNodeIcon? = null
) {
assertEquals(id, this.id())
val link = this.selectFirst("a")
checkNotNull(link)
assertEquals(text, link.text())
assertEquals(address, link.attr("href"))
if (icon != null) {
val iconStyles =
this.selectFirst("div.overview span.nav-link-grid")?.child(0)?.classNames()?.toList() ?: emptyList()
assertEquals(3, iconStyles.size)
assertEquals("nav-link-child", iconStyles[0])
assertEquals(icon.style(), "${iconStyles[1]} ${iconStyles[2]}")
}
}
}
|
