-
-
Notifications
You must be signed in to change notification settings - Fork 757
/
MaxChainedCallsOnSameLine.kt
100 lines (86 loc) · 3.72 KB
/
MaxChainedCallsOnSameLine.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
package io.gitlab.arturbosch.detekt.rules.style
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 org.jetbrains.kotlin.descriptors.PackageViewDescriptor
import org.jetbrains.kotlin.psi.KtExpression
import org.jetbrains.kotlin.psi.KtImportDirective
import org.jetbrains.kotlin.psi.KtPackageDirective
import org.jetbrains.kotlin.psi.KtQualifiedExpression
import org.jetbrains.kotlin.psi.KtReferenceExpression
import org.jetbrains.kotlin.psi.KtUnaryExpression
import org.jetbrains.kotlin.resolve.BindingContext
/**
* Limits the number of chained calls which can be placed on a single line.
*
* <noncompliant>
* a().b().c().d().e().f()
* </noncompliant>
*
* <compliant>
* a().b().c()
* .d().e().f()
* </compliant>
*/
@RequiresTypeResolution
class MaxChainedCallsOnSameLine(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
id = javaClass.simpleName,
severity = Severity.Style,
description = "Chained calls beyond the maximum should be wrapped to a new line.",
debt = Debt.FIVE_MINS,
)
@Configuration("maximum chained calls allowed on a single line")
private val maxChainedCalls: Int by config(defaultValue = 5)
@Suppress("ReturnCount")
override fun visitQualifiedExpression(expression: KtQualifiedExpression) {
super.visitQualifiedExpression(expression)
if (bindingContext == BindingContext.EMPTY) return
val parent = expression.parent
// skip if the parent is also a call on the same line to avoid duplicated warnings
if (parent is KtQualifiedExpression && !parent.callOnNewLine()) return
if (parent is KtImportDirective || parent is KtPackageDirective) return
val chainedCalls = expression.countChainedCalls() + 1
if (chainedCalls > maxChainedCalls) {
report(
CodeSmell(
issue = issue,
entity = Entity.from(expression),
message = "$chainedCalls chained calls on a single line; more than $maxChainedCalls calls should " +
"be wrapped to a new line."
)
)
}
}
private fun KtExpression.countChainedCalls(): Int {
return when (this) {
is KtQualifiedExpression -> when {
receiverExpression.isReferenceToPackage() || callOnNewLine() -> 0
else -> receiverExpression.countChainedCalls() + 1
}
is KtUnaryExpression -> baseExpression?.countChainedCalls() ?: 0
else -> 0
}
}
private fun KtExpression.isReferenceToPackage(): Boolean {
val selectorOrThis = (this as? KtQualifiedExpression)?.selectorExpression ?: this
if (selectorOrThis !is KtReferenceExpression) return false
return bindingContext[BindingContext.REFERENCE_TARGET, selectorOrThis] is PackageViewDescriptor
}
private fun KtQualifiedExpression.callOnNewLine(): Boolean {
val receiver = receiverExpression
val selector = selectorExpression ?: return false
val receiverEnd = receiver.startOffsetInParent + receiver.textLength
val selectorStart = selector.startOffsetInParent
return text
.subSequence(startIndex = receiverEnd, endIndex = selectorStart)
.contains('\n')
}
}