Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New check for CONSTANT_CASE fields that are not static and final
RELNOTES: New check for CONSTANT_CASE fields that are not static and final MOE_MIGRATED_REVID=124176225
- Loading branch information
Showing
6 changed files
with
276 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
core/src/main/java/com/google/errorprone/bugpatterns/ConstantField.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * Copyright 2016 Google Inc. All Rights Reserved. | ||
| * | ||
| * 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.google.errorprone.bugpatterns; | ||
|
|
||
| import static com.google.errorprone.BugPattern.Category.JDK; | ||
| import static com.google.errorprone.BugPattern.MaturityLevel.MATURE; | ||
| import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION; | ||
|
|
||
| import com.google.common.base.CaseFormat; | ||
| import com.google.errorprone.BugPattern; | ||
| import com.google.errorprone.VisitorState; | ||
| import com.google.errorprone.bugpatterns.BugChecker.VariableTreeMatcher; | ||
| import com.google.errorprone.fixes.Fix; | ||
| import com.google.errorprone.fixes.SuggestedFix; | ||
| import com.google.errorprone.fixes.SuggestedFixes; | ||
| import com.google.errorprone.matchers.Description; | ||
| import com.google.errorprone.util.ASTHelpers; | ||
|
|
||
| import com.sun.source.tree.VariableTree; | ||
| import com.sun.tools.javac.code.Symbol; | ||
| import com.sun.tools.javac.tree.JCTree; | ||
| import com.sun.tools.javac.tree.TreeScanner; | ||
|
|
||
| import javax.lang.model.element.ElementKind; | ||
| import javax.lang.model.element.Modifier; | ||
|
|
||
| /** @author cushon@google.com (Liam Miller-Cushon) */ | ||
| @BugPattern( | ||
| name = "ConstantField", | ||
| category = JDK, | ||
| summary = "Field name is CONSTANT_CASE, but field is not static and final", | ||
| severity = SUGGESTION, | ||
| maturity = MATURE | ||
| ) | ||
| public class ConstantField extends BugChecker implements VariableTreeMatcher { | ||
|
|
||
| @Override | ||
| public Description matchVariable(VariableTree tree, VisitorState state) { | ||
| Symbol.VarSymbol sym = ASTHelpers.getSymbol(tree); | ||
| if (sym == null || sym.getKind() != ElementKind.FIELD) { | ||
| return Description.NO_MATCH; | ||
| } | ||
| if (sym.isStatic() && sym.getModifiers().contains(Modifier.FINAL)) { | ||
| return Description.NO_MATCH; | ||
| } | ||
| String name = sym.getSimpleName().toString(); | ||
| if (!name.equals(name.toUpperCase())) { | ||
| return Description.NO_MATCH; | ||
| } | ||
| return buildDescription(tree) | ||
| .addFix(SuggestedFixes.addModifiers(tree, state, Modifier.FINAL, Modifier.STATIC)) | ||
| .addFix(renameFix(tree, state, name)) | ||
| .build(); | ||
| } | ||
|
|
||
| private Fix renameFix(VariableTree tree, VisitorState state, String name) { | ||
| int pos = ((JCTree) tree).getStartPosition() + state.getSourceForNode(tree).indexOf(name); | ||
| final String renamed = CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name); | ||
| final SuggestedFix.Builder fix = | ||
| SuggestedFix.builder().replace(pos, pos + name.length(), renamed); | ||
| final Symbol.VarSymbol sym = ASTHelpers.getSymbol(tree); | ||
| ((JCTree) state.getPath().getCompilationUnit()) | ||
| .accept( | ||
| new TreeScanner() { | ||
| @Override | ||
| public void visitIdent(JCTree.JCIdent tree) { | ||
| if (sym.equals(ASTHelpers.getSymbol(tree))) { | ||
| fix.replace(tree, renamed); | ||
| } | ||
| } | ||
| }); | ||
| return fix.build(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
core/src/test/java/com/google/errorprone/bugpatterns/ConstantFieldTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Copyright 2016 Google Inc. All Rights Reserved. | ||
| * | ||
| * 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.google.errorprone.bugpatterns; | ||
|
|
||
| import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
| import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChooser; | ||
| import com.google.errorprone.CompilationTestHelper; | ||
| import com.google.errorprone.fixes.Fix; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| /** {@link ConstantField}Test */ | ||
| @RunWith(JUnit4.class) | ||
| public class ConstantFieldTest { | ||
| CompilationTestHelper compilationHelper = | ||
| CompilationTestHelper.newInstance(ConstantField.class, getClass()); | ||
|
|
||
| @Test | ||
| public void positive() { | ||
| compilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "class Test {", | ||
| " // BUG: Diagnostic contains: static final Object CONSTANT1 = 42;", | ||
| " Object CONSTANT1 = 42;", | ||
| " // BUG: Diagnostic contains: @Deprecated static final Object CONSTANT2 = 42;", | ||
| " @Deprecated Object CONSTANT2 = 42;", | ||
| " // BUG: Diagnostic contains: static final Object CONSTANT3 = 42;", | ||
| " static Object CONSTANT3 = 42;", | ||
| " // BUG: Diagnostic contains: static final Object CONSTANT4 = 42;", | ||
| " final Object CONSTANT4 = 42;", | ||
| " // BUG: Diagnostic contains:" | ||
| + " @Deprecated private static final Object CONSTANT5 = 42;", | ||
| " @Deprecated private Object CONSTANT5 = 42;", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void rename() { | ||
| compilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "class Test {", | ||
| " // BUG: Diagnostic contains: 'Object constantCaseName = 42;'", | ||
| " Object CONSTANT_CASE_NAME = 42;", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void negative() { | ||
| compilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "class Test {", | ||
| " static final Object CONSTANT = 42;", | ||
| " Object nonConst = 42;", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void renameUsages() throws IOException { | ||
| BugCheckerRefactoringTestHelper.newInstance(new ConstantField(), getClass()) | ||
| .addInputLines( | ||
| "in/Test.java", | ||
| "class Test {", | ||
| " Object CONSTANT_CASE = 42;", | ||
| " void f() {", | ||
| " System.err.println(CONSTANT_CASE);", | ||
| " }", | ||
| "}") | ||
| .addOutputLines( | ||
| "out/Test.java", | ||
| "class Test {", | ||
| " Object constantCase = 42;", | ||
| " void f() {", | ||
| " System.err.println(constantCase);", | ||
| " }", | ||
| "}") | ||
| .setFixChooser( | ||
| new FixChooser() { | ||
| @Override | ||
| public Fix choose(List<Fix> fixes) { | ||
| return fixes.get(1); | ||
| } | ||
| }) | ||
| .doTest(BugCheckerRefactoringTestHelper.TestMode.TEXT_MATCH); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| The [Google Java Style Guide §5.2.4][style] requires constant names to use | ||
| `CONSTANT_CASE`. | ||
|
|
||
| [style]: https://google.github.io/styleguide/javaguide.html#s5.2.4-constant-names | ||
|
|
||
| When naming a field with `CONSTANT_CASE`, make sure the field is `static`, | ||
| `final`, and of immutable type. If the field doesn't meet those criteria, use | ||
| `lowerCamelCase` instead. |