From ce22d5ddd7b0dcbf70b8c30ae347848067fac3a9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michael=20Vo=C5=99=C3=AD=C5=A1ek?= <mvorisek@mvorisek.cz>
Date: Sat, 15 May 2021 17:26:28 +0200
Subject: [PATCH] [Finder] Fix gitignore regex build with "**"

---
 src/Symfony/Component/Finder/Gitignore.php    |  22 +--
 .../Component/Finder/Tests/GitignoreTest.php  | 154 +++++++++++++++---
 2 files changed, 139 insertions(+), 37 deletions(-)

diff --git a/src/Symfony/Component/Finder/Gitignore.php b/src/Symfony/Component/Finder/Gitignore.php
index 5bd6829491..304aba9e5a 100644
--- a/src/Symfony/Component/Finder/Gitignore.php
+++ b/src/Symfony/Component/Finder/Gitignore.php
@@ -68,20 +68,16 @@ class Gitignore
             $isAbsolute = false;
         }
 
-        $parts = array_map(function (string $v): string {
-            $v = preg_quote(str_replace('\\', '', $v), '~');
-            $v = preg_replace_callback('~\\\\\[([^\[\]]*)\\\\\]~', function (array $matches): string {
-                return '['.str_replace('\\-', '-', $matches[1]).']';
-            }, $v);
-            $v = preg_replace('~\\\\\*\\\\\*~', '[^/]+(?:/[^/]+)*', $v);
-            $v = preg_replace('~\\\\\*~', '[^/]*', $v);
-            $v = preg_replace('~\\\\\?~', '[^/]', $v);
-
-            return $v;
-        }, explode('/', $gitignoreLine));
+        $regex = preg_quote(str_replace('\\', '', $gitignoreLine), '~');
+        $regex = preg_replace_callback('~\\\\\[((?:\\\\!)?)([^\[\]]*)\\\\\]~', function (array $matches): string {
+            return '['.('' !== $matches[1] ? '^' : '').str_replace('\\-', '-', $matches[2]).']';
+        }, $regex);
+        $regex = preg_replace('~(?:(?:\\\\\*){2,}(/?))+~', '(?:(?:(?!//).(?<!//))+$1)?', $regex);
+        $regex = preg_replace('~\\\\\*~', '[^/]*', $regex);
+        $regex = preg_replace('~\\\\\?~', '[^/]', $regex);
 
         return ($isAbsolute ? '' : '(?:[^/]+/)*')
-            .implode('/', $parts)
-            .('' !== end($parts) ? '(?:$|/)' : '');
+            .$regex
+            .('/' !== substr($gitignoreLine, -1) ? '(?:$|/)' : '');
     }
 }
diff --git a/src/Symfony/Component/Finder/Tests/GitignoreTest.php b/src/Symfony/Component/Finder/Tests/GitignoreTest.php
index 01d9fc5f36..3fa01048f6 100644
--- a/src/Symfony/Component/Finder/Tests/GitignoreTest.php
+++ b/src/Symfony/Component/Finder/Tests/GitignoreTest.php
@@ -88,9 +88,9 @@ class GitignoreTest extends TestCase
                 [],
             ],
             [
-                ['/a', 'm/*'],
-                ['a', 'a/b', 'a/b/c', 'm/'],
-                ['aa', 'm', 'b/m', 'b/m/'],
+                ['/a', 'm/*', 'o/**', 'p/**/', 'x**y'],
+                ['a', 'a/b', 'a/b/c', 'm/', 'o/', 'p/', 'xy', 'xuy', 'x/y', 'x/u/y', 'xu/y', 'x/uy', 'xu/uy'],
+                ['aa', 'm', 'b/m', 'b/m/', 'o', 'b/o', 'b/o/', 'p', 'b/p', 'b/p/'],
             ],
             [
                 ['a', '!x'],
@@ -173,8 +173,8 @@ class GitignoreTest extends TestCase
             ],
             [
                 ['dir1/**/dir2/'],
-                ['dir1/dirA/dir2/', 'dir1/dirA/dirB/dir2/'],
-                [],
+                ['dir1/dir2/', 'dir1/dirA/dir2/', 'dir1/dirA/dirB/dir2/'],
+                ['dir1dir2/', 'dir1xdir2/', 'dir1/xdir2/', 'dir1x/dir2/'],
             ],
             [
                 ['dir1/*/dir2/'],
@@ -202,37 +202,22 @@ class GitignoreTest extends TestCase
                 ['a/app/cache/file.txt'],
             ],
             [
-                [
-                    '#IamComment',
-                    '/app/cache/',
-                ],
+                ['#IamComment', '/app/cache/'],
                 ['app/cache/file.txt', 'app/cache/subdir/ile.txt'],
                 ['a/app/cache/file.txt', '#IamComment', 'IamComment'],
             ],
             [
-                [
-                    '/app/cache/',
-                    '#LastLineIsComment',
-                ],
+                ['/app/cache/', '#LastLineIsComment'],
                 ['app/cache/file.txt', 'app/cache/subdir/ile.txt'],
                 ['a/app/cache/file.txt', '#LastLineIsComment', 'LastLineIsComment'],
             ],
             [
-                [
-                    '/app/cache/',
-                    '\#file.txt',
-                    '#LastLineIsComment',
-                ],
+                ['/app/cache/', '\#file.txt', '#LastLineIsComment'],
                 ['app/cache/file.txt', 'app/cache/subdir/ile.txt', '#file.txt'],
                 ['a/app/cache/file.txt', '#LastLineIsComment', 'LastLineIsComment'],
             ],
             [
-                [
-                    '/app/cache/',
-                    '\#file.txt',
-                    '#IamComment',
-                    'another_file.txt',
-                ],
+                ['/app/cache/', '\#file.txt', '#IamComment', 'another_file.txt'],
                 ['app/cache/file.txt', 'app/cache/subdir/ile.txt', '#file.txt', 'another_file.txt'],
                 ['a/app/cache/file.txt', 'IamComment', '#IamComment'],
             ],
