Libs update (#18)

marvin255 · web-flow · commit 3c66afb59b72 · 2023-08-19T19:00:13.000+02:00
* Remove useless php-doc tags

* Add php 8.2 to actions

* Update phpUnit to v10

* Make some test function static

* Fix path creating functions

* Fix testRemoveIfExists

* Fix testCopyFile

* Fix testCopyDir

* Fix testRenameDir

* Fix testRenameFile

* Fix testMkDir

* Fix testMkDirIfNotExist

* Fix testEmptyDir

* Fix all others

* Remove infection exception
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php-versions: ['8.1']
+        php-versions: ['8.1', '8.2']
 
     steps:
     - uses: actions/checkout@v2
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -15,7 +15,7 @@
     ],
     'yoda_style' => false,
     'phpdoc_no_empty_return' => false,
-    'no_superfluous_phpdoc_tags' => false,
+    'no_superfluous_phpdoc_tags' => true,
     'single_line_throw' => false,
     'array_indentation' => true,
     'declare_strict_types' => true,
diff --git a/composer.json b/composer.json
@@ -8,11 +8,10 @@
     "php": ">=8.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.0",
+    "phpunit/phpunit": "^10.0",
     "friendsofphp/php-cs-fixer": "^3.0",
-    "sebastian/phpcpd": "^6.0",
     "vimeo/psalm": "^5.0",
-    "infection/infection": "^0.26.13"
+    "infection/infection": "^0.27"
   },
   "autoload": {
     "psr-4": {
@@ -36,7 +35,6 @@
     ],
     "linter": [
       "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vv --allow-risky=yes --dry-run --stop-on-violation",
-      "vendor/bin/phpcpd ./ --exclude vendor --exclude tests",
       "vendor/bin/psalm --show-info=true --php-version=$(php -r \"echo phpversion();\")"
     ],
     "infection": [
diff --git a/docker/php/Dockerfile b/docker/php/Dockerfile
@@ -12,10 +12,11 @@ RUN set -xe && apk update && apk add --no-cache \
     git \
     autoconf \
     g++ \
-    make
+    make \
+    linux-headers
 
 
-RUN docker-php-ext-install zip soap \
+RUN docker-php-ext-install zip opcache \
     && docker-php-source extract \
     && pecl install xdebug \
     && docker-php-ext-enable xdebug \
@@ -24,7 +25,7 @@ RUN docker-php-ext-install zip soap \
     && echo 'xdebug.mode=coverage' >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
 
 
-RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer  --version=2.4.2 \
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer  --version=2.5.8 \
     && mkdir -p /.composer && chmod -Rf 777 /.composer
 
 
diff --git a/infection.json b/infection.json
@@ -17,21 +17,6 @@
                 "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::rename",
                 "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::runPhpFunction"
             ]
-        },
-        "LogicalOr": {
-            "ignore": [
-                "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::getTmpDir"
-            ]
-        },
-        "TrueValue": {
-            "ignore": [
-                "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::mkdir"
-            ]
-        },
-        "ArrayItemRemoval": {
-            "ignore": [
-                "Marvin255\\FileSystemHelper\\Helper\\PathHelper::fixDirectorySeparatorAndTrim"
-            ]
         }
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,13 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./vendor/autoload.php" executionOrder="random" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory>./src</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./vendor/autoload.php" executionOrder="random" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd">
+  <coverage/>
   <testsuites>
     <testsuite name="File system helper tests suite">
       <directory>./tests</directory>
     </testsuite>
   </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Exception/FileSystemException.php b/src/Exception/FileSystemException.php
