Implement inspection to remove @ from annotation argument #KT-9228 Fixed

(cherry picked from commit 543c6bc)
2016-07-08 23:44:55 +03:00
parent c80e094967
commit 113ab7640e
15 changed files with 169 additions and 0 deletions
@@ -0,0 +1,5 @@
+<html>
+<body>
+This inspection detects unnecessary '@' at annotations which are annotation arguments themselves.
+</body>
+</html>
@@ -0,0 +1,6 @@
+annotation class X(val value: Y)
+annotation class Y()
+
+@X(Y())
+fun foo() {}
+   
@@ -0,0 +1,5 @@
+annotation class X(val value: Y)
+annotation class Y()
+
+@X(@Y())
+fun foo() {}
@@ -0,0 +1,5 @@
+<html>
+<body>
+This intention removes unnecessary '@' from annotations which are annotation arguments themselves.
+</body>
+</html>
@@ -1255,6 +1255,11 @@
      <category>Kotlin</category>
    </intentionAction>

+    <intentionAction>
+      <className>org.jetbrains.kotlin.idea.intentions.RemoveAtFromAnnotationArgumentIntention</className>
+      <category>Kotlin</category>
+    </intentionAction>
+
    <localInspection implementationClass="org.jetbrains.kotlin.idea.intentions.ObjectLiteralToLambdaInspection"
                     displayName="Object literal can be converted to lambda"
                     groupName="Kotlin"
@@ -1594,6 +1599,14 @@
                     language="kotlin"
    />

+    <localInspection implementationClass="org.jetbrains.kotlin.idea.intentions.RemoveAtFromAnnotationArgumentInspection"
+                     displayName="Unnecessary @"
+                     groupName="Kotlin"
+                     enabledByDefault="true"
+                     level="WARNING"
+                     language="kotlin"
+    />
+
    <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>

    <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2010-2016 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jetbrains.kotlin.idea.intentions
+
+import com.intellij.openapi.editor.Editor
+import org.jetbrains.kotlin.idea.inspections.IntentionBasedInspection
+import org.jetbrains.kotlin.psi.KtAnnotatedExpression
+import org.jetbrains.kotlin.psi.KtAnnotationEntry
+import org.jetbrains.kotlin.psi.KtPsiFactory
+
+class RemoveAtFromAnnotationArgumentInspection : IntentionBasedInspection<KtAnnotatedExpression>(RemoveAtFromAnnotationArgumentIntention())
+
+class RemoveAtFromAnnotationArgumentIntention : SelfTargetingOffsetIndependentIntention<KtAnnotatedExpression>(
+        KtAnnotatedExpression::class.java,
+        "Remove @ from annotation argument"
+) {
+    override fun isApplicableTo(element: KtAnnotatedExpression): Boolean {
+        var parent = element.parent
+        while (parent != null) {
+            if (parent is KtAnnotationEntry) return true
+            parent = parent.parent
+        }
+        return false
+    }
+
+    override fun applyTo(element: KtAnnotatedExpression, editor: Editor?) {
+        val noAt = KtPsiFactory(element.project).createExpression(element.text.replaceFirst("@", ""))
+        element.replace(noAt)
+    }
+}
@@ -0,0 +1 @@
+org.jetbrains.kotlin.idea.intentions.RemoveAtFromAnnotationArgumentIntention
@@ -0,0 +1,8 @@
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Y)
+annotation class Y()
+
+@X(@Y()<caret>)
+fun foo() {
+}
@@ -0,0 +1,8 @@
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Y)
+annotation class Y()
+
+@X(Y())
+fun foo() {
+}
@@ -0,0 +1,9 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Array<Y>)
+annotation class Y()
+
+@X(arrayOf(Y(), @Y()<caret>))
+fun foo() {
+}
@@ -0,0 +1,9 @@
+// WITH_RUNTIME
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Array<Y>)
+annotation class Y()
+
+@X(arrayOf(Y(), Y()))
+fun foo() {
+}
@@ -0,0 +1,8 @@
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Y, val y: Y)
+annotation class Y()
+
+@X(@Y(), y = @Y()<caret>)
+fun foo() {
+}
@@ -0,0 +1,8 @@
+// INTENTION_TEXT: Remove @ from annotation argument
+
+annotation class X(val value: Y, val y: Y)
+annotation class Y()
+
+@X(@Y(), y = Y())
+fun foo() {
+}
@@ -0,0 +1,7 @@
+// IS_APPLICABLE: false
+
+annotation class X(val s: String)
+
+@X("@@@"<caret>)
+fun foo() {
+}
@@ -7653,6 +7653,39 @@ public class IntentionTestGenerated extends AbstractIntentionTest {
        }
    }

+    @TestMetadata("idea/testData/intentions/removeAtFromAnnotationArgument")
+    @TestDataPath("$PROJECT_ROOT")
+    @RunWith(JUnit3RunnerWithInners.class)
+    public static class RemoveAtFromAnnotationArgument extends AbstractIntentionTest {
+        public void testAllFilesPresentInRemoveAtFromAnnotationArgument() throws Exception {
+            KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/intentions/removeAtFromAnnotationArgument"), Pattern.compile("^([\\w\\-_]+)\\.kt$"), true);
+        }
+
+        @TestMetadata("atmarkArgument.kt")
+        public void testAtmarkArgument() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/removeAtFromAnnotationArgument/atmarkArgument.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("atmarkArrayArguments.kt")
+        public void testAtmarkArrayArguments() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/removeAtFromAnnotationArgument/atmarkArrayArguments.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("multipleAtmarkArguments.kt")
+        public void testMultipleAtmarkArguments() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/removeAtFromAnnotationArgument/multipleAtmarkArguments.kt");
+            doTest(fileName);
+        }
+
+        @TestMetadata("stringAtmark.kt")
+        public void testStringAtmark() throws Exception {
+            String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/removeAtFromAnnotationArgument/stringAtmark.kt");
+            doTest(fileName);
+        }
+    }
+
    @TestMetadata("idea/testData/intentions/removeBraces")
    @TestDataPath("$PROJECT_ROOT")
    @RunWith(JUnit3RunnerWithInners.class)
				`@@ -0,0 +1 @@`
				`org.jetbrains.kotlin.idea.intentions.RemoveAtFromAnnotationArgumentIntention`