/
RuleVisitor.kt
181 lines (158 loc) · 7.25 KB
/
RuleVisitor.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
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
package io.gitlab.arturbosch.detekt.generator.collection
import io.gitlab.arturbosch.detekt.api.Debt
import io.gitlab.arturbosch.detekt.api.DetektVisitor
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import io.gitlab.arturbosch.detekt.formatting.FormattingRule
import io.gitlab.arturbosch.detekt.generator.collection.exception.InvalidAliasesDeclaration
import io.gitlab.arturbosch.detekt.generator.collection.exception.InvalidDocumentationException
import io.gitlab.arturbosch.detekt.generator.collection.exception.InvalidIssueDeclaration
import io.gitlab.arturbosch.detekt.rules.empty.EmptyRule
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtClassOrObject
import org.jetbrains.kotlin.psi.KtProperty
import org.jetbrains.kotlin.psi.KtSuperTypeList
import org.jetbrains.kotlin.psi.KtValueArgument
import org.jetbrains.kotlin.psi.psiUtil.containingClass
import org.jetbrains.kotlin.psi.psiUtil.getSuperNames
import java.lang.reflect.Modifier
internal class RuleVisitor : DetektVisitor() {
val containsRule
get() = classesMap.any { it.value }
private var name = ""
private val documentationCollector = DocumentationCollector()
private var defaultActivationStatus: DefaultActivationStatus = Inactive
private var autoCorrect = false
private var requiresTypeResolution = false
private var severity = ""
private var debt = ""
private var aliases: String? = null
private var parent = ""
private val configurationCollector = ConfigurationCollector()
private val classesMap = mutableMapOf<String, Boolean>()
private var deprecationMessage: String? = null
fun getRule(): Rule {
if (documentationCollector.description.isEmpty()) {
throw InvalidDocumentationException("Rule $name is missing a description in its KDoc.")
}
val configurationByAnnotation = configurationCollector.getConfiguration()
return Rule(
name = name,
description = documentationCollector.description,
nonCompliantCodeExample = documentationCollector.nonCompliant,
compliantCodeExample = documentationCollector.compliant,
defaultActivationStatus = defaultActivationStatus,
severity = severity,
debt = debt,
aliases = aliases,
parent = parent,
configuration = configurationByAnnotation,
autoCorrect = autoCorrect,
deprecationMessage = deprecationMessage,
requiresTypeResolution = requiresTypeResolution
)
}
override fun visitSuperTypeList(list: KtSuperTypeList) {
val isRule = list.entries
?.asSequence()
?.map { it.typeAsUserType?.referencedName }
?.any { ruleClasses.contains(it) }
?: false
val containingClass = list.containingClass()
val className = containingClass?.name
if (containingClass != null && className != null && !classesMap.containsKey(className)) {
classesMap[className] = isRule
parent = containingClass.getSuperNames().firstOrNull { ruleClasses.contains(it) }.orEmpty()
extractIssueSeverityAndDebt(containingClass)
extractAliases(containingClass)
}
super.visitSuperTypeList(list)
}
override fun visitClassOrObject(classOrObject: KtClassOrObject) {
super.visitClassOrObject(classOrObject)
if (classesMap[classOrObject.name] != true) {
return
}
name = checkNotNull(classOrObject.name?.trim()) { "Unable to determine rule name." }
// Use unparsed KDoc text here to check for tabs
// Parsed [KDocSection] element contains no tabs
if (classOrObject.docComment?.text?.contains('\t') == true) {
throw InvalidDocumentationException("KDoc for rule $name must not contain tabs")
}
if (classOrObject.hasConfigurationKDocTag()) {
throw InvalidDocumentationException(
"Configuration of rule $name is invalid. Rule configuration via KDoc tag is no longer supported. " +
"Use config delegate instead."
)
}
if (classOrObject.isAnnotatedWith(ActiveByDefault::class)) {
val activeByDefaultSinceValue = classOrObject.firstAnnotationParameter(ActiveByDefault::class)
defaultActivationStatus = Active(since = activeByDefaultSinceValue)
}
autoCorrect = classOrObject.isAnnotatedWith(AutoCorrectable::class)
requiresTypeResolution = classOrObject.isAnnotatedWith(RequiresTypeResolution::class)
deprecationMessage = classOrObject.firstAnnotationParameterOrNull(Deprecated::class)
documentationCollector.setClass(classOrObject)
}
override fun visitProperty(property: KtProperty) {
super.visitProperty(property)
configurationCollector.addProperty(property)
}
override fun visitClass(klass: KtClass) {
super.visitClass(klass)
klass.companionObjects.forEach(configurationCollector::addCompanion)
}
private fun extractAliases(klass: KtClass) {
val initializer = klass.getProperties()
.singleOrNull { it.name == "defaultRuleIdAliases" }
?.initializer
if (initializer != null) {
aliases = (
initializer as? KtCallExpression
?: throw InvalidAliasesDeclaration()
)
.valueArguments
.joinToString(", ") { it.text.replace("\"", "") }
}
}
private fun extractIssueSeverityAndDebt(klass: KtClass) {
val arguments = (
klass.getProperties()
.singleOrNull { it.name == "issue" }
?.initializer as? KtCallExpression
)
?.valueArguments
.orEmpty()
if (arguments.size >= ISSUE_ARGUMENT_SIZE) {
severity = getArgument(arguments[1], "Severity")
val debtName = getArgument(arguments[DEBT_ARGUMENT_INDEX], "Debt")
val debtDeclarations = Debt::class.java.declaredFields.filter { Modifier.isStatic(it.modifiers) }
val debtDeclaration = debtDeclarations.singleOrNull { it.name == debtName }
if (debtDeclaration != null) {
debtDeclaration.isAccessible = true
debt = debtDeclaration[Debt::class.java].toString()
}
}
}
private fun getArgument(argument: KtValueArgument, name: String): String {
val text = argument.text
val type = text.split('.')
if (text.startsWith(name, true) && type.size == 2) {
return type[1]
}
throw InvalidIssueDeclaration(name)
}
companion object {
@Suppress("DEPRECATION")
private val ruleClasses = listOf(
io.gitlab.arturbosch.detekt.api.Rule::class.simpleName,
FormattingRule::class.simpleName,
io.gitlab.arturbosch.detekt.api.ThresholdRule::class.simpleName,
EmptyRule::class.simpleName
)
private const val ISSUE_ARGUMENT_SIZE = 4
private const val DEBT_ARGUMENT_INDEX = 3
}
}