-
Notifications
You must be signed in to change notification settings - Fork 434
Recipe to find maven modules that have no parent #5639
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
JohannisK
wants to merge
6
commits into
main
Choose a base branch
from
recipe_to_find_modules_that_have_no_parent
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
6 commits
S
8000
elect commit
Hold shift + click to select a range
1e4d42e
Added a recipe to find modules that have no parent
JohannisK fe211c9
Added test
JohannisK c162e25
imports and formatting
JohannisK 3612d49
Add license
JohannisK 3aec288
Let UpdateMavenWrapperTest use version 3.8.9 (#5641)
jevanlingen 35a851c
Merge branch 'main' into recipe_to_find_modules_that_have_no_parent
JohannisK 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
97 changes: 97 additions & 0 deletions
97
rewrite-maven/src/main/java/org/openrewrite/maven/search/ModuleHasNoParent.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,97 @@ | ||
/* | ||
* Copyright 2025 the original author or authors. | ||
* <p> | ||
* 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 | ||
* <p> | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* <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.maven.search; | ||
|
||
import lombok.EqualsAndHashCode; | ||
import lombok.Value; | ||
import org.jspecify.annotations.Nullable; | ||
import org.openrewrite.ExecutionContext; | ||
import org.openrewrite.ScanningRecipe; | ||
import org.openrewrite.Tree; | ||
import org.openrewrite.TreeVisitor; | ||
import org.openrewrite.java.marker.JavaProject; | ||
import org.openrewrite.marker.SearchResult; | ||
|
||
import java.util.HashSet; | ||
import java.util.Optional; | ||
import java.util.Set; | ||
|
||
@Value | ||
@EqualsAndHashCode(callSuper = false) | ||
public class ModuleHasNoParent extends ScanningRecipe<ModuleHasNoParent.Accumulator> { | ||
|
||
@Override | ||
public String getDisplayName() { | ||
return "Module has no parent"; | ||
} | ||
|
||
@Override | ||
public String getDescription() { | ||
return "Searches for Maven modules that have no parent. " + | ||
"Places a `SearchResult` marker on all sources within a module that has no parent. " + | ||
"This recipe is intended to be used as a precondition for other recipes. " + | ||
"For example: " + | ||
"this could be used to limit the application of recipes that add a parent to projects that currently don't have one."; | ||
} | ||
|
||
@Value | ||
public static class Accumulator { | ||
Set<JavaProject> projectsWithParent; | ||
} | ||
|
||
@Override | ||
public Accumulator getInitialValue(ExecutionContext ctx) { | ||
return new Accumulator(new HashSet<>()); | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getScanner(Accumulator acc) { | ||
return new TreeVisitor<Tree, ExecutionContext>() { | ||
@Override | ||
public Tree visit(@Nullable Tree tree, ExecutionContext ctx) { | ||
assert tree != null; | ||
tree.getMarkers() | ||
.findFirst(JavaProject.class) | ||
8000 | .ifPresent(jp -> { | |
Tree t = new ParentPomInsight("*", "*", null, false).getVisitor().visit(tree, ctx); | ||
if (t != tree) { | ||
acc.getProjectsWithParent().add(jp); | ||
} | ||
}); | ||
return tree; | ||
} | ||
}; | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getVisitor(Accumulator acc) { | ||
return new TreeVisitor<Tree, ExecutionContext>() { | ||
@Override | ||
public Tree visit(@Nullable Tree tree, ExecutionContext ctx) { | ||
assert tree != null; | ||
Optional<JavaProject> maybeJp = tree.getMarkers().findFirst(JavaProject.class); | ||
if (!maybeJp.isPresent()) { | ||
return tree; | ||
} | ||
JavaProject jp = maybeJp.get(); | ||
if (!acc.getProjectsWithParent().contains(jp)) { | ||
return SearchResult.found(tree, "Module has no parent."); | ||
} | ||
return tree; | ||
} | ||
}; | ||
} | ||
} |
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
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.
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.
What is the reasoning for this recipe being a scanning recipe?
I don't see why you couldn't just call
parentPomInsight
here and save the scanning cycle of the recipe :)