Skip to content

Handle nested types in AnnotateNullableMethods #579

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 2 commits into from
May 31, 2025
Merged

Handle nested types in AnnotateNullableMethods #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9874877
Handle nested types in AnnotateNullableMethods
timtebeek May 31, 2025
43be46e
No need to update cursor after changing course on implementation
timtebeek May 31, 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
5 changes: 4 additions & 1 deletion src/main/java/org/openrewrite/staticanalysis/AnnotateNullableMethods.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.staticanalysis.java.MoveFieldAnnotationToType;

import java.util.Arrays;
import java.util.Comparator;
Expand Down Expand Up @@ -92,7 +93,9 @@ public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration methodDecl
.build()
.apply(getCursor(), md.getCoordinates().addAnnotation(Comparator.comparing(J.Annotation::getSimpleName)));
doAfterVisit(ShortenFullyQualifiedTypeReferences.modifyOnly(annotatedMethod));
return (J.MethodDeclaration) new NullableOnMethodReturnType().getVisitor().visitNonNull(annotatedMethod, ctx, getCursor().getParentTreeCursor());
doAfterVisit(new MoveFieldAnnotationToType(fullyQualifiedName).getVisitor());
return (J.MethodDeclaration) new NullableOnMethodReturnType().getVisitor()
.visitNonNull(annotatedMethod, ctx, getCursor().getParentTreeCursor());
}
return md;
}
Expand Down
39 changes: 39 additions & 0 deletions src/test/java/org/openrewrite/staticanalysis/AnnotateNullableMethodsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
import org.openrewrite.test.SourceSpec;

import static org.assertj.core.api.Assertions.assertThat;
import static org.openrewrite.java.Assertions.java;
Expand Down Expand Up @@ -334,4 +335,42 @@ public String getString() {
)
);
}

@Test
void nestedType() {
rewriteRun(
//language=java
java(
"""
package a;
public class B {
public static class C {}
}
""",
SourceSpec::skip
),
//language=java
java(
"""
import a.B;
public class Foo {
public B.C bar() {
return null;
}
}
""",
"""
import a.B;
import org.jspecify.annotations.Nullable;

public class Foo {

public B.@Nullable C bar() {
Comment on lines +367 to +368
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite happy with this extra newline & double space yet, which are part of moving the annotation after it was added.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this should be fixed upstream, so we'll leave this here for now.

rewrite-static-analysis/src/main/java/org/openrewrite/staticanalysis/java/MoveFieldAnnotationToType.java

Lines 80 to 84 in a779afa

// auto format should handle this, but evidently doesn't
if (at.getAnnotations().isEmpty() && !(getCursor().getParentTreeCursor().getValue() instanceof J.MethodDeclaration)) {
at = at.withTypeExpression(te.withPrefix(te.getPrefix().withWhitespace("")));
}
at = autoFormat(at, at.getTypeExpression(), ctx, getCursor().getParentOrThrow());

return null;
}
}
"""
)
);
}
}
42 changes: 42 additions & 0 deletions src/test/java/org/openrewrite/staticanalysis/NullableOnMethodReturnTypeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
import org.openrewrite.test.SourceSpec;

import static org.openrewrite.java.Assertions.java;

Expand Down Expand Up @@ -55,6 +56,47 @@ class Test {
);
}

@Test
void nestedType() {
rewriteRun(
//language=java
java(
"""
package a;
public class B {
public static class C {}
}
""",
SourceSpec::skip
),
//language=java
java(
"""
import a.B;
import org.openrewrite.internal.lang.Nullable;

public class Foo {
@Nullable
public B.C bar() {
return null;
}
}
""",
"""
import a.B;
import org.openrewrite.internal.lang.Nullable;

public class Foo {

public @Nullable B.C bar() {
return null;
}
}
"""
)
);
}

@Test
void dontTouchArguments() {
rewriteRun(
Expand Down
42 changes: 42 additions & 0 deletions src/test/java/org/openrewrite/staticanalysis/java/MoveFieldAnnotationToTypeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
import org.openrewrite.test.SourceSpec;

import static org.openrewrite.java.Assertions.java;

Expand Down Expand Up @@ -222,4 +223,45 @@ public void someFunction(org.openrewrite.internal.@Nullable MetricsHelper metric
)
);
}

@Test
void nestedType() {
rewriteRun(
//language=java
java(
"""
package a;
public class B {
public static class C {}
}
""",
SourceSpec::skip
),
//language=java
java(
"""
import a.B;
import org.openrewrite.internal.lang.Nullable;

public class Foo {
@Nullable
public B.C bar() {
return null;
}
}
""",
"""
import a.B;
import org.openrewrite.internal.lang.Nullable;

public class Foo {

public B.@Nullable C bar() {
return null;
}
}
"""
)
);
}
}