@@ -280,6 +265,127 @@ class GitignoreTest extends TestCase
                 ['example/test', 'example/example.txt2', 'example/packages/foo.yaml'],
                 ['example/example.txt', 'example/packages', 'example/packages/'],
             ],
+            // based on https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+            [
+                ['**/logs'],
+                ['logs/debug.log', 'logs/monday/foo.bar'],
+                [],
+            ],
+            [
+                ['**/logs/debug.log'],
+                ['logs/debug.log', 'build/logs/debug.log'],
+                ['logs/build/debug.log'],
+            ],
+            [
+                ['*.log'],
+                ['debug.log', 'foo.log', '.log', 'logs/debug.log'],
+                [],
+            ],
+            [
+                [
+                    '*.log',
+                    '!important.log',
+                ],
+                ['debug.log', 'trace.log'],
+                ['important.log', 'logs/important.log'],
+            ],
+            [
+                [
+                    '*.log',
+                    '!important/*.log',
+                    'trace.*',
+                ],
+                ['debug.log', 'important/trace.log'],
+                ['important/debug.log'],
+            ],
+            [
+                ['/debug.log'],
+                ['debug.log'],
+                ['logs/debug.log'],
+            ],
+            [
+                ['debug.log'],
+                ['debug.log', 'logs/debug.log'],
+                [],
+            ],
+            [
+                ['debug?.log'],
+                ['debug0.log', 'debugg.log'],
+                ['debug10.log'],
+            ],
+            [
+                ['debug[0-9].log'],
+                ['debug0.log', 'debug1.log'],
+                ['debug10.log'],
+            ],
+            [
+                ['debug[01].log'],
+                ['debug0.log', 'debug1.log'],
+                ['debug2.log', 'debug01.log'],
+            ],
+            [
+                ['debug[!01].log'],
+                ['debug2.log'],
+                ['debug0.log', 'debug1.log', 'debug01.log'],
+            ],
+            [
+                ['debug[a-z].log'],
+                ['debuga.log', 'debugb.log'],
+                ['debug1.log'],
+            ],
+            [
+                ['logs'],
+                ['logs', 'logs/debug.log', 'logs/latest/foo.bar', 'build/logs', 'build/logs/debug.log'],
+                [],
+            ],
+            [
+                ['logs/'],
+                ['logs/debug.log', 'logs/latest/foo.bar', 'build/logs/foo.bar', 'build/logs/latest/debug.log'],
+                [],
+            ],
+            [
+                [
+                    'logs/',
+                    '!logs/important.log',
+                ],
+                ['logs/debug.log'/* must be pruned on traversal 'logs/important.log'*/],
+                [],
+            ],
+            [
+                ['logs/**/debug.log'],
+                ['logs/debug.log', 'logs/monday/debug.log', 'logs/monday/pm/debug.log'],
+                [],
+            ],
+            [
+                ['logs/*day/debug.log'],
+                ['logs/monday/debug.log', 'logs/tuesday/debug.log'],
+                ['logs/latest/debug.log'],
+            ],
+            [
+                ['logs/debug.log'],
+                ['logs/debug.log'],
+                ['debug.log', 'build/logs/debug.log'],
+            ],
+            [
+                ['*/vendor/*'],
+                ['a/vendor/', 'a/vendor/b', 'a/vendor/b/c'],
+                ['a', 'vendor', 'vendor/', 'a/vendor', 'a/b/vendor', 'a/b/vendor/c'],
+            ],
+            [
+                ['**/vendor/**'],
+                ['vendor/', 'vendor/a', 'vendor/a/b', 'a/b/vendor/c/d'],
+                ['a', 'vendor', 'a/vendor', 'a/b/vendor'],
+            ],
+            [
+                ['***/***/vendor/*****/*****'],
+                ['vendor/', 'vendor/a', 'vendor/a/b', 'a/b/vendor/c/d'],
+                ['a', 'vendor', 'a/vendor', 'a/b/vendor'],
+            ],
+            [
+                ['**vendor**'],
+                ['vendor', 'vendor/', 'vendor/a', 'vendor/a/b', 'a/vendor', 'a/b/vendor', 'a/b/vendor/c/d'],
+                ['a'],
+            ],
         ];
 
         return $cases;