/
ViolateTypeResolutionRequirements.kt
96 lines (86 loc) · 3.82 KB
/
ViolateTypeResolutionRequirements.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
@file:Suppress("ForbiddenComment")
package io.gitlab.arturbosch.detekt.authors
import io.gitlab.arturbosch.detekt.api.BaseRule
import io.gitlab.arturbosch.detekt.api.CodeSmell
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.Debt
import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import io.gitlab.arturbosch.detekt.rules.fqNameOrNull
import org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.psi.KtNameReferenceExpression
import org.jetbrains.kotlin.psi.KtReferenceExpression
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameOrNull
import org.jetbrains.kotlin.resolve.descriptorUtil.getAllSuperclassesWithoutAny
import kotlin.reflect.KClass
/**
* If a rule uses the property [BaseRule.bindingContext] should be annotated with `@RequiresTypeResolution`.
* And if the rule doesn't use that property it shouldn't be annotated with it.
*/
@ActiveByDefault("1.22.0")
@RequiresTypeResolution
class ViolateTypeResolutionRequirements(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Defect,
"`@RequiresTypeResolution` should be used if and only if the property `bindingContext` is used.",
Debt.FIVE_MINS
)
private val klasses: MutableList<KtClass> = mutableListOf()
private var usesBindingContext: Boolean = false
override fun visitKtFile(file: KtFile) {
super.visitKtFile(file)
klasses.forEach { klass ->
val isAnnotatedWithRequiresTypeResolution = klass.isAnnotatedWith(RequiresTypeResolution::class)
if (usesBindingContext && !isAnnotatedWithRequiresTypeResolution) {
report(
CodeSmell(
issue,
Entity.atName(klass),
"`${klass.name}` uses `bindingContext` but is not annotated with `@RequiresTypeResolution`"
)
)
} else if (!usesBindingContext && isAnnotatedWithRequiresTypeResolution) {
report(
CodeSmell(
issue,
Entity.atName(klass),
"`${klass.name}` is annotated with `@RequiresTypeResolution` but doesn't use `bindingContext`"
)
)
}
}
klasses.clear()
usesBindingContext = false
}
override fun visitClass(klass: KtClass) {
super.visitClass(klass)
if (klass.extendsFrom(BaseRule::class)) {
klasses.add(klass)
}
}
override fun visitReferenceExpression(expression: KtReferenceExpression) {
super.visitReferenceExpression(expression)
usesBindingContext = usesBindingContext ||
(expression is KtNameReferenceExpression && expression.text == "bindingContext")
}
}
context(BaseRule) private inline fun <reified T : Any> KtClass.extendsFrom(kClass: KClass<T>): Boolean {
return bindingContext[BindingContext.CLASS, this]
?.getAllSuperclassesWithoutAny()
.orEmpty()
.any { it.fqNameOrNull()?.toString() == checkNotNull(kClass.qualifiedName) }
}
context(BaseRule) private inline fun <reified T : Any> KtClass.isAnnotatedWith(kClass: KClass<T>): Boolean {
return annotationEntries
.asSequence()
.mapNotNull { it.typeReference }
.mapNotNull { bindingContext[BindingContext.TYPE, it] }
.any { it.fqNameOrNull()?.toString() == checkNotNull(kClass.qualifiedName) }
}