Perform recipe SelectRecipeExamples on rewrite itself to select recip…

…e examples
jprinet · Apr 26, 2023 · f6e37b9 · f6e37b9
1 parent 1f10a84
commit f6e37b9
Show file tree

Hide file tree

Showing 338 changed files with 683 additions and 5 deletions.
diff --git a/rewrite-core/src/test/java/org/openrewrite/ApplicabilityTest.java b/rewrite-core/src/test/java/org/openrewrite/ApplicabilityTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.marker.SearchResult;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -31,6 +32,7 @@ public void defaults(RecipeSpec spec) {
         spec.validateRecipeSerialization(false);
     }
 
+    @DocumentExample
     @Test
     void not() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/FindGitProvenanceTest.java b/rewrite-core/src/test/java/org/openrewrite/FindGitProvenanceTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.marker.GitProvenance;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -31,6 +32,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new FindGitProvenance());
     }
 
+    @DocumentExample
     @Test
     void showGitProvenance() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/RecipeLifecycleTest.java b/rewrite-core/src/test/java/org/openrewrite/RecipeLifecycleTest.java
@@ -18,6 +18,7 @@
 import org.intellij.lang.annotations.Language;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.config.RecipeDescriptor;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.internal.ListUtils;
 import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.marker.Markers;
@@ -101,6 +102,7 @@ public PlainText visitText(PlainText tree, P p) {
         }
     }
 
+    @DocumentExample
     @Test
     void recipeApplicabilityWithFindNothingApplicability() {
         // Given:
@@ -475,6 +477,7 @@ void sourceFilesAcceptOnlyApplicableVisitors() {
         }
     }
 
+    @DocumentExample
     @Test
     void accurateReportingOfRecipesMakingChanges() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/RecipeSchedulerTest.java b/rewrite-core/src/test/java/org/openrewrite/RecipeSchedulerTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 import org.openrewrite.text.PlainText;
 import org.openrewrite.text.PlainTextVisitor;
@@ -27,6 +28,7 @@
 
 class RecipeSchedulerTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void exceptionsCauseResult() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/TreeObserverTest.java b/rewrite-core/src/test/java/org/openrewrite/TreeObserverTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 import org.openrewrite.text.PlainText;
 import org.openrewrite.text.PlainTextVisitor;
@@ -28,6 +29,7 @@
 
 class TreeObserverTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void observePropertyChange() {
         var observed = new AtomicInteger(0);

diff --git a/rewrite-core/src/test/java/org/openrewrite/config/YamlResourceLoaderTest.java b/rewrite-core/src/test/java/org/openrewrite/config/YamlResourceLoaderTest.java
@@ -19,6 +19,7 @@
 import org.openrewrite.Contributor;
 import org.openrewrite.Maintainer;
 import org.openrewrite.Recipe;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import java.io.ByteArrayInputStream;
@@ -92,6 +93,7 @@ void maintainers() {
         assertThat(jon.getLogo()).isNull();
     }
 
+    @DocumentExample
     @Test
     void singleSourceApplicability() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/quark/QuarkTest.java b/rewrite-core/src/test/java/org/openrewrite/quark/QuarkTest.java
@@ -20,6 +20,7 @@
 import org.openrewrite.SourceFile;
 import org.openrewrite.Tree;
 import org.openrewrite.TreeVisitor;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.marker.SearchResult;
 import org.openrewrite.test.RewriteTest;
 
@@ -28,6 +29,7 @@
 
 class QuarkTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void renderMarkersOnQuarks() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/table/RecipeRunStatsTest.java b/rewrite-core/src/test/java/org/openrewrite/table/RecipeRunStatsTest.java
@@ -17,6 +17,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.*;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.internal.lang.Nullable;
 import org.openrewrite.marker.SearchResult;
 import org.openrewrite.test.RecipeSpec;
@@ -69,6 +70,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new RecipeWithApplicabilityTest());
     }
 
+    @DocumentExample
     @Test
     void singleRow() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/table/SourceFileResultsTest.java b/rewrite-core/src/test/java/org/openrewrite/table/SourceFileResultsTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.table;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import java.io.ByteArrayInputStream;
@@ -25,6 +26,7 @@
 
 class SourceFileResultsTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void hierarchical() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/table/SourcesFileResultsTest.java b/rewrite-core/src/test/java/org/openrewrite/table/SourcesFileResultsTest.java
