/
BooleanPropertyNaming.kt
101 lines (86 loc) · 3.49 KB
/
BooleanPropertyNaming.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
package io.gitlab.arturbosch.detekt.rules.naming
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.config
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.api.internal.RequiresTypeResolution
import io.gitlab.arturbosch.detekt.rules.fqNameOrNull
import io.gitlab.arturbosch.detekt.rules.identifierName
import io.gitlab.arturbosch.detekt.rules.isConstant
import io.gitlab.arturbosch.detekt.rules.isOverride
import org.jetbrains.kotlin.psi.KtCallableDeclaration
import org.jetbrains.kotlin.psi.KtParameter
import org.jetbrains.kotlin.psi.KtProperty
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.typeBinding.createTypeBindingForReturnType
/**
* Reports when a boolean property doesn't match a pattern
*
* <noncompliant>
* val progressBar: Boolean = true
* </noncompliant>
*
* <compliant>
* val hasProgressBar: Boolean = true
* </compliant>
*/
@RequiresTypeResolution
class BooleanPropertyNaming(config: Config = Config.empty) : Rule(config) {
@Configuration("naming pattern")
private val allowedPattern: Regex by config("^(is|has|are)", String::toRegex)
@Configuration("ignores properties that have the override modifier")
private val ignoreOverridden: Boolean by config(true)
override val issue = Issue(
javaClass.simpleName,
Severity.CodeSmell,
"Boolean property name should follow the naming convention set in the projects configuration.",
Debt.FIVE_MINS
)
override fun visitParameter(parameter: KtParameter) {
super.visitParameter(parameter)
if (parameter.hasValOrVar()) {
validateDeclaration(parameter)
}
}
override fun visitProperty(property: KtProperty) {
super.visitProperty(property)
validateDeclaration(property)
}
private fun validateDeclaration(declaration: KtCallableDeclaration) {
val name = declaration.identifierName()
val typeName = getTypeName(declaration)
val isBooleanType =
typeName == KOTLIN_BOOLEAN_TYPE_NAME || typeName == JAVA_BOOLEAN_TYPE_NAME
val isNonConstantBooleanType = isBooleanType && !declaration.isConstant()
if (isNonConstantBooleanType && !name.contains(allowedPattern) && !isIgnoreOverridden(declaration)) {
report(reportCodeSmell(declaration, name))
}
}
private fun reportCodeSmell(
declaration: KtCallableDeclaration,
name: String
): CodeSmell {
val description = "Boolean property name should match a $allowedPattern pattern."
return CodeSmell(
issue,
Entity.from(declaration),
message = "$description Actual name is $name"
)
}
private fun getTypeName(parameter: KtCallableDeclaration): String {
return parameter.createTypeBindingForReturnType(bindingContext)
?.type
?.fqNameOrNull()
.toString()
}
private fun isIgnoreOverridden(declaration: KtCallableDeclaration) = ignoreOverridden && declaration.isOverride()
companion object {
const val KOTLIN_BOOLEAN_TYPE_NAME = "kotlin.Boolean"
const val JAVA_BOOLEAN_TYPE_NAME = "java.lang.Boolean"
}
}