Enhance usability of the command (#40)

- Make prefix argument an optional option which defaults to a random prefix
- Add prefix to all the files found in the current working directory when no path given
- Throw an error when the output directory already exists and is not writeable
- Add a force option for non-interactive mode to be able to add prefixes although the output directory already exists and is not empty (without the option the process is interrupted)
- Make the errors a bit more readable by adding a color to the file paths
- Mock the filesystem in the command unit tests to control the calls being made and ensure no `remove()` is called by mistake and change the output dir to something different than the project dir... cost me a few project deletion

Author: theofidry

Makefile

@@ -15,9 +15,12 @@ help:
 
 build:            ## Build the PHAR
 build: bin/php-scoper
+	rm -rf build
 	rm composer.lock
 	composer install --no-dev --prefer-dist --classmap-authoritative
+	php -d zend.enable_gc=0 bin/php-scoper add-prefix --force
 	php -d zend.enable_gc=0 $(BOX) build
+	mv build/bin/php-scoper.phar bin/
 	composer install
 
 

box.json.dist

@@ -1,6 +1,7 @@
 {
     "output": "bin/php-scoper.phar",
     "main": "bin/php-scoper",
+    "base-path": "build",
     "directories": [
         "src"
     ],

src/Console/Command/AddPrefixCommand.php

@@ -29,12 +29,14 @@
 
 final class AddPrefixCommand extends Command
 {
-    /** @internal */
-    const PREFIX_ARG = 'prefix';
     /** @internal */
     const PATH_ARG = 'paths';
     /** @internal */
-    const OUTPUT_DIR = 'output-dir';
+    const PREFIX_OPT = 'prefix';
+    /** @internal */
+    const OUTPUT_DIR_OPT = 'output-dir';
+    /** @internal */
+    const FORCE_OPT = 'force';
 
     private $fileSystem;
     private $handle;
@@ -58,23 +60,30 @@ protected function configure()
         $this
             ->setName('add-prefix')
             ->setDescription('Goes through all the PHP files found in the given paths to apply the given prefix to namespaces & FQNs.')
-            ->addArgument(
-                self::PREFIX_ARG,
-                InputArgument::REQUIRED,
-                'The namespace prefix to add'
-            )
             ->addArgument(
                 self::PATH_ARG,
-                InputArgument::REQUIRED | InputArgument::IS_ARRAY,
+                InputArgument::IS_ARRAY,
                 'The path(s) to process.'
             )
             ->addOption(
-                self::OUTPUT_DIR,
+                self::PREFIX_OPT,
+                'p',
+                InputOption::VALUE_REQUIRED,
+                'The namespace prefix to add'
+            )
+            ->addOption(
+                self::OUTPUT_DIR_OPT,
                 'o',
                 InputOption::VALUE_REQUIRED,
                 'The output directory in which the prefixed code will be dumped.',
                 'build'
             )
+            ->addOption(
+                self::FORCE_OPT,
+                'f',
+                InputOption::VALUE_NONE,
+                'Deletes any existing content in the output directory without any warning'
+            )
         ;
     }
 
@@ -95,15 +104,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
         );
 
         $logger->outputScopingStart(
-            $input->getArgument(self::PREFIX_ARG),
+            $input->getOption(self::PREFIX_OPT),
             $input->getArgument(self::PATH_ARG)
         );
 
         try {
             $this->handle->__invoke(
-                $input->getArgument(self::PREFIX_ARG),
+                $input->getOption(self::PREFIX_OPT),
                 $input->getArgument(self::PATH_ARG),
-                $input->getOption(self::OUTPUT_DIR),
+                $input->getOption(self::OUTPUT_DIR_OPT),
                 $logger
             );
         } catch (Throwable $throwable) {
@@ -117,7 +126,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
     private function validatePrefix(InputInterface $input)
     {
-        $prefix = trim($input->getArgument(self::PREFIX_ARG));
+        $prefix = $input->getOption(self::PREFIX_OPT);
+
+        if (null === $prefix) {
+            $prefix = uniqid('PhpScoper');
+        } else {
+            $prefix = trim($prefix);
+        }
 
         if (1 === preg_match('/(?<prefix>.*?)\\\\*$/', $prefix, $matches)) {
             $prefix = $matches['prefix'];
@@ -127,12 +142,12 @@ private function validatePrefix(InputInterface $input)
             throw new RuntimeException(
                 sprintf(
                     'Expected "%s" argument to be a non empty string.',
-                    self::PREFIX_ARG
+                    self::PREFIX_OPT
                 )
             );
         }
 
-        $input->setArgument(self::PREFIX_ARG, $prefix);
+        $input->setOption(self::PREFIX_OPT, $prefix);
     }
 
     private function validatePaths(InputInterface $input)
@@ -151,28 +166,47 @@ function (string $path) use ($cwd, $fileSystem) {
             $input->getArgument(self::PATH_ARG)
         );
 
+        if (0 === count($paths)) {
+            $paths[] = $cwd;
+        }
+
         $input->setArgument(self::PATH_ARG, $paths);
     }
 
     private function validateOutputDir(InputInterface $input, OutputStyle $io)
     {
-        $outputDir = $input->getOption(self::OUTPUT_DIR);
+        $outputDir = $input->getOption(self::OUTPUT_DIR_OPT);
 
         if (false === $this->fileSystem->isAbsolutePath($outputDir)) {
             $outputDir = getcwd().DIRECTORY_SEPARATOR.$outputDir;
         }
 
-        $input->setOption(self::OUTPUT_DIR, $outputDir);
+        $input->setOption(self::OUTPUT_DIR_OPT, $outputDir);
 
         if (false === $this->fileSystem->exists($outputDir)) {
             return;
         }
 
+        if (false === is_writable($outputDir)) {
+            throw new RuntimeException(
+                sprintf(
+                    'Expected "<comment>%s</comment>" to be writeable.',
+                    $outputDir
+                )
+            );
+        }
+
+        if ($input->getOption(self::FORCE_OPT)) {
+            $this->fileSystem->remove($outputDir);
+
+            return;
+        }
+
         if (false === is_dir($outputDir)) {
             $canDeleteFile = $io->confirm(
                 sprintf(
-                    'Expected "%s" to be a directory but found a file instead. It will be removed, do you wish '
-                    .'to proceed?',
+                    'Expected "<comment>%s</comment>" to be a directory but found a file instead. It will be '
+                    .'removed, do you wish to proceed?',
                     $outputDir
                 ),
                 false
@@ -183,15 +217,21 @@ private function validateOutputDir(InputInterface $input, OutputStyle $io)
             }
 
             $this->fileSystem->remove($outputDir);
-        }
-
-        if (false === is_writable($outputDir)) {
-            throw new RuntimeException(
+        } else {
+            $canDeleteFile = $io->confirm(
                 sprintf(
-                    'Expected "%s" to be writeable.',
+                    'The output directory "<comment>%s</comment>" already exists. Continuing will erase its'
+                    .' content, do you wish to proceed?',
                     $outputDir
-                )
+                ),
+                false
             );
+
+            if (false === $canDeleteFile) {
+                return;
+            }
+
+            $this->fileSystem->remove($outputDir);
         }
     }
 }

