✨ up: update some for fs util and file tree builder

Author: inhere

src/Directory.php

@@ -265,11 +265,11 @@ public static function mkSubDirs(string $parentDir, array $subDirs, int $mode =
     /**
      * Copy dir files, contains sub-dir.
      *
-     * ### $options
+     * ### `$options`
      *
      * - skipExist: bool, whether skip exist file.
-     * - filterFn: callback func on handle each file.
-     * - beforeFn: callback func on before copy file.
+     * - filterFn: callback func on handle each file. return false to skip copy
+     * - beforeFn: callback func on before copy file. return false to skip copy
      * - afterFn: callback func on after copy file.
      *
      * @param string $oldDir source directory path.
@@ -286,7 +286,7 @@ public static function mkSubDirs(string $parentDir, array $subDirs, int $mode =
     public static function copy(string $oldDir, string $newDir, array $options = []): bool
     {
         if (!is_dir($oldDir)) {
-            throw new FileNotFoundException("Copy error: source dir does not exist！path: $oldDir");
+            throw new FileNotFoundException("Copy error: source dir does not exist! path: $oldDir");
         }
 
         self::doCopy($oldDir, $newDir, array_merge([

src/Extra/FileTreeBuilder.php

@@ -5,6 +5,7 @@
 use Toolkit\FsUtil\Dir;
 use Toolkit\FsUtil\File;
 use Toolkit\FsUtil\FS;
+use Toolkit\FsUtil\Path;
 use Toolkit\Stdlib\Helper\Assert;
 use Toolkit\Stdlib\Obj\AbstractObj;
 use Toolkit\Stdlib\Str;
@@ -715,7 +716,7 @@ public function setShowMsg(bool $showMsg): self
      */
     public function setTplDir(string $tplDir): self
     {
-        $this->tplDir = $tplDir;
+        $this->tplDir = Path::format($tplDir, false);
         return $this;
     }
 

src/FileSystem.php

@@ -97,35 +97,29 @@ public static function isRelative(string $path): bool
 
     /**
      * @param string $path
-     * @param array $patterns
+     * @param array $patterns eg: ['*.php', '*.html']
      *
      * @return bool
      */
     public static function isExclude(string $path, array $patterns): bool
     {
-        if (!$patterns) {
-            return false;
-        }
-        return self::isMatch($path, $patterns);
+        return $patterns && self::isMatch($path, $patterns);
     }
 
     /**
      * @param string $path
-     * @param array $patterns
+     * @param array $patterns eg: ['*.php', '*.html']
      *
      * @return bool
      */
     public static function isInclude(string $path, array $patterns): bool
     {
-        if (!$patterns) {
-            return true;
-        }
-        return self::isMatch($path, $patterns);
+        return !$patterns || self::isMatch($path, $patterns);
     }
 
     /**
      * @param string $path
-     * @param array $patterns
+     * @param array $patterns eg: ['*.php', '*.html']
      *
      * @return bool
      */
@@ -154,17 +148,21 @@ public static function getAbsPath(string $path): string
     }
 
     /**
-     * Path format. will replace \ to /, and always end /
+     * Path format. will replace \ to /
      *
      * @param string $dirName
+     * @param bool $endWithSlash set end with slash '/'. default true
      *
      * @return string
      */
-    public static function pathFormat(string $dirName): string
+    public static function pathFormat(string $dirName, bool $endWithSlash = true): string
     {
         $dirName = (string)str_ireplace('\\', '/', trim($dirName));
 
-        return str_ends_with($dirName, '/') ? $dirName : $dirName . '/';
+        if (str_ends_with($dirName, '/')) {
+            return $endWithSlash ? $dirName : substr($dirName, 0, -1);
+        }
+        return $endWithSlash ?  $dirName . '/' : $dirName;
     }
 
     /**

src/Path.php

@@ -31,11 +31,12 @@ public static function isAbsolute(string $path): bool
 
     /**
      * @param string $path
+     * @param bool   $endWithSlash
      *
      * @return string
      */
-    public static function format(string $path): string
+    public static function format(string $path, bool $endWithSlash = true): string
     {
-        return self::pathFormat($path);
+        return self::pathFormat($path, $endWithSlash);
     }
 }

test/FsTest.php

@@ -55,15 +55,15 @@ public function testBasicFsMethods(): void
     public function testIsExclude_isInclude(): void
     {
         $tests = [
-            ['./abc.php', '*', true],
-            ['./abc.php', '*.php', true],
-            ['./abc.php', '*.yml', false],
-            ['path/to/abc.php', '*.php', true],
+            ['./abc.php', ['*'], true],
+            ['./abc.php', ['*.php'], true],
+            ['./abc.php', ['*.yml'], false],
+            ['path/to/abc.php', ['*.php'], true],
         ];
         foreach ($tests as $item) {
-            $this->assertEquals($item[2], FS::isInclude($item[0], [$item[1]]));
-            $this->assertEquals($item[2], FS::isExclude($item[0], [$item[1]]));
-            $this->assertEquals($item[2], FS::isMatch($item[0], [$item[1]]));
+            $this->assertEquals($item[2], FS::isInclude($item[0], $item[1]));
+            $this->assertEquals($item[2], FS::isExclude($item[0], $item[1]));
+            $this->assertEquals($item[2], FS::isMatch($item[0], $item[1]));
         }
 
         $this->assertTrue(FS::isInclude('./abc.php', []));

test/PathTest.php

@@ -27,4 +27,20 @@ public function testPath_isAbs(): void
             $this->assertTrue(Path::isAbsolute($case));
         }
     }
+
+    public function testFormat(): void
+    {
+        $tests = [
+            '/path/to/tmp' => '/path/to/tmp',
+            'C:\tmp' => 'C:/tmp',
+            'C:/path/to/dir' => 'C:/path/to/dir',
+            'C:\\path\\to\\dir' => 'C:/path/to/dir',
+            "path\\to\\dir" => 'path/to/dir',
+        ];
+
+        foreach ($tests as $case => $expect) {
+            $this->assertSame($expect, Path::format($case, false));
+            $this->assertSame($expect . '/', Path::format($case));
+        }
+    }
 }