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

Enum order breaks white space #726

Merged
merged 9 commits into from
Feb 10, 2021
Merged

Enum order breaks white space #726

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3ae19c6
Enum order breaks white space
kentr0w Jan 25, 2021
a99ab64
Enum order breaks white space
kentr0w Jan 25, 2021
fcd6fe7
Merge remote-tracking branch 'origin/master' into bugfix/enum-order-s…
kentr0w Jan 27, 2021
c1e69f0
Enum order breaks white space
kentr0w Feb 9, 2021
42c5f28
Merge remote-tracking branch 'origin/master' into bugfix/enum-order-s…
kentr0w Feb 9, 2021
c28e2b5
Enum order breaks white space
kentr0w Feb 9, 2021
8ef90a3
Enum order breaks white space
kentr0w Feb 9, 2021
c5100ae
Enum order breaks white space
kentr0w Feb 9, 2021
2721441
Merge branch 'master' into bugfix/enum-order-space
kentr0w Feb 10, 2021
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
47 changes: 38 additions & 9 deletions diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter3/SortRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,28 @@ import org.cqfn.diktat.common.config.rules.RulesConfig
import org.cqfn.diktat.common.config.rules.getRuleConfig
import org.cqfn.diktat.ruleset.constants.Warnings.WRONG_DECLARATIONS_ORDER
import org.cqfn.diktat.ruleset.rules.DiktatRule
import org.cqfn.diktat.ruleset.utils.findAllNodesWithSpecificType
import org.cqfn.diktat.ruleset.utils.hasChildOfType
import org.cqfn.diktat.ruleset.utils.isClassEnum

import com.pinterest.ktlint.core.ast.ElementType
import com.pinterest.ktlint.core.ast.ElementType.CLASS_BODY
import com.pinterest.ktlint.core.ast.ElementType.COMMA
import com.pinterest.ktlint.core.ast.ElementType.CONST_KEYWORD
import com.pinterest.ktlint.core.ast.ElementType.ENUM_ENTRY
import com.pinterest.ktlint.core.ast.ElementType.EOL_COMMENT
import com.pinterest.ktlint.core.ast.ElementType.IDENTIFIER
import com.pinterest.ktlint.core.ast.ElementType.MODIFIER_LIST
import com.pinterest.ktlint.core.ast.ElementType.PROPERTY
import com.pinterest.ktlint.core.ast.ElementType.SEMICOLON
import com.pinterest.ktlint.core.ast.isPartOfComment
import com.pinterest.ktlint.core.ast.isWhiteSpace
import com.pinterest.ktlint.core.ast.isWhiteSpaceWithNewline
import com.pinterest.ktlint.core.ast.nextSibling
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.PsiWhiteSpaceImpl
import org.jetbrains.kotlin.psi.KtObjectDeclaration
import org.jetbrains.kotlin.psi.psiUtil.siblings

