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

Fixed KdocMethods #1757

Merged
merged 2 commits into from
Oct 3, 2023
Merged

Fixed KdocMethods #1757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
294f7a4
### What's done:
DrAlexD Oct 2, 2023
9492b66
Merge branch 'master' into feature/fix-kdoc-methods
DrAlexD Oct 2, 2023
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
29 changes: 18 additions & 11 deletions ...t-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import org.jetbrains.kotlin.kdoc.psi.impl.KDocTag
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.lexer.KtTokens.COLON
import org.jetbrains.kotlin.lexer.KtTokens.EQ
import org.jetbrains.kotlin.lexer.KtTokens.WHITE_SPACE
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtCatchClause
import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
Expand Down Expand Up @@ -106,11 +107,10 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(

val explicitlyThrownExceptions = getExplicitlyThrownExceptions(node) + getRethrownExceptions(node)
val missingExceptions = explicitlyThrownExceptions
.minus(kdocTags
.minus((kdocTags
?.filter { it.knownTag == KDocKnownTag.THROWS }
?.mapNotNull { it.getSubjectName() }
?.toSet() ?: emptySet(),
)
?.mapNotNull { it.getSubjectLinkName() }
?.toSet() ?: emptySet()).toSet())

val paramCheckFailed = (missingParameters.isNotEmpty() && !node.isSingleLineGetterOrSetter()) || kDocMissingParameters.isNotEmpty()
val returnCheckFailed = hasReturnCheckFailed(node, kdocTags)
Expand All @@ -135,14 +135,21 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
}
}

private fun KDocTag.getSubjectLinkName(): String? =
node.getChildren(null)
.dropWhile { it.elementType == KDocTokens.TAG_NAME }
.dropWhile { it.elementType == WHITE_SPACE }
.firstOrNull { it.elementType == KDocTokens.MARKDOWN_LINK }
?.text

@Suppress("TYPE_ALIAS")
private fun getMissingParameters(node: ASTNode, kdocTags: Collection<KDocTag>?): Pair<List<String?>, List<KDocTag>> {
val parameterNames = node.parameterNames()
val kdocParamList = kdocTags?.filter { it.knownTag == KDocKnownTag.PARAM && it.getSubjectName() != null }
val kdocParamList = kdocTags?.filter { it.knownTag == KDocKnownTag.PARAM && it.getSubjectLinkName() != null }
return if (parameterNames.isEmpty()) {
Pair(emptyList(), kdocParamList ?: emptyList())
} else if (kdocParamList != null && kdocParamList.isNotEmpty()) {
Pair(parameterNames.minus(kdocParamList.map { it.getSubjectName() }), kdocParamList.filter { it.getSubjectName() !in parameterNames })
} else if (!kdocParamList.isNullOrEmpty()) {
Pair(parameterNames.minus(kdocParamList.map { it.getSubjectLinkName() }.toSet()), kdocParamList.filter { it.getSubjectLinkName() !in parameterNames })
} else {
Pair(parameterNames.toList(), emptyList())
}
Expand Down Expand Up @@ -217,7 +224,7 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
) {
kdocMissingParameters.forEach {
KDOC_WITHOUT_PARAM_TAG.warn(configRules, emitWarn,
"${it.getSubjectName()} param isn't present in argument list", it.node.startOffset,
"${ it.getSubjectLinkName() } param isn't present in argument list", it.node.startOffset,
it.node)
}
if (missingParameters.isNotEmpty()) {
Expand All @@ -229,7 +236,7 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
kdoc?.insertTagBefore(beforeTag?.node) {
addChild(LeafPsiElement(KDocTokens.TAG_NAME, "@param"))
addChild(PsiWhiteSpaceImpl(" "))
addChild(LeafPsiElement(KDocTokens.TEXT, it))
addChild(LeafPsiElement(KDocTokens.MARKDOWN_LINK, it))
}
}
}
Expand Down Expand Up @@ -260,8 +267,8 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
missingExceptions.forEach {
kdoc?.insertTagBefore(null) {
addChild(LeafPsiElement(KDocTokens.TAG_NAME, "@throws"))
addChild(LeafPsiElement(KDocTokens.TEXT, " "))
addChild(LeafPsiElement(KDocTokens.TEXT, it))
addChild(PsiWhiteSpaceImpl(" "))
addChild(LeafPsiElement(KDocTokens.MARKDOWN_LINK, it))
}
}
}
Expand Down
4 changes: 0 additions & 4 deletions diktat-rules/src/test/kotlin/com/saveourtool/diktat/ruleset/chapter2/KdocMethodsFixTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import com.saveourtool.diktat.ruleset.rules.chapter2.kdoc.KdocMethods
import com.saveourtool.diktat.util.FixTestBase

import generated.WarningNames
import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Tags
import org.junit.jupiter.api.Test
Expand Down Expand Up @@ -37,7 +36,6 @@ class KdocMethodsFixTest : FixTestBase("test/paragraph2/kdoc/package/src/main/ko

@Test
@Tag(WarningNames.KDOC_WITHOUT_PARAM_TAG)
@Disabled("https://github.com/saveourtool/diktat/issues/1737")
fun `@param tag should be added to existing KDoc`() {
fixAndCompare("ParamTagInsertionExpected.kt", "ParamTagInsertionTested.kt")
}
Expand All @@ -50,7 +48,6 @@ class KdocMethodsFixTest : FixTestBase("test/paragraph2/kdoc/package/src/main/ko

@Test
@Tag(WarningNames.KDOC_WITHOUT_THROWS_TAG)
@Disabled("https://github.com/saveourtool/diktat/issues/1737")
fun `@throws tag should be added to existing KDoc`() {
fixAndCompare("ThrowsTagInsertionExpected.kt", "ThrowsTagInsertionTested.kt")
}
Expand All @@ -61,7 +58,6 @@ class KdocMethodsFixTest : FixTestBase("test/paragraph2/kdoc/package/src/main/ko
Tag(WarningNames.KDOC_WITHOUT_RETURN_TAG),
Tag(WarningNames.KDOC_WITHOUT_THROWS_TAG)
)
@Disabled("https://github.com/saveourtool/diktat/issues/1737")
fun `KdocMethods rule should reformat code (full example)`() {
fixAndCompare("KdocMethodsFullExpected.kt", "KdocMethodsFullTested.kt")
}
Expand Down
Loading