refactor: OpenRewrite best practices (#594)

* refactor: OpenRewrite best practices Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.recipes.OpenRewriteBestPractices?organizationId=T3BlblJld3JpdGU%3D Co-authored-by: Moderne <[email protected]> * Restore public modifier after recipe fix * Replace print with assertion --------- Co-authored-by: Moderne <[email protected]>
openrewrite · Feb 11, 2024 · b74f43b · b74f43b
1 parent b26d6fa
commit b74f43b
Show file tree

Hide file tree

Showing 31 changed files with 65 additions and 32 deletions.
diff --git a/src/main/java/org/openrewrite/kotlin/FindKotlinSources.java b/src/main/java/org/openrewrite/kotlin/FindKotlinSources.java
@@ -26,7 +26,7 @@
 import org.openrewrite.text.PlainText;
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class FindKotlinSources extends Recipe {
     transient KotlinSourceFile kotlinSourceFile = new KotlinSourceFile(this);
 

diff --git a/src/main/java/org/openrewrite/kotlin/RenameTypeAlias.java b/src/main/java/org/openrewrite/kotlin/RenameTypeAlias.java
@@ -23,7 +23,7 @@
 import org.openrewrite.kotlin.tree.K;
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class RenameTypeAlias extends Recipe {
 
     @Option(displayName = "Old alias name",
@@ -56,7 +56,7 @@ public String getDescription() {
     public TreeVisitor<?, ExecutionContext> getVisitor() {
         return new KotlinIsoVisitor<ExecutionContext>() {
             @Override
-            public K.TypeAlias visitTypeAlias(K.TypeAlias typeAlias, ExecutionContext executionContext) {
+            public K.TypeAlias visitTypeAlias(K.TypeAlias typeAlias, ExecutionContext ctx) {
                 if (!aliasName.equals(typeAlias.getSimpleName()) || !TypeUtils.isOfClassType(typeAlias.getType(), fullyQualifiedAliasedType)) {
                     return typeAlias;
                 }

diff --git a/src/main/java/org/openrewrite/kotlin/cleanup/EqualsMethodUsage.java b/src/main/java/org/openrewrite/kotlin/cleanup/EqualsMethodUsage.java
@@ -35,7 +35,7 @@
 import static org.openrewrite.Tree.randomId;
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class EqualsMethodUsage extends Recipe {
     @Nullable
     private static J.Binary equalsBinaryTemplate;

diff --git a/src/main/java/org/openrewrite/kotlin/cleanup/ImplicitParameterInLambda.java b/src/main/java/org/openrewrite/kotlin/cleanup/ImplicitParameterInLambda.java
@@ -31,7 +31,7 @@
 
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class ImplicitParameterInLambda extends Recipe {
     @Override
     public String getDisplayName() {

diff --git a/src/main/java/org/openrewrite/kotlin/cleanup/RemoveTrailingComma.java b/src/main/java/org/openrewrite/kotlin/cleanup/RemoveTrailingComma.java
@@ -23,7 +23,7 @@
 import org.openrewrite.kotlin.format.TrailingCommaVisitor;
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class RemoveTrailingComma extends Recipe {
     @Override
     public String getDisplayName() {

diff --git a/src/main/java/org/openrewrite/kotlin/cleanup/RemoveTrailingSemicolon.java b/src/main/java/org/openrewrite/kotlin/cleanup/RemoveTrailingSemicolon.java
@@ -37,7 +37,7 @@
 
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class RemoveTrailingSemicolon extends Recipe {
     @Override
     public String getDisplayName() {
@@ -72,7 +72,7 @@ public <M extends Marker> M visitMarker(Marker marker, ExecutionContext ctx) {
     }
 
     @Value
-    @EqualsAndHashCode(callSuper = true)
+    @EqualsAndHashCode(callSuper = false)
     private static class CollectSemicolonRemovableElements extends KotlinPrinter<Set<Marker>> {
         Pattern WS = Pattern.compile("^\\s+");
 

diff --git a/src/main/java/org/openrewrite/kotlin/cleanup/ReplaceCharToIntWithCode.java b/src/main/java/org/openrewrite/kotlin/cleanup/ReplaceCharToIntWithCode.java
@@ -29,7 +29,7 @@
 
 
 @Value
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode(callSuper = false)
 public class ReplaceCharToIntWithCode extends Recipe {
     private static final MethodMatcher CHAR_TO_INT_METHOD_MATCHER = new MethodMatcher("kotlin.Char toInt()");
     @Nullable

diff --git a/src/test/java/org/openrewrite/kotlin/AddImportTest.java b/src/test/java/org/openrewrite/kotlin/AddImportTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Issue;
 import org.openrewrite.Recipe;
@@ -70,6 +71,7 @@ class A {
         );
     }
 
+    @DocumentExample
     @Test
     void jvmStaticMember() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/AnnotationMatcherTest.java b/src/test/java/org/openrewrite/kotlin/AnnotationMatcherTest.java
@@ -25,7 +25,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
-public class AnnotationMatcherTest implements RewriteTest {
+class AnnotationMatcherTest implements RewriteTest {
 
     @Test
     void matchAnnotation() {

diff --git a/src/test/java/org/openrewrite/kotlin/AssertionsTest.java b/src/test/java/org/openrewrite/kotlin/AssertionsTest.java
@@ -29,7 +29,7 @@
 import static org.openrewrite.kotlin.Assertions.kotlin;
 import static org.openrewrite.test.RewriteTest.toRecipe;
 
-public class AssertionsTest implements RewriteTest {
+class AssertionsTest implements RewriteTest {
 
     @Issue("https://github.com/openrewrite/rewrite-kotlin/issues/30")
     @Test

diff --git a/src/test/java/org/openrewrite/kotlin/ChangeAnnotationAttributeNameTest.java b/src/test/java/org/openrewrite/kotlin/ChangeAnnotationAttributeNameTest.java
@@ -16,15 +16,17 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.java.ChangeAnnotationAttributeName;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
 class ChangeAnnotationAttributeNameTest implements RewriteTest {
 
+    @DocumentExample
     @Test
-    public void changeAnnotationAttributes() {
+    void changeAnnotationAttributes() {
         rewriteRun(
           spec -> spec.recipe(new ChangeAnnotationAttributeName(
               "org.junit.jupiter.api.Tag",

diff --git a/src/test/java/org/openrewrite/kotlin/FindFieldsTest.java b/src/test/java/org/openrewrite/kotlin/FindFieldsTest.java
@@ -16,13 +16,15 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.java.search.FindFields;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
-public class FindFieldsTest implements RewriteTest {
+class FindFieldsTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void jvmStaticField() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/FindMethodsTest.java b/src/test/java/org/openrewrite/kotlin/FindMethodsTest.java
@@ -16,13 +16,15 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.java.search.FindMethods;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
-public class FindMethodsTest implements RewriteTest {
+class FindMethodsTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void jvmStaticMethod() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/KotlinTypeGoatTest.java b/src/test/java/org/openrewrite/kotlin/KotlinTypeGoatTest.java
@@ -25,7 +25,7 @@
 import static org.openrewrite.ExecutionContext.REQUIRE_PRINT_EQUALS_INPUT;
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
-public class KotlinTypeGoatTest implements RewriteTest {
+class KotlinTypeGoatTest implements RewriteTest {
     @Language("kotlin")
     private static final String goat = StringUtils.readFully(KotlinTypeMappingTest.class.getResourceAsStream("/KotlinTypeGoat.kt"));
 

diff --git a/src/test/java/org/openrewrite/kotlin/MethodMatcherTest.java b/src/test/java/org/openrewrite/kotlin/MethodMatcherTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.java.MethodMatcher;
 import org.openrewrite.java.tree.J;
@@ -27,6 +28,7 @@
 
 class MethodMatcherTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void matchesTopLevelFunction() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/RemoveImportTest.java b/src/test/java/org/openrewrite/kotlin/RemoveImportTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Recipe;
 import org.openrewrite.kotlin.tree.K;
@@ -25,8 +26,9 @@
 import static org.openrewrite.kotlin.Assertions.kotlin;
 import static org.openrewrite.test.RewriteTest.toRecipe;
 
-public class RemoveImportTest implements RewriteTest {
+class RemoveImportTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void jvmStaticMember() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/RenameTypeAliasTest.java b/src/test/java/org/openrewrite/kotlin/RenameTypeAliasTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.Issue;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -54,6 +55,7 @@ class Test
         );
     }
 
+    @DocumentExample
     @Test
     void declaration() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/UseStaticImportTest.java b/src/test/java/org/openrewrite/kotlin/UseStaticImportTest.java
@@ -16,13 +16,15 @@
 package org.openrewrite.kotlin;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.java.UseStaticImport;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
-public class UseStaticImportTest implements RewriteTest {
+class UseStaticImportTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void noPriorImports() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/cleanup/ReplaceCharToIntWithCodeTest.java b/src/test/java/org/openrewrite/kotlin/cleanup/ReplaceCharToIntWithCodeTest.java
@@ -23,7 +23,7 @@
 import static org.openrewrite.kotlin.Assertions.kotlin;
 
 
-public class ReplaceCharToIntWithCodeTest implements RewriteTest {
+class ReplaceCharToIntWithCodeTest implements RewriteTest {
     @Override
     public void defaults(RecipeSpec spec) {
         spec.recipe(new ReplaceCharToIntWithCode());

diff --git a/src/test/java/org/openrewrite/kotlin/format/AutoFormatVisitorTest.java b/src/test/java/org/openrewrite/kotlin/format/AutoFormatVisitorTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin.format;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.InMemoryExecutionContext;
 import org.openrewrite.Issue;
 import org.openrewrite.java.tree.J;
@@ -40,6 +41,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new AutoFormat());
     }
 
+    @DocumentExample
     @Test
     void keepMaximumBetweenHeaderAndPackage() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/format/MinimumViableSpacingTest.java b/src/test/java/org/openrewrite/kotlin/format/MinimumViableSpacingTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin.format;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Issue;
 import org.openrewrite.java.JavaIsoVisitor;
@@ -46,6 +47,7 @@ public Space visitSpace(Space space, Space.Location loc, ExecutionContext ctx) {
         );
     }
 
+    @DocumentExample
     @Test
     void classDeclaration() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/format/NormalizeTabsOrSpacesTest.java b/src/test/java/org/openrewrite/kotlin/format/NormalizeTabsOrSpacesTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin.format;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.Issue;
 import org.openrewrite.Tree;
 import org.openrewrite.kotlin.KotlinParser;
@@ -47,6 +48,7 @@ private static Consumer<RecipeSpec> tabsAndIndents(UnaryOperator<org.openrewrite
           )));
     }
 
+    @DocumentExample
     @Test
     void mixedToTabs() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/format/RemoveTrailingWhitespaceTest.java b/src/test/java/org/openrewrite/kotlin/format/RemoveTrailingWhitespaceTest.java
@@ -25,7 +25,7 @@
 import static org.openrewrite.kotlin.Assertions.kotlin;
 import static org.openrewrite.test.RewriteTest.toRecipe;
 
-public class RemoveTrailingWhitespaceTest implements RewriteTest {
+class RemoveTrailingWhitespaceTest implements RewriteTest {
 
     @Override
     public void defaults(RecipeSpec spec) {

diff --git a/src/test/java/org/openrewrite/kotlin/format/TabsAndIndentsTest.java b/src/test/java/org/openrewrite/kotlin/format/TabsAndIndentsTest.java
@@ -2114,7 +2114,8 @@ public fun methodTwo(value: Int): Int {
     @Test
     void useContinuationIndentExtendsOnNewLine() {
         rewriteRun(
-          kotlin("""
+          kotlin(
+                """
             package org.a
 
             open class A {}
@@ -2424,7 +2425,8 @@ public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ct
                   return autoFormat(a, ctx);
               }
           })).parser(KotlinParser.builder().logCompilationWarningsAndErrors(true)),
-          kotlin("""
+          kotlin(
+                """
             package org.sample
             
             @SafeVarargs

diff --git a/src/test/java/org/openrewrite/kotlin/format/TrailingCommaTest.java b/src/test/java/org/openrewrite/kotlin/format/TrailingCommaTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin.format;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.kotlin.style.IntelliJ;
 import org.openrewrite.kotlin.style.OtherStyle;
 import org.openrewrite.test.RecipeSpec;
@@ -38,6 +39,7 @@ private static Consumer<RecipeSpec> trailingCommaStyle(UnaryOperator<OtherStyle>
         return spec -> spec.recipe(toRecipe(() -> new TrailingCommaVisitor<>(with.apply(IntelliJ.other()).getUseTrailingComma())));
     }
 
+    @DocumentExample
     @Test
     void classPropertiesWithTrailingCommaOff() {
         rewriteRun(

diff --git a/src/test/java/org/openrewrite/kotlin/format/WrappingAndBracesTest.java b/src/test/java/org/openrewrite/kotlin/format/WrappingAndBracesTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.kotlin.format;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
 import org.openrewrite.Issue;
 import org.openrewrite.Tree;
 import org.openrewrite.kotlin.KotlinParser;
@@ -77,6 +78,7 @@ class A   (
         );
     }
 
+    @DocumentExample
     @SuppressWarnings({"ClassInitializerMayBeStatic", "ReassignedVariable", "UnusedAssignment"})
     @Test
     void blockLevelStatements() {

diff --git a/src/test/java/org/openrewrite/kotlin/tree/ClassDeclarationTest.java b/src/test/java/org/openrewrite/kotlin/tree/ClassDeclarationTest.java
@@ -464,7 +464,8 @@ sealed interface InvalidField {
     @Test
     void init() {
         rewriteRun(
-          kotlin("""
+          kotlin(
+                """
             class Test {
                 init   {
                     println ( "Hello, world!" )

diff --git a/src/test/java/org/openrewrite/kotlin/tree/ContinueTest.java b/src/test/java/org/openrewrite/kotlin/tree/ContinueTest.java
@@ -27,11 +27,11 @@ void continueFromWhileLoop() {
         rewriteRun(
           kotlin(
             """
-                class Test {
-                    fun test ( ) {
-                        while ( true ) continue
-                    }
-                }
+              class Test {
+                  fun test ( ) {
+                      while ( true ) continue
+                  }
+              }
               """
           )
         );

diff --git a/src/test/java/org/openrewrite/kotlin/tree/ImportTest.java b/src/test/java/org/openrewrite/kotlin/tree/ImportTest.java
@@ -98,7 +98,7 @@ void methodName() {
           kotlin(
             "import   createInstance /*C1*/",
             spec -> spec.afterRecipe(cu -> {
-                System.out.println(cu.getImports().get(0).getPackageName());
+                assertThat(cu.getImports().get(0).getPackageName()).isEmpty();
             })
           )
         );