Skip to content

Commit ce2a30e

Browse files
timtebeekTeamModerne
timtebeek
and
TeamModerne
committed
Update recipe documentation examples
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices?organizationId=ODQ2MGExMTUtNDg0My00N2EwLTgzMGMtNGE1NGExMTBmZDkw Co-authored-by: Moderne <[email protected]>
1 parent 640ac12 commit ce2a30e

16 files changed

+309
-267
lines changed

‎src/main/resources/META-INF/rewrite/examples.yml‎

Lines changed: 210 additions & 198 deletions
Large diffs are not rendered by default.

‎src/test/java/org/openrewrite/java/migrate/DontOverfetchDtoTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@
1616
package org.openrewrite.java.migrate;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.test.RewriteTest;
2021
import org.openrewrite.test.TypeValidation;
2122

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

2425
class DontOverfetchDtoTest implements RewriteTest {
2526

27+
@DocumentExample
2628
@SuppressWarnings("LombokGetterMayBeUsed")
2729
@Test
2830
void findDtoOverfetching() {

‎src/test/java/org/openrewrite/java/migrate/guava/NoGuavaImmutableListOfTest.java‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.guava;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.InMemoryExecutionContext;
2021
import org.openrewrite.Issue;
2122
import org.openrewrite.java.JavaParser;
@@ -33,6 +34,34 @@ public void defaults(RecipeSpec spec) {
3334
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "guava"));
3435
}
3536

37+
@DocumentExample
38+
@Test
39+
void replaceArguments() {
40+
rewriteRun(
41+
version(
42+
//language=java
43+
java(
44+
"""
45+
import java.util.List;
46+
import com.google.common.collect.ImmutableList;
47+
48+
class Test {
49+
List<String> m = ImmutableList.of("A", "B", "C", "D");
50+
}
51+
""",
52+
"""
53+
import java.util.List;
54+
55+
class Test {
56+
List<String> m = List.of("A", "B", "C", "D");
57+
}
58+
"""
59+
),
60+
9
61+
)
62+
);
63+
}
64+
3665
@Test
3766
void doNotChangeReturnsImmutableList() {
3867
rewriteRun(
@@ -166,33 +195,6 @@ void method() {
166195
);
167196
}
168197

169-
@Test
170-
void replaceArguments() {
171-
rewriteRun(
172-
version(
173-
//language=java
174-
java(
175-
"""
176-
import java.util.List;
177-
import com.google.common.collect.ImmutableList;
178-
179-
class Test {
180-
List<String> m = ImmutableList.of("A", "B", "C", "D");
181-
}
182-
""",
183-
"""
184-
import java.util.List;
185-
186-
class Test {
187-
List<String> m = List.of("A", "B", "C", "D");
188-
}
189-
"""
190-
),
191-
9
192-
)
193-
);
194-
}
195-
196198
@Test
197199
void fieldAssignmentToList() {
198200
rewriteRun(

‎src/test/java/org/openrewrite/java/migrate/guava/NoGuavaImmutableMapOfTest.java‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import org.junit.jupiter.api.Nested;
1919
import org.junit.jupiter.api.Test;
20+
import org.openrewrite.DocumentExample;
2021
import org.openrewrite.InMemoryExecutionContext;
2122
import org.openrewrite.Issue;
2223
import org.openrewrite.java.JavaParser;
@@ -34,6 +35,34 @@ public void defaults(RecipeSpec spec) {
3435
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "guava"));
3536
}
3637

38+
@DocumentExample
39+
@Test
40+
void replaceArguments() {
41+
//language=java
42+
rewriteRun(
43+
version(
44+
java(
45+
"""
46+
import java.util.Map;
47+
import com.google.common.collect.ImmutableMap;
48+
49+
class Test {
50+
Map<String, String> m = ImmutableMap.of("A", "B", "C", "D");
51+
}
52+
""",
53+
"""
54+
import java.util.Map;
55+
56+
class Test {
57+
Map<String, String> m = Map.of("A", "B", "C", "D");
58+
}
59+
"""
60+
),
61+
9
62+
)
63+
);
64+
}
65+
3766
@Test
3867
void doNotChangeReturnsImmutableMap() {
3968
//language=java
@@ -151,33 +180,6 @@ void method() {
151180
);
152181
}
153182

154-
@Test
155-
void replaceArguments() {
156-
//language=java
157-
rewriteRun(
158-
version(
159-
java(
160-
"""
161-
import java.util.Map;
162-
import com.google.common.collect.ImmutableMap;
163-
164-
class Test {
165-
Map<String, String> m = ImmutableMap.of("A", "B", "C", "D");
166-
}
167-
""",
168-
"""
169-
import java.util.Map;
170-
171-
class Test {
172-
Map<String, String> m = Map.of("A", "B", "C", "D");
173-
}
174-
"""
175-
),
176-
9
177-
)
178-
);
179-
}
180-
181183
@Test
182184
void fieldAssignmentToMap() {
183185
//language=java

‎src/test/java/org/openrewrite/java/migrate/guava/NoGuavaJava21Test.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.guava;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.InMemoryExecutionContext;
2021
import org.openrewrite.Issue;
2122
import org.openrewrite.java.JavaParser;
@@ -32,6 +33,7 @@ public void defaults(RecipeSpec spec) {
3233
.parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(), "guava"));
3334
}
3435

