From eb1914e85f61b270ddd513dcf447357aad30123c Mon Sep 17 00:00:00 2001 From: Vincent Potucek Date: Thu, 15 May 2025 20:16:04 +0200 Subject: [PATCH 1/5] ReplaceCollectToListWithToList --- .../ReplaceCollectToListWithToList.java | 92 ++++++++++++++++ .../ReplaceCollectToListWithToListTest.java | 104 ++++++++++++++++++ 2 files changed, 196 insertions(+) create mode 100644 src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java create mode 100644 src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java diff --git a/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java new file mode 100644 index 000000000..1a6107f0e --- /dev/null +++ b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java @@ -0,0 +1,92 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * 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 + *

+ * https://docs.moderne.io/licensing/moderne-source-available-license + *

+ * 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.staticanalysis; + +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.UsesJavaVersion; +import org.openrewrite.java.search.UsesMethod; +import org.openrewrite.java.tree.J; + +import java.time.Duration; + +/** + * Replaces Stream.collect(Collectors.toList()) with Stream.toList() + *

+ * [POC] rewrite-maven-plugin: Introduce OpenRewrite by Moderne + * Modernize codebase with Java improvements + * suppression request + * + */ +public class ReplaceCollectToListWithToList extends Recipe { + + private static final MethodMatcher COLLECT_TO_LIST = new MethodMatcher("java.util.stream.Stream collect(java.util.stream.Collector)"); + + @Override + public String getDisplayName() { + return "Replace stream.collect(collectors.toList()) with stream.toList()"; + } + + @Override + public String getDescription() { + return "Replace Java 11 `Stream.collect(Collectors.toList())` with Java 16+ `Stream.toList()` for more concise syntax."; + } + + @Override + public Duration getEstimatedEffortPerOccurrence() { + return Duration.ofMinutes(1); + } + + @Override + public TreeVisitor getVisitor() { + return Preconditions.check(Preconditions.and( + new UsesJavaVersion<>(16), + new UsesMethod<>(COLLECT_TO_LIST)), + new JavaVisitor() { + + private final JavaTemplate template = JavaTemplate + .builder("#{any(java.util.stream.Stream)}.toList()") + .build(); + + @Override + public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) { + J.MethodInvocation m = (J.MethodInvocation) super.visitMethodInvocation(method, ctx); + + if (COLLECT_TO_LIST.matches(m) && isCollectorsToList(m)) { + maybeRemoveImport("java.util.stream.Collectors"); + return template.apply( + updateCursor(m), + m.getCoordinates().replace(), + m.getSelect() + ); + } + return m; + } + + private boolean isCollectorsToList(J.MethodInvocation method) { + return method.getArguments().get(0) instanceof J.MethodInvocation && + ((J.MethodInvocation) method.getArguments().get(0)).getSimpleName().equals("toList") && + ((J.MethodInvocation) method.getArguments().get(0)).getSelect() != null && + ((J.MethodInvocation) method.getArguments().get(0)).getSelect().toString().equals("Collectors"); + } + }); + } +} diff --git a/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java new file mode 100644 index 000000000..77e50e998 --- /dev/null +++ b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java @@ -0,0 +1,104 @@ +/* + * Copyright 2024 the original author or authors. + *

+ * 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 + *

+ * https://docs.moderne.io/licensing/moderne-source-available-license + *

+ * 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.staticanalysis; + +import org.junit.jupiter.api.Test; +import org.openrewrite.test.RecipeSpec; +import org.openrewrite.test.RewriteTest; + +import static org.openrewrite.java.Assertions.java; +import static org.openrewrite.java.Assertions.version; + +class InvertReplaceCollectToListWithToListTest implements RewriteTest { + + @Override + public void defaults(RecipeSpec spec) { + spec.recipe(new ReplaceCollectToListWithToList()); + } + + @Test + void replacesCollectToList() { + rewriteRun( + version( + //language=java + java( + """ + package com.example; + + import java.util.stream.Collectors; + import java.util.stream.Stream; + + class Example { + public void test() { + Stream.of().collect(Collectors.toList()); + } + } + """, + """ + package com.example; + + import java.util.stream.Stream; + + class Example { + public void test() { + Stream.of().toList(); + } + } + """), + 17)); + } + + @Test + void replacesCollectToListKeepImport() { + rewriteRun( + version( + //language=java + java( + """ + package com.example; + + import java.util.List; + import java.util.stream.Collector; + import java.util.stream.Collectors; + import java.util.stream.Stream; + + class Example { + public void test() { + Collector> list = Collectors.toList(); + Stream.of().collect(list); + Stream.of().collect(Collectors.toList()); + } + } + """, + """ + package com.example; + + import java.util.List; + import java.util.stream.Collector; + import java.util.stream.Collectors; + import java.util.stream.Stream; + + class Example { + public void test() { + Collector> list = Collectors.toList(); + Stream.of().collect(list); + Stream.of().toList(); + } + } + """), + 17)); + } +} From 583c16ea5b8f96c8fa6ad1bb1fd733c9c981fcc3 Mon Sep 17 00:00:00 2001 From: Pankraz76 <8830888+Pankraz76@users.noreply.github.com> Date: Sat, 17 May 2025 00:23:17 +0200 Subject: [PATCH 2/5] Update src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java Co-authored-by: Tim te Beek --- .../staticanalysis/ReplaceCollectToListWithToList.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java index 1a6107f0e..b8125c060 100644 --- a/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java +++ b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java @@ -42,12 +42,12 @@ public class ReplaceCollectToListWithToList extends Recipe { @Override public String getDisplayName() { - return "Replace stream.collect(collectors.toList()) with stream.toList()"; + return "Replace `Stream.collect(collectors.toList())` with `Stream.toList()`"; } @Override public String getDescription() { - return "Replace Java 11 `Stream.collect(Collectors.toList())` with Java 16+ `Stream.toList()` for more concise syntax."; + return "Replace Java 11 `Stream.collect(Collectors.toList())` with Java 16+ `Stream.toList()` for more concise syntax and an unmodifiable return value."; } @Override From 2f82622cddf7d7ff96e67b81553dcac4cf7bdf0a Mon Sep 17 00:00:00 2001 From: Pankraz76 <8830888+Pankraz76@users.noreply.github.com> Date: Sat, 17 May 2025 00:24:28 +0200 Subject: [PATCH 3/5] Update src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java Co-authored-by: Tim te Beek --- .../staticanalysis/ReplaceCollectToListWithToList.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java index b8125c060..de3db13c3 100644 --- a/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java +++ b/src/main/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToList.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 the original author or authors. + * Copyright 2025 the original author or authors. *

* Licensed under the Moderne Source Available License (the "License"); * you may not use this file except in compliance with the License. From 1abde3036b2333368de55bc2e6c0b7b1e6841be4 Mon Sep 17 00:00:00 2001 From: Pankraz76 <8830888+Pankraz76@users.noreply.github.com> Date: Sat, 17 May 2025 00:24:36 +0200 Subject: [PATCH 4/5] Update src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java Co-authored-by: Tim te Beek --- .../staticanalysis/ReplaceCollectToListWithToListTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java index 77e50e998..63de05cd7 100644 --- a/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java +++ b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java @@ -1,5 +1,5 @@ /* - * Copyright 2024 the original author or authors. + * Copyright 2025 the original author or authors. *

* Licensed under the Moderne Source Available License (the "License"); * you may not use this file except in compliance with the License. From 05721f1f3a4ec7e25acfd8abc30fb7155357c5ec Mon Sep 17 00:00:00 2001 From: Pankraz76 <8830888+Pankraz76@users.noreply.github.com> Date: Sat, 17 May 2025 00:24:56 +0200 Subject: [PATCH 5/5] Update src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java Co-authored-by: Tim te Beek --- .../staticanalysis/ReplaceCollectToListWithToListTest.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java index 63de05cd7..5c4551e14 100644 --- a/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java +++ b/src/test/java/org/openrewrite/staticanalysis/ReplaceCollectToListWithToListTest.java @@ -29,6 +29,7 @@ public void defaults(RecipeSpec spec) { spec.recipe(new ReplaceCollectToListWithToList()); } + @DocumentExample @Test void replacesCollectToList() { rewriteRun(