@@ -17,13 +17,15 @@
 
 import org.intellij.lang.annotations.Language;
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.openrewrite.test.SourceSpecs.text;
 
 
 class SourcesFileResultsTest implements RewriteTest {
+    @DocumentExample
     @Test
     void twoResultsOnly() {
         @Language("yaml")

diff --git a/rewrite-core/src/test/java/org/openrewrite/text/AppendToTextFileTest.java b/rewrite-core/src/test/java/org/openrewrite/text/AppendToTextFileTest.java
@@ -18,6 +18,7 @@
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
 import org.openrewrite.Recipe;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 import org.openrewrite.test.SourceSpec;
 
@@ -59,6 +60,7 @@ void createsFileIfNeededWithMultipleInstances() {
         );
     }
 
+    @DocumentExample
     @Test
     void replacesFileIfRequested() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/text/EndOfLineAtEndOfFileTest.java b/rewrite-core/src/test/java/org/openrewrite/text/EndOfLineAtEndOfFileTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.text;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 
@@ -28,6 +29,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new EndOfLineAtEndOfFile());
     }
 
+    @DocumentExample
     @Test
     void nonTxtExtension() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/text/FindAndReplaceTest.java b/rewrite-core/src/test/java/org/openrewrite/text/FindAndReplaceTest.java
@@ -16,12 +16,14 @@
 package org.openrewrite.text;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.test.SourceSpecs.text;
 
 class FindAndReplaceTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void nonTxtExtension() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/text/FindTest.java b/rewrite-core/src/test/java/org/openrewrite/text/FindTest.java
@@ -16,12 +16,14 @@
 package org.openrewrite.text;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.test.SourceSpecs.text;
 
 class FindTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void regex() {
         rewriteRun(

diff --git a/rewrite-gradle/src/main/groovy/RepositoryHandler.groovy b/rewrite-gradle/src/main/groovy/RepositoryHandler.groovy
@@ -25,4 +25,4 @@ interface RepositoryHandlerSpec extends RepositoryHandler {
 
 interface MavenArtifactRepositorySpec extends MavenArtifactRepository {
     void url(Object url)
-}
+}
diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ActivateStyleTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ActivateStyleTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.gradle;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 import org.openrewrite.test.TypeValidation;
@@ -32,6 +33,7 @@ public void defaults(RecipeSpec spec) {
           .typeValidationOptions(TypeValidation.none());
     }
 
+    @DocumentExample
     @Test
     void addToRewriteDsl() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/AddDelegatesToGradleApiTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/AddDelegatesToGradleApiTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.gradle;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.java.JavaParser;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -31,6 +32,7 @@ public void defaults(RecipeSpec spec) {
           .recipe(new AddDelegatesToGradleApi());
     }
 
+    @DocumentExample
     @Test
     void simpleMethod() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyArtifactIdTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyArtifactIdTest.java
@@ -18,12 +18,14 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyArtifactIdTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyClassifierTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyClassifierTest.java
@@ -18,11 +18,13 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyClassifierTest implements RewriteTest {
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyConfigurationTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyConfigurationTest.java
@@ -19,11 +19,13 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyConfigurationTest implements RewriteTest {
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyExtensionTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyExtensionTest.java
@@ -18,12 +18,14 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyExtensionTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyGroupIdTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyGroupIdTest.java
@@ -18,12 +18,14 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyGroupIdTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyVersionTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/ChangeDependencyVersionTest.java
@@ -18,12 +18,14 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RewriteTest;
 
 import static org.openrewrite.gradle.Assertions.buildGradle;
 
 class ChangeDependencyVersionTest implements RewriteTest {
 
+    @DocumentExample
     @Test
     void worksWithEmptyStringConfig() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/DependencyUseMapNotationTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/DependencyUseMapNotationTest.java
@@ -17,6 +17,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.Issue;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 
@@ -29,6 +30,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new DependencyUseMapNotation());
     }
 
+    @DocumentExample
     @Test
     void basicString() {
         rewriteRun(

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/DependencyUseStringNotationTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/DependencyUseStringNotationTest.java
@@ -16,6 +16,7 @@
 package org.openrewrite.gradle;
 
 import org.junit.jupiter.api.Test;
+import org.openrewrite.internal.DocumentExample;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
 
@@ -28,6 +29,7 @@ public void defaults(RecipeSpec spec) {
         spec.recipe(new DependencyUseStringNotation());
     }
 
+    @DocumentExample
     @Test
     void basicMap() {
         rewriteRun(
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,4 +25,4 @@ interface RepositoryHandlerSpec extends RepositoryHandler { @@
     interface MavenArtifactRepositorySpec extends MavenArtifactRepository {
         void url(Object url)
-    }
+    }