azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Introduce ReplaceToStringWithStringTemplateInspection #KT-13782 Fixed

Browse Source
This commit is contained in:
kenji tomita
2018-04-14 02:30:49 +03:00
committed by Mikhail Glukhikh
parent f956e8d85d
commit 817d75a47f
14 changed files with 155 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/resources/inspectionDescriptions/ReplaceToStringWithStringTemplate.html
+5
View File
@@ -0,0 +1,5 @@
<html>
<body>
This inspection reports <code>toString</code> function calls replaceable with string template.
</body>
</html>
idea/src/META-INF/plugin.xml
+9
View File
@@ -2900,6 +2900,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/META-INF/plugin.xml.172
+9
View File
@@ -2898,6 +2898,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/META-INF/plugin.xml.173
+9
View File
@@ -2898,6 +2898,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/META-INF/plugin.xml.182
+9
View File
@@ -2899,6 +2899,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/META-INF/plugin.xml.as31
+9
View File
@@ -2898,6 +2898,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/META-INF/plugin.xml.as32
+9
View File
@@ -2898,6 +2898,15 @@ The Kotlin plugin provides language support in IntelliJ IDEA and Android Studio.
language="kotlin" language="kotlin"
/> />
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection"
displayName="Replace 'toString' with string template"
groupPath="Kotlin"
groupName="Style issues"
enabledByDefault="true"
level="INFORMATION"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/> <referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/> <fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>
idea/src/org/jetbrains/kotlin/idea/inspections/ReplaceToStringWithStringTemplateInspection.kt
+46
View File
@@ -0,0 +1,46 @@
/*
* Copyright 2010-2018 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.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.PsiElement
import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor
import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
import org.jetbrains.kotlin.idea.core.getDeepestSuperDeclarations
import org.jetbrains.kotlin.idea.intentions.toResolvedCall
import org.jetbrains.kotlin.psi.*
import org.jetbrains.kotlin.psi.psiUtil.getParentOfType
import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameUnsafe
import org.jetbrains.kotlin.resolve.lazy.BodyResolveMode
class ReplaceToStringWithStringTemplateInspection : AbstractApplicabilityBasedInspection<KtDotQualifiedExpression>(
KtDotQualifiedExpression::class.java
) {
override fun isApplicable(element: KtDotQualifiedExpression): Boolean {
if (element.receiverExpression !is KtReferenceExpression) return false
if (element.parent is KtBlockStringTemplateEntry) return false
return element.isToString()
}
override fun applyTo(element: PsiElement, project: Project, editor: Editor?) {
val expression = element.getParentOfType<KtDotQualifiedExpression>(strict = false) ?: return
val variable = expression.receiverExpression.text
element.replace(KtPsiFactory(element).createExpression("\"$$variable\""))
}
override fun inspectionText(element: KtDotQualifiedExpression) = "Should be replaced 'toString' with string template"
override fun inspectionTarget(element: KtDotQualifiedExpression) = element
override val defaultFixText = "Replace 'toString' with string template"
private fun KtDotQualifiedExpression.isToString(): Boolean {
val resolvedCall = toResolvedCall(BodyResolveMode.PARTIAL) ?: return false
val callableDescriptor = resolvedCall.resultingDescriptor as? CallableMemberDescriptor ?: return false
return callableDescriptor.getDeepestSuperDeclarations().any { it.fqNameUnsafe.asString() == "kotlin.Any.toString" }
}
}
idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/.inspection
Vendored
+1
View File
@@ -0,0 +1 @@
org.jetbrains.kotlin.idea.inspections.ReplaceToStringWithStringTemplateInspection
idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/nonReference.kt
Vendored
+5
View File
@@ -0,0 +1,5 @@
// WITH_RUNTIME
// PROBLEM: none
fun test(): String {
return 1.<caret>toString()
}
idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/simple.kt
Vendored
+5
View File
@@ -0,0 +1,5 @@
// WITH_RUNTIME
fun test(): String {
val x = 1
return x.<caret>toString()
}
idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/simple.kt.after
Vendored
+5
View File
@@ -0,0 +1,5 @@
// WITH_RUNTIME
fun test(): String {
val x = 1
return "$x"
}
idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/stringTemplate.kt
Vendored
+6
View File
@@ -0,0 +1,6 @@
// WITH_RUNTIME
// PROBLEM: none
fun test(): String {
val x = 1
return "Foo: ${x.<caret>toString()}"
}
idea/tests/org/jetbrains/kotlin/idea/inspections/LocalInspectionTestGenerated.java
Generated
+28
View File
@@ -4206,6 +4206,34 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
} }
} }
@TestMetadata("idea/testData/inspectionsLocal/replaceToStringWithStringTemplate")
@TestDataPath("$PROJECT_ROOT")
@RunWith(JUnit3RunnerWithInners.class)
public static class ReplaceToStringWithStringTemplate extends AbstractLocalInspectionTest {
private void runTest(String testDataFilePath) throws Exception {
KotlinTestUtils.runTest(this::doTest, TargetBackend.ANY, testDataFilePath);
}
public void testAllFilesPresentInReplaceToStringWithStringTemplate() throws Exception {
KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/inspectionsLocal/replaceToStringWithStringTemplate"), Pattern.compile("^([\\w\\-_]+)\\.(kt|kts)$"), TargetBackend.ANY, true);
}
@TestMetadata("nonReference.kt")
public void testNonReference() throws Exception {
runTest("idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/nonReference.kt");
}
@TestMetadata("simple.kt")
public void testSimple() throws Exception {
runTest("idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/simple.kt");
}
@TestMetadata("stringTemplate.kt")
public void testStringTemplate() throws Exception {
runTest("idea/testData/inspectionsLocal/replaceToStringWithStringTemplate/stringTemplate.kt");
}
}
@TestMetadata("idea/testData/inspectionsLocal/replaceToWithInfixForm") @TestMetadata("idea/testData/inspectionsLocal/replaceToWithInfixForm")
@TestDataPath("$PROJECT_ROOT") @TestDataPath("$PROJECT_ROOT")
@RunWith(JUnit3RunnerWithInners.class) @RunWith(JUnit3RunnerWithInners.class)