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

Fixed duplicate @property generation for parameter with ' in name #1873

Merged
merged 3 commits into from
Dec 18, 2023
Merged

Fixed duplicate @property generation for parameter with ' in name #1873

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cdde3c
Fixed duplicate `@property` generation for parameter with ' in name
DrAlexD Dec 18, 2023
ffc577b
- detekt fix
DrAlexD Dec 18, 2023
ca8dddf
Merge branch 'master' into bugifx/property_duplicate
DrAlexD Dec 18, 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
52 changes: 21 additions & 31 deletions ...-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,8 @@
kdocBeforeClass: ASTNode,
isParamTagNeeded: Boolean
) {
val parameterName = node.findChildByType(IDENTIFIER)!!.text
val parameterTagInClassKdoc = kdocBeforeClass
.kDocTags()
.firstOrNull { (it.knownTag == KDocKnownTag.PARAM || it.knownTag == KDocKnownTag.PROPERTY) && it.getSubjectName() == parameterName }
val parameterName = getParameterName(node)
val parameterTagInClassKdoc = findParameterTagInClassKdoc(kdocBeforeClass, parameterName)

parameterTagInClassKdoc?.let {
val correctTag = if (isParamTagNeeded) KDocKnownTag.PARAM else KDocKnownTag.PROPERTY
Expand Down Expand Up @@ -303,7 +301,7 @@
@Suppress("UnsafeCallOnNullableType")
private fun createKdocBasicKdoc(node: ASTNode, isParamTagNeeded: Boolean) {
if (isNeedToWarn(node, isParamTagNeeded)) {
val parameterName = node.findChildByType(IDENTIFIER)!!.text
val parameterName = getParameterName(node)
val warningText = if (isParamTagNeeded) "add param <$parameterName> to KDoc" else "add property <$parameterName> to KDoc"

KDOC_NO_CONSTRUCTOR_PROPERTY.warnAndFix(configRules, emitWarn, isFixMode, warningText, node.startOffset, node) {
Expand All @@ -324,7 +322,7 @@
isParamTagNeeded: Boolean
) {
if (isNeedToWarn(node, isParamTagNeeded)) {
val parameterName = node.findChildByType(IDENTIFIER)!!.text
val parameterName = getParameterName(node)
val classNode = node.parent { it.elementType == CLASS }!!

// if property or parameter is documented with KDoc, which has a tag inside, then it can contain some additional more
Expand All @@ -334,7 +332,8 @@
val warningText = if (isParamTagNeeded) "add comment for param <$parameterName> to KDoc" else "add comment for property <$parameterName> to KDoc"

KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT.warnOnlyOrWarnAndFix(configRules, emitWarn, warningText, prevComment.startOffset, node, isFixable, isFixMode) {
val newKdocText = createClassKdocTextFromComment(prevComment, parameterName, isParamTagNeeded)
val paramOrPropertyTagText = if (isParamTagNeeded) "@param" else "@property"
val newKdocText = createClassKdocTextFromComment(prevComment, parameterName, paramOrPropertyTagText)
val newKdoc = KotlinParser().createNode(newKdocText).findChildByType(KDOC)!!

classNode.addChild(PsiWhiteSpaceImpl("\n"), classNode.firstChildNode)
Expand All @@ -347,23 +346,11 @@
private fun createClassKdocTextFromComment(
prevComment: ASTNode,
parameterName: String,
isParamTagNeeded: Boolean
paramOrPropertyTagText: String
) = when (prevComment.elementType) {
KDOC -> if (isParamTagNeeded) {
"/**\n * @param $parameterName${createClassKdocTextFromKdocComment(prevComment)}\n */"
} else {
"/**\n * @property $parameterName${createClassKdocTextFromKdocComment(prevComment)}\n */"
}
EOL_COMMENT -> if (isParamTagNeeded) {
"/**\n * @param $parameterName ${createClassKdocTextFromEolComment(prevComment)}\n */"
} else {
"/**\n * @property $parameterName ${createClassKdocTextFromEolComment(prevComment)}\n */"
}
else -> if (isParamTagNeeded) {
"/**\n * @param $parameterName${createClassKdocTextFromBlockComment(prevComment)}\n */"
} else {
"/**\n * @property $parameterName${createClassKdocTextFromBlockComment(prevComment)}\n */"
}
KDOC -> "/**\n * $paramOrPropertyTagText $parameterName${createClassKdocTextFromKdocComment(prevComment)}\n */"
EOL_COMMENT -> "/**\n * $paramOrPropertyTagText $parameterName ${createClassKdocTextFromEolComment(prevComment)}\n */"
else -> "/**\n * $paramOrPropertyTagText $parameterName${createClassKdocTextFromBlockComment(prevComment)}\n */"
}

private fun createClassKdocTextFromKdocComment(prevComment: ASTNode) =
Expand Down Expand Up @@ -401,10 +388,8 @@
prevComment: ASTNode,
isParamTagNeeded: Boolean
) {
val parameterName = node.findChildByType(IDENTIFIER)!!.text
val parameterTagInClassKdoc = kdocBeforeClass
.kDocTags()
.firstOrNull { (it.knownTag == KDocKnownTag.PARAM || it.knownTag == KDocKnownTag.PROPERTY) && it.getSubjectName() == parameterName }
val parameterName = getParameterName(node)
val parameterTagInClassKdoc = findParameterTagInClassKdoc(kdocBeforeClass, parameterName)
val parameterInClassKdoc = parameterTagInClassKdoc?.node

val commentText = if (prevComment.elementType == KDOC) {
Expand Down Expand Up @@ -456,10 +441,8 @@
prevComment: ASTNode,
isParamTagNeeded: Boolean
) {
val parameterName = node.findChildByType(IDENTIFIER)!!.text
val parameterTagInClassKdoc = kdocBeforeClass
.kDocTags()
.firstOrNull { (it.knownTag == KDocKnownTag.PARAM || it.knownTag == KDocKnownTag.PROPERTY) && it.getSubjectName() == parameterName }
val parameterName = getParameterName(node)
val parameterTagInClassKdoc = findParameterTagInClassKdoc(kdocBeforeClass, parameterName)
val parameterInClassKdoc = parameterTagInClassKdoc?.node

val (isHasWrongTag, warningText) = checkWrongTagAndMakeWarningText(parameterTagInClassKdoc, parameterName, isParamTagNeeded)
Expand Down Expand Up @@ -500,6 +483,13 @@
}
}

private fun getParameterName(node: ASTNode) = node.findChildByType(IDENTIFIER)!!.text.replace("`", "")
Fixed Show fixed Hide fixed

private fun findParameterTagInClassKdoc(kdocBeforeClass: ASTNode, parameterName: String) =
kdocBeforeClass
.kDocTags()
.firstOrNull { (it.knownTag == KDocKnownTag.PARAM || it.knownTag == KDocKnownTag.PROPERTY) && it.getSubjectName() == parameterName }

private fun checkWrongTagAndMakeWarningText(
parameterTagInClassKdoc: KDocTag?,
parameterName: String,
Expand Down
13 changes: 13 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentExpected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,3 +309,16 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

/**
* kdoc
* class
* comment
*
* @property as
kgevorkyan marked this conversation as resolved.
Show resolved Hide resolved
* @property keyAs
*/
actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
9 changes: 9 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentNoKDocExpected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,12 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

/**
* @property as
* @property keyAs
*/
actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
5 changes: 5 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentNoKDocTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,3 +223,8 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
9 changes: 9 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentPropertiesExpected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,3 +263,12 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

/**
* @property keyAs
* @property as
*/
actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
8 changes: 8 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentPropertiesTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,3 +289,11 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

/**
* @property keyAs
*/
actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
10 changes: 10 additions & 0 deletions diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,3 +308,13 @@ class A<K : Any, P: Any, G: Any> constructor(
*/
paramAddr: String,
) : B<K>(), C<P>, D<G> {}

/**
* kdoc
* class
* comment
*/
actual annotation class JsonSerialize(
actual val `as`: KClass<*>,
actual val keyAs: KClass<*>,
)
Loading