Skip to content

Commit b93d869

Browse files
timtebeekTeamModerne
timtebeek
and
TeamModerne
authored
Update recipe documentation examples (#747)
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 7165caf commit b93d869

File tree

8 files changed

+263
-249
lines changed

8 files changed

+263
-249
lines changed

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

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

‎src/test/java/org/openrewrite/staticanalysis/CombineSemanticallyEqualCatchBlocksTest.java‎

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

1818
import org.junit.jupiter.api.Test;
1919
import org.junitpioneer.jupiter.ExpectedToFail;
20+
import org.openrewrite.DocumentExample;
2021
import org.openrewrite.Issue;
2122
import org.openrewrite.test.RecipeSpec;
2223
import org.openrewrite.test.RewriteTest;
@@ -31,8 +32,9 @@ public void defaults(RecipeSpec spec) {
3132
spec.recipe(new CombineSemanticallyEqualCatchBlocks());
3233
}
3334

35+
@DocumentExample
3436
@Test
35-
void doNotCombineDifferentCatchBlocks() {
37+
void blocksContainSameComments() {
3638
rewriteRun(
3739
//language=java
3840
java("class A extends RuntimeException {}"),
@@ -45,9 +47,19 @@ class Test {
4547
void method() {
4648
try {
4749
} catch (A ex) {
48-
String s = "foo";
50+
// Same
4951
} catch (B ex) {
50-
String s = "bar";
52+
// Same
53+
}
54+
}
55+
}
56+
""",
57+
"""
58+
class Test {
59+
void method() {
60+
try {
61+
} catch (A | B ex) {
62+
// Same
5163
}
5264
}
5365
}
@@ -57,24 +69,22 @@ void method() {
5769
}
5870

5971
@Test
60-
void childClassIsCaughtBeforeParentClass() {
72+
void doNotCombineDifferentCatchBlocks() {
6173
rewriteRun(
6274
//language=java
6375
java("class A extends RuntimeException {}"),
6476
//language=java
65-
java("class B extends BaseException {}"),
66-
//language=java
67-
java("class BaseException extends RuntimeException {}"),
77+
java("class B extends RuntimeException {}"),
6878
//language=java
6979
java(
7080
"""
7181
class Test {
7282
void method() {
7383
try {
7484
} catch (A ex) {
75-
} catch (B ex) { // Is subtype of BaseException with a unique block.
76-
String diff;
77-
} catch (BaseException ex) {
85+
String s = "foo";
86+
} catch (B ex) {
87+
String s = "bar";
7888
}
7989
}
8090
}
@@ -84,22 +94,24 @@ void method() {
8494
}
8595

8696
@Test
87-
void blocksContainDifferentComments() {
97+
void childClassIsCaughtBeforeParentClass() {
8898
rewriteRun(
8999
//language=java
90100
java("class A extends RuntimeException {}"),
91101
//language=java
92-
java("class B extends RuntimeException {}"),
102+
java("class B extends BaseException {}"),
103+
//language=java
104+
java("class BaseException extends RuntimeException {}"),
93105
//language=java
94106
java(
95107
"""
96108
class Test {
97109
void method() {
98110
try {
99111
} catch (A ex) {
100-
// Comment 1
101-
} catch (B ex) {
102-
// Comment 2
112+
} catch (B ex) { // Is subtype of BaseException with a unique block.
113+
String diff;
114+
} catch (BaseException ex) {
103115
}
104116
}
105117
}
@@ -109,7 +121,7 @@ void method() {
109121
}
110122

111123
@Test
112-
void blocksContainSameComments() {
124+
void blocksContainDifferentComments() {
113125
rewriteRun(
114126
//language=java
115127
java("class A extends RuntimeException {}"),
@@ -122,19 +134,9 @@ class Test {
122134
void method() {
123135
try {
124136
} catch (A ex) {
125-
// Same
137+
// Comment 1
126138
} catch (B ex) {
127-
// Same
128-
}
129-
}
130-
}
131-
""",
132-
"""
133-
class Test {
134-
void method() {
135-
try {
136-
} catch (A | B ex) {
137-
// Same
139+
// Comment 2
138140
}
139141
}
140142
}

‎src/test/java/org/openrewrite/staticanalysis/CompareEnumsWithEqualityOperatorTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.staticanalysis;
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;
@@ -39,6 +40,7 @@ public enum A {
3940
"""
4041
);
4142

43+
@DocumentExample
4244
@SuppressWarnings("StatementWithEmptyBody")
4345
@Test
4446
void changeEnumEquals() {

‎src/test/java/org/openrewrite/staticanalysis/MethodNameCasingTest.java‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package org.openrewrite.staticanalysis;
1717

1818
import org.junit.jupiter.api.Test;
19+
import org.openrewrite.DocumentExample;
1920
import org.openrewrite.ExecutionContext;
2021
import org.openrewrite.Issue;
2122
import org.openrewrite.java.JavaIsoVisitor;
@@ -35,6 +36,30 @@ public void defaults(RecipeSpec spec) {
3536
spec.recipe(new MethodNameCasing(false, false));
3637
}
3738

39+
@DocumentExample
40+
@Test
41+
void changeMethodDeclaration() {
42+
rewriteRun(
43+
srcMainJava(
44+
//language=java
45+
java(
46+
"""
47+
class Test {
48+
void MyMethod_with_über() {
49+
}
50+
}
51+
""",
52+
"""
53+
class Test {
54+
void myMethodWithUber() {
55+
}
56+
}
57+
"""
58+
)
59+
)
60+
);
61+
}
62+
3863
@Issue("https://github.com/openrewrite/rewrite/issues/2571")
3964
@Test
4065
void noChangesOnMethodsBeginningWithUnderscore() {
@@ -204,29 +229,6 @@ void myMethodWithUber() {
204229
);
205230
}
206231

207-
@Test
208-
void changeMethodDeclaration() {
209-
rewriteRun(
210-
srcMainJava(
211-
//language=java
212-
java(
213-
"""
214-
class Test {
215-
void MyMethod_with_über() {
216-
}
217-
}
218-
""",
219-
"""
220-
class Test {
221-
void myMethodWithUber() {
222-
}
223-
}
224-
"""
225-
)
226-
)
227-
);
228-
}
229-
230232
@Test
231233
void changeCamelCaseMethodWithFirstLetterUpperCase() {
232234
rewriteRun(

‎src/test/java/org/openrewrite/staticanalysis/RemoveInstanceOfPatternMatchTest.java‎

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

1818
import org.junit.jupiter.api.Disabled;
1919
import org.junit.jupiter.api.Test;
20+
import org.openrewrite.DocumentExample;
2021
import org.openrewrite.test.RecipeSpec;
2122
import org.openrewrite.test.RewriteTest;
2223

@@ -30,6 +31,7 @@ public void defaults(RecipeSpec spec) {
3031
spec.recipe(new RemoveInstanceOfPatternMatch());
3132
}
3233

34+
@DocumentExample
3335
@Test
3436
void blockOfStatements() {
3537
rewriteRun(

‎src/test/java/org/openrewrite/staticanalysis/ReplaceDeprecatedRuntimeExecMethodsTest.java‎

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

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

@@ -28,6 +29,7 @@ public void defaults(RecipeSpec spec) {
2829
spec.recipe(new ReplaceDeprecatedRuntimeExecMethods());
2930
}
3031

32+
@DocumentExample
3133
@Test
3234
void rawString() {
3335
rewriteRun(

‎src/test/java/org/openrewrite/staticanalysis/UseAsBuilderTest.java‎

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

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

@@ -27,6 +28,7 @@ public void defaults(RecipeSpec spec) {
2728
spec.recipe(new UseAsBuilder("Buildable.Builder", true, "Buildable builder()"));
2829
}
2930

31+
@DocumentExample
3032
@Test
3133
void useAsBuilder() {
3234
rewriteRun(

‎src/test/java/org/openrewrite/staticanalysis/kotlin/ReplaceLambdaWithMethodReferenceTest.java‎

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

1818
import org.junit.jupiter.api.Test;
1919
import org.junitpioneer.jupiter.ExpectedToFail;
20+
import org.openrewrite.DocumentExample;
2021
import org.openrewrite.staticanalysis.ReplaceLambdaWithMethodReference;
2122
import org.openrewrite.test.RecipeSpec;
2223
import org.openrewrite.test.RewriteTest;
@@ -29,6 +30,7 @@ public void defaults(RecipeSpec spec) {
2930
spec.recipe(new ReplaceLambdaWithMethodReference());
3031
}
3132

33+
@DocumentExample
3234
@ExpectedToFail("Kotlin visitor to be implemented")
3335
@Test
3436
void toQualifiedMethodReference() {

0 commit comments

Comments
 (0)