Make the prefix configurable (#202)

Closes #178
humbug · May 12, 2018 · a095ee2 · a095ee2
2 parents 8abd8de + fe77969
commit a095ee2
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ potentially very difficult to debug due to dissimilar or unsupported package ver
     - [PHAR](#phar)
     - [Composer](#composer)
 - [Configuration](#configuration)
+    - [Prefix](#prefix)
     - [Finders and paths](#finders-and-paths)
     - [Patchers](#patchers)
     - [Whitelist][whitelist]
@@ -122,14 +123,20 @@ with a `--config` option.
 use Isolated\Symfony\Component\Finder\Finder;
 
 return [
+    'prefix' => null,
     'finders' => [],
     'patchers' => [],
-    'global_namespace_whitelist' => [],
     'whitelist' => [],
 ];
 ```
 
 
+### Prefix
+
+The prefix to be used to isolate the code. If `null` or `'''` is given, then a random
+prefix will be automatically be generated.
+
+
 ### Finders and paths
 
 By default when running `php-scoper add-prefix`, it will prefix all relevant

diff --git a/scoper.inc.php b/scoper.inc.php
@@ -15,6 +15,7 @@
 use Isolated\Symfony\Component\Finder\Finder;
 
 return [
+    'prefix' => 'Foo',
     'whitelist' => [
         Finder::class,
     ],

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -31,14 +31,12 @@ class Configuration
     private const FINDER_KEYWORD = 'finders';
     private const PATCHERS_KEYWORD = 'patchers';
     private const WHITELIST_KEYWORD = 'whitelist';
-    private const GLOBAL_NAMESPACE_KEYWORD = 'global_namespace_whitelist';
 
     private const KEYWORDS = [
         self::PREFIX,
         self::FINDER_KEYWORD,
         self::PATCHERS_KEYWORD,
         self::WHITELIST_KEYWORD,
-        self::GLOBAL_NAMESPACE_KEYWORD,
     ];
 
     private $path;
@@ -200,7 +198,7 @@ private static function retrievePrefix(array $config): ?string
         $prefix = array_key_exists(self::PREFIX, $config) ? $config[self::PREFIX] : null;
 
         if (null === $prefix) {
-            return uniqid('_PhpScoper');
+            return null;
         }
 
         $prefix = trim($prefix);
@@ -345,6 +343,13 @@ private static function retrieveFilesFromPaths(array $paths): iterable
         $finder->files()
             ->in($pathsToSearch)
             ->append($filesToAppend)
+            ->filter(function (SplFileInfo $fileInfo): ?bool {
+                if ($fileInfo->isLink()) {
+                    return false;
+                }
+
+                return null;
+            })
             ->sortByName()
         ;
 

diff --git a/src/Console/Command/AddPrefixCommand.php b/src/Console/Command/AddPrefixCommand.php
@@ -363,14 +363,23 @@ private function validateOutputDir(InputInterface $input, OutputStyle $io): void
 
     private function retrieveConfig(InputInterface $input, OutputInterface $output, OutputStyle $io): Configuration
     {
+        $prefix = $input->getOption(self::PREFIX_OPT);
+
         if ($input->getOption(self::NO_CONFIG_OPT)) {
             $io->writeln(
                 'Loading without configuration file.',
-                OutputStyle::VERBOSITY_DEBUG
+                OutputInterface::VERBOSITY_DEBUG
             );
 
             $config = Configuration::load();
-            $config = $config->withPrefix($input->getOption(self::PREFIX_OPT));
+
+            if (null !== $prefix) {
+                $config = $config->withPrefix($prefix);
+            }
+
+            if (null === $config->getPrefix()) {
+                $config = $config->withPrefix($this->generateRandomPrefix());
+            }
 
             return $this->retrievePaths($input, $config);
         }
@@ -395,7 +404,7 @@ private function retrieveConfig(InputInterface $input, OutputInterface $output,
                         'Config file "<comment>%s</comment>" not found. Skipping.',
                         $configFile
                     ),
-                    OutputStyle::VERBOSITY_DEBUG
+                    OutputInterface::VERBOSITY_DEBUG
                 );
 
                 return self::retrieveConfig($input, $output, $io);
@@ -411,7 +420,7 @@ private function retrieveConfig(InputInterface $input, OutputInterface $output,
         if (null === $configFile) {
             $io->writeln(
                 'Loading without configuration file.',
-                OutputStyle::VERBOSITY_DEBUG
+                OutputInterface::VERBOSITY_DEBUG
             );
         } elseif (false === file_exists($configFile)) {
             throw new RuntimeException(
@@ -426,14 +435,22 @@ private function retrieveConfig(InputInterface $input, OutputInterface $output,
                     'Using the configuration file "%s".',
                     $configFile
                 ),
-                OutputStyle::VERBOSITY_DEBUG
+                OutputInterface::VERBOSITY_DEBUG
             );
         }
 
         $config = Configuration::load($configFile);
         $config = $this->retrievePaths($input, $config);
 
-        return $config->withPrefix($input->getOption(self::PREFIX_OPT));
+        if (null !== $prefix) {
+            $config = $config->withPrefix($prefix);
+        }
+
+        if (null === $config->getPrefix()) {
+            $config = $config->withPrefix($this->generateRandomPrefix());
+        }
+
+        return $config;
     }
 
     private function retrievePaths(InputInterface $input, Configuration $config): Configuration
@@ -456,4 +473,9 @@ private function makeAbsolutePath(string $path): string
 
         return $path;
     }
+
+    private function generateRandomPrefix(): string
+    {
+        return uniqid('_PhpScoper', false);
+    }
 }
diff --git a/src/scoper.inc.php.tpl b/src/scoper.inc.php.tpl
@@ -5,6 +5,9 @@ declare(strict_types=1);
 use Isolated\Symfony\Component\Finder\Finder;
 
 return [
+    // The prefix configuration. If a non null value will be used, a random prefix will be generated.
+    'prefix' => null,
+
     // By default when running php-scoper add-prefix, it will prefix all relevant code found in the current working
     // directory. You can however define which files should be scoped by defining a collection of Finders in the
     // following configuration key.