forked from detekt/detekt
/
MultiRuleCollector.kt
128 lines (107 loc) · 4.3 KB
/
MultiRuleCollector.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
package io.gitlab.arturbosch.detekt.generator.collection
import io.gitlab.arturbosch.detekt.api.DetektVisitor
import io.gitlab.arturbosch.detekt.generator.collection.exception.InvalidDocumentationException
import io.gitlab.arturbosch.detekt.rules.isOverride
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtClassOrObject
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.psi.KtProperty
import org.jetbrains.kotlin.psi.KtReferenceExpression
import org.jetbrains.kotlin.psi.KtSuperTypeList
import org.jetbrains.kotlin.psi.KtValueArgumentList
import org.jetbrains.kotlin.psi.psiUtil.containingClass
import org.jetbrains.kotlin.psi.psiUtil.referenceExpression
data class MultiRule(
val name: String,
val rules: List<String> = emptyList()
) {
operator fun contains(ruleName: String) = ruleName in this.rules
}
@Suppress("DEPRECATION")
private val multiRule = io.gitlab.arturbosch.detekt.api.MultiRule::class.simpleName.orEmpty()
class MultiRuleCollector : Collector<MultiRule> {
override val items = mutableListOf<MultiRule>()
override fun visit(file: KtFile) {
val visitor = MultiRuleVisitor()
file.accept(visitor)
if (visitor.containsMultiRule) {
items.add(visitor.getMultiRule())
}
}
}
class MultiRuleVisitor : DetektVisitor() {
val containsMultiRule
get() = classesMap.any { it.value }
private val classesMap = mutableMapOf<String, Boolean>()
private var name = ""
private val rulesVisitor = RuleListVisitor()
private val properties: MutableMap<String, String> = mutableMapOf()
fun getMultiRule(): MultiRule {
val rules = mutableListOf<String>()
val ruleProperties = rulesVisitor.ruleProperties
.mapNotNull { properties[it] }
rules.addAll(ruleProperties)
rules.addAll(rulesVisitor.ruleNames)
if (name.isEmpty()) {
throw InvalidDocumentationException("MultiRule without name found.")
}
if (rules.isEmpty()) {
throw InvalidDocumentationException("MultiRule $name contains no rules.")
}
return MultiRule(name, rules)
}
override fun visitSuperTypeList(list: KtSuperTypeList) {
val isMultiRule = list.entries
?.mapNotNull { it.typeAsUserType?.referencedName }
?.any { it == multiRule }
?: false
val containingClass = list.containingClass()
val className = containingClass?.name
if (containingClass != null && className != null && !classesMap.containsKey(className)) {
classesMap[className] = isMultiRule
}
super.visitSuperTypeList(list)
}
override fun visitClassOrObject(classOrObject: KtClassOrObject) {
super.visitClassOrObject(classOrObject)
if (classesMap[classOrObject.name] != true) {
return
}
name = classOrObject.name?.trim().orEmpty()
}
override fun visitProperty(property: KtProperty) {
super.visitProperty(property)
if (classesMap[property.containingClass()?.name] != true) {
return
}
if (property.isOverride() && property.name != null && property.name == "rules") {
property.accept(rulesVisitor)
} else {
val name = property.name
val initializer = property.initializer?.referenceExpression()?.text
if (name != null && initializer != null) {
properties[name] = initializer
}
}
}
}
class RuleListVisitor : DetektVisitor() {
val ruleNames: MutableSet<String> = mutableSetOf()
val ruleProperties: MutableSet<String> = mutableSetOf()
override fun visitValueArgumentList(list: KtValueArgumentList) {
super.visitValueArgumentList(list)
val argumentExpressions = list.arguments.map { it.getArgumentExpression() }
// Call Expression = Constructor of rule
ruleNames.addAll(
argumentExpressions
.filterIsInstance<KtCallExpression>()
.map { it.calleeExpression?.text.orEmpty() }
)
// Reference Expression = variable we need to search for
ruleProperties.addAll(
argumentExpressions
.filterIsInstance<KtReferenceExpression>()
.map { it.text.orEmpty() }
)
}
}