Introduce NameContentEquals Refaster rule (#1379)

PicnicSupermarket · Oct 29, 2024 · 9940576 · 9940576
1 parent caf2a86
commit 9940576
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/ConstantNaming.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/ConstantNaming.java
@@ -112,7 +112,7 @@ private static boolean isVariableNameInUse(String name, VisitorState state) {
         new TreeScanner<Boolean, @Nullable Void>() {
           @Override
           public Boolean visitVariable(VariableTree tree, @Nullable Void unused) {
-            return ASTHelpers.getSymbol(tree).getSimpleName().toString().equals(name)
+            return ASTHelpers.getSymbol(tree).getSimpleName().contentEquals(name)
                 || super.visitVariable(tree, null);
           }
 

diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BugCheckerRules.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BugCheckerRules.java
@@ -9,6 +9,7 @@
 import com.google.errorprone.refaster.annotation.BeforeTemplate;
 import com.sun.tools.javac.util.Constants;
 import com.sun.tools.javac.util.Convert;
+import javax.lang.model.element.Name;
 import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
 
 /** Refaster rules related to {@link com.google.errorprone.bugpatterns.BugChecker} classes. */
@@ -67,4 +68,22 @@ String after(String value) {
       return Constants.format(value);
     }
   }
+
+  /** Prefer {@link Name#contentEquals(CharSequence)} over more verbose alternatives. */
+  static final class NameContentEquals {
+    @BeforeTemplate
+    boolean before(Name name, CharSequence string) {
+      return name.toString().equals(string.toString());
+    }
+
+    @BeforeTemplate
+    boolean before(Name name, String string) {
+      return name.toString().equals(string);
+    }
+
+    @AfterTemplate
+    boolean after(Name name, CharSequence string) {
+      return name.contentEquals(string);
+    }
+  }
 }
diff --git a/...rib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestInput.java b/...rib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestInput.java
@@ -5,6 +5,7 @@
 import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChoosers;
 import com.google.errorprone.bugpatterns.BugChecker;
 import com.sun.tools.javac.util.Convert;
+import javax.lang.model.element.Name;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class BugCheckerRulesTest implements RefasterRuleCollectionTestCase {
@@ -31,4 +32,10 @@ ImmutableSet<BugCheckerRefactoringTestHelper> testBugCheckerRefactoringTestHelpe
   String testConstantsFormat() {
     return String.format("\"%s\"", Convert.quote("foo"));
   }
+
+  ImmutableSet<Boolean> testNameContentEquals() {
+    return ImmutableSet.of(
+        ((Name) null).toString().equals("foo".subSequence(0, 1).toString()),
+        ((com.sun.tools.javac.util.Name) null).toString().equals("bar"));
+  }
 }
diff --git a/...ib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestOutput.java b/...ib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestOutput.java
@@ -6,6 +6,7 @@
 import com.google.errorprone.bugpatterns.BugChecker;
 import com.sun.tools.javac.util.Constants;
 import com.sun.tools.javac.util.Convert;
+import javax.lang.model.element.Name;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class BugCheckerRulesTest implements RefasterRuleCollectionTestCase {
@@ -30,4 +31,10 @@ ImmutableSet<BugCheckerRefactoringTestHelper> testBugCheckerRefactoringTestHelpe
   String testConstantsFormat() {
     return Constants.format("foo");
   }
+
+  ImmutableSet<Boolean> testNameContentEquals() {
+    return ImmutableSet.of(
+        ((Name) null).contentEquals("foo".subSequence(0, 1)),
+        ((com.sun.tools.javac.util.Name) null).contentEquals("bar"));
+  }
 }