Skip to content

Commit 55f801a

Browse files
timtebeekTeamModerne
timtebeek
and
TeamModerne
committed
OpenRewrite recipe best practices
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices?organizationId=QUxML01vZGVybmUvTW9kZXJuZSArIE9wZW5SZXdyaXRl Co-authored-by: Moderne <[email protected]>
1 parent 96d6dd9 commit 55f801a

11 files changed

Lines changed: 111 additions & 76 deletions

‎src/main/java/org/openrewrite/java/migrate/util/MigrateCollectionsEmptyList.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
package org.openrewrite.java.migrate.util;
1717

1818
import lombok.Getter;
19-
import org.openrewrite.*;
19+
import org.openrewrite.ExecutionContext;
20+
import org.openrewrite.Preconditions;
21+
import org.openrewrite.Recipe;
22+
import org.openrewrite.TreeVisitor;
2023
import org.openrewrite.java.JavaIsoVisitor;
2124
import org.openrewrite.java.JavaTemplate;
2225
import org.openrewrite.java.MethodMatcher;

‎src/main/java/org/openrewrite/java/migrate/util/MigrateCollectionsEmptyMap.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
package org.openrewrite.java.migrate.util;
1717

1818
import lombok.Getter;
19-
import org.openrewrite.*;
19+
import org.openrewrite.ExecutionContext;
20+
import org.openrewrite.Preconditions;
21+
import org.openrewrite.Recipe;
22+
import org.openrewrite.TreeVisitor;
2023
import org.openrewrite.java.JavaIsoVisitor;
2124
import org.openrewrite.java.JavaTemplate;
2225
import org.openrewrite.java.MethodMatcher;

‎src/main/java/org/openrewrite/java/migrate/util/MigrateCollectionsEmptySet.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
package org.openrewrite.java.migrate.util;
1717

