Skip to content

Omit migration to @Setter annotated field of other annotations are present #672

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.

Sign up for GitHub

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 4 commits into from
Feb 12, 2025
Merged

Omit migration to @Setter annotated field of other annotations are present #672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ef36f6
Omit migration to @Setter annotated field of other annotations are pr…
MBoegers Feb 11, 2025
5938f5e
make `LombokUtils` use a `Cursor` instead a `J.MethodDeclaration`
MBoegers Feb 11, 2025
143c1d1
Retrieve AnnotationService through `org.openrewrite.java.JavaVisitor.…
timtebeek Feb 12, 2025
0c46ec6
Rename private method to express when to skip Getter/Setter
timtebeek Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions src/main/java/org/openrewrite/java/migrate/lombok/LombokUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,28 @@

import lombok.AccessLevel;
import org.jspecify.annotations.Nullable;
import org.openrewrite.Cursor;
import org.openrewrite.internal.StringUtils;
import org.openrewrite.java.AnnotationMatcher;
import org.openrewrite.java.service.AnnotationService;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;

import java.util.List;

import static lombok.AccessLevel.*;
import static org.openrewrite.java.tree.J.Modifier.Type.*;

class LombokUtils {

static boolean isGetter(J.MethodDeclaration method) {
private static final AnnotationMatcher OVERRIDE_MATCHER = new AnnotationMatcher("java.lang.Override");

static boolean isGetter(Cursor cursor, AnnotationService service) {
if (!(cursor.getValue() instanceof J.MethodDeclaration)) {
return false;
}
J.MethodDeclaration method = cursor.getValue();
if (method.getMethodType() == null) {
return false;
}
Expand All @@ -41,6 +52,10 @@ static boolean isGetter(J.MethodDeclaration method) {
!(method.getBody().getStatements().get(0) instanceof J.Return)) {
return false;
}
// Check there is no annotation except @Overwrite
if (hasAnyAnnotatioOtherThanOverride(cursor, service)) {
return false;
}
// Check field is declared on method type
JavaType.FullyQualified declaringType = method.getMethodType().getDeclaringType();
Expression returnExpression = ((J.Return) method.getBody().getStatements().get(0)).getExpression();
Expand Down Expand Up @@ -83,7 +98,12 @@ private static String deriveGetterMethodName(@Nullable JavaType type, String fie
return "get" + StringUtils.capitalize(fieldName);
}

static boolean isSetter(J.MethodDeclaration method) {
static boolean isSetter(Cursor cursor, AnnotationService service) {
if (!(cursor.getValue() instanceof J.MethodDeclaration)) {
return false;
}
J.MethodDeclaration method = cursor.getValue();

// Check return type: void
if (method.getType() != JavaType.Primitive.Void) {
return false;
Expand All @@ -99,6 +119,11 @@ static boolean isSetter(J.MethodDeclaration method) {
return false;
}

// Check there is no annotation except @Overwrite
if (hasAnyAnnotatioOtherThanOverride(cursor, service)) {
return false;
}

// Check there's no up/down cast between parameter and field
J.VariableDeclarations.NamedVariable param = ((J.VariableDeclarations) method.getParameters().get(0)).getVariables().get(0);
Expression variable = ((J.Assignment) method.getBody().getStatements().get(0)).getVariable();
Expand Down Expand Up @@ -141,4 +166,9 @@ static AccessLevel getAccessLevel(J.MethodDeclaration methodDeclaration) {
}
return PACKAGE;
}

private static boolean hasAnyAnnotatioOtherThanOverride(Cursor cursor, AnnotationService service) {
List<J.Annotation> annotations = service.getAllAnnotations(cursor);
return !(annotations.isEmpty() || (annotations.size() == 1 && OVERRIDE_MATCHER.matches(annotations.get(0))));
}
}
3 changes: 2 additions & 1 deletion src/main/java/org/openrewrite/java/migrate/lombok/UseLombokGetter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.service.AnnotationService;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;

Expand Down Expand Up @@ -54,7 +55,7 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
return new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.@Nullable MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) {
if (LombokUtils.isGetter(method)) {
if (LombokUtils.isGetter(getCursor(), service(AnnotationService.class))) {
Expression returnExpression = ((J.Return) method.getBody().getStatements().get(0)).getExpression();
if (returnExpression instanceof J.Identifier &&
((J.Identifier) returnExpression).getFieldType() != null) {
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/openrewrite/java/migrate/lombok/UseLombokSetter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.service.AnnotationService;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;

Expand Down Expand Up @@ -53,7 +54,7 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
return new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.@Nullable MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) {
if (LombokUtils.isSetter(method)) {
if (LombokUtils.isSetter(getCursor(), service(AnnotationService.class))) {
Expression assignmentVariable = ((J.Assignment) method.getBody().getStatements().get(0)).getVariable();
if (assignmentVariable instanceof J.FieldAccess &&
((J.FieldAccess) assignmentVariable).getName().getFieldType() != null) {
Expand Down
51 changes: 51 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/lombok/UseLombokGetterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.Issue;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

Expand Down Expand Up @@ -528,4 +529,54 @@ public int getFoo() {
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite/issues/5015")
void noChangeIfAnnotated() {
rewriteRun(// language=java
java("@interface MyOtherAnnotation {}"),
java(
"""
class A {

int foo = 9;

@MyOtherAnnotation
public int getFoo() {
return foo;
}
}
"""
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite/issues/5015")
void replaceGetterIfOverwrite() {
rewriteRun(// language=java
java(
"""
class A {

int foo = 9;

@Override
public int getFoo() {
return foo;
}
}
""",
"""
import lombok.Getter;

class A {

@Getter
int foo = 9;
}
"""
)
);
}
}
51 changes: 51 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/lombok/UseLombokSetterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.Issue;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
Expand Down Expand Up @@ -537,4 +538,54 @@ public void setFoo(int foo) {
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite/issues/5015")
void noChangeIfAnnotated() {
rewriteRun(// language=java
java("@interface MyOtherAnnotation {}"),
java(
"""
class A {

int foo = 9;

@MyOtherAnnotation
public void setFoo(int fub) {
this.foo = fub;
}
}
"""
)
);
}

@Test
@Issue("https://github.com/openrewrite/rewrite/issues/5015")
void replaceSetterIfOverwrite() {
rewriteRun(// language=java
java(
"""
class A {

int foo = 9;

@Override
public void setFoo(int foo) {
this.foo = foo;
}
}
""",
"""
import lombok.Setter;

class A {

@Setter
int foo = 9;
}
"""
)
);
}
}