deprecate(documentator): `LastDragon_ru\LaraASP\Documentator\Utils\Pa…

…th` (please use `LastDragon_ru\LaraASP\Core\Utils\Path` instead). (#146)
LastDragon-ru · Mar 23, 2024 · d2c7592 · d2c7592
1 parent 3e30a97
commit d2c7592
Show file tree

Hide file tree

Showing 15 changed files with 69 additions and 56 deletions.
diff --git a/packages/core/composer.json b/packages/core/composer.json
@@ -22,6 +22,7 @@
     "illuminate/console": "^10.34.0",
     "illuminate/container": "^10.34.0",
     "illuminate/contracts": "^10.34.0",
+    "symfony/filesystem": "^6.3.0",
     "symfony/polyfill-php83": "^1.28"
   },
   "require-dev": {

diff --git a/packages/core/src/Utils/Path.php b/packages/core/src/Utils/Path.php
@@ -0,0 +1,49 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Core\Utils;
+
+use Symfony\Component\Filesystem\Path as SymfonyPath;
+
+use function dirname;
+use function is_file;
+
+class Path {
+    public static function getPath(string $root, string $path): string {
+        $path = static::isRelative($path)
+            ? static::join(static::getDirname($root), $path)
+            : $path;
+        $path = static::normalize($path);
+
+        return $path;
+    }
+
+    public static function getRelativePath(string $root, string $path): string {
+        $path = static::isRelative($path)
+            ? static::join(static::getDirname($root), $path)
+            : $path;
+        $path = SymfonyPath::makeRelative($path, $root);
+        $path = static::normalize($path);
+
+        return $path;
+    }
+
+    public static function getDirname(string $path): string {
+        return static::normalize(is_file($path) ? dirname($path) : $path);
+    }
+
+    public static function isRelative(string $path): bool {
+        return SymfonyPath::isRelative(static::normalize($path));
+    }
+
+    public static function isAbsolute(string $path): bool {
+        return SymfonyPath::isAbsolute(static::normalize($path));
+    }
+
+    public static function normalize(string $path): string {
+        return SymfonyPath::canonicalize($path);
+    }
+
+    public static function join(string ...$paths): string {
+        return SymfonyPath::join(...$paths);
+    }
+}
diff --git a/packages/documentator/src/Utils/PathTest.php → packages/core/src/Utils/PathTest.php b/packages/documentator/src/Utils/PathTest.php → packages/core/src/Utils/PathTest.php
@@ -1,8 +1,8 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Utils;
+namespace LastDragon_ru\LaraASP\Core\Utils;
 
-use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
+use LastDragon_ru\LaraASP\Core\Testing\Package\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 use function dirname;

diff --git a/packages/documentator/src/Commands/Commands.php b/packages/documentator/src/Commands/Commands.php
@@ -5,10 +5,10 @@
 use Illuminate\Console\Command;
 use Illuminate\Support\Str;
 use LastDragon_ru\LaraASP\Core\Utils\Cast;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Package;
 use LastDragon_ru\LaraASP\Documentator\PackageViewer;
 use LastDragon_ru\LaraASP\Documentator\Utils\ArtisanSerializer;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Filesystem\Filesystem;

diff --git a/packages/documentator/src/Commands/CommandsTest.php b/packages/documentator/src/Commands/CommandsTest.php
@@ -5,8 +5,8 @@
 use Exception;
 use Illuminate\Console\Command;
 use Illuminate\Support\ServiceProvider;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use Override;
 use PHPUnit\Framework\Attributes\CoversClass;
 use Symfony\Component\Console\Attribute\AsCommand;

diff --git a/packages/documentator/src/Commands/Requirements.php b/packages/documentator/src/Commands/Requirements.php
@@ -5,12 +5,12 @@
 use Exception;
 use Illuminate\Console\Command;
 use LastDragon_ru\LaraASP\Core\Utils\Cast;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Metadata\Metadata;
 use LastDragon_ru\LaraASP\Documentator\Metadata\Storage;
 use LastDragon_ru\LaraASP\Documentator\Package;
 use LastDragon_ru\LaraASP\Documentator\PackageViewer;
 use LastDragon_ru\LaraASP\Documentator\Utils\Git;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Utils\Version;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializer;
 use Symfony\Component\Console\Attribute\AsCommand;

diff --git a/packages/documentator/src/Metadata/Storage.php b/packages/documentator/src/Metadata/Storage.php
@@ -2,7 +2,7 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Metadata;
 
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Utils\Version;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializer;
 use Symfony\Component\Serializer\Context\Encoder\JsonEncoderContextBuilder;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludeDocBlock/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludeDocBlock/Instruction.php
@@ -3,10 +3,10 @@
 namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeDocBlock;
 
 use Exception;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotFile;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotValidPhpFile;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 use Override;
 use PhpParser\NameContext;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludeDocumentList/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludeDocumentList/Instruction.php
@@ -2,12 +2,12 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeDocumentList;
 
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\PackageViewer;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\DocumentTitleIsMissing;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotDirectory;
 use LastDragon_ru\LaraASP\Documentator\Utils\Markdown;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 use Override;
 use Symfony\Component\Finder\Finder;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludeExample/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludeExample/Instruction.php
@@ -5,10 +5,10 @@
 use Exception;
 use Illuminate\Container\Container;
 use Illuminate\Process\Factory;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetExecFailed;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotFile;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use Override;
 
 use function dirname;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludeFile/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludeFile/Instruction.php
@@ -2,9 +2,9 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeFile;
 
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ProcessableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotFile;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use Override;
 
 use function dirname;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludePackageList/Instruction.php
@@ -3,14 +3,14 @@
 namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludePackageList;
 
 use Exception;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\PackageViewer;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\DocumentTitleIsMissing;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\PackageComposerJsonIsMissing;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\PackageReadmeIsMissing;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotDirectory;
 use LastDragon_ru\LaraASP\Documentator\Utils\Markdown;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 use Override;
 use Symfony\Component\Finder\Finder;

diff --git a/packages/documentator/src/Preprocessor/Instructions/IncludeTemplate/Instruction.php b/packages/documentator/src/Preprocessor/Instructions/IncludeTemplate/Instruction.php
@@ -2,12 +2,12 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeTemplate;
 
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TargetIsNotFile;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TemplateDataMissed;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TemplateVariablesMissed;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\TemplateVariablesUnused;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 use Override;
 

diff --git a/packages/documentator/src/Preprocessor/Preprocessor.php b/packages/documentator/src/Preprocessor/Preprocessor.php
@@ -4,6 +4,7 @@
 
 use Exception;
 use Illuminate\Container\Container;
+use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Commands\Preprocess;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\ParameterizableInstruction;
@@ -16,7 +17,6 @@
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeFile\Instruction as IncludeFile;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludePackageList\Instruction as IncludePackageList;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeTemplate\Instruction as IncludeTemplate;
-use LastDragon_ru\LaraASP\Documentator\Utils\Path;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializer;
 
 use function array_column;

diff --git a/packages/documentator/src/Utils/Path.php b/packages/documentator/src/Utils/Path.php
@@ -2,48 +2,11 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Utils;
 
-use Symfony\Component\Filesystem\Path as SymfonyPath;
+use LastDragon_ru\LaraASP\Core\Utils\Path as CorePath;
 
-use function dirname;
-use function is_file;
-
-class Path {
-    public static function getPath(string $root, string $path): string {
-        $path = static::isRelative($path)
-            ? static::join(static::getDirname($root), $path)
-            : $path;
-        $path = static::normalize($path);
-
-        return $path;
-    }
-
-    public static function getRelativePath(string $root, string $path): string {
-        $path = static::isRelative($path)
-            ? static::join(static::getDirname($root), $path)
-            : $path;
-        $path = SymfonyPath::makeRelative($path, $root);
-        $path = static::normalize($path);
-
-        return $path;
-    }
-
-    public static function getDirname(string $path): string {
-        return static::normalize(is_file($path) ? dirname($path) : $path);
-    }
-
-    public static function isRelative(string $path): bool {
-        return SymfonyPath::isRelative(static::normalize($path));
-    }
-
-    public static function isAbsolute(string $path): bool {
-        return SymfonyPath::isAbsolute(static::normalize($path));
-    }
-
-    public static function normalize(string $path): string {
-        return SymfonyPath::canonicalize($path);
-    }
-
-    public static function join(string ...$paths): string {
-        return SymfonyPath::join(...$paths);
-    }
+/**
+ * @deprecated ${version} Use {@see CorePath} instead.
+ */
+class Path extends CorePath {
+    // empty
 }