-
Notifications
You must be signed in to change notification settings - Fork 110
Create recipe for @InlineMe annotation replacements
#788
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
4dcad6a
Create replace for `@InlineMe` annotations
timtebeek f14bcc6
Implement conversion from replacement string to templated
timtebeek f122b98
Small tweaks
timtebeek 171791d
Drop JetBrains annotation
timtebeek 8b075ff
Make `createTemplateString` static as well
timtebeek 422e156
Update Inlinings.java
timtebeek aac36ab
Additional test cases
timtebeek 78bd090
Merge branch 'main' into recipe-for-InlineMe-annotation
timtebeek e9ac12f
Add support for constructors as well
timtebeek 506797a
Merge branch 'main' into recipe-for-InlineMe-annotation
timtebeek 76d8972
Update InliningsTest.java
timtebeek c83ce5a
Add an even simpler document example test case
timtebeek d7eacf8
Merge branch 'main' into recipe-for-InlineMe-annotation
timtebeek a3468ef
Show initial passing test
timtebeek 939f31f
Fix template when select is null
timtebeek 576cb71
Show more tests passing
timtebeek 1a791d6
Show all tests passing
timtebeek 7fec2ca
Avoid self referential replacements
timtebeek f4bc91b
Switch to `latest.release`
timtebeek 439a911
Show problematic case for Guava
timtebeek 1dc2878
Rename recipe
timtebeek 2524fe3
Explicitly show parameter names are not available
timtebeek 6ee0d51
Merge branch 'main' into recipe-for-InlineMe-annotation
timtebeek 9dc3314
Apply code suggestion
timtebeek 2aca035
Quit early when we encounter `arg0`
timtebeek 30b9b79
Remove imports before adding imports
timtebeek b406699
Add support for adding static imports
timtebeek 4086d65
Add support for removing static imports
timtebeek 6a7ed9f
Merge the visitors for regular and static import removal
timtebeek 5a4359f
Pull out a separate recipe to `findOriginalImports`
timtebeek 739a032
Create a Guava recipe to inline methods and move the tests there
timtebeek 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 hidden or 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
170 changes: 170 additions & 0 deletions
170
src/main/java/org/openrewrite/java/migrate/Inlinings.java
This file contains hidden or 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,170 @@ | ||
| /* | ||
| * Copyright 2025 the original author or authors. | ||
| * <p> | ||
| * Licensed under the Moderne Source Available License (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * <p> | ||
| * https://docs.moderne.io/licensing/moderne-source-available-license | ||
| * <p> | ||
| * 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 org.openrewrite.java.migrate; | ||
|
|
||
| import lombok.AccessLevel; | ||
| import lombok.Getter; | ||
| import lombok.Value; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jspecify.annotations.Nullable; | ||
| import org.openrewrite.ExecutionContext; | ||
| import org.openrewrite.Recipe; | ||
| import org.openrewrite.TreeVisitor; | ||
| import org.openrewrite.java.JavaIsoVisitor; | ||
| import org.openrewrite.java.JavaTemplate; | ||
| import org.openrewrite.java.tree.Expression; | ||
| import org.openrewrite.java.tree.J; | ||
| import org.openrewrite.java.tree.JavaType; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class Inlinings extends Recipe { | ||
|
|
||
| private static final String INLINE_ME = "com.google.errorprone.annotations.InlineMe"; | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "Inline methods annotated with `@InlineMe`"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "Apply inlinings defined by Error Prone's [`@InlineMe` annotation](https://errorprone.info/docs/inlineme)."; | ||
| } | ||
|
|
||
| @Override | ||
| public TreeVisitor<?, ExecutionContext> getVisitor() { | ||
| return //Preconditions.check( | ||
| // new UsesType<>(INLINE_ME, true), // FIXME Not picked up that we're calling an annotated method | ||
| new JavaIsoVisitor<ExecutionContext>() { | ||
| @Override | ||
| public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { | ||
| J.MethodInvocation mi = super.visitMethodInvocation(method, ctx); | ||
| InlineMeValues values = findInlineMeValues(mi.getMethodType()); | ||
| if (values == null) { | ||
| return mi; | ||
| } | ||
| Template template = values.template(mi); | ||
| if (template == null) { | ||
| return mi; | ||
| } | ||
| return JavaTemplate.builder(template.getString()) | ||
| .doBeforeParseTemplate(System.out::println) | ||
| .contextSensitive() | ||
| .imports(values.getImports()) | ||
| .staticImports(values.getStaticImports()) | ||
| .build() | ||
| .apply(getCursor(), mi.getCoordinates().replace(), template.getParameters()); | ||
| } | ||
|
|
||
| private @Nullable InlineMeValues findInlineMeValues(JavaType.@Nullable Method methodType) { | ||
| if (methodType == null) { | ||
| return null; | ||
| } | ||
| List<JavaType.FullyQualified> annotations = methodType.getAnnotations(); | ||
| for (JavaType.FullyQualified annotation : annotations) { | ||
| if (INLINE_ME.equals(annotation.getFullyQualifiedName())) { | ||
| return InlineMeValues.parse((JavaType.Annotation) annotation); | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
| } | ||
| /*)*/; | ||
| } | ||
|
|
||
| @Value | ||
| private static class InlineMeValues { | ||
| private static final Pattern TEMPLATE_IDENTIFIER = Pattern.compile("#\\{(\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*):any\\(\\)}"); | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @Getter(AccessLevel.NONE) | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| String replacement; | ||
| String[] imports; | ||
| String[] staticImports; | ||
|
|
||
| static InlineMeValues parse(JavaType.Annotation annotation) { | ||
| Map<String, Object> collect = annotation.getValues().stream() | ||
| .collect(Collectors.toMap( | ||
| e -> ((JavaType.Method) e.getElement()).getName(), | ||
| JavaType.Annotation.ElementValue::getValue | ||
| )); | ||
| String replacement = (String) collect.get("replacement"); | ||
| // TODO Parse imports and static imports from the annotation values too | ||
| String[] imports = new String[0]; | ||
| String[] staticImports = new String[0]; | ||
| return new InlineMeValues(replacement, imports, staticImports); | ||
| } | ||
|
|
||
| @Nullable | ||
| Template template(J.MethodInvocation original) { | ||
| JavaType.Method methodType = original.getMethodType(); | ||
| if (methodType == null) { | ||
| return null; | ||
| } | ||
|
|
||
| List<String> originalParameterNames = methodType.getParameterNames(); | ||
| String templateString = createTemplateString(originalParameterNames); | ||
| Expression[] parameters = createParameters(templateString, originalParameterNames, original); | ||
| return new Template(templateString, parameters); | ||
| } | ||
|
|
||
| private @NotNull String createTemplateString(List<String> originalParameterNames) { | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| String templateString = replacement.replaceAll("\\bthis\\b", "#{this:any()}"); | ||
| for (String parameterName : originalParameterNames) { | ||
| // Replace parameter names with their values in the templateString | ||
| templateString = templateString.replaceAll( | ||
| String.format("\\b%s\\b", parameterName), | ||
| String.format("#{%s:any()}", parameterName)); // TODO 2nd, 3rd etc should use shorthand `#{a}` | ||
| } | ||
| return templateString; | ||
| } | ||
|
|
||
| private static Expression[] createParameters(String templateString, List<String> originalParameterNames, J.MethodInvocation original) { | ||
| Map<String, Expression> lookup = new HashMap<>(); | ||
| if (original.getSelect() != null) { | ||
| lookup.put("this", original.getSelect()); | ||
| } | ||
| for (int i = 0; i < originalParameterNames.size(); i++) { | ||
| String originalName = originalParameterNames.get(i); | ||
| Expression originalValue = original.getArguments().get(i); | ||
| lookup.put(originalName, originalValue); | ||
| } | ||
| List<Expression> parameters = new ArrayList<>(); | ||
| Matcher matcher = TEMPLATE_IDENTIFIER.matcher(templateString); | ||
| while (matcher.find()) { | ||
| Expression o = lookup.get(matcher.group(1)); | ||
| if (o != null) { | ||
| parameters.add(o); | ||
| } else { | ||
| throw new IllegalStateException( | ||
| "No parameter found for " + matcher.group(1) + " in template: " + templateString); | ||
| } | ||
| } | ||
| return parameters.toArray(new Expression[0]); | ||
| } | ||
| } | ||
|
|
||
| @Value | ||
| private static class Template { | ||
| String string; | ||
| Object[] parameters; | ||
| } | ||
| } | ||
83 changes: 83 additions & 0 deletions
83
src/test/java/org/openrewrite/java/migrate/InliningsTest.java
This file contains hidden or 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,83 @@ | ||
| /* | ||
| * Copyright 2025 the original author or authors. | ||
| * <p> | ||
| * Licensed under the Moderne Source Available License (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * <p> | ||
| * https://docs.moderne.io/licensing/moderne-source-available-license | ||
| * <p> | ||
| * 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 org.openrewrite.java.migrate; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.openrewrite.DocumentExample; | ||
| import org.openrewrite.java.JavaParser; | ||
| import org.openrewrite.test.RecipeSpec; | ||
| import org.openrewrite.test.RewriteTest; | ||
| import org.openrewrite.test.SourceSpec; | ||
|
|
||
| import static org.openrewrite.java.Assertions.java; | ||
|
|
||
| class InliningsTest implements RewriteTest { | ||
|
|
||
| @Override | ||
| public void defaults(RecipeSpec spec) { | ||
| spec.recipe(new Inlinings()) | ||
| .parser(JavaParser.fromJavaVersion().classpath("guava", "error_prone_annotations")); | ||
| } | ||
|
|
||
| @Test | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @DocumentExample | ||
| void inlineMe() { | ||
| //language=java | ||
| rewriteRun( | ||
| java( | ||
| """ | ||
| package m; | ||
|
|
||
| import com.google.errorprone.annotations.InlineMe; | ||
| import java.time.Duration; | ||
|
|
||
| public final class MyClass { | ||
| private final Duration deadline; | ||
|
|
||
| public Duration getDeadline() { | ||
| return deadline; | ||
| } | ||
|
|
||
| @Deprecated | ||
| @InlineMe(replacement = "this.getDeadline().toMillis()") | ||
| public long getDeadlineMillis() { | ||
| return getDeadline().toMillis(); | ||
| } | ||
| } | ||
| """, | ||
| SourceSpec::skip | ||
| ), | ||
| java( | ||
| """ | ||
| import m.MyClass; | ||
| class Foo { | ||
| void foo(MyClass myClass) { | ||
| myClass.getDeadlineMillis(); | ||
| } | ||
| } | ||
| """, | ||
| """ | ||
| import m.MyClass; | ||
| class Foo { | ||
| void foo(MyClass myClass) { | ||
| myClass.getDeadline().toMillis(); | ||
| } | ||
| } | ||
| """ | ||
| ) | ||
| ); | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.