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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
package content.annotations
import matchers.content.*
import org.jetbrains.dokka.pages.ContentPage
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.base.transformers.documentables.deprecatedAnnotation
import org.jetbrains.dokka.pages.ContentStyle
import org.jetbrains.dokka.base.transformers.documentables.isDeprecated
import org.jetbrains.dokka.model.Documentable
import org.jetbrains.dokka.model.properties.WithExtraProperties
import org.junit.jupiter.api.Test
import utils.ParamAttributes
import utils.bareSignature
import utils.pWrapped
import kotlin.test.assertEquals
import kotlin.test.assertTrue
class KotlinDeprecatedTest : BaseAbstractTest() {
private val testConfiguration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
}
}
}
@Test
@Suppress("UNCHECKED_CAST")
fun `should assert util functions for deprecation`() {
testInline(
"""
|/src/main/kotlin/kotlin/KotlinFile.kt
|package kotlin
|
|@Deprecated(
| message = "Fancy message"
|)
|fun simpleFunction() {}
""".trimIndent(),
testConfiguration
) {
documentablesTransformationStage = { module ->
val deprecatedFunction = module.children
.single { it.name == "kotlin" }.children
.single { it.name == "simpleFunction" }
val isDeprecated = (deprecatedFunction as WithExtraProperties<out Documentable>).isDeprecated()
assertTrue(isDeprecated)
val deprecatedAnnotation = (deprecatedFunction as WithExtraProperties<out Documentable>).deprecatedAnnotation
checkNotNull(deprecatedAnnotation)
assertTrue(deprecatedAnnotation.isDeprecated())
assertEquals("kotlin", deprecatedAnnotation.dri.packageName)
assertEquals("Deprecated", deprecatedAnnotation.dri.classNames)
}
}
}
@Test
fun `should change header if deprecation level is not default`() {
testInline(
"""
|/src/main/kotlin/kotlin/DeprecatedKotlin.kt
|package kotlin
|
|/**
| * Average function description
| */
|@Deprecated(
| message = "Reason for deprecation bla bla",
| level = DeprecationLevel.ERROR
|)
|fun oldLegacyFunction(typedParam: SomeOldType, someLiteral: String): String {}
|
|fun newShinyFunction(typedParam: SomeOldType, someLiteral: String, newTypedParam: SomeNewType): String {}
|class SomeOldType {}
|class SomeNewType {}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionWithDeprecatedFunction = module.children
.single { it.name == "kotlin" }.children
.single { it.name == "oldLegacyFunction" } as ContentPage
functionWithDeprecatedFunction.content.assertNode {
group {
header(1) { +"oldLegacyFunction" }
}
divergentGroup {
divergentInstance {
divergent {
bareSignature(
annotations = emptyMap(),
visibility = "",
modifier = "",
keywords = emptySet(),
name = "oldLegacyFunction",
returnType = "String",
params = arrayOf(
"typedParam" to ParamAttributes(emptyMap(), emptySet(), "SomeOldType"),
"someLiteral" to ParamAttributes(emptyMap(), emptySet(), "String"),
)
)
}
after {
group {
header(3) {
+"Deprecated (with error)"
}
p {
+"Reason for deprecation bla bla"
}
}
group { pWrapped("Average function description") }
}
}
}
}
}
}
}
@Test
fun `should display repalceWith param with imports as code blocks`() {
testInline(
"""
|/src/main/kotlin/kotlin/DeprecatedKotlin.kt
|package kotlin
|
|/**
| * Average function description
| */
|@Deprecated(
| message = "Reason for deprecation bla bla",
| replaceWith = ReplaceWith(
| "newShinyFunction(typedParam, someLiteral, SomeNewType())",
| imports = [
| "com.example.dokka.debug.newShinyFunction",
| "com.example.dokka.debug.SomeOldType",
| "com.example.dokka.debug.SomeNewType",
| ]
| ),
|)
|fun oldLegacyFunction(typedParam: SomeOldType, someLiteral: String): String {}
|
|fun newShinyFunction(typedParam: SomeOldType, someLiteral: String, newTypedParam: SomeNewType): String {}
|class SomeOldType {}
|class SomeNewType {}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionWithDeprecatedFunction = module.children
.single { it.name == "kotlin" }.children
.single { it.name == "oldLegacyFunction" } as ContentPage
functionWithDeprecatedFunction.content.assertNode {
group {
header(1) { +"oldLegacyFunction" }
}
divergentGroup {
divergentInstance {
divergent {
bareSignature(
annotations = emptyMap(),
visibility = "",
modifier = "",
keywords = emptySet(),
name = "oldLegacyFunction",
returnType = "String",
params = arrayOf(
"typedParam" to ParamAttributes(emptyMap(), emptySet(), "SomeOldType"),
"someLiteral" to ParamAttributes(emptyMap(), emptySet(), "String"),
)
)
}
after {
group {
header(3) {
+"Deprecated"
}
p {
+"Reason for deprecation bla bla"
}
header(4) {
+"Replace with"
}
codeBlock {
+"import com.example.dokka.debug.newShinyFunction"
br()
+"import com.example.dokka.debug.SomeOldType"
br()
+"import com.example.dokka.debug.SomeNewType"
br()
}
codeBlock {
+"newShinyFunction(typedParam, someLiteral, SomeNewType())"
}
}
group { pWrapped("Average function description") }
}
}
}
}
}
}
}
@Test
fun `should add footnote for DeprecatedSinceKotlin annotation`() {
testInline(
"""
|/src/main/kotlin/kotlin/DeprecatedKotlin.kt
|package kotlin
|
|/**
| * Average function description
| */
|@DeprecatedSinceKotlin(
| warningSince = "1.4",
| errorSince = "1.5",
| hiddenSince = "1.6"
|)
|@Deprecated(
| message = "Deprecation reason bla bla"
|)
|fun oldLegacyFunction(typedParam: SomeOldType, someLiteral: String): String {}
|
|fun newShinyFunction(typedParam: SomeOldType, someLiteral: String, newTypedParam: SomeNewType): String {}
|class SomeOldType {}
|class SomeNewType {}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionWithDeprecatedFunction = module.children
.single { it.name == "kotlin" }.children
.single { it.name == "oldLegacyFunction" } as ContentPage
functionWithDeprecatedFunction.content.assertNode {
group {
header(1) { +"oldLegacyFunction" }
}
divergentGroup {
divergentInstance {
divergent {
bareSignature(
annotations = emptyMap(),
visibility = "",
modifier = "",
keywords = emptySet(),
name = "oldLegacyFunction",
returnType = "String",
params = arrayOf(
"typedParam" to ParamAttributes(emptyMap(), emptySet(), "SomeOldType"),
"someLiteral" to ParamAttributes(emptyMap(), emptySet(), "String"),
)
)
}
after {
group {
header(3) {
+"Deprecated"
}
group {
check { assertEquals(ContentStyle.Footnote, this.style.firstOrNull()) }
p {
+"Warning since 1.4"
}
p {
+"Error since 1.5"
}
p {
+"Hidden since 1.6"
}
}
p {
+"Deprecation reason bla bla"
}
}
group { pWrapped("Average function description") }
}
}
}
}
}
}
}
@Test
fun `should generate deprecation block with all parameters present and long description`() {
testInline(
"""
|/src/main/kotlin/kotlin/DeprecatedKotlin.kt
|package kotlin
|
|/**
| * Average function description
| */
|@Deprecated(
| message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas vel vulputate risus. " +
| "Etiam dictum odio vel vulputate auctor.Nulla facilisi. Duis ullamcorper ullamcorper lectus " +
| "nec rutrum. Quisque eu risus eu purus bibendum ultricies. Maecenas tincidunt dui in sodales " +
| "faucibus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin id sem felis. " +
| "Praesent et libero lacinia, egestas libero in, ultrices lectus. Suspendisse eget volutpat " +
| "velit. Phasellus laoreet mi eu egestas mattis.",
| replaceWith = ReplaceWith(
| "newShinyFunction(typedParam, someLiteral, SomeNewType())",
| imports = [
| "com.example.dokka.debug.newShinyFunction",
| "com.example.dokka.debug.SomeOldType",
| "com.example.dokka.debug.SomeNewType",
| ]
| ),
| level = DeprecationLevel.ERROR
|)
|fun oldLegacyFunction(typedParam: SomeOldType, someLiteral: String): String {}
|
|fun newShinyFunction(typedParam: SomeOldType, someLiteral: String, newTypedParam: SomeNewType): String {}
|class SomeOldType {}
|class SomeNewType {}
""".trimIndent(),
testConfiguration
) {
pagesTransformationStage = { module ->
val functionWithDeprecatedFunction = module.children
.single { it.name == "kotlin" }.children
.single { it.name == "oldLegacyFunction" } as ContentPage
functionWithDeprecatedFunction.content.assertNode {
group {
header(1) { +"oldLegacyFunction" }
}
divergentGroup {
divergentInstance {
divergent {
bareSignature(
annotations = emptyMap(),
visibility = "",
modifier = "",
keywords = emptySet(),
name = "oldLegacyFunction",
returnType = "String",
params = arrayOf(
"typedParam" to ParamAttributes(emptyMap(), emptySet(), "SomeOldType"),
"someLiteral" to ParamAttributes(emptyMap(), emptySet(), "String"),
)
)
}
after {
group {
header(3) {
+"Deprecated (with error)"
}
p {
+("Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Maecenas vel vulputate risus. Etiam dictum odio vel " +
"vulputate auctor.Nulla facilisi. Duis ullamcorper " +
"ullamcorper lectus nec rutrum. Quisque eu risus eu " +
"purus bibendum ultricies. Maecenas tincidunt dui in sodales faucibus. " +
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Proin id sem felis. Praesent et libero lacinia, egestas " +
"libero in, ultrices lectus. Suspendisse eget volutpat velit. " +
"Phasellus laoreet mi eu egestas mattis.")
}
header(4) {
+"Replace with"
}
codeBlock {
+"import com.example.dokka.debug.newShinyFunction"
br()
+"import com.example.dokka.debug.SomeOldType"
br()
+"import com.example.dokka.debug.SomeNewType"
br()
}
codeBlock {
+"newShinyFunction(typedParam, someLiteral, SomeNewType())"
}
}
group { pWrapped("Average function description") }
}
}
}
}
}
}
}
}
|
