MaxChainedCallsOnSameLine: don't count package references as chained …

…calls (#5036) * MaxChainedCallsOnSameLine: don't count package references as chained calls * Use compileAndLintWithContext
detekt · Jul 5, 2022 · aa2a1bf · aa2a1bf
1 parent c953140
commit aa2a1bf
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 15 deletions.
diff --git a/...tyle/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/MaxChainedCallsOnSameLine.kt b/...tyle/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/MaxChainedCallsOnSameLine.kt
@@ -9,11 +9,15 @@ 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.
@@ -27,6 +31,7 @@ import org.jetbrains.kotlin.psi.KtUnaryExpression
  *   .d().e().f()
  * </compliant>
  */
+@RequiresTypeResolution
 class MaxChainedCallsOnSameLine(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue(
         id = javaClass.simpleName,
@@ -38,9 +43,12 @@ class MaxChainedCallsOnSameLine(config: Config = Config.empty) : Rule(config) {
     @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
@@ -63,13 +71,21 @@ class MaxChainedCallsOnSameLine(config: Config = Config.empty) : Rule(config) {
 
     private fun KtExpression.countChainedCalls(): Int {
         return when (this) {
-            is KtQualifiedExpression ->
-                if (callOnNewLine()) 0 else receiverExpression.countChainedCalls() + 1
+            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

diff --git a/.../src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/MaxChainedCallsOnSameLineSpec.kt b/.../src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/MaxChainedCallsOnSameLineSpec.kt
@@ -1,58 +1,61 @@
 package io.gitlab.arturbosch.detekt.rules.style
 
+import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest
 import io.gitlab.arturbosch.detekt.test.TestConfig
 import io.gitlab.arturbosch.detekt.test.assertThat
-import io.gitlab.arturbosch.detekt.test.compileAndLint
+import io.gitlab.arturbosch.detekt.test.compileAndLintWithContext
 import io.gitlab.arturbosch.detekt.test.lint
+import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
 import org.junit.jupiter.api.Test
 
-class MaxChainedCallsOnSameLineSpec {
+@KotlinCoreEnvironmentTest
+class MaxChainedCallsOnSameLineSpec(private val env: KotlinCoreEnvironment) {
     @Test
     fun `does not report 2 calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0.plus(0)"
 
-        assertThat(rule.compileAndLint(code)).isEmpty()
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
     }
 
     @Test
     fun `does not report 3 calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0.plus(0).plus(0)"
 
-        assertThat(rule.compileAndLint(code)).isEmpty()
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
     }
 
     @Test
     fun `reports 4 calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0.plus(0).plus(0).plus(0)"
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
     fun `reports 4 safe qualified calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0?.plus(0)?.plus(0)?.plus(0)"
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
     fun `reports 4 non-null asserted calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0!!.plus(0)!!.plus(0)!!.plus(0)"
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
     fun `reports once for 7 calls on a single line with a max of 3`() {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "val a = 0.plus(0).plus(0).plus(0).plus(0).plus(0).plus(0)"
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
@@ -66,7 +69,7 @@ class MaxChainedCallsOnSameLineSpec {
                 .plus(0)
         """
 
-        assertThat(rule.compileAndLint(code)).isEmpty()
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
     }
 
     @Test
@@ -78,7 +81,7 @@ class MaxChainedCallsOnSameLineSpec {
                 .plus(0).plus(0).plus(0)
         """
 
-        assertThat(rule.compileAndLint(code)).isEmpty()
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
     }
 
     @Test
@@ -90,7 +93,7 @@ class MaxChainedCallsOnSameLineSpec {
                 .plus(0)
         """
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
@@ -103,7 +106,7 @@ class MaxChainedCallsOnSameLineSpec {
                 .plus(0)
         """
 
-        assertThat(rule.compileAndLint(code)).hasSize(1)
+        assertThat(rule.compileAndLintWithContext(env, code)).hasSize(1)
     }
 
     @Test
@@ -119,6 +122,24 @@ class MaxChainedCallsOnSameLineSpec {
         val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
         val code = "package a.b.c.d.e"
 
-        assertThat(rule.lint(code)).isEmpty()
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
+    }
+
+    @Test
+    fun `does not count package references as chained calls`() {
+        val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
+        val code = """
+            val x = kotlin.math.floor(1.0).plus(1).plus(1)
+        """
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
+    }
+
+    @Test
+    fun `does not count a package reference as chained calls`() {
+        val rule = MaxChainedCallsOnSameLine(TestConfig(mapOf("maxChainedCalls" to 3)))
+        val code = """
+            val x = kotlin.run { 1 }.plus(1).plus(1)
+        """
+        assertThat(rule.compileAndLintWithContext(env, code)).isEmpty()
     }
 }