-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Suggest canonical modifier usage for Refaster template definitions #254
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
111 changes: 111 additions & 0 deletions
111
...e-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/RefasterTemplateModifiers.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,111 @@ | ||
| package tech.picnic.errorprone.bugpatterns; | ||
|
|
||
| import static com.google.errorprone.BugPattern.LinkType.NONE; | ||
| import static com.google.errorprone.BugPattern.SeverityLevel.SUGGESTION; | ||
| import static com.google.errorprone.BugPattern.StandardTags.STYLE; | ||
| import static com.google.errorprone.matchers.Matchers.anyOf; | ||
| import static com.google.errorprone.matchers.Matchers.hasAnnotation; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import com.google.errorprone.BugPattern; | ||
| import com.google.errorprone.VisitorState; | ||
| import com.google.errorprone.bugpatterns.BugChecker; | ||
| import com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher; | ||
| import com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher; | ||
| import com.google.errorprone.fixes.SuggestedFix; | ||
| import com.google.errorprone.fixes.SuggestedFixes; | ||
| import com.google.errorprone.matchers.Description; | ||
| import com.google.errorprone.matchers.Matcher; | ||
| import com.google.errorprone.refaster.annotation.AfterTemplate; | ||
| import com.google.errorprone.refaster.annotation.BeforeTemplate; | ||
| import com.google.errorprone.refaster.annotation.Placeholder; | ||
| import com.google.errorprone.util.ASTHelpers; | ||
| import com.sun.source.tree.ClassTree; | ||
| import com.sun.source.tree.MethodTree; | ||
| import com.sun.source.tree.Tree; | ||
| import java.util.EnumSet; | ||
| import java.util.Set; | ||
| import javax.lang.model.element.Modifier; | ||
|
|
||
| /** | ||
| * A {@link BugChecker} which suggests a canonical set of modifiers for Refaster class and method | ||
| * definitions. | ||
| */ | ||
| @AutoService(BugChecker.class) | ||
| @BugPattern( | ||
| summary = "Refaster class and method definitions should specify a canonical set of modifiers", | ||
| linkType = NONE, | ||
| severity = SUGGESTION, | ||
| tags = STYLE) | ||
| public final class RefasterTemplateModifiers extends BugChecker | ||
| implements ClassTreeMatcher, MethodTreeMatcher { | ||
| private static final long serialVersionUID = 1L; | ||
| private static final Matcher<Tree> BEFORE_TEMPLATE_METHOD = hasAnnotation(BeforeTemplate.class); | ||
| private static final Matcher<Tree> AFTER_TEMPLATE_METHOD = hasAnnotation(AfterTemplate.class); | ||
| private static final Matcher<Tree> PLACEHOLDER_METHOD = hasAnnotation(Placeholder.class); | ||
| private static final Matcher<Tree> REFASTER_METHOD = | ||
| anyOf(BEFORE_TEMPLATE_METHOD, AFTER_TEMPLATE_METHOD, PLACEHOLDER_METHOD); | ||
|
|
||
| @Override | ||
| public Description matchClass(ClassTree tree, VisitorState state) { | ||
| if (!hasMatchingMember(tree, BEFORE_TEMPLATE_METHOD, state)) { | ||
| /* This class does not contain a Refaster template. */ | ||
| return Description.NO_MATCH; | ||
| } | ||
|
|
||
| SuggestedFix fix = suggestCanonicalModifiers(tree, state); | ||
| return fix.isEmpty() ? Description.NO_MATCH : describeMatch(tree, fix); | ||
| } | ||
|
|
||
| @Override | ||
| public Description matchMethod(MethodTree tree, VisitorState state) { | ||
| if (!REFASTER_METHOD.matches(tree, state)) { | ||
| return Description.NO_MATCH; | ||
| } | ||
|
|
||
| return SuggestedFixes.removeModifiers( | ||
| tree, | ||
| state, | ||
| Modifier.FINAL, | ||
| Modifier.PRIVATE, | ||
| Modifier.PROTECTED, | ||
| Modifier.PUBLIC, | ||
| Modifier.STATIC, | ||
| Modifier.SYNCHRONIZED) | ||
| .map(fix -> describeMatch(tree, fix)) | ||
| .orElse(Description.NO_MATCH); | ||
| } | ||
|
|
||
| private static SuggestedFix suggestCanonicalModifiers(ClassTree tree, VisitorState state) { | ||
| Set<Modifier> modifiersToAdd = EnumSet.noneOf(Modifier.class); | ||
| Set<Modifier> modifiersToRemove = | ||
| EnumSet.of(Modifier.PRIVATE, Modifier.PROTECTED, Modifier.PUBLIC, Modifier.SYNCHRONIZED); | ||
|
|
||
| if (!hasMatchingMember(tree, PLACEHOLDER_METHOD, state)) { | ||
| /* | ||
| * Templates without a `@Placeholder` method should be `final`. Note that Refaster enforces | ||
| * that `@Placeholder` methods are `abstract`, so templates _with_ such a method will | ||
| * naturally be `abstract` and non-`final`. | ||
| */ | ||
| modifiersToAdd.add(Modifier.FINAL); | ||
| modifiersToRemove.add(Modifier.ABSTRACT); | ||
| } | ||
|
|
||
| if (ASTHelpers.findEnclosingNode(state.getPath(), ClassTree.class) != null) { | ||
| /* Nested classes should be `static`. */ | ||
| modifiersToAdd.add(Modifier.STATIC); | ||
| } | ||
|
|
||
| SuggestedFix.Builder fix = SuggestedFix.builder(); | ||
| SuggestedFixes.addModifiers(tree, tree.getModifiers(), state, modifiersToAdd) | ||
| .ifPresent(fix::merge); | ||
| SuggestedFixes.removeModifiers(tree.getModifiers(), state, modifiersToRemove) | ||
| .ifPresent(fix::merge); | ||
| return fix.build(); | ||
| } | ||
|
|
||
| private static boolean hasMatchingMember( | ||
| ClassTree tree, Matcher<Tree> matcher, VisitorState state) { | ||
| return tree.getMembers().stream().anyMatch(member -> matcher.matches(member, state)); | ||
| } | ||
| } |
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
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
208 changes: 208 additions & 0 deletions
208
...ntrib/src/test/java/tech/picnic/errorprone/bugpatterns/RefasterTemplateModifiersTest.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,208 @@ | ||
| package tech.picnic.errorprone.bugpatterns; | ||
|
|
||
| import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
| import com.google.errorprone.BugCheckerRefactoringTestHelper.TestMode; | ||
| import com.google.errorprone.CompilationTestHelper; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| final class RefasterTemplateModifiersTest { | ||
| private final CompilationTestHelper compilationTestHelper = | ||
| CompilationTestHelper.newInstance(RefasterTemplateModifiers.class, getClass()); | ||
| private final BugCheckerRefactoringTestHelper refactoringTestHelper = | ||
| BugCheckerRefactoringTestHelper.newInstance(RefasterTemplateModifiers.class, getClass()); | ||
|
|
||
| @Test | ||
| void identification() { | ||
| compilationTestHelper | ||
| .addSourceLines( | ||
| "A.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "", | ||
| "final class A {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " String nonRefasterMethod(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " static final class Inner {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "}") | ||
| .addSourceLines( | ||
| "B.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "import com.google.errorprone.refaster.annotation.Placeholder;", | ||
| "", | ||
| "abstract class B<I, O> {", | ||
| " @Placeholder", | ||
| " abstract O someFunction(I input);", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " String before(I input) {", | ||
| " return String.valueOf(someFunction(input));", | ||
| " }", | ||
| "", | ||
| " abstract static class Inner<I, O> {", | ||
| " @Placeholder", | ||
| " abstract O someFunction(I input);", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " String before(I input) {", | ||
| " return String.valueOf(someFunction(input));", | ||
| " }", | ||
| " }", | ||
| "}") | ||
| .addSourceLines( | ||
| "C.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "", | ||
| "// BUG: Diagnostic contains:", | ||
| "class C {", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " final String beforeFinal(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " private String beforePrivate(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " public String beforePublic(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " static String beforeStatic(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " synchronized String beforeSynchronized(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " abstract static class AbstractInner {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " static class NonFinalInner {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "", | ||
| " // BUG: Diagnostic contains:", | ||
| " final class NonStaticInner {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "}") | ||
| .addSourceLines( | ||
| "D.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "", | ||
| "// BUG: Diagnostic contains:", | ||
| "abstract class D {", | ||
| " @BeforeTemplate", | ||
| " // BUG: Diagnostic contains:", | ||
| " protected String beforeProtected(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| void replacement() { | ||
| refactoringTestHelper | ||
| .addInputLines( | ||
| "A.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "", | ||
| "class A {", | ||
| " @BeforeTemplate", | ||
| " private static String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "}") | ||
| .addOutputLines( | ||
| "A.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "", | ||
| "final class A {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| "}") | ||
| .addInputLines( | ||
| "B.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "import com.google.errorprone.refaster.annotation.Placeholder;", | ||
| "", | ||
| "final class B {", | ||
| " abstract class WithoutPlaceholder {", | ||
| " @BeforeTemplate", | ||
| " protected synchronized String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "", | ||
| " abstract class WithPlaceholder<I, O> {", | ||
| " @Placeholder", | ||
| " public abstract O someFunction(I input);", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " public final String before(I input) {", | ||
| " return String.valueOf(someFunction(input));", | ||
| " }", | ||
| " }", | ||
| "}") | ||
| .addOutputLines( | ||
| "B.java", | ||
| "import com.google.errorprone.refaster.annotation.BeforeTemplate;", | ||
| "import com.google.errorprone.refaster.annotation.Placeholder;", | ||
| "", | ||
| "final class B {", | ||
| " static final class WithoutPlaceholder {", | ||
| " @BeforeTemplate", | ||
| " String before(String str) {", | ||
| " return str;", | ||
| " }", | ||
| " }", | ||
| "", | ||
| " abstract static class WithPlaceholder<I, O> {", | ||
| " @Placeholder", | ||
| " abstract O someFunction(I input);", | ||
| "", | ||
| " @BeforeTemplate", | ||
| " String before(I input) {", | ||
| " return String.valueOf(someFunction(input));", | ||
| " }", | ||
| " }", | ||
| "}") | ||
| .doTest(TestMode.TEXT_MATCH); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't
beforeStaticcome beforebeforeSynchronized?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By that logic we should swap more stuff; will add a commit.