Skip to content

feat: merge categories which have matching roots #5288

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

Closed
lkerford wants to merge 3 commits into from
Closed

feat: merge categories which have matching roots #5288

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e61aa2
feat: merge categories which have matching roots
lkerford Apr 11, 2025
5c876af
Merge branch 'main' into merge-matching-roots
pstreef May 6, 2025
62852e6
Rename `packageName` to `subPackageName` to avoid confusion
pstreef May 6, 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
2 changes: 2 additions & 0 deletions rewrite-core/src/main/java/org/openrewrite/config/CategoryDescriptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ public class CategoryDescriptor {
int priority;

boolean synthetic;

Set<String> rootPackages;
Copy link
Member

@jkschneider jkschneider Apr 11, 2025

Choose a reason for hiding this comment

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

Something looks suspicious about this to me. We shouldn't have both packageName and Set of rootPackages. Which of the set of rootPackages does packageName represent?

Copy link
Contributor Author

@lkerford lkerford Apr 11, 2025

Choose a reason for hiding this comment

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

packageName does not include the root so that we can merge the packages together
while the rootPackages contains all the know subset of roots.

For example org.openrewrite.path.to.subcategory has a packageName of path.to.subcategory and a rootPackages of listof(org.openrewrite)

Copy link
Contributor

@pstreef pstreef May 6, 2025

Choose a reason for hiding this comment

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

I guess we should rename packageName then, to avoid this confusion.

}
69 changes: 59 additions & 10 deletions rewrite-core/src/main/java/org/openrewrite/config/CategoryTree.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ private CategoryTree(G group, CategoryDescriptor descriptor) {
public static class Root<G> extends CategoryTree<G> {
private static final CategoryDescriptor ROOT_DESCRIPTOR = new CategoryDescriptor(
"ε", "", "", emptySet(), true,
CategoryDescriptor.LOWEST_PRECEDENCE, true);
CategoryDescriptor.LOWEST_PRECEDENCE, true, emptySet());

private Root() {
super();
Expand Down Expand Up @@ -96,9 +96,13 @@ public CategoryTree.Root<G> putRecipes(G group, RecipeDescriptor... recipes) {
}

public synchronized CategoryTree.Root<G> putCategories(G group, CategoryDescriptor... categories) {

synchronized (lock) {
List<String> rootGroups = Arrays.stream(categories).filter(CategoryDescriptor::isRoot)
.map(CategoryDescriptor::getPackageName)
.collect(toList());
for (CategoryDescriptor category : categories) {
findOrAddCategory(group, category);
findOrAddCategory(group, category, rootGroups);
}
}
return this;
Expand Down Expand Up @@ -249,9 +253,36 @@ public CategoryTree<G> getCategoryOrThrow(String... subcategories) {
return null;
}

CategoryTree<G> findOrAddCategory(G group, CategoryDescriptor category) {
CategoryTree<G> findOrAddCategory(G group, CategoryDescriptor category, List<String> rootGroups) {
String packageName = getDescriptor().getPackageName();
String categoryPackage = category.getPackageName();
Set<String> roots = new HashSet<>();
if (category.isRoot()) {
return this;
} else {
List<String> possibleRoots = rootGroups.stream()
.filter(categoryPackage::startsWith).collect(toList());
int elementCount = possibleRoots
.stream().map(s -> s.length() - s.replace(".", "").length())
.max(Comparator.comparingInt(s -> s)).orElse(0);

possibleRoots.stream().filter(s -> s.length() - s.replace(".", "").length() == elementCount)
.forEach(s -> roots.add(s));

if (!possibleRoots.isEmpty()) {
String rootPrefix = possibleRoots.get(0);
categoryPackage = categoryPackage.replace(rootPrefix, "");

if (categoryPackage.startsWith(".")) {
categoryPackage = categoryPackage.substring(1);
}
category = category.withPackageName(categoryPackage);

String finalCategoryPackage = categoryPackage;
subtrees.stream().filter(t -> finalCategoryPackage.startsWith(t.getDescriptor().getPackageName())).collect(toList())
.forEach(s -> roots.addAll(s.getDescriptor().getRootPackages()));
}
}

// same category with a potentially different descriptor coming from this group
if (categoryPackage.equals(packageName)) {
Expand Down Expand Up @@ -283,10 +314,17 @@ CategoryTree<G> findOrAddCategory(G group, CategoryDescriptor category) {
emptySet(),
false,
CategoryDescriptor.LOWEST_PRECEDENCE,
true
true,
roots
));
} else {
CategoryDescriptor groupCategoryDescriptor = subtree.descriptorsByGroup.get(group);
Set<String> knownRootPackages = groupCategoryDescriptor.getRootPackages();
knownRootPackages.addAll(roots);
groupCategoryDescriptor.withRootPackages(knownRootPackages);
subtree.descriptorsByGroup.put(group, groupCategoryDescriptor);
}
return subtree.findOrAddCategory(group, category);
return subtree.findOrAddCategory(group, category, rootGroups);
}
}

Expand All @@ -309,8 +347,9 @@ CategoryTree<G> findOrAddCategory(G group, CategoryDescriptor category) {
emptySet(),
false,
CategoryDescriptor.LOWEST_PRECEDENCE,
true
)).findOrAddCategory(group, category);
true,
roots
), rootGroups).findOrAddCategory(group, category, rootGroups);
}

