add Filesystem::joinPath

tomasfejfar · tomasfejfar · commit fcc6eaa452e3 · 2019-08-28T21:15:12.000+02:00
diff --git a/src/Symfony/Component/Filesystem/CHANGELOG.md b/src/Symfony/Component/Filesystem/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * support for passing a `null` value to `Filesystem::isAbsolutePath()` is deprecated and will be removed in 5.0
+ * `Filesystem::joinPaths()` added
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -24,6 +24,30 @@ class Filesystem
 {
     private static $lastError;
 
+    /**
+     * @param string[] $pathSegments
+     */
+    public static function joinPaths(...$pathSegments): string
+    {
+        // remove empty segments
+        $pathSegments = array_filter($pathSegments);
+
+        $potentialDirectorySeparators = '/\\';
+        // keep leading separator
+        $first = rtrim(array_shift($pathSegments), $potentialDirectorySeparators);
+        // keep trailing separator
+        $last = ltrim(array_pop($pathSegments), $potentialDirectorySeparators);
+        // trim separators in between
+        $pathSegments = array_map(function ($item) use ($potentialDirectorySeparators) {
+            return trim($item, $potentialDirectorySeparators);
+        }, $pathSegments);
+
+        array_push($pathSegments, $last);
+        array_unshift($pathSegments, $first);
+
+        return implode('/', $pathSegments);
+    }
+
     /**
      * Copies a file.
      *
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -1710,6 +1710,44 @@ public function testCopyShouldKeepExecutionPermission()
         $this->assertFilePermissions(767, $targetFilePath);
     }
 
+    /**
+     * @dataProvider providePathSegmentsForJoin
+     */
+    public function testJoinPath(string $expectedJoinedPath, array $pathSegments): void
+    {
+        $this->assertSame($expectedJoinedPath, \Symfony\Component\Filesystem\Filesystem::joinPaths(...$pathSegments));
+    }
+
+    public function providePathSegmentsForJoin(): array
+    {
+        return [
+            'simple join' => [
+                'etc/init.d',
+                ['etc', 'init.d'],
+            ],
+            'keep heading and trailing separators' => [
+                '/etc/init.d/',
+                ['/etc', 'init.d/'],
+            ],
+            'skip empty' => [
+                'etc/init.d',
+                ['', 'etc', '', '', 'init.d', ''],
+            ],
+            'does not trim heading and trailing separator if respective segments are empty' => [
+                '/etc/init.d/',
+                ['', '/etc', '', '', 'init.d/', ''],
+            ],
+            'trims both types of separators' => [
+                'etc/some/other',
+                ['etc\\', '\\some\\', '\\other'],
+            ],
+            'keeps heading and trailing backslashes' => [
+                '\\etc/init.d\\',
+                ['\\etc', 'init.d\\'],
+            ],
+        ];
+    }
+
     /**
      * Normalize the given path (transform each blackslash into a real directory separator).
      */
