-
Notifications
You must be signed in to change notification settings - Fork 100
[draft] Remove Spring annotations if they repeating in subclasses #698
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
Draft
arodionov
wants to merge
4
commits into
main
Choose a base branch
from
remove-repeating-annotations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
e9e4c22
[draft] Remove Spring annotations if they repeating in subclasses
arodionov 60339e0
Update src/testWithSpringBoot_1_5/java/org/openrewrite/java/spring/No…
arodionov 2ea2faa
- detect repeating and remove methods annotation
arodionov 198b052
- add test only for annotated method
arodionov 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
83 changes: 83 additions & 0 deletions
83
src/main/java/org/openrewrite/java/spring/NotRepeatSpringAnnotationsInSubclasses.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.spring; | ||
|
||
import org.openrewrite.ExecutionContext; | ||
import org.openrewrite.Recipe; | ||
import org.openrewrite.TreeVisitor; | ||
import org.openrewrite.internal.ListUtils; | ||
import org.openrewrite.java.JavaIsoVisitor; | ||
import org.openrewrite.java.RemoveAnnotation; | ||
import org.openrewrite.java.tree.J; | ||
import org.openrewrite.java.tree.JavaType; | ||
import org.openrewrite.java.tree.TypeUtils; | ||
|
||
import java.util.List; | ||
import java.util.Optional; | ||
import java.util.stream.Collectors; | ||
|
||
public class NotRepeatSpringAnnotationsInSubclasses extends Recipe { | ||
|
||
@Override | ||
public String getDisplayName() { | ||
return "Remove Spring annotations if they repeating in subclasses"; | ||
} | ||
|
||
@Override | ||
public String getDescription() { | ||
return "Remove Spring annotations in subclasses if they present in base classes."; | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getVisitor() { | ||
//return Preconditions.check(new UsesType<>("org.springframework.web.bind.annotation.PostMapping", false), new JavaIsoVisitor<ExecutionContext>() { | ||
return new JavaIsoVisitor<ExecutionContext>() { | ||
@Override | ||
public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) { | ||
return super.visitClassDeclaration(classDecl, ctx); | ||
} | ||
|
||
@Override | ||
public J.MethodDeclaration visitMethodDeclaration(J.MethodDeclaration method, ExecutionContext ctx) { | ||
J.MethodDeclaration md = super.visitMethodDeclaration(method, ctx); | ||
|
||
Optional<JavaType.Method> overriddenMethod = TypeUtils.findOverriddenMethod(md.getMethodType()); | ||
if (overriddenMethod.isPresent()) { | ||
|
||
JavaType.Method overrideMethod = overriddenMethod.get(); | ||
|
||
List<JavaType.FullyQualified> baseAnnotations = overrideMethod.getAnnotations(); | ||
List<JavaType.FullyQualified> methodAnnotations = md.getMethodType().getAnnotations(); | ||
List<JavaType.FullyQualified> repeated = methodAnnotations.stream() | ||
.filter(a -> baseAnnotations.stream().anyMatch(b -> TypeUtils.isOfType(a, b))) | ||
.collect(Collectors.toList()); | ||
|
||
List<J.Annotation> annotations = ListUtils.map(md.getLeadingAnnotations(), | ||
a -> { | ||
if (repeated.stream().anyMatch(n -> TypeUtils.isOfType(a.getType(), ((JavaType.Annotation) n).getType()))) { | ||
return (J.Annotation) new RemoveAnnotation(a.getType().toString()).getVisitor().visit(a, ctx, getCursor().getParentOrThrow()); | ||
} | ||
return a; | ||
}); | ||
md = md.withLeadingAnnotations(annotations); | ||
|
||
repeated.forEach(this::maybeRemoveImport); | ||
} | ||
return md; | ||
} | ||
}; | ||
} | ||
} |
146 changes: 146 additions & 0 deletions
146
...Boot_1_5/java/org/openrewrite/java/spring/NotRepeatSpringAnnotationsInSubclassesTest.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,146 @@ | ||
/* | ||
* 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.spring; | ||
|
||
import org.junit.jupiter.api.Disabled; | ||
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 static org.openrewrite.java.Assertions.java; | ||
|
||
class NotRepeatSpringAnnotationsInSubclassesTest implements RewriteTest { | ||
|
||
@Override | ||
public void defaults(RecipeSpec spec) { | ||
spec.recipe(new NotRepeatSpringAnnotationsInSubclasses()) | ||
.parser(JavaParser.fromJavaVersion().classpath("spring-beans", "spring-boot", | ||
"spring-context", "spring-core", "spring-web") | ||
.dependsOn( | ||
""" | ||
import org.springframework.web.bind.annotation.PathVariable; | ||
import org.springframework.web.bind.annotation.PostMapping; | ||
import org.springframework.web.bind.annotation.RequestBody; | ||
|
||
public interface UserApi { | ||
@PostMapping("/users/{id}") | ||
String updateUser( | ||
@PathVariable("id") Long id, | ||
@RequestBody UserData request | ||
); | ||
|
||
class UserData { | ||
private String firstName; | ||
private String lastName; | ||
|
||
public String getFirstName() { | ||
return firstName; | ||
} | ||
|
||
public void setFirstName(String firstName) { | ||
this.firstName = firstName; | ||
} | ||
|
||
public String getLastName() { | ||
return lastName; | ||
} | ||
|
||
public void setLastName(String lastName) { | ||
this.lastName = lastName; | ||
} | ||
} | ||
} | ||
""" | ||
)); | ||
} | ||
|
||
@Test | ||
@DocumentExample | ||
void removeMethodAnnotation() { | ||
//language=java | ||
rewriteRun( | ||
java( | ||
""" | ||
import org.springframework.web.bind.annotation.PostMapping; | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
public class UserController implements UserApi { | ||
|
||
@Override @PostMapping("/users/{id}") | ||
public String updateUser(Long id, UserData request) { | ||
return "User " + id + " updated: " + request.getFirstName() + " " + request.getLastName(); | ||
} | ||
} | ||
""", | ||
""" | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
public class UserController implements UserApi { | ||
|
||
@Override | ||
public String updateUser(Long id, UserData request) { | ||
return "User " + id + " updated: " + request.getFirstName() + " " + request.getLastName(); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
arodionov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
@Disabled | ||
void removeMethodArgumentsAnnotation() { | ||
//language=java | ||
rewriteRun( | ||
java( | ||
""" | ||
import org.springframework.web.bind.annotation.PathVariable; | ||
import org.springframework.web.bind.annotation.PostMapping; | ||
import org.springframework.web.bind.annotation.RequestBody; | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
public class UserController implements UserApi { | ||
|
||
@Override @PostMapping("/users/{id}") | ||
public String updateUser( | ||
@PathVariable("id") Long id, | ||
@RequestBody UserData request | ||
) { | ||
return "User " + id + " updated: " + request.getFirstName() + " " + request.getLastName(); | ||
} | ||
} | ||
""", | ||
""" | ||
import org.springframework.web.bind.annotation.RestController; | ||
|
||
@RestController | ||
public class UserController implements UserApi { | ||
|
||
@Override | ||
public String updateUser(Long id, UserData request) { | ||
return "User " + id + " updated: " + request.getFirstName() + " " + request.getLastName(); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
} |
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.