Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ReturnCount: correctly count assignment expressions with elvis return as guard clauses #5539

Merged
merged 1 commit into from Nov 18, 2022
Merged

ReturnCount: correctly count assignment expressions with elvis return as guard clauses #5539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion detekt-psi-utils/api/detekt-psi-utils.api
View file
Open in desktop
Expand Up @@ -45,7 +45,7 @@ public final class io/gitlab/arturbosch/detekt/rules/AllowedExceptionNamePattern
}

public final class io/gitlab/arturbosch/detekt/rules/GuardClausesKt {
public static final fun isElvisOperatorGuardClause (Lorg/jetbrains/kotlin/psi/KtExpression;)Z
public static final fun isElvisOperatorGuardClause (Lorg/jetbrains/kotlin/psi/KtExpression;Lorg/jetbrains/kotlin/psi/KtExpression;)Z
public static final fun isIfConditionGuardClause (Lorg/jetbrains/kotlin/psi/KtExpression;Lorg/jetbrains/kotlin/psi/KtExpression;)Z
}

Expand Down
9 changes: 4 additions & 5 deletions detekt-psi-utils/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/GuardClauses.kt
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@ import org.jetbrains.kotlin.psi.KtBinaryExpression
import org.jetbrains.kotlin.psi.KtExpression
import org.jetbrains.kotlin.psi.KtIfExpression
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.psi.psiUtil.anyDescendantOfType
import org.jetbrains.kotlin.psi.psiUtil.findDescendantOfType
import org.jetbrains.kotlin.psi.psiUtil.lastBlockStatementOrThis

Expand All @@ -23,7 +24,7 @@ inline fun <reified T : KtExpression> KtNamedFunction.yieldStatementsSkippingGua

inline fun <reified T : KtExpression> KtExpression.isGuardClause(): Boolean {
val descendantExpr = this.findDescendantOfType<T>() ?: return false
return this.isIfConditionGuardClause(descendantExpr) || this.isElvisOperatorGuardClause()
return this.isIfConditionGuardClause(descendantExpr) || this.isElvisOperatorGuardClause(descendantExpr)
}

fun <T : KtExpression> KtExpression.isIfConditionGuardClause(descendantExpr: T): Boolean {
Expand All @@ -32,7 +33,5 @@ fun <T : KtExpression> KtExpression.isIfConditionGuardClause(descendantExpr: T):
descendantExpr === ifExpr.then?.lastBlockStatementOrThis()
}

fun KtExpression.isElvisOperatorGuardClause(): Boolean {
val elvisExpr = this.findDescendantOfType<KtBinaryExpression>() ?: return false
return elvisExpr.operationToken == KtTokens.ELVIS
}
fun <T : KtExpression> KtExpression.isElvisOperatorGuardClause(descendantExpr: T): Boolean =
this.anyDescendantOfType<KtBinaryExpression> { it.operationToken == KtTokens.ELVIS && it.right == descendantExpr }
4 changes: 3 additions & 1 deletion ...kt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ReturnCountSpec.kt
View file
Open in desktop
Expand Up @@ -186,10 +186,12 @@ class ReturnCountSpec {
@Nested
inner class `a file with multiple guard clauses` {
val code = """
fun multipleGuards(a: Int?, b: Any?, c: Int?) {
var x = 1
fun multipleGuards(a: Int?, b: Any?, c: Int?, d: Int?) {
if(a == null) return
val models = b as? Int ?: return
val position = c?.takeIf { it != -1 } ?: return
x = d ?: return
if(b !is String) {
println("b is not a String")
return
Expand Down