Make prefix non-nullable (#485)

Author: theofidry

src/Configuration.php

@@ -29,6 +29,7 @@
 use function array_reduce;
 use function array_unique;
 use function array_unshift;
+use function bin2hex;
 use function dirname;
 use function file_exists;
 use function gettype;
@@ -42,6 +43,7 @@
 use function is_readable;
 use function is_string;
 use function iterator_to_array;
+use function random_bytes;
 use function realpath as native_realpath;
 use function Safe\file_get_contents;
 use function Safe\preg_match;
@@ -73,7 +75,7 @@ final class Configuration
     ];
 
     private ?string $path;
-    private ?string $prefix;
+    private string $prefix;
     private array $filesWithContents;
     private array $patchers;
     private Whitelist $whitelist;
@@ -150,19 +152,22 @@ public static function load(string $path = null, array $paths = []): self
     }
 
     /**
-     * @param string|null $path              Absolute path to the configuration file loaded.
-     * @param string|null $prefix            The prefix applied.
-     * @param string[][]  $filesWithContents Array of tuple with the first argument being the file path and the second its contents
-     * @param callable[]  $patchers          List of closures which can alter the content of the files being
-     *                                       scoped.
-     * @param Whitelist   $whitelist         List of classes that will not be scoped.
-     *                                       returning a boolean which if `true` means the class should be scoped
-     *                                       (i.e. is ignored) or scoped otherwise.
-     * @param string[]    $whitelistedFiles  List of absolute paths of files to completely ignore
+     * @param string|null $path                   Absolute path to the configuration file loaded.
+     * @param string      $prefix                 The prefix applied.
+     * @param string[][]  $filesWithContents      Array of tuple with the first argument being the
+     *                                            file path and the second its contents
+     * @param callable[]  $patchers               List of closures which can alter the content of
+     *                                            the files being scoped.
+     * @param Whitelist   $whitelist              List of classes that will not be scoped.
+     *                                            returning a boolean which if `true` means the
+     *                                            class should be scoped
+     *                                            (i.e. is ignored) or scoped otherwise.
+     * @param string[]    $whitelistedFiles       List of absolute paths of files to completely
+     *                                            ignore
      */
     private function __construct(
         ?string $path,
-        ?string $prefix,
+        string $prefix,
         array $filesWithContents,
         array $patchers,
         Whitelist $whitelist,
@@ -215,7 +220,7 @@ public function getPath(): ?string
         return $this->path;
     }
 
-    public function getPrefix(): ?string
+    public function getPrefix(): string
     {
         return $this->prefix;
     }
@@ -266,24 +271,18 @@ private static function validateConfigKey(string $key): void
         }
     }
 
-    /**
-     * If the prefix is set to null in the config file/argument then a random prefix is being used. However if set to
-     * empty, the configuration will use a null prefix.
-     *
-     * TL:DR; setting the prefix is a big confusing because it is not properly split in "set prefix" & prefix strategy".
-     */
-    private static function retrievePrefix(array $config): ?string
+    private static function retrievePrefix(array $config): string
     {
         $prefix = $config[self::PREFIX_KEYWORD] ?? null;
 
         if (null === $prefix) {
-            return null;
+            return self::generateRandomPrefix();
         }
 
         $prefix = trim($prefix);
 
         if ('' === $prefix) {
-            return null;
+            return self::generateRandomPrefix();
         }
 
         if (1 === preg_match('/^[\p{L}\d_]+$/u', $prefix)) {
@@ -569,4 +568,9 @@ static function (array $files, SplFileInfo $fileInfo): array {
             []
         );
     }
+
+    private static function generateRandomPrefix(): string
+    {
+        return '_PhpScoper'.bin2hex(random_bytes(6));
+    }
 }

src/Console/ConfigLoader.php

@@ -196,10 +196,6 @@ private static function configurePrefix(Configuration $config, string $prefix):
             return $config->withPrefix($prefix);
         }
 
-        if (null === $config->getPrefix()) {
-            return $config->withPrefix(self::generateRandomPrefix());
-        }
-
         return $config;
     }
 
@@ -217,11 +213,6 @@ private static function configurePaths(
         return $config;
     }
 
-    private static function generateRandomPrefix(): string
-    {
-        return '_PhpScoper'.bin2hex(random_bytes(6));
-    }
-
     private function makeAbsolutePath(
         string $path,
         string $cwd

src/Console/ConsoleScoper.php

@@ -169,7 +169,7 @@ private function scopeFile(
             $scoppedContent = $this->scoper->scope(
                 $inputFilePath,
                 $inputContents,
-                (string) $config->getPrefix(),
+                $config->getPrefix(),
                 $config->getPatchers(),
                 $config->getWhitelist(),
             );

tests/ConfigurationTest.php

@@ -35,7 +35,7 @@ public function test_it_can_be_created_without_a_file(): void
             $configuration->getWhitelist()
         );
         $this->assertNull($configuration->getPath());
-        $this->assertNull($configuration->getPrefix());
+        $this->assertMatchesRegularExpression('/_PhpScoper[a-z\d]{12}/', $configuration->getPrefix());
         $this->assertSame([], $configuration->getFilesWithContents());
         $this->assertEquals([new SymfonyPatcher()], $configuration->getPatchers());
     }