-
-
Notifications
You must be signed in to change notification settings - Fork 757
/
KDocReferencesNonPublicPropertySpec.kt
134 lines (123 loc) · 3.46 KB
/
KDocReferencesNonPublicPropertySpec.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
package io.gitlab.arturbosch.detekt.rules.documentation
import io.gitlab.arturbosch.detekt.test.compileAndLint
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
class KDocReferencesNonPublicPropertySpec {
val subject = KDocReferencesNonPublicProperty()
@Test
fun `reports referenced non-public properties`() {
val code = """
/**
* Comment
* [prop1] - non-public property
* [prop2] - public property
*/
class Test {
private val nonReferencedProp = 0
private val prop1 = 0
val prop2 = 0
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `reports referenced non-public properties in private class`() {
val code = """
/**
* Comment
* [prop1] - non-public property
* [prop2] - public property
*/
private class Test {
private val nonReferencedProp = 0
private val prop1 = 0
val prop2 = 0
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `reports referenced non-public properties in nested objects`() {
val code = """
/**
* Comment
* [prop1] - non-public property
* [A.prop2] - non-public property
* [A.B.prop3] - non-public property
* [A.C.prop4] - non-public property
*/
class Test {
private val prop1 = 0
object A {
private val nonReferencedProp = 0
private val prop2 = 0
private object B {
val prop3 = 0
}
object C {
private val prop4 = 0
}
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(4)
}
@Test
fun `does not report properties with no KDoc`() {
val code = """
class Test {
private val prop1 = 0
val prop2 = 0
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report properties with empty comments`() {
val code = """
/**
*/
class Test {
private val prop1 = 0
val prop2 = 0
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report properties not enclosed in a class`() {
val code = """
/**
* [prop1]
* [prop2]
*/
private val prop1 = 0
val prop2 = 0
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report referenced public properties in nested objects`() {
val code = """
/**
* Comment
* [prop1] - public property
* [A.B.prop2] - public property
* [C.prop3] - public property
*/
open class Test {
protected val prop1 = 0
object A {
object B {
val nonReferencedProp = 0
val prop2 = 0
}
}
object C {
val prop3 = 0
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
}