Sort modifiers: process final modifier correctly #KT-22954 fixed

idea/src/org/jetbrains/kotlin/idea/inspections/SortModifiersInspection.kt

@@ -9,6 +9,7 @@ import com.intellij.codeInspection.*
 import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElementVisitor
 import org.jetbrains.kotlin.lexer.KtModifierKeywordToken
+import org.jetbrains.kotlin.lexer.KtTokens
 import org.jetbrains.kotlin.psi.*
 import org.jetbrains.kotlin.psi.addRemoveModifier.sortModifiers
 import org.jetbrains.kotlin.psi.psiUtil.allChildren
@@ -34,6 +35,8 @@ class SortModifiersInspection : AbstractKotlinInspection(), CleanupLocalInspecti
                 val modifiers = modifierElements.mapNotNull { it.node.elementType as? KtModifierKeywordToken }.toList()
                 if (modifiers.isEmpty()) return
 
+                val startElement = modifierElements.firstOrNull { it.node.elementType is KtModifierKeywordToken } ?: return
+
                 val sortedModifiers = sortModifiers(modifiers)
                 if (modifiers == sortedModifiers && !modifiersBeforeAnnotations) return
 
@@ -41,12 +44,16 @@ class SortModifiersInspection : AbstractKotlinInspection(), CleanupLocalInspecti
                     "Modifiers should follow annotations"
                 else
                     "Non-canonical modifiers order"
-                holder.registerProblem(
+
+                val descriptor = holder.manager.createProblemDescriptor(
+                    startElement,
                     list,
                     message,
                     ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
+                    isOnTheFly,
                     SortModifiersFix(sortedModifiers)
                 )
+                holder.registerProblem(descriptor)
             }
         }
     }
@@ -62,7 +69,10 @@ private class SortModifiersFix(private val modifiers: List<KtModifierKeywordToke
         val owner = list.parent as? KtModifierListOwner ?: return
 
         modifiers.forEach { owner.removeModifier(it) }
-        modifiers.forEach { owner.addModifier(it) }
+        modifiers
+            .partition { it == KtTokens.FINAL_KEYWORD }
+            .let { it.second + it.first }
+            .forEach { owner.addModifier(it) }
     }
 }
 

idea/testData/inspections/sortModifiers/inspectionData/expected.xml

@@ -0,0 +1,10 @@
+<problems>
+    <problem>
+        <file>test.kt</file>
+        <line>4</line>
+        <module>light_idea_test_case</module>
+        <entry_point TYPE="file" FQNAME="temp:///src/test.kt" />
+        <problem_class severity="WARNING" attribute_key="WARNING_ATTRIBUTES">Non-canonical modifier order</problem_class>
+        <description>Non-canonical modifiers order</description>
+    </problem>
+</problems>

idea/testData/inspections/sortModifiers/inspectionData/inspections.test

@@ -0,0 +1 @@
+// INSPECTION_CLASS: org.jetbrains.kotlin.idea.inspections.SortModifiersInspection

idea/testData/inspections/sortModifiers/test.kt

@@ -0,0 +1,4 @@
+annotation class Ann
+
+@Ann
+abstract public class Test

idea/testData/inspectionsLocal/sortModifiers/annotationOverrideFinal.kt

@@ -0,0 +1,10 @@
+annotation class Ann
+
+open class Base {
+    open fun bar() {}
+}
+
+open class Test : Base() {
+    @Ann
+    <caret>override final fun bar() {}
+}

idea/testData/inspectionsLocal/sortModifiers/annotationOverrideFinal.kt.after

@@ -0,0 +1,10 @@
+annotation class Ann
+
+open class Base {
+    open fun bar() {}
+}
+
+open class Test : Base() {
+    @Ann
+    final override fun bar() {}
+}

idea/testData/inspectionsLocal/sortModifiers/overrideFinal.kt

@@ -0,0 +1,7 @@
+open class Base {
+    open fun foo() {}
+}
+
+open class Test : Base() {
+    <caret>override final public fun foo() {}
+}

idea/testData/inspectionsLocal/sortModifiers/overrideFinal.kt.after

@@ -0,0 +1,7 @@
+open class Base {
+    open fun foo() {}
+}
+
+open class Test : Base() {
+    public final override fun foo() {}
+}

idea/tests/org/jetbrains/kotlin/idea/codeInsight/InspectionTestGenerated.java

@@ -372,6 +372,12 @@ public class InspectionTestGenerated extends AbstractInspectionTest {
             doTest(fileName);
         }
 
+        @TestMetadata("sortModifiers/inspectionData/inspections.test")
+        public void testSortModifiers_inspectionData_Inspections_test() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspections/sortModifiers/inspectionData/inspections.test");
+            doTest(fileName);
+        }
+
         @TestMetadata("spelling/inspectionData/inspections.test")
         public void testSpelling_inspectionData_Inspections_test() throws Exception {
             String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspections/spelling/inspectionData/inspections.test");

idea/tests/org/jetbrains/kotlin/idea/inspections/LocalInspectionTestGenerated.java

@@ -4152,6 +4152,18 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
             doTest(fileName);
         }
 
+        @TestMetadata("annotationOverrideFinal.kt")
+        public void testAnnotationOverrideFinal() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspectionsLocal/sortModifiers/annotationOverrideFinal.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("overrideFinal.kt")
+        public void testOverrideFinal() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspectionsLocal/sortModifiers/overrideFinal.kt");
+            doTest(fileName);
+        }
+
         @TestMetadata("simple.kt")
         public void testSimple() throws Exception {
             String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspectionsLocal/sortModifiers/simple.kt");