Skip to content

Commit 6044cbb

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 114a5a2 commit 6044cbb

File tree

10 files changed

+147
-27
lines changed

10 files changed

+147
-27
lines changed

‎src/main/java/org/openrewrite/java/migrate/lang/IfElseIfConstructToSwitch.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import java.util.*;
3838
import java.util.concurrent.atomic.AtomicBoolean;
3939

40+
import static java.util.Collections.emptyList;
4041
import static java.util.Collections.singletonList;
4142
import static org.openrewrite.java.migrate.lang.NullCheck.Matcher.nullCheck;
4243
import static org.openrewrite.java.tree.J.Block.createEmptyBlock;
@@ -246,30 +247,29 @@ private J.Switch fixTypeAttribution(J.Switch switch_) {
246247
}
247248
J.Case case_ = (J.Case) stmt;
248249
J.InstanceOf instanceOf = instanceOfs.next();
249-
J label = case_.getCaseLabels().get(0);
250+
J label = case_.getCaseLabels().get( 0 );
250251

251252
if (label instanceof J.VariableDeclarations) {
252253
J.VariableDeclarations varDecl = (J.VariableDeclarations) label;
253254
// Replace typeExpression with the original clazz (which has proper type info)
254255
varDecl = varDecl.withTypeExpression(
255256
varDecl.getTypeExpression() != null ?
256-
instanceOf.getClazz().withPrefix(varDecl.getTypeExpression().getPrefix()) :
257-
instanceOf.getClazz().withPrefix(Space.EMPTY));
257+
instanceOf.getClazz().withPrefix( varDecl.getTypeExpression().getPrefix() ) :
258+
instanceOf.getClazz().withPrefix( Space.EMPTY ) );
258259
// Fix variable type from original pattern
259260
if (instanceOf.getPattern() instanceof J.Identifier && !varDecl.getVariables().isEmpty()) {
260261
J.Identifier originalPattern = (J.Identifier) instanceOf.getPattern();
261-
J.VariableDeclarations.NamedVariable var0 = varDecl.getVariables().get(0);
262-
varDecl = varDecl.withVariables(singletonList(
263-
var0.withType(originalPattern.getType())
264-
.withName(var0.getName().withType(originalPattern.getType()))));
262+
J.VariableDeclarations.NamedVariable var0 = varDecl.getVariables().get( 0 );
263+
varDecl = varDecl.withVariables( singletonList(
264+
var0.withType( originalPattern.getType() )
265+
.withName( var0.getName().withType( originalPattern.getType() ) ) ) );
265266
}
266-
return case_.withCaseLabels(singletonList(varDecl.withPrefix(label.getPrefix())));
267-
} else {
268-
// JavaTemplate couldn't resolve the type, so no VariableDeclarations was produced.
269-
// Reconstruct one from the original instanceof pattern.
270-
return case_.withCaseLabels(singletonList(
271-
buildVariableDeclarations(instanceOf, label.getPrefix())));
267+
return case_.withCaseLabels( singletonList( varDecl.withPrefix( label.getPrefix() ) ) );
272268
}
269+
// JavaTemplate couldn't resolve the type, so no VariableDeclarations was produced.
270+
// Reconstruct one from the original instanceof pattern.
271+
return case_.withCaseLabels( singletonList(
272+
buildVariableDeclarations( instanceOf, label.getPrefix() ) ) );
273273
})));
274274
}
275275

