refactor: Introduce a Prefix value object

humbug · Jun 16, 2024 · a786f9b · a786f9b
1 parent fbbcac0
commit a786f9b
Show file tree

Hide file tree

Showing 24 changed files with 180 additions and 72 deletions.
diff --git a/src/Configuration/Configuration.php b/src/Configuration/Configuration.php
@@ -16,16 +16,10 @@
 
 use Humbug\PhpScoper\Configuration\Throwable\InvalidConfigurationValue;
 use Humbug\PhpScoper\Patcher\Patcher;
-use function Safe\preg_match;
 
 final class Configuration
 {
-    private const PREFIX_PATTERN = '/^[\p{L}\d_\\\\]+$/u';
-
-    /**
-     * @var non-empty-string
-     */
-    private readonly string $prefix;
+    private readonly Prefix $prefix;
 
     /**
      * @param non-empty-string|null                $path                      Absolute canonical path to the configuration file loaded.
@@ -43,15 +37,15 @@ final class Configuration
     public function __construct(
         private ?string $path,
         private ?string $outputDir,
-        string $prefix,
+        string|Prefix $prefix,
         private array $filesWithContents,
         private array $excludedFilesWithContents,
         private Patcher $patcher,
         private SymbolsConfiguration $symbolsConfiguration
     ) {
-        self::validatePrefix($prefix);
-
-        $this->prefix = $prefix;
+        $this->prefix = $prefix instanceof Prefix
+            ? $prefix
+            : new Prefix($prefix);
     }
 
     /**
@@ -89,9 +83,9 @@ public function withPrefix(string $prefix): self
     }
 
     /**
-     * @return non-empty-string
+     * @return non-empty-string|Prefix
      */
-    public function getPrefix(): string
+    public function getPrefix(): string|Prefix
     {
         return $this->prefix;
     }
@@ -150,15 +144,4 @@ public function getSymbolsConfiguration(): SymbolsConfiguration
     {
         return $this->symbolsConfiguration;
     }
-
-    private static function validatePrefix(string $prefix): void
-    {
-        if (1 !== preg_match(self::PREFIX_PATTERN, $prefix)) {
-            throw InvalidConfigurationValue::forInvalidPrefixPattern($prefix);
-        }
-
-        if (preg_match('/\\\{2,}/', $prefix)) {
-            throw InvalidConfigurationValue::forInvalidNamespaceSeparator($prefix);
-        }
-    }
 }
diff --git a/src/Configuration/Prefix.php b/src/Configuration/Prefix.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <[email protected]>,
+ *                    Pádraic Brady <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Humbug\PhpScoper\Configuration;
+
+use Stringable;
+
+final readonly class Prefix implements Stringable
+{
+    public function __construct(private string $prefix)
+    {
+        PrefixValidator::validate($this->prefix);
+    }
+
+    public function __toString(): string
+    {
+        return $this->prefix;
+    }
+
+    public function toString(): string
+    {
+        return (string) $this;
+    }
+}
diff --git a/src/Configuration/PrefixValidator.php b/src/Configuration/PrefixValidator.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <[email protected]>,
+ *                    Pádraic Brady <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Humbug\PhpScoper\Configuration;
+
+use Humbug\PhpScoper\Configuration\Throwable\InvalidConfigurationValue;
+use function Safe\preg_match;
+
+final class PrefixValidator
+{
+    private const PREFIX_PATTERN = '/^[\p{L}\d_\\\\]+$/u';
+
+    /**
+     * @phpstan-assert non-empty-string $prefix
+     *
+     * @throws InvalidConfigurationValue
+     */
+    public static function validate(string $prefix): void
+    {
+        if (1 !== preg_match(self::PREFIX_PATTERN, $prefix)) {
+            throw InvalidConfigurationValue::forInvalidPrefixPattern($prefix);
+        }
+
+        if (preg_match('/\\\{2,}/', $prefix)) {
+            throw InvalidConfigurationValue::forInvalidNamespaceSeparator($prefix);
+        }
+    }
+}
diff --git a/src/Console/ScoperLogger.php b/src/Console/ScoperLogger.php
@@ -16,6 +16,7 @@
 
 use Fidry\Console\Application\Application as FidryApplication;
 use Fidry\Console\IO;
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\Throwable\Exception\ParsingException;
 use PHPUnit\Framework\Attributes\CodeCoverageIgnore;
 use Symfony\Component\Console\Helper\ProgressBar;