1818
import lombok.Getter;
19-
import org.openrewrite.*;
19+
import org.openrewrite.ExecutionContext;
20+
import org.openrewrite.Preconditions;
21+
import org.openrewrite.Recipe;
22+
import org.openrewrite.TreeVisitor;
2023
import org.openrewrite.java.JavaIsoVisitor;
2124
import org.openrewrite.java.JavaTemplate;
2225
import org.openrewrite.java.MethodMatcher;

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

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1336,6 +1336,44 @@ examples:
13361336
type: specs.openrewrite.org/v1beta/example
13371337
recipeName: org.openrewrite.java.migrate.UpgradeToJava25
13381338
examples:
1339+
- description: '`EnableLombokAnnotationProcessorTest#doesNotAddLombokWhenNotPresentViaUpgradeToJava25`'
1340+
sources:
1341+
- before: project
1342+
language: mavenProject
1343+
- before: |
1344+
<project>
1345+
<groupId>com.mycompany.app</groupId>
1346+
<artifactId>my-app</artifactId>
1347+
<version>1</version>
1348+
<properties>
1349+
<maven.compiler.release>17</maven.compiler.release>
1350+
</properties>
1351+
<dependencies>
1352+
<dependency>
1353+
<groupId>com.google.guava</groupId>
1354+
<artifactId>guava</artifactId>
1355+
<version>33.0.0-jre</version>
1356+
</dependency>
1357+
</dependencies>
1358+
</project>
1359+
after: |
1360+
<project>
1361+
<groupId>com.mycompany.app</groupId>
1362+
<artifactId>my-app</artifactId>
1363+
<version>1</version>
1364+
<properties>
1365+
<maven.compiler.release>25</maven.compiler.release>
1366+
</properties>
1367+
<dependencies>
1368+
<dependency>
1369+
<groupId>com.google.guava</groupId>
1370+
<artifactId>guava</artifactId>
1371+
<version>33.0.0-jre</version>
1372+
</dependency>
1373+
</dependencies>
1374+
</project>
1375+
path: pom.xml
1376+
language: xml
13391377
- description: '`UpgradeToJava25Test#updateCompilerVersion`'
13401378
sources:
13411379
- before: project
@@ -8980,40 +9018,40 @@ examples:
89809018
language: java
89819019
---
89829020
type: specs.openrewrite.org/v1beta/example
8983-
recipeName: org.openrewrite.java.migrate.util.MigrateCollectionsEmptySet
9021+
recipeName: org.openrewrite.java.migrate.util.MigrateCollectionsEmptyMap
89849022
examples:
8985-
- description: '`MigrateCollectionsEmptySetTest#emptySet`'
9023+
- description: '`MigrateCollectionsEmptyMapTest#emptyList`'
89869024
sources:
89879025
- before: |
89889026
import java.util.*;
89899027
89909028
class Test {
8991-
Set<String> set = Collections.emptySet();
9029+
Map<String, String> map = Collections.emptyMap();
89929030
}
89939031
after: |
8994-
import java.util.Set;
9032+
import java.util.Map;
89959033
89969034
class Test {
8997-
Set<String> set = Set.of();
9035+
Map<String, String> map = Map.of();
89989036
}
89999037
language: java
90009038
---
90019039
type: specs.openrewrite.org/v1beta/example
9002-
recipeName: org.openrewrite.java.migrate.util.MigrateCollectionsEmptyMap
9040+
recipeName: org.openrewrite.java.migrate.util.MigrateCollectionsEmptySet
90039041
examples:
9004-
- description: '`MigrateCollectionsEmptyMapTest#emptyMap`'
9042+
- description: '`MigrateCollectionsEmptySetTest#emptyList`'
90059043
sources:
90069044
- before: |
90079045
import java.util.*;
90089046
90099047
class Test {
9010-
Map<String, String> map = Collections.emptyMap();
9048+
Set<String> set = Collections.emptySet();
90119049
}
90129050
after: |
9013-
import java.util.Map;
9051+
import java.util.Set;
90149052
90159053
class Test {
9016-
Map<String, String> map = Map.of();
9054+
Set<String> set = Set.of();
90179055
}
90189056
language: java
90199057
---

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@ void compilerPluginVersionAddedWhenMissing() {
9797
</project>
9898
""",
9999
spec -> spec.after(pomXml -> {
100-
assertThat(pomXml).contains("<version>3.");
101-
return pomXml;
100+
return assertThat( pomXml ).contains( "<version>3." ).actual();
102101
})
103102
)
104103
),
@@ -137,12 +136,11 @@ void compilerPluginVersionAddedAndReleaseSetForFullMigration() {
137136
</project>
138137
""",
139138
spec -> spec.after(pomXml -> {
140-
assertThat(pomXml)
141-
.contains("<release>11</release>")
142-
.contains("<version>3.")
143-
.doesNotContain("<source>")
144-
.doesNotContain("<target>");
145-
return pomXml;
139+
return assertThat( pomXml )
140+
.contains( "<release>11</release>" )
141+
.contains( "<version>3." )
142+
.doesNotContain( "<source>" )
143+
.doesNotContain( "<target>" ).actual();
146144
})
147145
)
148146
),

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,7 @@ void upgradesGradleWrapperForJava25() {
132132
""",
133133
spec -> spec.path("gradle/wrapper/gradle-wrapper.properties")
134134
.after(actual -> {
135-
assertThat(actual).containsPattern("gradle-9\\.1\\.\\d+-bin\\.zip");
136-
return actual;
135+
return assertThat( actual ).containsPattern( "gradle-9\\.1\\.\\d+-bin\\.zip" ).actual();
137136
})
138137
),
139138
text("", spec -> spec.path("gradlew").after(a -> {

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,11 @@ public class TestApplication {
110110
</project>
111111
""",
112112
spec -> spec.after(pom -> {
113-
assertThat(pom)
114-
.containsPattern(
115-
"<groupId>jakarta\\.inject</groupId>\\s*" +
116-
"<artifactId>jakarta\\.inject-api</artifactId>\\s*" +
117-
"<version>2\\.0\\.\\d+</version>");
118-
return pom;
113+
return assertThat( pom )
114+
.containsPattern(
115+
"<groupId>jakarta\\.inject</groupId>\\s*" +
116+
"<artifactId>jakarta\\.inject-api</artifactId>\\s*" +
117+
"<version>2\\.0\\.\\d+</version>" ).actual();
119118
})
120119
)
121120
)

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

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,12 @@ void switchesJavaxJspApiDependencyToJakartaJspApiDependency() {
6262
</project>
6363
""",
6464
spec -> spec.after(pom -> {
65-
assertThat(pom)
66-
.doesNotContain("javax.servlet.jsp")
67-
.containsPattern(
68-
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
69-
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
70-
"<version>3\\.0\\.\\d+</version>");
71-
return pom;
65+
return assertThat( pom )
66+
.doesNotContain( "javax.servlet.jsp" )
67+
.containsPattern(
68+
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
69+
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
70+
"<version>3\\.0\\.\\d+</version>" ).actual();
7271
})
7372
)
7473
),
@@ -128,12 +127,11 @@ public class TestApplication {
128127
</project>
129128
""",
130129
spec -> spec.after(pom -> {
131-
assertThat(pom)
132-
.containsPattern(
133-
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
134-
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
135-
"<version>3\\.0\\.\\d+</version>");
136-
return pom;
130+
return assertThat( pom )
131+
.containsPattern(
132+
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
133+
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
134+
"<version>3\\.0\\.\\d+</version>" ).actual();
137135
})
138136
)
139137
)
@@ -163,12 +161,11 @@ void upgradesJakartaJspApiDependencyIfAlreadyExistingAtLowerVersion() {
163161
</project>
164162
""",
165163
spec -> spec.after(pom -> {
166-
assertThat(pom)
167-
.containsPattern(
168-
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
169-
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
170-
"<version>3\\.0\\.\\d+</version>");
171-
return pom;
164+
return assertThat( pom )
165+
.containsPattern(
166+
"<groupId>jakarta\\.servlet\\.jsp</groupId>\\s*" +
167+
"<artifactId>jakarta\\.servlet\\.jsp-api</artifactId>\\s*" +
168+
"<version>3\\.0\\.\\d+</version>" ).actual();
172169
})
173170
)
174171
)
@@ -208,9 +205,8 @@ public class TestApplication {
208205
}
209206
""",
210207
spec -> spec.after(gradle -> {
211-
assertThat(gradle)
212-
.contains("jakarta.servlet.jsp:jakarta.servlet.jsp-api:3.0.");
213-
return gradle;
208+
return assertThat( gradle )
209+
.contains( "jakarta.servlet.jsp:jakarta.servlet.jsp-api:3.0." ).actual();
214210
})
215211
)
216212
)

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

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,12 @@ void switchesJavaxPersistenceApiDependencyToJakartaPersistenceApiDependency() {
6060
</project>
6161
""",
6262
spec -> spec.after(pom -> {
63-
assertThat(pom)
64-
.doesNotContain("javax.persistence")
65-
.containsPattern(
66-
"<groupId>jakarta\\.persistence</groupId>\\s*" +
67-
"<artifactId>jakarta\\.persistence-api</artifactId>\\s*" +
68-
"<version>3\\.0\\.\\d+</version>");
69-
return pom;
63+
return assertThat( pom )
64+
.doesNotContain( "javax.persistence" )
65+
.containsPattern(
66+
"<groupId>jakarta\\.persistence</groupId>\\s*" +
67+
"<artifactId>jakarta\\.persistence-api</artifactId>\\s*" +
68+
"<version>3\\.0\\.\\d+</version>" ).actual();
7069
})
7170
)
7271
),
@@ -126,12 +125,11 @@ public class TestApplication {
126125
</project>
127126
""",
128127
spec -> spec.after(pom -> {
129-
assertThat(pom)
130-
.containsPattern(
131-
"<groupId>jakarta\\.persistence</groupId>\\s*" +
132-
"<artifactId>jakarta\\.persistence-api</artifactId>\\s*" +
133-
"<version>3\\.0\\.\\d+</version>");
134-
return pom;
128+
return assertThat( pom )
129+
.containsPattern(
130+
"<groupId>jakarta\\.persistence</groupId>\\s*" +
131+
"<artifactId>jakarta\\.persistence-api</artifactId>\\s*" +
132+
"<version>3\\.0\\.\\d+</version>" ).actual();
135133
})
136134
)
137135
)

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,11 @@ public class TestApplication {
148148
</project>
149149
""",
150150
spec -> spec.after(pom -> {
151-
assertThat(pom)
152-
.containsPattern(
153-
"<groupId>jakarta\\.transaction</groupId>\\s*" +
154-
"<artifactId>jakarta\\.transaction-api</artifactId>\\s*" +
155-
"<version>2\\.0\\.\\d+</version>");
156-
return pom;
151+
return assertThat( pom )
152+
.containsPattern(
153+
"<groupId>jakarta\\.transaction</groupId>\\s*" +
154+
"<artifactId>jakarta\\.transaction-api</artifactId>\\s*" +
155+
"<version>2\\.0\\.\\d+</version>" ).actual();
157156
})
158157
)
159158
)

0 commit comments

Comments
 (0)