Java inspection: convert the intention for "Make Type Generic" into an INFORMATION-level inspection (IDEA-157727)

This commit is contained in:
Pavel Dolgov
2016-06-28 15:13:49 +03:00
parent e3eb6b1670
commit c3bd56a80c
14 changed files with 221 additions and 148 deletions
@@ -0,0 +1,128 @@
/*
* Copyright 2000-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 com.intellij.codeInspection.miscGenerics;
import com.intellij.codeInspection.*;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.TypeConversionUtil;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* @author dsl
*/
public class MakeTypeGenericInspection extends BaseJavaBatchLocalInspectionTool {
@NotNull
@Override
public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder,
boolean isOnTheFly) {
return new JavaElementVisitor() {
@Override
public void visitVariable(PsiVariable variable) {
super.visitVariable(variable);
visitVariableImpl(variable);
}
@Override
public void visitJavaToken(PsiJavaToken token) {
super.visitJavaToken(token);
if (token.getTokenType() == JavaTokenType.EQ) {
final PsiElement parent = token.getParent();
if (parent instanceof PsiVariable) {
visitVariableImpl((PsiVariable)parent);
}
}
}
private void visitVariableImpl(@NotNull PsiVariable variable) {
if (variable.getTypeElement() != null) {
final PsiType type = getSuggestedType(variable);
if (type != null) {
final String typeText = type.getCanonicalText();
final String message =
InspectionsBundle.message("inspection.raw.variable.type.make.generic.text", variable.getName(), typeText);
holder.registerProblem(variable, message, new MyLocalQuickFix(message));
}
}
}
};
}
@Nullable
private static PsiType getSuggestedType(@NotNull PsiVariable variable) {
final PsiExpression initializer = variable.getInitializer();
if (initializer == null) return null;
final PsiType variableType = variable.getType();
final PsiType initializerType = initializer.getType();
if (!(variableType instanceof PsiClassType)) return null;
final PsiClassType variableClassType = (PsiClassType) variableType;
if (!variableClassType.isRaw()) return null;
if (!(initializerType instanceof PsiClassType)) return null;
final PsiClassType initializerClassType = (PsiClassType) initializerType;
if (initializerClassType.isRaw()) return null;
final PsiClassType.ClassResolveResult variableResolveResult = variableClassType.resolveGenerics();
final PsiClassType.ClassResolveResult initializerResolveResult = initializerClassType.resolveGenerics();
if (initializerResolveResult.getElement() == null) return null;
PsiClass variableResolved = variableResolveResult.getElement();
if (variableResolved == null) return null;
PsiSubstitutor targetSubstitutor = TypeConversionUtil.getClassSubstitutor(variableResolved, initializerResolveResult.getElement(), initializerResolveResult.getSubstitutor());
if (targetSubstitutor == null) return null;
PsiType type = JavaPsiFacade.getInstance(variable.getProject()).getElementFactory().createType(variableResolved, targetSubstitutor);
if (variableType.equals(type)) return null;
return type;
}
private static class MyLocalQuickFix implements LocalQuickFix {
private String myName;
public MyLocalQuickFix(@NotNull String name) {
myName = name;
}
@Nls
@NotNull
@Override
public String getName() {
return myName;
}
@Nls
@NotNull
@Override
public String getFamilyName() {
return InspectionsBundle.message("inspection.raw.variable.type.make.generic.family");
}
@Override
public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
final PsiElement element = descriptor.getPsiElement();
if (element instanceof PsiVariable) {
final PsiVariable variable = (PsiVariable)element;
final PsiTypeElement typeElement = variable.getTypeElement();
if (typeElement != null) {
final PsiType type = getSuggestedType(variable);
if (type != null) {
final PsiElementFactory factory = JavaPsiFacade.getInstance(variable.getProject()).getElementFactory();
typeElement.replace(factory.createTypeElement(type));
}
}
}
}
}
}
@@ -1,104 +0,0 @@
/*
* Copyright 2000-2009 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 com.intellij.codeInsight.intention.impl;
import com.intellij.codeInsight.CodeInsightBundle;
import com.intellij.codeInsight.intention.PsiElementBaseIntentionAction;
import com.intellij.openapi.editor.CaretModel;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Pair;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiUtil;
import com.intellij.psi.util.TypeConversionUtil;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.NotNull;
/**
* @author dsl
*/
public class MakeTypeGenericAction extends PsiElementBaseIntentionAction {
private String variableName;
private String newTypeName;
@Override
@NotNull
public String getFamilyName() {
return CodeInsightBundle.message("intention.make.type.generic.family");
}
@Override
@NotNull
public String getText() {
return CodeInsightBundle.message("intention.make.type.generic.text", variableName, newTypeName);
}
@Override
public boolean isAvailable(@NotNull Project project, Editor editor, @NotNull PsiElement element) {
if (!PsiUtil.isLanguageLevel5OrHigher(element)) return false;
if (!element.isWritable()) return false;
return findVariable(element) != null;
}
private Pair<PsiVariable,PsiType> findVariable(final PsiElement element) {
PsiVariable variable = null;
PsiElement elementParent = element.getParent();
if (element instanceof PsiIdentifier) {
if (elementParent instanceof PsiVariable) {
variable = (PsiVariable)elementParent;
}
}
else if (element instanceof PsiJavaToken) {
final PsiJavaToken token = (PsiJavaToken)element;
if (token.getTokenType() != JavaTokenType.EQ) return null;
if (elementParent instanceof PsiVariable) {
variable = (PsiVariable)elementParent;
}
}
if (variable == null) return null;
variableName = variable.getName();
final PsiExpression initializer = variable.getInitializer();
if (initializer == null) return null;
final PsiType variableType = variable.getType();
final PsiType initializerType = initializer.getType();
if (!(variableType instanceof PsiClassType)) return null;
final PsiClassType variableClassType = (PsiClassType) variableType;
if (!variableClassType.isRaw()) return null;
if (!(initializerType instanceof PsiClassType)) return null;
final PsiClassType initializerClassType = (PsiClassType) initializerType;
if (initializerClassType.isRaw()) return null;
final PsiClassType.ClassResolveResult variableResolveResult = variableClassType.resolveGenerics();
final PsiClassType.ClassResolveResult initializerResolveResult = initializerClassType.resolveGenerics();
if (initializerResolveResult.getElement() == null) return null;
PsiClass variableResolved = variableResolveResult.getElement();
PsiSubstitutor targetSubstitutor = TypeConversionUtil.getClassSubstitutor(variableResolved, initializerResolveResult.getElement(), initializerResolveResult.getSubstitutor());
if (targetSubstitutor == null) return null;
PsiType type = JavaPsiFacade.getInstance(variable.getProject()).getElementFactory().createType(variableResolved, targetSubstitutor);
if (variableType.equals(type)) return null;
newTypeName = type.getCanonicalText();
return Pair.create(variable, type);
}
@Override
public void invoke(@NotNull Project project, Editor editor, @NotNull PsiElement element) throws IncorrectOperationException {
Pair<PsiVariable, PsiType> pair = findVariable(element);
if (pair == null) return;
PsiVariable variable = pair.getFirst();
PsiType type = pair.getSecond();
variable.getTypeElement().replace(JavaPsiFacade.getInstance(variable.getProject()).getElementFactory().createTypeElement(type));
}
}
@@ -0,0 +1,7 @@
import java.util.*;
public class F {
void f() {
List li<caret>st = new ArrayList<String>();
}
}
@@ -1,7 +1,6 @@
import java.util.ArrayList;
import java.util.List;
import java.util.*;
public class X {
public class F {
void f() {
List<String> list = new ArrayList<String>();
}
@@ -1,26 +0,0 @@
/*
* Copyright 2000-2012 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 com.intellij.codeInsight.daemon.quickFix;
import com.intellij.codeInsight.daemon.LightIntentionActionTestCase;
public class MakeTypeGenericTest extends LightIntentionActionTestCase {
public void test() throws Exception { doAllTests(); }
@Override
protected String getBasePath() {
return "/codeInsight/daemonCodeAnalyzer/quickFix/makeTypeGeneric";
}
}
@@ -0,0 +1,76 @@
/*
* Copyright 2000-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 com.intellij.codeInspection;
import com.intellij.JavaTestUtil;
import com.intellij.codeInsight.intention.IntentionAction;
import com.intellij.codeInspection.miscGenerics.MakeTypeGenericInspection;
import com.intellij.openapi.roots.ModuleRootModificationUtil;
import com.intellij.testFramework.IdeaTestUtil;
import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
import java.util.List;
public class MakeTypeGenericTest extends LightCodeInsightFixtureTestCase {
private MakeTypeGenericInspection myInspection = new MakeTypeGenericInspection();
@Override
protected String getBasePath() {
return JavaTestUtil.getRelativeJavaTestDataPath() + "/codeInspection/makeTypeGeneric";
}
@Override
protected void setUp() throws Exception {
super.setUp();
ModuleRootModificationUtil.setModuleSdk(myModule, IdeaTestUtil.getMockJdk18());
myFixture.enableInspections(myInspection);
}
@Override
protected void tearDown() throws Exception {
try {
myFixture.disableInspections(myInspection);
}
finally {
super.tearDown();
}
}
public void testField() {
doTest("Change type of TT to java.util.Comparator<java.lang.String>");
}
public void testLocalVariable() {
doTest("Change type of list to java.util.List<java.lang.String>");
}
public void testImplementedRaw() {
assertIntentionNotAvailable("Change type of");
}
private void doTest(String intentionName) {
myFixture.configureByFiles(getTestName(false) + ".java");
final IntentionAction singleIntention = myFixture.findSingleIntention(intentionName);
myFixture.launchAction(singleIntention);
myFixture.checkResultByFile(getTestName(false) + ".java", getTestName(false) + "_after.java", true);
}
private void assertIntentionNotAvailable(String intentionName) {
myFixture.configureByFiles(getTestName(false) + ".java");
final List<IntentionAction> intentionActions = myFixture.filterAvailableIntentions(intentionName);
assertEmpty(intentionName + " is not expected", intentionActions);
}
}
@@ -170,8 +170,6 @@ intention.join.declaration.text=Join declaration and assignment
intention.split.declaration.assignment.text=Split into declaration and assignment
intention.add.override.annotation=Add '@Override' annotation
intention.add.override.annotation.family=Add Override Annotation
intention.make.type.generic.family=Make Type Generic
intention.make.type.generic.text=Change type of {0} to {1}
intention.split.if.family=Split If
intention.split.if.text=Split into 2 if's
intention.split.filter.text=Split into filter's chain
@@ -215,6 +215,9 @@ inspection.suspicious.collections.method.calls.display.name=Suspicious collectio
inspection.suspicious.collections.method.calls.problem.descriptor=''{0}'' may not contain objects of type ''{1}''
inspection.suspicious.collections.method.calls.problem.descriptor1=Suspicious call to ''{0}''
inspection.raw.variable.type.make.generic.family=Make Type Generic
inspection.raw.variable.type.make.generic.text=Change type of {0} to {1}
inspection.reference.invalid=element no longer exists
inspection.reference.default.package=default package
inspection.reference.implicit.constructor.name=implicit constructor of {0}
@@ -1,6 +1,6 @@
<html>
<body>
This intention considers variable declaration with initializer and adjusts variable type
This inspection considers variable declaration with initializer and adjusts variable type
if it was declared with <b>raw</b> type whereas initializer has fully parameterized <b>generic</b> type.
</body>
@@ -1,8 +0,0 @@
import java.util.ArrayList;
import java.util.List;
public class X {
void f() {
List list <spot>=</spot> new ArrayList<String>();
}
}
+4 -4
View File
@@ -636,6 +636,10 @@
key="inspection.suspicious.collections.method.calls.display.name" groupKey="group.names.probable.bugs" enabledByDefault="true"
level="WARNING"
implementationClass="com.intellij.codeInspection.miscGenerics.SuspiciousCollectionsMethodCallsInspection"/>
<localInspection groupPath="Java" language="JAVA" shortName="MakeTypeGeneric" bundle="messages.InspectionsBundle"
key="inspection.suspicious.collections.method.calls.display.name" groupKey="group.names.code.style.issues"
enabledByDefault="true" level="INFORMATION"
implementationClass="com.intellij.codeInspection.miscGenerics.MakeTypeGenericInspection"/>
<localInspection groupPath="Java" language="JAVA" shortName="LocalCanBeFinal" bundle="messages.InspectionsBundle" key="inspection.local.can.be.final.display.name"
groupKey="group.names.code.style.issues" enabledByDefault="false" level="WARNING"
implementationClass="com.intellij.codeInspection.localCanBeFinal.LocalCanBeFinal"/>
@@ -949,10 +953,6 @@
<className>com.intellij.codeInsight.daemon.impl.quickfix.AddRuntimeExceptionToThrowsAction</className>
<category>Java/Declaration</category>
</intentionAction>
<intentionAction>
<className>com.intellij.codeInsight.intention.impl.MakeTypeGenericAction</className>
<category>Java/Declaration</category>
</intentionAction>
<intentionAction>
<className>com.intellij.codeInsight.intention.impl.AddOverrideAnnotationAction</className>
<category>Java/Annotations</category>