@@ -6,6 +6,8 @@
 
 /**
  * Exception class for errors in file helper.
+ *
+ * @psalm-api
  */
 final class FileSystemException extends \Exception
 {
@@ -17,10 +19,7 @@ private function __construct(string $message = '')
     /**
      * Creates FileSystemException.
      *
-     * @param string                          $message
      * @param array<int, \SplFileInfo|string> $params
-     *
-     * @return FileSystemException
      */
     public static function create(string $message, ...$params): FileSystemException
     {
diff --git a/src/FileSystemFactory.php b/src/FileSystemFactory.php
@@ -6,6 +6,8 @@
 
 /**
  * Factory object for file system helper.
+ *
+ * @psalm-api
  */
 final class FileSystemFactory
 {
@@ -15,12 +17,8 @@ private function __construct()
 
     /**
      * Creates new FileSystemHelperInterface instance with default settings.
-     *
-     * @param string|null $baseFolder
-     *
-     * @return FileSystemHelper
      */
-    public static function create(?string $baseFolder = null): FileSystemHelper
+    public static function create(string $baseFolder = null): FileSystemHelper
     {
         return new FileSystemHelperImpl($baseFolder);
     }
diff --git a/src/FileSystemHelperImpl.php b/src/FileSystemHelperImpl.php
@@ -16,7 +16,7 @@ final class FileSystemHelperImpl implements FileSystemHelper
 {
     private readonly ?string $baseFolder;
 
-    public function __construct(?string $baseFolder = null)
+    public function __construct(string $baseFolder = null)
     {
         $validatedBaseFolder = null;
 
@@ -342,7 +342,6 @@ private function makeFileInfoAndCheckBasePath(\SplFileInfo|string $data): \SplFi
     /**
      * Runs set php function in try/catch.
      *
-     * @param string  $functionName
      * @param mixed[] $params
      *
      * @throws FileSystemException
diff --git a/src/Helper/PathHelper.php b/src/Helper/PathHelper.php
@@ -6,6 +6,8 @@
 
 /**
  * Set of functions for working with file paths.
+ *
+ * @internal
  */
 final class PathHelper
 {
@@ -64,8 +66,7 @@ public static function unifyPath(string $path): string
             }
         }
 
-        return ($hasLeadingSlash ? \DIRECTORY_SEPARATOR : '')
-            . implode(\DIRECTORY_SEPARATOR, $absolutes);
+        return ($hasLeadingSlash ? \DIRECTORY_SEPARATOR : '') . implode(\DIRECTORY_SEPARATOR, $absolutes);
     }
 
     /**
diff --git a/tests/BaseCase.php b/tests/BaseCase.php
@@ -13,96 +13,73 @@
  */
 abstract class BaseCase extends TestCase
 {
-    private ?string $tempDir = null;
-
-    protected function tearDown(): void
-    {
-        if ($this->tempDir) {
-            $this->removeDir($this->tempDir);
-        }
-
-        parent::tearDown();
-    }
-
     /**
      * Returns path to temporary folder.
      */
-    protected function getTempDir(): string
+    protected static function getTempDir(): string
     {
-        if ($this->tempDir === null) {
-            $this->tempDir = sys_get_temp_dir();
-            if (!$this->tempDir || !is_writable($this->tempDir)) {
-                throw new \RuntimeException(
-                    "Can't find or write temporary folder: {$this->tempDir}"
-                );
-            }
-            $this->tempDir .= \DIRECTORY_SEPARATOR . md5(random_bytes(20));
-            $this->removeDir($this->tempDir);
-            if (!mkdir($this->tempDir, 0777, true)) {
-                throw new \RuntimeException(
-                    "Can't create temporary folder: {$this->tempDir}"
-                );
-            }
+        $tmpDir = sys_get_temp_dir();
+
+        if (!$tmpDir || !is_writable($tmpDir)) {
+            throw new \RuntimeException(
+                "Can't find or write temporary folder: {$tmpDir}"
+            );
+        }
+
+        $tmpDir .= \DIRECTORY_SEPARATOR . 'file_system_helper_test';
+
+        if (!is_dir($tmpDir) && !mkdir($tmpDir, 0777, true)) {
+            throw new \RuntimeException(
+                "Can't create temporary folder: {$tmpDir}"
+            );
         }
 
-        return $this->tempDir;
+        return $tmpDir;
     }
 
     /**
      * Creates new directory for test and returns it's absolute path.
+     *
+     * @psalm-param string[]|string[][] $parts
      */
-    protected function getPathToTestDir(string $name = ''): string
+    protected static function getPathToTestDir(...$parts): string
     {
-        if ($name === '') {
-            $name = md5(random_bytes(10));
-        }
-
-        if (strpos($name, $this->getTempDir() . \DIRECTORY_SEPARATOR) === 0) {
-            $pathToFolder = $name;
-        } else {
-            $pathToFolder = $this->getTempDir() . \DIRECTORY_SEPARATOR . $name;
-        }
+        $path = self::convertPartsToPath(...$parts);
 
-        if (!file_exists($pathToFolder) && !mkdir($pathToFolder, 0777, true)) {
-            throw new \RuntimeException("Can't create {$pathToFolder} folder");
+        if (!is_dir($path) && !mkdir($path, 0777, true)) {
+            throw new \RuntimeException("Can't create {$path} folder");
         }
 
-        return $pathToFolder;
+        return $path;
     }
 
     /**
      * Creates file within temporary folder.
+     *
+     * @psalm-param string[]|string[][] $parts
      */
-    protected function getPathToTestFile(string $name = '', ?string $content = null): string
+    protected static function getPathToTestFile(...$parts): string
     {
-        if ($name === '') {
-            $name = md5(random_bytes(10)) . '.txt';
-        }
+        $content = md5(random_bytes(10));
+        $dir = self::getPathToTestDir(...$parts);
+        $file = $dir . \DIRECTORY_SEPARATOR . md5(random_bytes(10)) . '.txt';
 
-        if (strpos($name, $this->getTempDir()) === 0) {
-            $pathToFile = $name;
-        } else {
-            $pathToFile = $this->getTempDir() . \DIRECTORY_SEPARATOR . $name;
+        if (file_put_contents($file, $content) === false) {
+            throw new \RuntimeException("Can't create file {$file}");
         }
 
-        $dir = pathinfo($pathToFile, \PATHINFO_DIRNAME);
-        if (!file_exists($dir) && !mkdir($dir, 0777, true)) {
-            throw new \RuntimeException("Can't create folder {$dir} for the tests file {$name}");
-        }
-
-        $content = $content === null ? md5(random_bytes(10)) : $content;
-        if (file_put_contents($pathToFile, $content) === false) {
-            throw new \RuntimeException("Can't create file {$pathToFile}");
-        }
-
-        return $pathToFile;
+        return $file;
     }
 
     /**
      * Removes set dir with all content.
+     *
+     * @psalm-param string[]|string[][] $parts
      */
-    protected function removeDir(string $folderPath): void
+    protected static function clearDir(...$parts): void
     {
+        $folderPath = self::convertPartsToPath(...$parts);
+
         if (is_dir($folderPath)) {
             $it = new \RecursiveDirectoryIterator(
                 $folderPath,
@@ -127,7 +104,7 @@ protected function removeDir(string $folderPath): void
     /**
      * Converts SplFileInfo to string and change delimeters to the set one.
      */
-    protected function convertPathToString(\SplFileInfo|string $path, string $delimeter = \DIRECTORY_SEPARATOR): string
+    protected static function convertPathToString(\SplFileInfo|string $path, string $delimeter = \DIRECTORY_SEPARATOR): string
     {
         $pathStr = $path instanceof \SplFileInfo ? $path->getPathname() : $path;
 
@@ -137,7 +114,7 @@ protected function convertPathToString(\SplFileInfo|string $path, string $delime
     /**
      * Converts string to SplFileInfo.
      */
-    protected function convertPathToSpl(\SplFileInfo|string $path): \SplFileInfo
+    protected static function convertPathToSpl(\SplFileInfo|string $path): \SplFileInfo
     {
         if ($path instanceof \SplFileInfo) {
             return $path;
@@ -146,12 +123,43 @@ protected function convertPathToSpl(\SplFileInfo|string $path): \SplFileInfo
         return new \SplFileInfo($path);
     }
 
+    /**
+     * @psalm-param string[]|string[][] $parts
+     */
+    private static function convertPartsToPath(...$parts): string
+    {
+        $flattenParts = [];
+        foreach ($parts as $part) {
+            if (\is_array($part)) {
+                $flattenParts = array_merge($flattenParts, $part);
+            } else {
+                $flattenParts[] = $part;
+            }
+        }
+
+        $preparedParts = [self::getTempDir()];
+        foreach ($flattenParts as $part) {
+            $preparedPart = trim($part);
+            $preparedPart = mb_strtolower($part);
+            $preparedPart = str_replace([' ', '\\', '/', '.', ','], '_', $preparedPart);
+            if ($preparedPart !== '') {
+                $preparedParts[] = $preparedPart;
+            }
+        }
+
+        if (\count($preparedParts) < 2) {
+            throw new \RuntimeException('Parts for path must be provided');
+        }
+
+        return implode(\DIRECTORY_SEPARATOR, $preparedParts);
+    }
+
     /**
      * Assertion that checks that directory has set permissions.
      */
     protected function assertDirectoryHasPermissions(int $awaitedPermissions, \SplFileInfo|string $directory): void
     {
-        $directory = $this->convertPathToString($directory);
+        $directory = self::convertPathToString($directory);
         $awaitedPermissions = sprintf('%o', $awaitedPermissions);
         $realPermissions = substr(sprintf('%o', fileperms($directory)), -3);
         $this->assertSame($awaitedPermissions, $realPermissions, 'Directory has correct permissions');
diff --git a/tests/FileSystemHelperImplTest.php b/tests/FileSystemHelperImplTest.php
diff --git a/tests/Helper/PathHelperTest.php b/tests/Helper/PathHelperTest.php

Original file line number	Diff line number	Diff line change
`@@ -17,21 +17,6 @@`
`17`	`17`	`"Marvin255\\FileSystemHelper\\FileSystemHelperImpl::rename",`
`18`	`18`	`"Marvin255\\FileSystemHelper\\FileSystemHelperImpl::runPhpFunction"`
`19`	`19`	`]`
`20`		`- },`
`21`		`- "LogicalOr": {`
`22`		`- "ignore": [`
`23`		`- "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::getTmpDir"`
`24`		`- ]`
`25`		`- },`
`26`		`- "TrueValue": {`
`27`		`- "ignore": [`
`28`		`- "Marvin255\\FileSystemHelper\\FileSystemHelperImpl::mkdir"`
`29`		`- ]`
`30`		`- },`
`31`		`- "ArrayItemRemoval": {`
`32`		`- "ignore": [`
`33`		`- "Marvin255\\FileSystemHelper\\Helper\\PathHelper::fixDirectorySeparatorAndTrim"`
`34`		`- ]`
`35`	`20`	`}`
`36`	`21`	`}`
`37`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Exception class for errors in file helper.`
	`9`	`+ *`
	`10`	`+ * @psalm-api`
`9`	`11`	`*/`
`10`	`12`	`final class FileSystemException extends \Exception`
`11`	`13`	`{`
`@@ -17,10 +19,7 @@ private function __construct(string $message = '')`
`17`	`19`	`/**`
`18`	`20`	`* Creates FileSystemException.`
`19`	`21`	`*`
`20`		`- * @param string $message`
`21`	`22`	`* @param array<int, \SplFileInfo\|string> $params`
`22`		`- *`
`23`		`- * @return FileSystemException`
`24`	`23`	`*/`
`25`	`24`	`public static function create(string $message, ...$params): FileSystemException`
`26`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ final class FileSystemHelperImpl implements FileSystemHelper`
`16`	`16`	`{`
`17`	`17`	`private readonly ?string $baseFolder;`
`18`	`18`
`19`		`- public function __construct(?string $baseFolder = null)`
	`19`	`+ public function __construct(string $baseFolder = null)`
`20`	`20`	`{`
`21`	`21`	`$validatedBaseFolder = null;`
`22`	`22`
`@@ -342,7 +342,6 @@ private function makeFileInfoAndCheckBasePath(\SplFileInfo\|string $data): \SplFi`
`342`	`342`	`/**`
`343`	`343`	`* Runs set php function in try/catch.`
`344`	`344`	`*`
`345`		`- * @param string $functionName`
`346`	`345`	`* @param mixed[] $params`
`347`	`346`	`*`
`348`	`347`	`* @throws FileSystemException`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Set of functions for working with file paths.`
	`9`	`+ *`
	`10`	`+ * @internal`
`9`	`11`	`*/`
`10`	`12`	`final class PathHelper`
`11`	`13`	`{`
`@@ -64,8 +66,7 @@ public static function unifyPath(string $path): string`
`64`	`66`	`}`
`65`	`67`	`}`
`66`	`68`
`67`		`- return ($hasLeadingSlash ? \DIRECTORY_SEPARATOR : '')`
`68`		`- . implode(\DIRECTORY_SEPARATOR, $absolutes);`
	`69`	`+ return ($hasLeadingSlash ? \DIRECTORY_SEPARATOR : '') . implode(\DIRECTORY_SEPARATOR, $absolutes);`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`/**`