jlengrand/error-prone-support
1
0
Fork 0
mirror of https://github.com/jlengrand/error-prone-support.git synced 2026-03-10 08:11:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support dropping trailing commas from annotation arrays

Browse Source
This commit is contained in:
Stephan Schroevers
2017-10-26 00:34:05 +02:00
parent 151783e63f
commit be5c149a66
2 changed files with 36 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
error-prone-contrib/src/main/java/com/picnicinternational/errorprone/bugpatterns/CanonicalAnnotationSyntaxCheck.java
View File

@@ -23,8 +23,8 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.function.BiFunction;
import java.util.regex.Pattern;
// XXX: Also flag/drop trailing commas?
@AutoService(BugChecker.class)
@BugPattern(
name = "CanonicalAnnotationSyntax",
@@ -37,6 +37,7 @@ import java.util.function.BiFunction;
public final class CanonicalAnnotationSyntaxCheck extends BugChecker
implements AnnotationTreeMatcher {
private static final long serialVersionUID = 1L;
private static final Pattern TRAILING_ARRAY_COMMA = Pattern.compile(",\\s*}$");
private static final ImmutableSet<BiFunction<AnnotationTree, VisitorState, Optional<Fix>>>
FIX_FACTORIES =
ImmutableSet.of(
@@ -103,7 +104,7 @@ public final class CanonicalAnnotationSyntaxCheck extends BugChecker
/* Replace the assignment with (the simplified representation of) just its value. */
ExpressionTree expr = assignment.getExpression();
return Optional.of(
SuggestedFix.replace(arg, simplifyAttributeValue(expr).orElseGet(expr::toString)));
SuggestedFix.replace(arg, simplifyAttributeValue(expr, state).orElseGet(expr::toString)));
}
private static Optional<Fix> dropRedundantCurlies(AnnotationTree tree, VisitorState state) {
@@ -117,26 +118,34 @@ public final class CanonicalAnnotationSyntaxCheck extends BugChecker
(arg.getKind() == Kind.ASSIGNMENT) ? ((AssignmentTree) arg).getExpression() : arg;
/* Store a fix for each expression that was successfully simplified. */
simplifyAttributeValue(value)
simplifyAttributeValue(value, state)
.ifPresent(expr -> fixes.add(SuggestedFix.builder().replace(value, expr)));
}
return fixes.stream().reduce(SuggestedFix.Builder::merge).map(SuggestedFix.Builder::build);
}
private static Optional<String> simplifyAttributeValue(ExpressionTree expr) {
private static Optional<String> simplifyAttributeValue(ExpressionTree expr, VisitorState state) {
if (expr.getKind() != Kind.NEW_ARRAY) {
/* There are no curly braces to be dropped here. */
/* There are no curly braces or commas to be dropped here. */
return Optional.empty();
}
NewArrayTree newArray = (NewArrayTree) expr;
if (newArray.getInitializers().size() != 1) {
/* Only singleton arrays can be simplified. */
return Optional.empty();
if (newArray.getInitializers().size() == 1) {
/* Return the expression describing the array's sole element. */
return Optional.of(newArray.getInitializers().get(0).toString());
}
/* Return the expression describing the array's sole element. */
return Optional.of(newArray.getInitializers().get(0).toString());
String src = state.getSourceForNode(newArray);
if (src != null && TRAILING_ARRAY_COMMA.matcher(src).find()) {
/*
* Drop a trailing command from the source code by returning the expression's
* "prettified" representation.
*/
return Optional.of(newArray.toString());
}
return Optional.empty();
}
}

18
error-prone-contrib/src/test/java/com/picnicinternational/errorprone/bugpatterns/CanonicalAnnotationSyntaxCheckTest.java
View File

@@ -1,6 +1,7 @@
package com.picnicinternational.errorprone.bugpatterns;
import com.google.errorprone.BugCheckerRefactoringTestHelper;
import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode;
import com.google.errorprone.CompilationTestHelper;
import java.io.IOException;
import org.junit.Test;
@@ -76,6 +77,13 @@ public final class CanonicalAnnotationSyntaxCheckTest {
" @pkg.A.Foo(value = 1, value2 = 2) A extended1();",
" @A.Foo(value = 1, value2 = 2) A extended2();",
" @Foo(value = 1, value2 = 2) A extended3();",
"",
" // BUG: Diagnostic contains:",
" @pkg.A.Foo({1, 1,}) A trailingComma1();",
" // BUG: Diagnostic contains:",
" @A.Foo({1, 1,}) A trailingComma2();",
" // BUG: Diagnostic contains:",
" @Foo({1, 1,}) A trailingComma3();",
"}")
.doTest();
}
@@ -110,6 +118,10 @@ public final class CanonicalAnnotationSyntaxCheckTest {
" @pkg.A.Foo(value = {1, 1}, value2 = {2}) A extended1();",
" @A.Foo(value = {1, 1}, value2 = {2}) A extended2();",
" @Foo(value = {1, 1}, value2 = {2}) A extended3();",
"",
" @pkg.A.Foo({1, 1,}) A trailingComma1();",
" @A.Foo({1, 1,}) A trailingComma2();",
" @Foo({1, 1,}) A trailingComma3();",
"}")
.addOutputLines(
"out/pkg/A.java",
@@ -138,7 +150,11 @@ public final class CanonicalAnnotationSyntaxCheckTest {
" @pkg.A.Foo(value = {1, 1}, value2 = 2) A extended1();",
" @A.Foo(value = {1, 1}, value2 = 2) A extended2();",
" @Foo(value = {1, 1}, value2 = 2) A extended3();",
"",
" @pkg.A.Foo({1, 1}) A trailingComma1();",
" @A.Foo({1, 1}) A trailingComma2();",
" @Foo({1, 1}) A trailingComma3();",
"}")
.doTest();
.doTest(TestMode.TEXT_MATCH);
}
}