// a direct subcategory of this category
Expand All @@ -335,15 +374,17 @@ void addRecipe(G group, RecipeDescriptor recipe) {
"a package, but it did not.");
}
String category = recipe.getName().substring(0, recipe.getName().lastIndexOf('.'));
List<String> rootPackageNames = this.getRootPackageNames();
CategoryTree<G> categoryTree = findOrAddCategory(group, new CategoryDescriptor(
StringUtils.capitalize(category.substring(category.lastIndexOf('.') + 1)),
category,
"",
emptySet(),
false,
CategoryDescriptor.LOWEST_PRECEDENCE,
true
));
true,
emptySet()
), rootPackageNames);
categoryTree.recipesByGroup.computeIfAbsent(group, g -> new CopyOnWriteArrayList<>()).add(recipe);
}

Expand Down Expand Up @@ -384,6 +425,13 @@ public Collection<CategoryTree<G>> getCategories() {
return getCategories(true, true);
}

public List<String> getRootPackageNames() {
return getCategories(false, false)
.stream().map(i -> i.getDescriptor().getRootPackages())
.flatMap(Set::stream)
.collect(toList());
}

/**
* Used to recursively navigate the whole category tree without
* any advance knowledge of what categories exist.
Expand Down Expand Up @@ -428,7 +476,8 @@ public CategoryDescriptor getDescriptor() {
emptySet(),
false,
CategoryDescriptor.LOWEST_PRECEDENCE,
true
true,
emptySet()
);
}

Expand Down
5 changes: 2 additions & 3 deletions rewrite-core/src/main/java/org/openrewrite/config/YamlResourceLoader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
import java.util.function.Consumer;
import java.util.stream.Stream;

import static java.util.Collections.emptyList;
import static java.util.Collections.emptyMap;
import static java.util.Collections.*;
import static java.util.stream.Collectors.toList;
import static org.openrewrite.RecipeSerializer.maybeAddKotlinModule;
import static org.openrewrite.Tree.randomId;
Expand Down Expand Up @@ -529,7 +528,7 @@ public Collection<CategoryDescriptor> listCategoryDescriptors() {
boolean root = c.containsKey("root") && (Boolean) c.get("root");
int priority = c.containsKey("priority") ? (Integer) c.get("priority") : CategoryDescriptor.DEFAULT_PRECEDENCE;

return new CategoryDescriptor(name, packageName, description, tags, root, priority, false);
return new CategoryDescriptor(name, packageName, description, tags, root, priority, false, emptySet());
})
.collect(toList());
}
Expand Down
39 changes: 28 additions & 11 deletions rewrite-core/src/test/java/org/openrewrite/config/CategoryTreeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import java.net.URI;
import java.util.Collection;
import java.util.List;
import java.util.Properties;

import static java.util.Collections.emptyList;
Expand Down Expand Up @@ -123,16 +124,6 @@ void removeCategory() {
.doesNotContain("io.moderne.rewrite", "io.moderne.cloud", "io.moderne");
}

@Test
void categoryRoots() {
CategoryTree.Root<Group> ct = categoryTree();
assertThat(ct.getCategories().stream().map(sub -> sub.getDescriptor().getPackageName()))
.contains(
"io.moderne.rewrite", "io.moderne.cloud", // because "io.moderne" is marked as a root
"org.openrewrite" // because "org" is marked as a root
);
}

@Test
void getCategory() {
CategoryTree.Root<Group> ct = categoryTree();
Expand Down Expand Up @@ -171,10 +162,36 @@ void getRecipeGroup() {
.isEqualTo(Group1);
}

@Test
void mergeRootCategory() {
CategoryTree.Root<Integer> categoryTree = CategoryTree.build();
categoryTree
.putCategories(2, categoryRootDescriptor("io.moderne"), categoryRootDescriptor("org.openrewrite"), categoryDescriptor("org.openrewrite.java.test"), categoryDescriptor("io.moderne.java.test"))
.putRecipes(2, recipeDescriptor("org.openrewrite.java.test"), recipeDescriptor("io.moderne.java.test"));


assertThat(categoryTree.getCategory("java.test")).isNotNull();
assertThat(categoryTree.getCategory("org.openrewrite")).isNull();
assertThat(categoryTree.getCategory("org")).isNull();
assertThat(categoryTree.getCategory("io.moderne")).isNull();
assertThat(categoryTree.getCategory("io")).isNull();

assertThat(categoryTree.getCategory("java.test").getRecipes()).containsAll(List.of(
recipeDescriptor("org.openrewrite.java.test"),
recipeDescriptor("io.moderne.java.test")
));
}

private static CategoryDescriptor categoryDescriptor(String packageName) {
return new CategoryDescriptor(StringUtils.capitalize(packageName.substring(packageName.lastIndexOf('.') + 1)),
packageName, "", emptySet(),
false, CategoryDescriptor.DEFAULT_PRECEDENCE, false);
false, CategoryDescriptor.DEFAULT_PRECEDENCE, false, emptySet());
}

private static CategoryDescriptor categoryRootDescriptor(String packageName) {
return new CategoryDescriptor(StringUtils.capitalize(packageName.substring(packageName.lastIndexOf('.') + 1)),
packageName, "", emptySet(),
true, CategoryDescriptor.DEFAULT_PRECEDENCE, false, emptySet());
}

enum Group {
Expand Down
Loading