refactor: Use Symfony's Path instead of a custom function (#806)

Author: theofidry

src/Console/ConsoleScoper.php

@@ -23,12 +23,13 @@
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use Humbug\PhpScoper\Throwable\Exception\ParsingException;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Filesystem\Path;
 use Throwable;
+use Webmozart\Assert\Assert;
 use function array_column;
 use function array_keys;
 use function array_map;
 use function count;
-use function Humbug\PhpScoper\get_common_path;
 use function preg_match as native_preg_match;
 use function Safe\file_get_contents;
 use function Safe\fileperms;
@@ -166,17 +167,22 @@ private static function getFiles(Configuration $config, string $outputDir): arra
         $filesWithContent = $config->getFilesWithContents();
         $excludedFilesWithContents = $config->getExcludedFilesWithContents();
 
-        $commonPath = get_common_path(
-            [
-                ...array_keys($filesWithContent),
-                ...array_keys($excludedFilesWithContents),
-            ],
+        $commonDirectoryPath = Path::getLongestCommonBasePath(
+            ...array_map(
+                static fn (string $path) => Path::getDirectory($path),
+                array_keys($filesWithContent),
+            ),
+            ...array_map(
+                static fn (string $path) => Path::getDirectory($path),
+                array_keys($excludedFilesWithContents),
+            ),
         );
+        Assert::notNull($commonDirectoryPath);
 
         $mapFiles = static fn (array $inputFileTuple) => [
             $inputFileTuple[0],
             $inputFileTuple[1],
-            $outputDir.str_replace($commonPath, '', $inputFileTuple[0]),
+            $outputDir.str_replace($commonDirectoryPath, '', $inputFileTuple[0]),
         ];
 
         return [

src/functions.php

@@ -16,11 +16,7 @@
 
 use Composer\InstalledVersions;
 use Iterator;
-use function array_pop;
-use function count;
-use function str_split;
 use function str_starts_with;
-use function strrpos;
 use function substr;
 
 function get_php_scoper_version(): string
@@ -38,48 +34,6 @@ function get_php_scoper_version(): string
     return $prettyVersion.'@'.$shortCommitHash;
 }
 
-/**
- * @param string[] $paths Absolute paths
- */
-function get_common_path(array $paths): string
-{
-    $nbPaths = count($paths);
-
-    if (0 === $nbPaths) {
-        return '';
-    }
-
-    $pathRef = (string) array_pop($paths);
-
-    if (1 === $nbPaths) {
-        $commonPath = $pathRef;
-    } else {
-        $commonPath = '';
-
-        foreach (str_split($pathRef) as $pos => $char) {
-            foreach ($paths as $path) {
-                if (!isset($path[$pos]) || $path[$pos] !== $char) {
-                    break 2;
-                }
-            }
-
-            $commonPath .= $char;
-        }
-    }
-
-    foreach (['/', '\\'] as $separator) {
-        $lastSeparatorPos = strrpos($commonPath, $separator);
-
-        if (false !== $lastSeparatorPos) {
-            $commonPath = rtrim(substr($commonPath, 0, $lastSeparatorPos), $separator);
-
-            break;
-        }
-    }
-
-    return $commonPath;
-}
-
 function chain(iterable ...$iterables): Iterator
 {
     foreach ($iterables as $iterable) {

tests/FunctionsTest.php

@@ -40,16 +40,6 @@ public function test_it_gets_the_php_scoper_version(): void
         self::assertStringContainsString('@', $version);
     }
 
-    /**
-     * @dataProvider providePaths
-     */
-    public function test_get_the_common_path(array $paths, string $expected): void
-    {
-        $actual = get_common_path($paths);
-
-        self::assertSame($expected, $actual);
-    }
-
     /**
      * @dataProvider provideGenerators
      */
@@ -60,85 +50,6 @@ public function test_it_can_chain_iterators(array $iterators, array $expected):
         self::assertSame($expected, $actual);
     }
 
-    public static function providePaths(): iterable
-    {
-        yield [
-            [],
-            '',
-        ];
-
-        yield [
-            [
-                '/path/to/file',
-            ],
-            '/path/to',
-        ];
-
-        yield [
-            [
-                '/path/to/file',
-                '/path/to/another-file',
-            ],
-            '/path/to',
-        ];
-
-        yield [
-            [
-                '/path/to/file',
-                '/path/to/another-file',
-                '/path/another-to/another-file',
-            ],
-            '/path',
-        ];
-
-        yield [
-            [
-                '/path/to/file',
-                '/another/path/to/another-file',
-            ],
-            '',
-        ];
-
-        yield [
-            [
-                '/file',
-            ],
-            '',
-        ];
-
-        yield [
-            [
-                'C:\\path\\to\\file',
-            ],
-            'C:\\path\\to',
-        ];
-
-        yield [
-            [
-                'C:\\path\\to\\file',
-                'C:\\path\\to\\another-file',
-            ],
-            'C:\\path\\to',
-        ];
-
-        yield [
-            [
-                'C:\\path\\to\\file',
-                'C:\\path\\to\\another-file',
-                'C:\\path\\another-to\\another-file',
-            ],
-            'C:\\path',
-        ];
-
-        yield [
-            [
-                'C:\\path\\to\\file',
-                'D:\\another\\path\\to\\another-file',
-            ],
-            '',
-        ];
-    }
-
     public static function provideGenerators(): iterable
     {
         yield [