Drop HasSourcePath in favor of FindSourceFiles (#3758)

* Drop HasSourcePath in favor of FindSourceFiles * Demonstrate feature from HasSourcePath not present in FindSourceFiles * Add to PathUtilsTest * Gradle wrapper 8.5 * Only document limitation for now * Restore match when pattern is empty
openrewrite · Dec 4, 2023 · 9055f92 · 9055f92
1 parent b066fa0
commit 9055f92
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 204 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/HasSourcePath.java b/rewrite-core/src/main/java/org/openrewrite/HasSourcePath.java
diff --git a/rewrite-core/src/main/java/org/openrewrite/PathUtils.java b/rewrite-core/src/main/java/org/openrewrite/PathUtils.java
@@ -24,7 +24,8 @@
 import java.util.List;
 
 public class PathUtils {
-    private PathUtils() {}
+    private PathUtils() {
+    }
 
     private static final char UNIX_SEPARATOR = '/';
 
@@ -43,7 +44,7 @@ public static boolean equalIgnoringSeparators(Path a, Path b) {
     /**
      * Compare two strings representing file paths, returning true if they indicate the same path regardless of separators
      */
-    public static boolean equalIgnoringSeparators(String a , String b) {
+    public static boolean equalIgnoringSeparators(String a, String b) {
         return separatorsToSystem(a).equals(separatorsToSystem(b));
     }
 
@@ -127,7 +128,7 @@ private static boolean matchesGlob(String pattern, String path) {
                 return false;
             }
             if (pattIdxEnd == (pattTokens.length - 1)
-                    && (isFileSeparator(pattern.charAt(pattern.length() - 1)) ^ isFileSeparator(path.charAt(path.length() - 1)))) {
+                && (isFileSeparator(pattern.charAt(pattern.length() - 1)) ^ isFileSeparator(path.charAt(path.length() - 1)))) {
                 return false;
             }
             pattIdxEnd--;

diff --git a/rewrite-core/src/main/java/org/openrewrite/text/ChangeText.java b/rewrite-core/src/main/java/org/openrewrite/text/ChangeText.java
@@ -48,7 +48,7 @@ public String getDisplayName() {
     @Override
     public String getDescription() {
         return "Completely replaces the contents of the text file with other text. " +
-               "Use together with a `HasSourcePath` precondition to limit which files are changed.";
+               "Use together with a `FindSourceFiles` precondition to limit which files are changed.";
     }
 
     @Override

diff --git a/rewrite-core/src/main/java/org/openrewrite/text/Find.java b/rewrite-core/src/main/java/org/openrewrite/text/Find.java
@@ -137,7 +137,7 @@ public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
         if (filePattern != null) {
             //noinspection unchecked
             TreeVisitor<?, ExecutionContext> check = Preconditions.or(Arrays.stream(filePattern.split(";"))
-                    .map(HasSourcePath::new)
+                    .map(FindSourceFiles::new)
                     .map(Recipe::getVisitor)
                     .toArray(TreeVisitor[]::new));
 

diff --git a/rewrite-core/src/main/java/org/openrewrite/text/FindAndReplace.java b/rewrite-core/src/main/java/org/openrewrite/text/FindAndReplace.java
@@ -147,7 +147,7 @@ public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
         if(filePattern != null) {
             //noinspection unchecked
             TreeVisitor<?, ExecutionContext> check = Preconditions.or(Arrays.stream(filePattern.split(";"))
-                    .map(HasSourcePath::new)
+                    .map(FindSourceFiles::new)
                     .map(Recipe::getVisitor)
                     .toArray(TreeVisitor[]::new));
 

diff --git a/rewrite-core/src/main/java/org/openrewrite/text/FindMultiselect.java b/rewrite-core/src/main/java/org/openrewrite/text/FindMultiselect.java
@@ -144,7 +144,7 @@ public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
         if (filePattern != null) {
             //noinspection unchecked
             TreeVisitor<?, ExecutionContext> check = Preconditions.or(Arrays.stream(filePattern.split(";"))
-                    .map(HasSourcePath::new)
+                    .map(FindSourceFiles::new)
                     .map(Recipe::getVisitor)
                     .toArray(TreeVisitor[]::new));
 

diff --git a/rewrite-core/src/test/java/org/openrewrite/PathUtilsTest.java b/rewrite-core/src/test/java/org/openrewrite/PathUtilsTest.java
@@ -15,6 +15,7 @@
  */
 package org.openrewrite;
 
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import java.nio.file.Path;
@@ -98,6 +99,18 @@ void globMatching() {
         assertThat(matchesGlob(path("a-test/test.txt"), "**/*-test/*-test/test.txt")).isFalse();
     }
 
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite/pull/3758")
+    @Disabled("{} syntax not supported yet")
+    void eitherOr() {
+        // matches with {}'s, used in for instance `"**/{application,application-*,bootstrap,bootstrap-*}.{yml,yaml}"`
+        assertThat(matchesGlob(path("test/"), "test/{foo,bar}")).isFalse();
+        assertThat(matchesGlob(path("test/quz"), "test/{foo,bar}")).isFalse();
+        assertThat(matchesGlob(path("test/foo"), "test/{foo,bar}")).isTrue();
+        assertThat(matchesGlob(path("test/foo"), "test/{f*,bar}")).isTrue();
+        assertThat(matchesGlob(path("test/bar"), "test/{foo,bar}")).isTrue();
+    }
+
     private static Path path(String path) {
         return Paths.get(path);
     }

diff --git a/...ite-java-test/src/test/java/org/openrewrite/java/recipes/MigrateRecipeToRewrite8Test.java b/...ite-java-test/src/test/java/org/openrewrite/java/recipes/MigrateRecipeToRewrite8Test.java
@@ -589,7 +589,7 @@ public String getDisplayName() {
                   @Override
                   protected TreeVisitor<?, ExecutionContext> getSingleSourceApplicableTest() {
                       if (fileMatcher != null) {
-                          return new HasSourcePath(fileMatcher).getVisitor();
+                          return new FindSourceFiles(fileMatcher).getVisitor();
                       } else {
                           return null;
                       }
@@ -633,7 +633,7 @@ public String getDisplayName() {
                   @Override
                   protected TreeVisitor<?, ExecutionContext> getSingleSourceApplicableTest() {
                       if (fileMatcher != null) {
-                          return new HasSourcePath(fileMatcher).getVisitor();
+                          return new FindSourceFiles(fileMatcher).getVisitor();
                       } else {
                           return null;
                       }

diff --git a/rewrite-test/src/test/java/org/openrewrite/FindSourceFilesTest.java b/rewrite-test/src/test/java/org/openrewrite/FindSourceFilesTest.java
@@ -15,6 +15,7 @@
  */
 package org.openrewrite;
 
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
@@ -120,4 +121,23 @@ void findDotfiles() {
           )
         );
     }
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite/pull/3758")
+    @Disabled("{} syntax not supported yet")
+    void eitherOr() {
+        rewriteRun(
+          spec -> spec.recipe(new FindSourceFiles("**/*.{md,txt}")),
+          text(
+            "hello world!",
+            "~~>hello world!",
+            spec -> spec.path("a/b/hello.md")
+          ),
+          text(
+            "hello world!",
+            "~~>hello world!",
+            spec -> spec.path("a/c/hello.txt")
+          )
+        );
+    }
 }
diff --git a/rewrite-test/src/test/java/org/openrewrite/HasSourcePathTest.java b/rewrite-test/src/test/java/org/openrewrite/HasSourcePathTest.java
diff --git a/rewrite-xml/src/main/java/org/openrewrite/xml/RemoveXmlTag.java b/rewrite-xml/src/main/java/org/openrewrite/xml/RemoveXmlTag.java
@@ -48,7 +48,7 @@ public String getDescription() {
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
-        return Preconditions.check(fileMatcher != null ? new HasSourcePath(fileMatcher) : new HasSourcePath(""), new XmlIsoVisitor<ExecutionContext>() {
+        return Preconditions.check(fileMatcher != null ? new FindSourceFiles(fileMatcher) : new FindSourceFiles("**"), new XmlIsoVisitor<ExecutionContext>() {
             private final XPathMatcher xPathMatcher = new XPathMatcher(xPath);
 
             @Override

diff --git a/rewrite-yaml/src/test/java/org/openrewrite/yaml/CopyValueTest.java b/rewrite-yaml/src/test/java/org/openrewrite/yaml/CopyValueTest.java
@@ -18,7 +18,7 @@
 import org.junit.jupiter.api.Test;
 import org.openrewrite.DocumentExample;
 import org.openrewrite.ExecutionContext;
-import org.openrewrite.HasSourcePath;
+import org.openrewrite.FindSourceFiles;
 import org.openrewrite.Preconditions;
 import org.openrewrite.test.RewriteTest;
 import org.openrewrite.yaml.tree.Yaml;
@@ -89,7 +89,7 @@ void insertCopyValueAndRemoveSource() {
     void changeOnlyMatchingFile() {
         rewriteRun(
           spec -> spec.recipe(
-            toRecipe(() -> Preconditions.check(new HasSourcePath("**/a.yml"), new YamlIsoVisitor<>() {
+            toRecipe(() -> Preconditions.check(new FindSourceFiles("**/a.yml"), new YamlIsoVisitor<>() {
                 @Override
                 public Yaml.Documents visitDocuments(Yaml.Documents documents, ExecutionContext executionContext) {
                     doAfterVisit(new CopyValue(".source", ".destination").getVisitor());