@@ -49,7 +50,7 @@ public function __construct(
     /**
      * @param string[] $paths
      */
-    public function outputScopingStart(?string $prefix, array $paths): void
+    public function outputScopingStart(Prefix|string|null $prefix, array $paths): void
     {
         $this->io->writeln($this->application->getHelp());
 

diff --git a/src/Patcher/Patcher.php b/src/Patcher/Patcher.php
@@ -14,6 +14,9 @@
 
 namespace Humbug\PhpScoper\Patcher;
 
+/**
+ * @phpstan-type PatcherCallable callable(string, string, string): string
+ */
 interface Patcher
 {
     public function __invoke(string $filePath, string $prefix, string $contents): string;

diff --git a/src/Patcher/PatcherChain.php b/src/Patcher/PatcherChain.php
@@ -16,10 +16,13 @@
 
 use function array_reduce;
 
+/**
+ * @phpstan-import-type PatcherCallable from Patcher
+ */
 final readonly class PatcherChain implements Patcher
 {
     /**
-     * @param array<(callable(string, string, string): string)|Patcher> $patchers
+     * @param array<PatcherCallable|Patcher> $patchers
      */
     public function __construct(private array $patchers = [])
     {

diff --git a/src/PhpParser/Node/FullyQualifiedFactory.php b/src/PhpParser/Node/FullyQualifiedFactory.php
@@ -18,18 +18,19 @@
 use InvalidArgumentException;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
+use Stringable;
 
 final class FullyQualifiedFactory
 {
     use NotInstantiable;
 
     /**
-     * @param string|Name|string[]|null $name1
-     * @param string|Name|string[]|null $name2
+     * @param string|Name|string[]|Stringable|null $name1
+     * @param string|Name|string[]|Stringable|null $name2
      */
     public static function concat(
-        array|Name|string|null $name1,
-        array|Name|string|null $name2,
+        array|Name|string|Stringable|null $name1,
+        array|Name|string|Stringable|null $name2,
         ?array $attributes = null,
     ): FullyQualified {
         if (null === $name1 && null === $name2) {
@@ -38,6 +39,9 @@ public static function concat(
 
         $newAttributes = NameFactory::getConcatenatedNamesAttributes($name1, $name2, $attributes);
 
+        $name1 = $name1 instanceof Stringable ? (string) $name1 : $name1;
+        $name2 = $name2 instanceof Stringable ? (string) $name2 : $name2;
+
         return FullyQualified::concat($name1, $name2, $newAttributes);
     }
 }
diff --git a/src/PhpParser/Node/NameFactory.php b/src/PhpParser/Node/NameFactory.php
@@ -17,6 +17,7 @@
 use Humbug\PhpScoper\NotInstantiable;
 use InvalidArgumentException;
 use PhpParser\Node\Name;
+use Stringable;
 
 final class NameFactory
 {
@@ -41,12 +42,12 @@ public static function concat(
     }
 
     /**
-     * @param string|string[]|Name|null $name1
-     * @param string|string[]|Name|null $name2
+     * @param string|Stringable|string[]|Name|null $name1
+     * @param string|Stringable|string[]|Name|null $name2
      */
     public static function getConcatenatedNamesAttributes(
-        string|array|Name|null $name1,
-        string|array|Name|null $name2,
+        string|Stringable|array|Name|null $name1,
+        string|Stringable|array|Name|null $name2,
         ?array $attributes = null,
     ): array {
         return match (true) {

diff --git a/src/PhpParser/NodeVisitor/ClassIdentifierRecorder.php b/src/PhpParser/NodeVisitor/ClassIdentifierRecorder.php
@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
@@ -35,7 +36,7 @@
 final class ClassIdentifierRecorder extends NodeVisitorAbstract
 {
     public function __construct(
-        private readonly string $prefix,
+        private readonly Prefix $prefix,
         private readonly IdentifierResolver $identifierResolver,
         private readonly SymbolsRegistry $symbolsRegistry,
         private readonly EnrichedReflector $enrichedReflector,

diff --git a/src/PhpParser/NodeVisitor/ExcludedFunctionExistsEnricher.php b/src/PhpParser/NodeVisitor/ExcludedFunctionExistsEnricher.php
@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use PhpParser\Node\Arg;
@@ -57,7 +58,7 @@
 final class ExcludedFunctionExistsEnricher extends NodeVisitorAbstract
 {
     public function __construct(
-        private readonly string $prefix,
+        private readonly Prefix $prefix,
         private readonly ExcludedFunctionExistsStringNodeStack $excludedFunctionExistsStringNodeStack,
     ) {
     }
@@ -76,7 +77,7 @@ public function afterTraverse(array $nodes): array
         return $nodes;
     }
 
-    private static function addScopedFunctionExistsCondition(string $prefix, String_ $string): void
+    private static function addScopedFunctionExistsCondition(Prefix $prefix, String_ $string): void
     {
         $parentNodes = self::findFlattenedParentIfStmt($string);
 
@@ -154,7 +155,7 @@ private static function findFlattenedParentIfStmt(String_ $string): ?array
     }
 
     private static function replaceCondition(
-        string $prefix,
+        Prefix $prefix,
         If_ $ifStmt,
         BooleanAnd|BooleanOr|null $ifCondition,
         BooleanNot|Equal|Identical $boolExpr,
@@ -217,11 +218,11 @@ private static function createNewArgument(Arg $previous, String_ $string): Arg
         return $newArg;
     }
 
-    private static function prefixString(string $prefix, String_ $previous): String_
+    private static function prefixString(Prefix $prefix, String_ $previous): String_
     {
         return new String_(
             (string) FullyQualified::concat(
-                $prefix,
+                $prefix->toString(),
                 $previous->value,
             ),
             $previous->getAttributes(),

diff --git a/src/PhpParser/NodeVisitor/FunctionIdentifierRecorder.php b/src/PhpParser/NodeVisitor/FunctionIdentifierRecorder.php
@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
@@ -38,7 +39,7 @@
 final class FunctionIdentifierRecorder extends NodeVisitorAbstract
 {
     public function __construct(
-        private readonly string $prefix,
+        private readonly Prefix $prefix,
         private readonly IdentifierResolver $identifierResolver,
         private readonly SymbolsRegistry $symbolsRegistry,
         private readonly EnrichedReflector $enrichedReflector,

diff --git a/src/PhpParser/NodeVisitor/NameStmtPrefixer.php b/src/PhpParser/NodeVisitor/NameStmtPrefixer.php
@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt\NamespaceStmtCollection;
@@ -95,7 +96,7 @@ final class NameStmtPrefixer extends NodeVisitorAbstract
     ];
 
     public function __construct(
-        private readonly string $prefix,
+        private readonly Prefix $prefix,
         private readonly NamespaceStmtCollection $namespaceStatements,
         private readonly UseStmtCollection $useStatements,
         private readonly EnrichedReflector $enrichedReflector,
@@ -233,7 +234,7 @@ private function isNamePrefixable(Name $resolvedName): bool
             return false;
         }
 
-        $isAlreadyPrefixed = $this->prefix === $resolvedName->getFirst();
+        $isAlreadyPrefixed = $this->prefix->toString() === $resolvedName->getFirst();
 
         return (
             $isAlreadyPrefixed

diff --git a/src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceStmtPrefixer.php b/src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceStmtPrefixer.php
@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt;
 
+use Humbug\PhpScoper\Configuration\Prefix;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use PhpParser\Node;
 use PhpParser\Node\Name;
@@ -38,7 +39,7 @@
 final class NamespaceStmtPrefixer extends NodeVisitorAbstract
 {
     public function __construct(
-        private readonly string $prefix,
+        private readonly Prefix $prefix,
         private readonly EnrichedReflector $enrichedReflector,
         private readonly NamespaceStmtCollection $namespaceStatements,
     ) {
@@ -75,11 +76,11 @@ private function shouldPrefixStmt(Namespace_ $namespace): bool
         return $this->prefix !== $nameFirstPart;
     }
 
-    private static function prefixStmt(Namespace_ $namespace, string $prefix): void
+    private static function prefixStmt(Namespace_ $namespace, Prefix $prefix): void
     {
         $originalName = $namespace->name;
 
-        $namespace->name = Name::concat($prefix, $originalName);
+        $namespace->name = Name::concat($prefix->toString(), $originalName);
 
         NamespaceManipulator::setOriginalName($namespace, $originalName);
     }