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

Bugfix. CommentsRule doesn't detect commented out class declaration #630

Merged
merged 10 commits into from
Dec 14, 2020
Merged

Bugfix. CommentsRule doesn't detect commented out class declaration #630

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
75fdb94
bugfix/comments-rule-detect-class(#462)
aktsay6 Dec 10, 2020
a8585f3
bugfix/comments-rule-detect-class(#462)
aktsay6 Dec 10, 2020
57e969a
bugfix/comments-rule-detect-class(#462)
aktsay6 Dec 10, 2020
c75dba6
bugfix/comments-rule-detect-class(#462)
aktsay6 Dec 10, 2020
5bd8071
bugfix/comments-rule-doesnt-detect-class(#462)
aktsay6 Dec 11, 2020
b18c988
bugfix/comments-rule-doesnt-detect-class(#462)
aktsay6 Dec 11, 2020
5d18321
bugfix/comments-rule-doesn't-detect-class(#462)
aktsay6 Dec 14, 2020
1f7014b
bugfix/comments-rule-doesn't-detect-class(#462)
aktsay6 Dec 14, 2020
6ff56c4
bugfix/comments-rule-doesn't-detect-class(#462)
aktsay6 Dec 14, 2020
10e1804
Merge branch 'master' into bugfix/comments-rule-doesnt-detect-class(#…
aktsay6 Dec 14, 2020
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
12 changes: 5 additions & 7 deletions diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/comments/CommentsRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,21 +126,19 @@ class CommentsRule(private val configRules: List<RulesConfig>) : Rule("comments"
*/
private fun isCodeAfterCommentStart(text: String): Boolean {
val textWithoutCommentStartToken = text.removePrefix("//").trim()
return textWithoutCommentStartToken.contains(classRegex) ||
textWithoutCommentStartToken.contains(importOrPackageRegex) ||
textWithoutCommentStartToken.contains(functionRegex) ||
textWithoutCommentStartToken.contains(rightBraceRegex)
return codeFileStartCases.any { textWithoutCommentStartToken.contains(it) }
}

companion object {
private val importKeyword = KtTokens.IMPORT_KEYWORD.value
private val packageKeyword = KtTokens.PACKAGE_KEYWORD.value
private val importOrPackage = """($importKeyword|$packageKeyword) """.toRegex()
private val classRegex =
"""^\s*(public|private|open|internal|protected)*\s*(class|object)\s+(\w+)(\(.*\))*(\s*:\s*\w+(\(.*\))*)?\s*\{*$""".toRegex()
private val importOrPackageRegex = """^(import|package)?\s+([a-zA-Z.])+$""".toRegex()
private val functionRegex = """^(override)*\s?fun\s+\w+(\(.*\))?(\s*:\s*\w+)?\s*\{$""".toRegex()
"""^\s*(public|private|open|internal|protected|data|sealed)*\s*(class|object)\s+(\w+)(\(.*\))*(\s*:\s*\w+(\(.*\))*)?\s*\{*$""".toRegex()
private val importOrPackageRegex = """^(import|package)?\s+([a-zA-Z.])+;*$""".toRegex()
private val functionRegex = """^(override|abstract|actual|expected)*\s?fun\s+\w+(\(.*\))?(\s*:\s*\w+)?\s*[{=]$""".toRegex()
private val rightBraceRegex = """^\s*}$""".toRegex()
private val codeFileStartCases = listOf(classRegex, importOrPackageRegex, functionRegex, rightBraceRegex)
private val eolCommentStart = """// \S""".toRegex()
}
}
15 changes: 13 additions & 2 deletions diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/comments/CommentedCodeTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class CommentedCodeTest : LintTestBase(::CommentsRule) {

@Test
@Tag(WarningNames.COMMENTED_OUT_CODE)
fun `Should warn if commented out function is detected single line comments with surrounding text`() {
fun `Should warn if commented out function is detected - single line comments with surrounding text`() {
lintMethod(
"""
|import org.junit.Test
Expand Down Expand Up @@ -205,7 +205,7 @@ class CommentedCodeTest : LintTestBase(::CommentsRule) {

@Test
@Tag(WarningNames.COMMENTED_OUT_CODE)
fun `should trigger on function with one space after comment start token`() {
fun `should trigger on function with one space after comment start token - { sign`() {
lintMethod(
"""
|// fun someFunc(name: String): Boolean {
Expand All @@ -214,4 +214,15 @@ class CommentedCodeTest : LintTestBase(::CommentsRule) {
""".trimMargin(),
LintError(1, 1, ruleId, "${COMMENTED_OUT_CODE.warnText()} fun someFunc(name: String): Boolean {", false))
}

@Test
@Tag(WarningNames.COMMENTED_OUT_CODE)
fun `should trigger on function with one space after comment start token - = sign`() {
lintMethod(
"""
|// fun someFunc(name: String): Boolean =
|// name.contains("a")
""".trimMargin(),
LintError(1, 1, ruleId, "${COMMENTED_OUT_CODE.warnText()} fun someFunc(name: String): Boolean =", false))
}
}