36+
@DocumentExample
3537
@Test
3638
void preferMathClampForDouble() {
3739
//language=java

‎src/test/java/org/openrewrite/java/migrate/jakarta/JavaxMailToJakartaMailTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.jakarta;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.java.JavaParser;
2021
import org.openrewrite.test.RecipeSpec;
2122
import org.openrewrite.test.RewriteTest;
@@ -34,6 +35,7 @@ public void defaults(RecipeSpec spec) {
3435
"org.openrewrite.java.migrate.jakarta.JavaxMailToJakartaMail");
3536
}
3637

38+
@DocumentExample
3739
@Test
3840
void switchesJavaxMailApiDependencyToJakartaMailApiDependency() {
3941
rewriteRun(

‎src/test/java/org/openrewrite/java/migrate/jakarta/JavaxServletToJakartaServletTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.jakarta;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.InMemoryExecutionContext;
2021
import org.openrewrite.java.JavaParser;
2122
import org.openrewrite.test.RecipeSpec;
@@ -35,6 +36,7 @@ public void defaults(RecipeSpec spec) {
3536
"org.openrewrite.java.migrate.jakarta.JavaxServletToJakartaServlet");
3637
}
3738

39+
@DocumentExample
3840
@Test
3941
void switchesJavaxServletApiDependencyToJakartaServletApiDependency() {
4042
rewriteRun(

‎src/test/java/org/openrewrite/java/migrate/jakarta/JavaxWsToJakartaWsTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.jakarta;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.java.JavaParser;
2021
import org.openrewrite.test.RecipeSpec;
2122
import org.openrewrite.test.RewriteTest;
@@ -33,6 +34,7 @@ public void defaults(RecipeSpec spec) {
3334
"org.openrewrite.java.migrate.jakarta.JavaxWsToJakartaWs");
3435
}
3536

37+
@DocumentExample
3638
@Test
3739
void switchesJavaxWsApiDependencyToJakartaWsApiDependency() {
3840
rewriteRun(

‎src/test/java/org/openrewrite/java/migrate/javax/AddCommonAnnotationsDependenciesTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.javax;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.java.JavaParser;
2021
import org.openrewrite.test.RecipeSpec;
2122
import org.openrewrite.test.RewriteTest;
@@ -33,6 +34,7 @@ public void defaults(RecipeSpec spec) {
3334
.allSources(src -> src.markers(javaVersion(8)));
3435
}
3536

37+
@DocumentExample
3638
@Test
3739
void addDependencyIfAnnotationJsr250Present() {
3840
rewriteRun(

‎src/test/java/org/openrewrite/java/migrate/lang/StringFormattedTest.java‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.java.migrate.lang;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.Issue;
2021
import org.openrewrite.test.RecipeSpec;
2122
import org.openrewrite.test.RewriteTest;
@@ -30,29 +31,25 @@ public void defaults(RecipeSpec spec) {
3031
spec.recipe(new StringFormatted(null));
3132
}
3233

33-
@Issue("https://github.com/openrewrite/rewrite/issues/2163")
34+
@DocumentExample
3435
@Test
35-
void textBlock() {
36+
void concatenatedText() {
3637
//language=java
3738
rewriteRun(
3839
version(
3940
java(
4041
"""
4142
package com.example.app;
4243
class A {
43-
String str = String.format(\"""
44-
foo
45-
%s
46-
\""", "a");
44+
String str = String.format("foo"
45+
+ "%s", "a");
4746
}
4847
""",
4948
"""
5049
package com.example.app;
5150
class A {
52-
String str = \"""
53-
foo
54-
%s
55-
\""".formatted("a");
51+
String str = ("foo"
52+
+ "%s").formatted("a");
5653
}
5754
"""
5855
),
@@ -61,24 +58,29 @@ class A {
6158
);
6259
}
6360

61+
@Issue("https://github.com/openrewrite/rewrite/issues/2163")
6462
@Test
65-
void concatenatedText() {
63+
void textBlock() {
6664
//language=java
6765
rewriteRun(
6866
version(
6967
java(
7068
"""
7169
package com.example.app;
7270
class A {
73-
String str = String.format("foo"
74-
+ "%s", "a");
71+
String str = String.format(\"""
72+
foo
73+
%s
74+
\""", "a");
7575
}
7676
""",
7777
"""
7878
package com.example.app;
7979
class A {
80-
String str = ("foo"
81-
+ "%s").formatted("a");
80+
String str = \"""
81+
foo
82+
%s
83+
\""".formatted("a");
8284
}
8385
"""
8486
),

0 commit comments

Comments
 (0)