/**
* Rule that sorts class properties and enum members alphabetically
Expand Down Expand Up @@ -67,17 +72,41 @@ class SortRule(configRules: List<RulesConfig>) : DiktatRule("sort-rule", configR
}
}

@OptIn(ExperimentalStdlibApi::class)
private fun swapSortNodes(
sortList: List<ASTNode>,
nonSortList: List<ASTNode>,
node: ASTNode) {
val nodeBefore: ASTNode? = nonSortList.last().treeNext
val isEnum = nonSortList.first().elementType == ENUM_ENTRY
val spaceBefore = if (node.findAllNodesWithSpecificType(EOL_COMMENT).isNotEmpty() && isEnum) {
nonSortList.last().run {
if (this.hasChildOfType(EOL_COMMENT) && !this.hasChildOfType(COMMA)) {
this.addChild(LeafPsiElement(COMMA, ","), this.findChildByType(EOL_COMMENT))
}
}
buildList(nonSortList.size) {
add(null)
repeat(nonSortList.size - 1) {
add(listOf(PsiWhiteSpaceImpl("\n")))
}
}
} else {
nonSortList.map { astNode ->
astNode
.siblings(false)
.toList()
.takeWhile { it.isWhiteSpace() || it.isPartOfComment() }
.ifEmpty { null }
}
}
val nodeInsertBefore: ASTNode? = nonSortList.last().treeNext
node.removeRange(nonSortList.first(), nonSortList.last().treeNext)
sortList.forEachIndexed { nodeIndex, astNode ->
if (nodeIndex != 0) {
node.addChild(PsiWhiteSpaceImpl("\n"), nodeBefore)
sortList.mapIndexed { index, astNode ->
spaceBefore[index]?.let { prevList -> prevList.map { node.addChild(it, nodeInsertBefore) } }
if (!astNode.hasChildOfType(COMMA) && isEnum) {
astNode.addChild(LeafPsiElement(COMMA, ","), null)
}
node.addChild(astNode, nodeBefore)
node.addChild(astNode, nodeInsertBefore)
}
}

Expand All @@ -99,7 +128,7 @@ class SortRule(configRules: List<RulesConfig>) : DiktatRule("sort-rule", configR

@Suppress("UnsafeCallOnNullableType")
private fun sortEnum(node: ASTNode) {
val enumEntryList = node.getChildren(null).filter { it.elementType == ElementType.ENUM_ENTRY }
val enumEntryList = node.getChildren(null).filter { it.elementType == ENUM_ENTRY }
if (enumEntryList.size <= 1) {
return
}
Expand All @@ -110,8 +139,8 @@ class SortRule(configRules: List<RulesConfig>) : DiktatRule("sort-rule", configR
val hasTrailingComma = (sortList.last() != enumEntryList.last() && enumEntryList.last().hasChildOfType(COMMA))
swapSortNodes(sortList, enumEntryList, node)
if (!hasTrailingComma) {
enumEntryList.last().addChild(LeafPsiElement(COMMA, ","), null)
sortList.last().removeChild(sortList.last().findChildByType(COMMA)!!)
val lastEntry = node.findAllNodesWithSpecificType(ENUM_ENTRY).last()
lastEntry.removeChild(lastEntry.findChildByType(COMMA)!!)
}
if (isEndSpace) {
sortList.last().addChild(PsiWhiteSpaceImpl("\n"), null)
Expand Down
8 changes: 4 additions & 4 deletions diktat-rules/src/test/resources/test/paragraph3/sort_error/ConstantsExpected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package test.paragraph3.sort_error
class Test {
companion object {
private const val B = 4
private const val C = 4
private const val D = 4
private const val C = 4
private const val D = 4
private val SIMPLE_VALUE = listOf(IDENTIFIER, WHITE_SPACE, COMMA, SEMICOLON)
}
}
Expand All @@ -28,7 +28,7 @@ class Test2 {
private const val D = 4
private val SIMPLE_VALUE = listOf(IDENTIFIER, WHITE_SPACE, COMMA, SEMICOLON)
private const val Ba = 4
private const val Baa = 4
private const val Bb = 4
private const val Baa = 4
private const val Bb = 4
}
}
36 changes: 28 additions & 8 deletions diktat-rules/src/test/resources/test/paragraph3/sort_error/EnumSortExpected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ package test.paragraph3.sort_error

enum class Alp {
BLUE(0x0000FF),
GREEN(0x00FF00),
RED(0xFF0000),
GREEN(0x00FF00),
RED(0xFF0000),
;
}

enum class Warnings {
TALKING {
override fun signal() = TALKING
},
WAITING {
WAITING {
override fun signal() = TALKING
},
;
Expand All @@ -23,7 +23,7 @@ enum class Warnings {
TALKING {
override fun signal() = TALKING
},
WAITING {
WAITING {
override fun signal() = TALKING
};

Expand All @@ -32,13 +32,33 @@ WAITING {

enum class Alp {
BLUE(0x0000FF),
GREEN(0x00FF00),
RED(0xFF0000),
GREEN(0x00FF00),
RED(0xFF0000),
}

enum class Alp {
BLUE(0x0000FF),
GREEN(0x00FF00),
RED(0xFF0000)
GREEN(0x00FF00),
RED(0xFF0000)
;
}

enum class IssueType {
PROJECT_STRUCTURE, TESTS, VCS
}

enum class IssueType {
PROJECT_STRUCTURE,TESTS,VCS
}

enum class IssueType {
PROJECT_STRUCTURE, // comment
TESTS,
VCS
}

enum class IssueType {
PROJECT_STRUCTURE ,// comment
TESTS,
VCS
}
19 changes: 18 additions & 1 deletion diktat-rules/src/test/resources/test/paragraph3/sort_error/EnumSortTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,22 @@ enum class Alp {
RED(0xFF0000),
GREEN(0x00FF00),
BLUE(0x0000FF)
;
;
}

enum class IssueType {
VCS, PROJECT_STRUCTURE, TESTS
}

enum class IssueType {
VCS,PROJECT_STRUCTURE,TESTS
}

enum class IssueType {
VCS,PROJECT_STRUCTURE, // comment
TESTS
}

enum class IssueType {
VCS, TESTS, PROJECT_STRUCTURE // comment
}
4 changes: 4 additions & 0 deletions diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example3Expected.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ class Example {
}
}

enum class IssueType {
PROJECT_STRUCTURE, TESTS, VCS
}

class Foo {
/**
* @implNote lorem ipsum
Expand Down
3 changes: 3 additions & 0 deletions diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example3Test.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ class Example {
}
}

enum class IssueType {
VCS, PROJECT_STRUCTURE, TESTS
}

class Foo {
/**
Expand Down