Add inspection for Integer.toString(i) to i.toString() (KT-12721)

2019-03-25 13:09:24 +03:00
parent dde2b30601
commit efcc6f0967
14 changed files with 170 additions and 0 deletions
@@ -3346,6 +3346,15 @@
                     language="kotlin"
    />

+    <localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceJavaIntegerToStringWithMemberInspection"
+                     displayName="Replace 'Integer.toString(int)' with 'int.toString()'"
+                     groupPath="Kotlin"
+                     groupName="Style issues"
+                     enabledByDefault="true"
+                     level="WEAK WARNING"
+                     language="kotlin"
+    />
+
    <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>

    <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
@@ -0,0 +1,5 @@
+<html>
+<body>
+This inspection reports explicit calls of <b>Integer.toString(int)</b> which can be replaced with <b>int.toString()</b>
+</body>
+</html>
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
+ * that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.idea.inspections
+
+import com.intellij.codeInspection.LocalQuickFix
+import com.intellij.codeInspection.ProblemDescriptor
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElementVisitor
+import org.jetbrains.kotlin.idea.caches.resolve.resolveToCall
+import org.jetbrains.kotlin.psi.*
+import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameUnsafe
+
+class ReplaceJavaIntegerToStringWithMemberInspection : AbstractKotlinInspection() {
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return dotQualifiedExpressionVisitor { dotQualifiedExpression ->
+            if (dotQualifiedExpression.isToString()) {
+                holder.registerProblem(
+                    dotQualifiedExpression,
+                    "Could be replaced with `int.toString()`",
+                    ConvertIntegerToStringQuickFix()
+                )
+            }
+        }
+    }
+}
+
+private class ConvertIntegerToStringQuickFix : LocalQuickFix {
+    override fun getName() = "Replace with 'int.toString()'"
+
+    override fun getFamilyName() = name
+
+    override fun applyFix(project: Project, descriptor: ProblemDescriptor) {
+        val dotQualifiedExpression = descriptor.psiElement as? KtDotQualifiedExpression ?: return
+        val element = dotQualifiedExpression.selectorExpression as? KtCallExpression ?: return
+        val arguments = element.valueArguments
+        val integerArg = arguments.getOrNull(0) ?: return
+        val radixArg = arguments.getOrNull(1)
+
+        dotQualifiedExpression.replace(
+            KtPsiFactory(element).createExpressionByPattern(
+                "$0.toString($1)",
+                integerArg.getArgumentExpression() ?: return,
+                radixArg?.getArgumentExpression() ?: ""
+            )
+        )
+    }
+}
+
+private fun KtDotQualifiedExpression.isToString(): Boolean {
+    val calleeExpression = (selectorExpression as? KtCallExpression)?.calleeExpression ?: return false
+    val nameReference = calleeExpression as? KtNameReferenceExpression ?: return false
+    if (nameReference.getReferencedName() != "toString") return false
+
+    val resolvedCall = this.resolveToCall() ?: return false
+    if (!resolvedCall.status.isSuccess) return false
+    val fqName = resolvedCall.resultingDescriptor.fqNameUnsafe.asString()
+    return fqName == "java.lang.Integer.toString"
+}
@@ -0,0 +1 @@
+org.jetbrains.kotlin.idea.inspections.ReplaceJavaIntegerToStringWithMemberInspection
@@ -0,0 +1,7 @@
+// WITH_RUNTIME
+// PROBLEM: none
+// ERROR: None of the following functions can be called with the arguments supplied: <br>public open fun toString(i: Int): String! defined in java.lang.Integer<br>public open fun toString(i: Int, radix: Int): String! defined in java.lang.Integer
+
+fun main() {
+    println(Integer.toString(<caret>))
+}
@@ -0,0 +1,5 @@
+// WITH_RUNTIME
+
+fun foo() {
+    Integer.<caret>toString(5)
+}
@@ -0,0 +1,5 @@
+// WITH_RUNTIME
+
+fun foo() {
+    5.toString()
+}
@@ -0,0 +1,7 @@
+// WITH_RUNTIME
+
+fun foo() {
+    val list = arrayListOf<Int>()
+    list.add(5)
+    Integer.<caret>toString(list[0])
+}
@@ -0,0 +1,7 @@
+// WITH_RUNTIME
+
+fun foo() {
+    val list = arrayListOf<Int>()
+    list.add(5)
+    list[0].toString()
+}
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+
+fun foo() {
+    var number = 5
+    val numberString = Integer.<caret>toString(number)
+}
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+
+fun foo() {
+    var number = 5
+    val numberString = number.toString()
+}
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+
+fun foo() {
+    var number = 5
+    val numberString = Integer.<caret>toString(number, 2)
+}
@@ -0,0 +1,6 @@
+// WITH_RUNTIME
+
+fun foo() {
+    var number = 5
+    val numberString = number.toString(2)
+}
@@ -7046,6 +7046,44 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
        }
    }

+    @TestMetadata("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember")
+    @TestDataPath("$PROJECT_ROOT")
+    @RunWith(JUnit3RunnerWithInners.class)
+    public static class ReplaceJavaIntegerToStringWithMember extends AbstractLocalInspectionTest {
+        private void runTest(String testDataFilePath) throws Exception {
+            KotlinTestUtils.runTest(this::doTest, TargetBackend.ANY, testDataFilePath);
+        }
+
+        public void testAllFilesPresentInReplaceJavaIntegerToStringWithMember() throws Exception {
+            KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember"), Pattern.compile("^([\\w\\-_]+)\\.(kt|kts)$"), TargetBackend.ANY, true);
+        }
+
+        @TestMetadata("incorrectDescriptor.kt")
+        public void testIncorrectDescriptor() throws Exception {
+            runTest("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember/incorrectDescriptor.kt");
+        }
+
+        @TestMetadata("replaceIntToString.kt")
+        public void testReplaceIntToString() throws Exception {
+            runTest("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember/replaceIntToString.kt");
+        }
+
+        @TestMetadata("replaceListElementToString.kt")
+        public void testReplaceListElementToString() throws Exception {
+            runTest("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember/replaceListElementToString.kt");
+        }
+
+        @TestMetadata("replaceToStringBase.kt")
+        public void testReplaceToStringBase() throws Exception {
+            runTest("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember/replaceToStringBase.kt");
+        }
+
+        @TestMetadata("replaceToStringWithRadix.kt")
+        public void testReplaceToStringWithRadix() throws Exception {
+            runTest("idea/testData/inspectionsLocal/replaceJavaIntegerToStringWithMember/replaceToStringWithRadix.kt");
+        }
+    }
+
    @TestMetadata("idea/testData/inspectionsLocal/replaceNegatedIsEmptyWithIsNotEmpty")
    @TestDataPath("$PROJECT_ROOT")
    @RunWith(JUnit3RunnerWithInners.class)
				`@@ -0,0 +1 @@`
				`org.jetbrains.kotlin.idea.inspections.ReplaceJavaIntegerToStringWithMemberInspection`