@@ -281,16 +281,16 @@ private J.VariableDeclarations buildVariableDeclarations(J.InstanceOf instanceOf
281281
Space.SINGLE_SPACE,
282282
Markers.EMPTY,
283283
pattern.withPrefix(Space.EMPTY),
284-
Collections.emptyList(),
284+
emptyList(),
285285
null,
286286
null
287287
);
288288
return new J.VariableDeclarations(
289289
Tree.randomId(),
290290
prefix,
291291
Markers.EMPTY,
292-
Collections.emptyList(),
293-
Collections.emptyList(),
292+
emptyList(),
293+
emptyList(),
294294
instanceOf.getClazz().withPrefix(Space.EMPTY),
295295
null,
296296
null,

‎src/main/java/org/openrewrite/java/migrate/lombok/LombokUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,8 @@ static boolean isConstructorAssigningExactFields(J.MethodDeclaration constructor
298298
return false;
299299
}
300300

301-
JavaType.FullyQualified declaringType = constructor.getMethodType() != null
302-
? constructor.getMethodType().getDeclaringType() : null;
301+
JavaType.FullyQualified declaringType = constructor.getMethodType() != null ?
302+
constructor.getMethodType().getDeclaringType() : null;
303303

304304
for (int i = 0; i < expectedFields.size(); i++) {
305305
J.VariableDeclarations.NamedVariable expectedField = expectedFields.get(i);

‎src/main/java/org/openrewrite/java/migrate/lombok/UseRequiredArgsConstructor.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,9 @@ static String buildAnnotationTemplate(String annotationName, AccessLevel accessL
130130

131131
private static String guessImport(J.Annotation ann) {
132132
if (ann.getAnnotationType().getType() != null) {
133-
return TypeUtils.asFullyQualified(ann.getAnnotationType().getType()) != null
134-
? TypeUtils.asFullyQualified(ann.getAnnotationType().getType()).getFullyQualifiedName()
135-
: ann.getAnnotationType().toString();
133+
return TypeUtils.asFullyQualified(ann.getAnnotationType().getType()) != null ?
134+
TypeUtils.asFullyQualified(ann.getAnnotationType().getType()).getFullyQualifiedName() :
135+
ann.getAnnotationType().toString();
136136
}
137137
return ann.getAnnotationType().toString();
138138
}

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

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3498,6 +3498,80 @@ examples:
34983498
language: java
34993499
---
35003500
type: specs.openrewrite.org/v1beta/example
3501+
recipeName: org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_4_0
3502+
examples:
3503+
- description: '`UpgradeDataNucleus_4_0Test#renameSchemaPropertyKeys`'
3504+
sources:
3505+
- before: |
3506+
datanucleus.autoCreateSchema=true
3507+
datanucleus.autoCreateTables=true
3508+
datanucleus.autoCreateColumns=true
3509+
datanucleus.autoCreateConstraints=true
3510+
datanucleus.validateSchema=true
3511+
datanucleus.validateTables=true
3512+
datanucleus.validateColumns=true
3513+
datanucleus.validateConstraints=true
3514+
after: |
3515+
datanucleus.schema.autoCreateAll=true
3516+
datanucleus.schema.autoCreateTables=true
3517+
datanucleus.schema.autoCreateColumns=true
3518+
datanucleus.schema.autoCreateConstraints=true
3519+
datanucleus.schema.validateAll=true
3520+
datanucleus.schema.validateTables=true
3521+
datanucleus.schema.validateColumns=true
3522+
datanucleus.schema.validateConstraints=true
3523+
language: properties
3524+
---
3525+
type: specs.openrewrite.org/v1beta/example
3526+
recipeName: org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_0
3527+
examples:
3528+
- description: '`UpgradeDataNucleus_5_0Test#renamePropertyKeys`'
3529+
sources:
3530+
- before: |
3531+
datanucleus.query.compileOptimiser=true
3532+
datanucleus.rdbms.adapter.informixUseSerialForIdentity=true
3533+
datanucleus.rdbms.oracleNlsSortOrder=BINARY
3534+
datanucleus.schema.autoCreateSchema=true
3535+
after: |
3536+
datanucleus.query.compileOptimiseVarThis=true
3537+
datanucleus.rdbms.informix.useSerialForIdentity=true
3538+
datanucleus.rdbms.oracle.nlsSortOrder=BINARY
3539+
datanucleus.schema.autoCreateDatabase=true
3540+
language: properties
3541+
---
3542+
type: specs.openrewrite.org/v1beta/example
3543+
recipeName: org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_1
3544+
examples:
3545+
- description: '`UpgradeDataNucleus_5_1Test#renameTransactionProperties`'
3546+
sources:
3547+
- before: |
3548+
datanucleus.nontransactionalRead=true
3549+
datanucleus.nontransactionalWrite=false
3550+
datanucleus.transactionType=JTA
3551+
datanucleus.transactionIsolation=read-committed
3552+
after: |
3553+
datanucleus.transaction.nontx.read=true
3554+
datanucleus.transaction.nontx.write=false
3555+
datanucleus.transaction.type=JTA
3556+
datanucleus.transaction.isolation=read-committed
3557+
language: properties
3558+
---
3559+
type: specs.openrewrite.org/v1beta/example
3560+
recipeName: org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_2
3561+
examples:
3562+
- description: '`UpgradeDataNucleus_5_2Test#renameQueryPropertyKeys`'
3563+
sources:
3564+
- before: |
3565+
datanucleus.jdoql.strict=true
3566+
datanucleus.jpql.strict=true
3567+
datanucleus.sql.syntaxChecks=true
3568+
after: |
3569+
datanucleus.query.jdoql.strict=true
3570+
datanucleus.query.jpql.strict=true
3571+
datanucleus.query.sql.syntaxChecks=true
3572+
language: properties
3573+
---
3574+
type: specs.openrewrite.org/v1beta/example
35013575
recipeName: org.openrewrite.java.migrate.guava.NoGuava
35023576
examples:
35033577
- description: '`NoGuavaJava21Test#preferMathClampForDouble`'
@@ -7863,6 +7937,31 @@ examples:
78637937
language: xml
78647938
---
78657939
type: specs.openrewrite.org/v1beta/example
7940+
recipeName: org.openrewrite.java.migrate.lombok.UseAllArgsConstructor
7941+
examples:
7942+
- description: '`UseAllArgsConstructorTest#allNonStaticFields`'
7943+
sources:
7944+
- before: |
7945+
class A {
7946+
private final String name;
7947+
private int age;
7948+
7949+
public A(String name, int age) {
7950+
this.name = name;
7951+
this.age = age;
7952+
}
7953+
}
7954+
after: |
7955+
import lombok.AllArgsConstructor;
7956+
7957+
@AllArgsConstructor
7958+
class A {
7959+
private final String name;
7960+
private int age;
7961+
}
7962+
language: java
7963+
---
7964+
type: specs.openrewrite.org/v1beta/example
78667965
recipeName: org.openrewrite.java.migrate.lombok.UseLombokGetter
78677966
examples:
78687967
- description: '`UseLombokGetterTest#replaceGetter`'
@@ -7928,6 +8027,28 @@ examples:
79288027
language: java
79298028
---
79308029
type: specs.openrewrite.org/v1beta/example
8030+
recipeName: org.openrewrite.java.migrate.lombok.UseRequiredArgsConstructor
8031+
examples:
8032+
- description: '`UseRequiredArgsConstructorTest#singleFinalField`'
8033+
sources:
8034+
- before: |
8035+
class A {
8036+
private final int foo;
8037+
8038+
public A(int foo) {
8039+
this.foo = foo;
8040+
}
8041+
}
8042+
after: |
8043+
import lombok.RequiredArgsConstructor;
8044+
8045+
@RequiredArgsConstructor
8046+
class A {
8047+
private final int foo;
8048+
}
8049+
language: java
8050+
---
8051+
type: specs.openrewrite.org/v1beta/example
79318052
recipeName: org.openrewrite.java.migrate.lombok.log.UseLombokLogAnnotations
79328053
examples:
79338054
- description: '`ConvertAnyLogTest#replaceAllLoggers`'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717

1818
import org.junit.jupiter.api.Test;
1919
import org.openrewrite.DocumentExample;
20+
import org.openrewrite.Tree;
2021
import org.openrewrite.marker.BuildTool;
2122
import org.openrewrite.test.RecipeSpec;
2223
import org.openrewrite.test.RewriteTest;
23-
import org.openrewrite.Tree;
2424

2525
import static org.assertj.core.api.Assertions.assertThat;
2626
import static org.openrewrite.gradle.toolingapi.Assertions.withToolingApi;

‎src/test/java/org/openrewrite/java/migrate/datanucleus/UpgradeDataNucleus_4_0Test.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public void defaults(RecipeSpec spec) {
3232
spec.recipeFromResources("org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_4_0");
3333
}
3434

35-
@Test
3635
@DocumentExample
36+
@Test
3737
void renameSchemaPropertyKeys() {
3838
rewriteRun(
3939
properties(

‎src/test/java/org/openrewrite/java/migrate/datanucleus/UpgradeDataNucleus_5_0Test.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public void defaults(RecipeSpec spec) {
3232
spec.recipeFromResources("org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_0");
3333
}
3434

35-
@Test
3635
@DocumentExample
36+
@Test
3737
void renamePropertyKeys() {
3838
rewriteRun(
3939
properties(

‎src/test/java/org/openrewrite/java/migrate/datanucleus/UpgradeDataNucleus_5_1Test.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ public void defaults(RecipeSpec spec) {
3030
spec.recipeFromResources("org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_1");
3131
}
3232

33-
@Test
3433
@DocumentExample
34+
@Test
3535
void renameTransactionProperties() {
3636
rewriteRun(
3737
properties(

‎src/test/java/org/openrewrite/java/migrate/datanucleus/UpgradeDataNucleus_5_2Test.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public void defaults(RecipeSpec spec) {
3232
spec.recipeFromResources("org.openrewrite.java.migrate.datanucleus.UpgradeDataNucleus_5_2");
3333
}
3434

35-
@Test
3635
@DocumentExample
36+
@Test
3737
void renameQueryPropertyKeys() {
3838
rewriteRun(
3939
properties(

‎src/test/java/org/openrewrite/java/migrate/lombok/UseRequiredArgsConstructorTest.java‎

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

1818
import org.junit.jupiter.api.Test;
1919
import org.openrewrite.DocumentExample;
20-
import org.openrewrite.java.JavaParser;
2120
import org.openrewrite.test.RecipeSpec;
2221
import org.openrewrite.test.RewriteTest;
2322

0 commit comments

Comments
 (0)