-
Notifications
You must be signed in to change notification settings - Fork 134
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
Implement DeprecatedGuavaObjects error-prone migration #1521
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
70 changes: 70 additions & 0 deletions
70
...ne-error-prone/src/main/java/com/palantir/baseline/errorprone/DeprecatedGuavaObjects.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,70 @@ | ||
/* | ||
* (c) Copyright 2020 Palantir Technologies 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.palantir.baseline.errorprone; | ||
|
||
import com.google.auto.service.AutoService; | ||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.BugPattern.LinkType; | ||
import com.google.errorprone.BugPattern.SeverityLevel; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker; | ||
import com.google.errorprone.fixes.SuggestedFix; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.matchers.Matcher; | ||
import com.google.errorprone.matchers.method.MethodMatchers; | ||
import com.sun.source.tree.ExpressionTree; | ||
import com.sun.source.tree.MethodInvocationTree; | ||
|
||
@AutoService(BugChecker.class) | ||
@BugPattern( | ||
name = "DeprecatedGuavaObjects", | ||
link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks", | ||
linkType = LinkType.CUSTOM, | ||
severity = SeverityLevel.WARNING, | ||
summary = "The standard library java.util.Objects utilities replace Guava " | ||
+ "com.google.common.base.Objects in java 1.7 and beyond.") | ||
public final class DeprecatedGuavaObjects extends BugChecker implements BugChecker.MethodInvocationTreeMatcher { | ||
|
||
private static final String GUAVA_OBJECTS_NAME = "com.google.common.base.Objects"; | ||
private static final String GUAVA_OBJECTS_EQUAL = GUAVA_OBJECTS_NAME + ".equal"; | ||
private static final String GUAVA_OBJECTS_HASH_CODE = GUAVA_OBJECTS_NAME + ".hashCode"; | ||
private static final String JAVA_OBJECTS_NAME = "java.util.Objects"; | ||
private static final Matcher<ExpressionTree> EQUAL_MATCHER = MethodMatchers.staticMethod() | ||
.onClass("com.google.common.base.Objects") | ||
.named("equal"); | ||
private static final Matcher<ExpressionTree> HASH_CODE_MATCHER = MethodMatchers.staticMethod() | ||
.onClass("com.google.common.base.Objects") | ||
.named("hashCode"); | ||
|
||
@Override | ||
public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) { | ||
boolean hashCode = HASH_CODE_MATCHER.matches(tree, state); | ||
boolean equal = EQUAL_MATCHER.matches(tree, state); | ||
if (hashCode || equal) { | ||
return buildDescription(tree) | ||
.addFix(SuggestedFix.builder() | ||
.removeImport(GUAVA_OBJECTS_NAME) | ||
.removeStaticImport(GUAVA_OBJECTS_EQUAL) | ||
.removeStaticImport(GUAVA_OBJECTS_HASH_CODE) | ||
.addImport(JAVA_OBJECTS_NAME) | ||
.replace(tree.getMethodSelect(), equal ? "Objects.equals" : "Objects.hash") | ||
.build()) | ||
.build(); | ||
} | ||
return Description.NO_MATCH; | ||
} | ||
} |
56 changes: 56 additions & 0 deletions
56
...rror-prone/src/test/java/com/palantir/baseline/errorprone/DeprecatedGuavaObjectsTest.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,56 @@ | ||
/* | ||
* (c) Copyright 2020 Palantir Technologies 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.palantir.baseline.errorprone; | ||
|
||
import org.junit.jupiter.api.Test; | ||
|
||
class DeprecatedGuavaObjectsTest { | ||
|
||
@Test | ||
public void test() { | ||
fix().addInputLines( | ||
"Test.java", | ||
"import com.google.common.base.Objects;", | ||
"import static com.google.common.base.Objects.equal;", | ||
"public class Test {", | ||
" void f(Object a, Object b) {", | ||
" com.google.common.base.Objects.equal(a, b);", | ||
" Objects.equal(a, b);", | ||
" equal(a, b);", | ||
" com.google.common.base.Objects.hashCode(a, b);", | ||
" Objects.hashCode(a, b);", | ||
" }", | ||
"}") | ||
.addOutputLines( | ||
"Test.java", | ||
"import java.util.Objects;", | ||
"public class Test {", | ||
" void f(Object a, Object b) {", | ||
" Objects.equals(a, b);", | ||
" Objects.equals(a, b);", | ||
" Objects.equals(a, b);", | ||
" Objects.hash(a, b);", | ||
" Objects.hash(a, b);", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
private RefactoringValidator fix() { | ||
return RefactoringValidator.of(new DeprecatedGuavaObjects(), getClass()); | ||
} | ||
} |
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,5 @@ | ||
type: improvement | ||
improvement: | ||
description: Implement DeprecatedGuavaObjects error-prone migration | ||
links: | ||
- https://github.com/palantir/gradle-baseline/pull/1521 |
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
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.
should we treat single arg version differently to map to
java.util.Objects.hashCode(Object)
and varargs maps tojava.util.Objects.hash(Objects...)
?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.
I was planning to keep this simple as a direct migration and write a separate check for
java.util.Objects.hash(value)
->java.util.Objects.hashCode(value)
to eventually resolve to the ideal implementation.That would result in the first refactor run failing in this case, so it might be fine to share the complexity with this check as well. What do you think?
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.
👍 your proposal makes sense to me and is additive beyond just the Guava -> java.util conversion
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.
PR is #1522