AppendToTextFile: support glob patterns for the relative file name (#7417)

Matching is now delegated to `PathMatcher` with `glob:` syntax, consistent
with `DeleteSourceFiles`, `RenameFile`, `MoveFile`, and `SetFilePermissions`.
When the pattern contains glob metacharacters no new file is generated,
since a glob does not specify a concrete path to create.

Author: timtebeek

rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java

@@ -34,7 +34,8 @@
 @EqualsAndHashCode(callSuper = false)
 public class AppendToTextFile extends ScanningRecipe<AtomicBoolean> {
     @Option(displayName = "Relative file name",
-            description = "File name, using a relative path. If a non-plaintext file already exists at this location, then this recipe will do nothing.",
+            description = "File name, using a relative path. May also be a glob expression (e.g. `**/*.txt`) to match one or more existing files; " +
+                          "when a glob is supplied no new file is created. If a non-plaintext file matches, that file is left unchanged.",
             example = "foo/bar/baz.txt")
     String relativeFileName;
 
@@ -93,7 +94,7 @@ public TreeVisitor<?, ExecutionContext> getScanner(AtomicBoolean fileExists) {
             @Override
             public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
                 SourceFile sourceFile = (SourceFile) requireNonNull(tree);
-                if (!fileExists.get() && sourceFile.getSourcePath().toString().equals(Paths.get(relativeFileName).toString())) {
+                if (!fileExists.get() && matchesTarget(sourceFile.getSourcePath())) {
                     fileExists.set(true);
                 }
                 return sourceFile;
@@ -103,6 +104,11 @@ public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
 
     @Override
     public Collection<PlainText> generate(AtomicBoolean fileExists, Collection<SourceFile> generatedInThisCycle, ExecutionContext ctx) {
+        // A glob can match multiple existing files but doesn't specify a concrete path to create.
+        if (relativeFileName.matches(".*[*?\\[{].*")) {
+            return emptyList();
+        }
+
         String maybeNewline = !Boolean.FALSE.equals(appendNewline) ? "\n" : "";
         String content = this.content + maybeNewline;
         String preamble = this.preamble != null ? this.preamble + maybeNewline : "";
@@ -132,7 +138,7 @@ public TreeVisitor<?, ExecutionContext> getVisitor(AtomicBoolean fileExists) {
             @Override
             public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
                 SourceFile sourceFile = (SourceFile) requireNonNull(tree);
-                if (sourceFile.getSourcePath().toString().equals(Paths.get(relativeFileName).toString())) {
+                if (sourceFile instanceof PlainText && matchesTarget(sourceFile.getSourcePath())) {
                     String maybeNewline = !Boolean.FALSE.equals(appendNewline) ? "\n" : "";
                     String content = AppendToTextFile.this.content + maybeNewline;
                     String preamble = AppendToTextFile.this.preamble != null ? AppendToTextFile.this.preamble + maybeNewline : "";
@@ -155,6 +161,10 @@ public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
         });
     }
 
+    private boolean matchesTarget(Path sourcePath) {
+        return sourcePath.getFileSystem().getPathMatcher("glob:" + relativeFileName).matches(sourcePath);
+    }
+
     /**
      * Merges new content with existing content by appending only lines that are not already present.
      * Lines are compared after trimming whitespace.

rewrite-core/src/test/java/org/openrewrite/text/AppendToTextFileTest.java

@@ -316,6 +316,59 @@ void leaveStrategyWithPartialExistingContent() {
         }
     }
 
+    @Nested
+    class Glob {
+
+        @Test
+        void globMatchesMultipleFiles() {
+            rewriteRun(
+              spec -> spec.recipe(new AppendToTextFile("**/*.txt", "content", null, true, AppendToTextFile.Strategy.Continue)),
+              text(
+                "existing1",
+                """
+                  existing1
+                  content
+                  """,
+                spec -> spec.path("a/file1.txt").noTrim()
+              ),
+              text(
+                "existing2",
+                """
+                  existing2
+                  content
+                  """,
+                spec -> spec.path("b/file2.txt").noTrim()
+              )
+            );
+        }
+
+        @Test
+        void globDoesNotCreateNewFile() {
+            rewriteRun(
+              spec -> spec.recipe(new AppendToTextFile("**/*.txt", "content", "preamble", true, AppendToTextFile.Strategy.Leave))
+            );
+        }
+
+        @Test
+        void globSkipsNonMatchingFiles() {
+            rewriteRun(
+              spec -> spec.recipe(new AppendToTextFile("**/*.txt", "content", null, true, AppendToTextFile.Strategy.Continue)),
+              text(
+                "keep me",
+                spec -> spec.path("a/file.md")
+              ),
+              text(
+                "existing",
+                """
+                  existing
+                  content
+                  """,
+                spec -> spec.path("a/file.txt").noTrim()
+              )
+            );
+        }
+    }
+
     @Nested
     class Merge {
         /**