Fix assertion failed in rule [kdoc-formatting] #1489 (#1522)

Assertion failed: anchorBefore == null || anchorBefore.getTreeParent() == parent in rule [kdoc-formatting] #1489

What's done:
- fix for KDOC_WRONG_TAGS_ORDER rule
- warning test "tags should be ordered assertion issue"
- fix test "extra new line with tags ordering should not cause assert"

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocFormatting.kt

@@ -219,7 +219,6 @@ class KdocFormatting(configRules: List<RulesConfig>) : DiktatRule(
                     .first()
                     .node
                     .startOffset, basicTags.first().node) {
-                val kdocSection = node.getFirstChildWithType(KDOC_SECTION)!!
                 val basicTagChildren = kdocTags
                     .filter { basicTagsOrdered.contains(it.knownTag) }
                     .map { it.node }
@@ -229,6 +228,7 @@ class KdocFormatting(configRules: List<RulesConfig>) : DiktatRule(
                     .map { it.node }
 
                 basicTagChildren.mapIndexed { index, astNode ->
+                    val kdocSection = astNode.treeParent
                     kdocSection.addChild(correctKdocOrder[index].clone() as CompositeElement, astNode)
                     kdocSection.removeChild(astNode)
                 }

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocFormattingFixTest.kt

@@ -21,6 +21,12 @@ class KdocFormattingFixTest : FixTestBase("test/paragraph2/kdoc/", ::KdocFormatt
         fixAndCompare("OrderedTagsExpected.kt", "OrderedTagsTest.kt")
     }
 
+    @Test
+    @Tag(WarningNames.KDOC_WRONG_TAGS_ORDER)
+    fun `extra new line with tags ordering should not cause assert`() {
+        fixAndCompare("OrderedTagsAssertionExpected.kt", "OrderedTagsAssertionTest.kt")
+    }
+
     @Test
     @Tag(WarningNames.KDOC_NO_NEWLINES_BETWEEN_BASIC_TAGS)
     fun `basic tags should not have empty lines between`() {

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocFormattingTest.kt

@@ -200,6 +200,31 @@ class KdocFormattingTest : LintTestBase(::KdocFormatting) {
                 "${KDOC_WRONG_TAGS_ORDER.warnText()} @return, @throws, @param", true))
     }
 
+    @Test
+    @Tag(WarningNames.KDOC_WRONG_TAGS_ORDER)
+    fun `tags should be ordered assertion issue`() {
+        val invalidCode = """
+            /**
+             * Reporter that produces a JSON report as a [Report]
+             *
+             * @property out a sink for output
+             *
+             * @param builder additional configuration lambda for serializers module
+             */
+            class JsonReporter(
+                override val out: BufferedSink,
+                builder: PolymorphicModuleBuilder<Plugin.TestFiles>.() -> Unit = {}
+            ) : Reporter
+        """.trimIndent()
+
+        lintMethod(invalidCode,
+            LintError(4, 4, ruleId,
+                "${KDOC_NO_NEWLINES_BETWEEN_BASIC_TAGS.warnText()} @property", true),
+            LintError(4, 4, ruleId,
+                "${KDOC_WRONG_TAGS_ORDER.warnText()} @property, @param", true)
+        )
+    }
+
     @Test
     @Tag(WarningNames.KDOC_NO_NEWLINES_BETWEEN_BASIC_TAGS)
     fun `newlines are not allowed between basic tags`() {

diktat-rules/src/test/resources/test/paragraph2/kdoc/OrderedTagsAssertionExpected.kt

@@ -0,0 +1,12 @@
+package com.saveourtool.save.reporter.json
+
+/**
+ * Reporter that produces a JSON report as a [Report]
+ *
+ * @param builder additional configuration lambda for serializers module
+ * @property out a sink for output
+ */
+class JsonReporter(
+    override val out: BufferedSink,
+    builder: PolymorphicModuleBuilder<Plugin.TestFiles>.() -> Unit = {}
+) : Reporter

diktat-rules/src/test/resources/test/paragraph2/kdoc/OrderedTagsAssertionTest.kt

@@ -0,0 +1,13 @@
+package com.saveourtool.save.reporter.json
+
+/**
+ * Reporter that produces a JSON report as a [Report]
+ *
+ * @property out a sink for output
+ *
+ * @param builder additional configuration lambda for serializers module
+ */
+class JsonReporter(
+    override val out: BufferedSink,
+    builder: PolymorphicModuleBuilder<Plugin.TestFiles>.() -> Unit = {}
+) : Reporter