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

Allow factory methods to use generics, and to overload other factory … #2366

Merged
merged 1 commit into from
Nov 19, 2023
Merged

Allow factory methods to use generics, and to overload other factory … #2366

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion ...tandard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ package com.pinterest.ktlint.ruleset.standard.rules
import com.pinterest.ktlint.rule.engine.core.api.ElementType
import com.pinterest.ktlint.rule.engine.core.api.ElementType.ANNOTATION
import com.pinterest.ktlint.rule.engine.core.api.ElementType.ANNOTATION_ENTRY
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CALL_EXPRESSION
import com.pinterest.ktlint.rule.engine.core.api.ElementType.FUN
import com.pinterest.ktlint.rule.engine.core.api.ElementType.FUN_KEYWORD
import com.pinterest.ktlint.rule.engine.core.api.ElementType.IDENTIFIER
import com.pinterest.ktlint.rule.engine.core.api.ElementType.IMPORT_DIRECTIVE
import com.pinterest.ktlint.rule.engine.core.api.ElementType.MODIFIER_LIST
import com.pinterest.ktlint.rule.engine.core.api.ElementType.OVERRIDE_KEYWORD
import com.pinterest.ktlint.rule.engine.core.api.ElementType.REFERENCE_EXPRESSION
import com.pinterest.ktlint.rule.engine.core.api.ElementType.USER_TYPE
import com.pinterest.ktlint.rule.engine.core.api.ElementType.VALUE_PARAMETER_LIST
import com.pinterest.ktlint.rule.engine.core.api.RuleId
import com.pinterest.ktlint.rule.engine.core.api.SinceKtlint
Expand Down Expand Up @@ -81,7 +84,34 @@ public class FunctionNamingRule :

private fun ASTNode.isFactoryMethod() =
(this.psi as KtFunction)
.let { it.hasDeclaredReturnType() && it.name == it.typeReference?.text }
.let { ktFunction ->
if (ktFunction.hasDeclaredReturnType()) {
// Allow:
// fun Foo(): Foo = ..
// fun <T> Foo(action: () -> T): Foo<T> = ..
ktFunction.name == ktFunction.typeReferenceNameWithoutGenerics()
} else {
// Allow factory methods to overload another factory method or class constructor without specifying the type like:
// fun Foo(value: Bar) = Foo(value.baz())
ktFunction.name == callExpressionReferenceIdentifier(ktFunction)
}
}

private fun KtFunction.typeReferenceNameWithoutGenerics() =
typeReference
?.node
?.findChildByType(USER_TYPE)
?.findChildByType(REFERENCE_EXPRESSION)
?.text

private fun callExpressionReferenceIdentifier(ktFunction: KtFunction) =
ktFunction
.bodyExpression
?.node
?.takeIf { it.elementType == CALL_EXPRESSION }
?.findChildByType(REFERENCE_EXPRESSION)
?.findChildByType(IDENTIFIER)
?.text

private fun ASTNode.isMethodInTestClass() = isTestClass && hasValidTestFunctionName()

Expand Down
20 changes: 20 additions & 0 deletions ...ard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,24 @@ class FunctionNamingRuleTest {
.withEditorConfigOverride(IGNORE_WHEN_ANNOTATED_WITH_PROPERTY to "Composable, Foo")
.hasNoLintViolations()
}

@Test
fun `Issue 2350 - Given a factory method with generic type`() {
val code =
"""
fun <T> Generics(action: () -> T): Generics<T> = Generics(action())
""".trimIndent()
functionNamingRuleAssertThat(code).hasNoLintViolations()
}

@Test
fun `Issue 2350 - Given a factory method which overloads a class constructor`() {
val code =
"""
class Foo(value: String)

fun Foo(value: Double) = Foo(value.toString())
""".trimIndent()
functionNamingRuleAssertThat(code).hasNoLintViolations()
}
}