tests/Console/Command/AddPrefixCommandIntegrationTest.php

@@ -57,14 +57,13 @@ protected function setUp()
             return;
         }
 
-        $this->cwd = getcwd();
-
         $application = create_application();
         $application->setAutoExit(false);
         $application->setCatchExceptions(false);
 
         $this->appTester = new ApplicationTester($application);
 
+        $this->cwd = getcwd();
         $this->tmp = make_tmp_dir('scoper', __CLASS__);
     }
 
@@ -82,11 +81,12 @@ public function test_scope_the_given_paths()
     {
         $input = [
             'add-prefix',
-            'prefix' => 'MyPrefix',
+            '--prefix' => 'MyPrefix',
             'paths' => [
                 self::FIXTURE_PATH,
             ],
             '--output-dir' => $this->tmp,
+            '--no-interaction' => null,
         ];
 
         $this->appTester->run($input);
@@ -100,12 +100,12 @@ public function test_scope_in_quiet_mode()
     {
         $input = [
             'add-prefix',
-            'prefix' => 'MyPrefix',
+            '--prefix' => 'MyPrefix',
             'paths' => [
                 self::FIXTURE_PATH,
             ],
             '--output-dir' => $this->tmp,
-            '--quiet',
+            '--quiet' => null,
         ];
 
         $this->appTester->run($input);
@@ -122,11 +122,12 @@ public function test_scope_in_normal_mode()
     {
         $input = [
             'add-prefix',
-            'prefix' => 'MyPrefix',
+            '--prefix' => 'MyPrefix',
             'paths' => [
                 self::FIXTURE_PATH,
             ],
             '--output-dir' => $this->tmp,
+            '--no-interaction' => null,
         ];
 
         $this->appTester->run($input);
@@ -162,12 +163,13 @@ public function test_scope_in_verbose_mode()
     {
         $input = [
             'add-prefix',
-            'prefix' => 'MyPrefix',
+            '--prefix' => 'MyPrefix',
             'paths' => [
                 self::FIXTURE_PATH,
             ],
             '--output-dir' => $this->tmp,
-            '-v',
+            '-v' => null,
+            '--no-interaction' => null,
         ];
 
         $this->appTester->run($input);