Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/*
* 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.migrate.guava;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.J;

import java.util.Set;

import static java.util.Collections.singleton;

public class NoGuavaSetsFilter extends Recipe {
private static final MethodMatcher SETS_FILTER = new MethodMatcher("com.google.common.collect.Sets filter(java.util.Set, com.google.common.base.Predicate)");
private static final MethodMatcher SETS_FILTER_SORTED_SET = new MethodMatcher("com.google.common.collect.Sets filter(java.util.SortedSet, com.google.common.base.Predicate)");

@Override
public String getDisplayName() {
return "Prefer `Collection.stream().filter(Predicate)`";
}

@Override
public String getDescription() {
return "Prefer `Collection.stream().filter(Predicate)` over `Sets.filter(Set, Predicate)`.";
}

@Override
public Set<String> getTags() {
return singleton("guava");
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
TreeVisitor<?, ExecutionContext> precondition = Preconditions.or(new UsesMethod<>(SETS_FILTER), new UsesMethod<>(SETS_FILTER_SORTED_SET));
return Preconditions.check(precondition, new JavaVisitor<ExecutionContext>() {
@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
if (SETS_FILTER_SORTED_SET.matches(method)) {
maybeRemoveImport("com.google.common.base.Predicate");
maybeRemoveImport("com.google.common.collect.Sets");
maybeAddImport("java.util.TreeSet");
maybeAddImport("java.util.function.Predicate");
maybeAddImport("java.util.stream.Collectors");

return JavaTemplate.builder("#{any(java.util.Collection)}.stream().filter(#{any(java.util.function.Predicate)}).collect(Collectors.toCollection(TreeSet::new))")
.imports("java.util.TreeSet")
.imports("java.util.stream.Collectors")
.build()
.apply(getCursor(),
method.getCoordinates().replace(),
method.getArguments().get(0),
method.getArguments().get(1));
}
if (SETS_FILTER.matches(method)) {
maybeRemoveImport("com.google.common.base.Predicate");
maybeRemoveImport("com.google.common.collect.Sets");
maybeAddImport("java.util.TreeSet");
maybeAddImport("java.util.function.Predicate");
maybeAddImport("java.util.stream.Collectors");

return JavaTemplate.builder("#{any(java.util.Collection)}.stream().filter(#{any(java.util.function.Predicate)}).collect(Collectors.toSet())")
.imports("java.util.stream.Collectors")
.build()
.apply(getCursor(),
method.getCoordinates().replace(),
method.getArguments().get(0),
method.getArguments().get(1));
}
return super.visitMethodInvocation(method, ctx);
}
}
);
}
}
1 change: 1 addition & 0 deletions src/main/resources/META-INF/rewrite/no-guava.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ recipeList:
- org.openrewrite.java.migrate.guava.NoGuavaPrimitiveAsList
- org.openrewrite.java.migrate.guava.NoGuavaRefasterRecipes
- org.openrewrite.java.migrate.guava.NoGuavaMapsNewHashMap
- org.openrewrite.java.migrate.guava.NoGuavaSetsFilter
- org.openrewrite.java.migrate.guava.NoGuavaSetsNewHashSet
- org.openrewrite.java.migrate.guava.NoGuavaSetsNewConcurrentHashSet
- org.openrewrite.java.migrate.guava.NoGuavaSetsNewLinkedHashSet
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
/*
* 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.migrate.guava;

import org.junit.jupiter.api.Test;
import org.junitpioneer.jupiter.ExpectedToFail;
import org.junitpioneer.jupiter.Issue;
import org.openrewrite.DocumentExample;
import org.openrewrite.InMemoryExecutionContext;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

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

class NoGuavaSetsFilterTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec
.recipe(new NoGuavaSetsFilter())
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "guava"));
}

@DocumentExample
@Test
void replaceSetsFilter() {
//language=java
rewriteRun(
java(
"""
import java.util.Set;

import com.google.common.base.Predicate;
import com.google.common.collect.Sets;

class Test {
public static Set<Object> test(Set<Object> set, Predicate<Object> isNotNull) {
return Sets.filter(set, isNotNull);
}
}
""",
"""
import java.util.Set;
import java.util.stream.Collectors;

import com.google.common.base.Predicate;

class Test {
public static Set<Object> test(Set<Object> set, Predicate<Object> isNotNull) {
return set.stream().filter(isNotNull).collect(Collectors.toSet());
}
}
"""
)
);
}

@Test
void replaceSetsFilterUsingSortedSet() {
//language=java
rewriteRun(
java(
"""
import java.util.Set;
import java.util.SortedSet;

import com.google.common.base.Predicate;
import com.google.common.collect.Sets;

class Test {
public static Set<Object> test(SortedSet<Object> set, Predicate<Object> isNotNull) {
return Sets.filter(set, isNotNull);
}
}
""",
"""
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.stream.Collectors;

import com.google.common.base.Predicate;

class Test {
public static Set<Object> test(SortedSet<Object> set, Predicate<Object> isNotNull) {
return set.stream().filter(isNotNull).collect(Collectors.toCollection(TreeSet::new));
}
}
"""
)
);
}

@ExpectedToFail("Sets.filter has special handling for sorted sets which now gets lost")
@Issue("https://github.com/openrewrite/rewrite-migrate-java/pull/898#discussion_r2461706208")
@Test
void replaceSetsFilterIndirectlyUsingSortedSet() {
//language=java
rewriteRun(
java(
"""
import java.util.Set;
import java.util.SortedSet;

import com.google.common.base.Predicate;
import com.google.common.collect.Sets;

class Test {
public static Set<Object> test(SortedSet<Object> set, Predicate<Object> isNotNull) {
Set<Object> indirectSet = set;
return Sets.filter(indirectSet, isNotNull);
Comment on lines +123 to +125
Copy link
Member

Choose a reason for hiding this comment

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

This case is tricky; we can't really deduce from the type system whether we'd end up in this conditional of special handling:
https://github.com/google/guava/blob/21cdcf6d9a49c1a498acb422471d8d71f9219865/guava/src/com/google/common/collect/Sets.java#L1190-L1194

Copy link
Member

Choose a reason for hiding this comment

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

I'd hope that to be rare enough to perhaps still merge the current work, but there is a risk here which could only be mitigated by data flow analysis to figure out if it might be a SortedSet going into this filter(Set, Predicate) method. 🤔

Copy link
Member

Choose a reason for hiding this comment

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

Either way thanks for the quick rework; would love to hear your thoughts on this edge case.

}
}
"""
// This now gets converted, but skips past a `instanceof SortedSet` check that keeps it a sorted set
)
);
}
}