cli: create OptimizeUseCommand, add OptimizeUseCommand to CLI

OptimizeUse: uses the new features from NameScanner to implement

Author: pscheit

src/main/QafooLabs/Refactoring/Adapters/Symfony/CliApplication.php

@@ -42,6 +42,7 @@ protected function getDefaultCommands()
         $commands[] = new Commands\RenameLocalVariableCommand();
         $commands[] = new Commands\ConvertLocalToInstanceVariableCommand();
         $commands[] = new Commands\FixClassNamesCommand();
+        $commands[] = new Commands\OptimizeUseCommand();
 
         return $commands;
     }

src/main/QafooLabs/Refactoring/Adapters/Symfony/Commands/OptimizeUseCommand.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * Qafoo PHP Refactoring Browser
+ *
+ * LICENSE
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.txt.
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so I can send you a copy immediately.
+ */
+
+namespace QafooLabs\Refactoring\Adapters\Symfony\Commands;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Command\Command;
+
+use QafooLabs\Refactoring\Application\OptimizeUse;
+use QafooLabs\Refactoring\Adapters\PHPParser\ParserVariableScanner;
+use QafooLabs\Refactoring\Adapters\PHPParser\ParserPhpNameScanner;
+use QafooLabs\Refactoring\Adapters\TokenReflection\StaticCodeAnalysis;
+use QafooLabs\Refactoring\Adapters\Patches\PatchEditor;
+use QafooLabs\Refactoring\Adapters\Symfony\OutputPatchCommand;
+
+use QafooLabs\Refactoring\Domain\Model\LineRange;
+use QafooLabs\Refactoring\Domain\Model\File;
+
+/**
+ * Symfony Adapter to execute the Optimize Use Refactoring
+ */
+class OptimizeUseCommand extends Command
+{
+    protected function configure()
+    {
+        $this
+            ->setName('optimize-use')
+            ->setDescription('Optimize use statements of a file. Replace FQNs with imported aliases.')
+            ->addArgument('file', InputArgument::REQUIRED, 'File that contains the use statements to optimize')
+            ->setHelp(<<<HELP
+Optimizes the use of Fully qualified names in a file so that FQN is imported with 
+"use" at the top of the file and the FQN is replaced with its classname.
+
+All other use statements will be untouched, only new ones will be added.
+
+<comment>Operations:</comment>
+
+1. import found FQNs
+2. replace FQNs with the imported classname
+
+<comment>Pre-Conditions:</comment>
+
+1. File has a single namespace defined
+
+<comment>Known issues:</comment>
+
+1. a FQN might be renamed with an conflicting name when the className of the renamend full qualified name is already in use
+2. if there is no use statement in the whole file, new ones will be appended after the namespace
+
+<comment>Usage:</comment>
+
+    <info>php refactor.phar optimize-use file.php</info>
+
+Will optimize the use statements in <info>file.php</info>.
+HELP
+            );
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $file = File::createFromPath($input->getArgument('file'), getcwd());
+
+        $codeAnalysis = new StaticCodeAnalysis();
+        $editor = new PatchEditor(new OutputPatchCommand($output));
+        $phpNameScanner = new ParserPhpNameScanner();
+
+        $optimizeUse = new OptimizeUse($codeAnalysis, $editor, $phpNameScanner);
+        $optimizeUse->refactor($file);
+    }
+}

src/main/QafooLabs/Refactoring/Application/OptimizeUse.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * Qafoo PHP Refactoring Browser
+ *
+ * LICENSE
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this package in the file LICENSE.txt.
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so I can send you a copy immediately.
+ */
+
+namespace QafooLabs\Refactoring\Application;
+
+use QafooLabs\Refactoring\Domain\Model\Directory;
+use QafooLabs\Refactoring\Domain\Model\File;
+use QafooLabs\Refactoring\Domain\Model\PhpClassName;
+use QafooLabs\Refactoring\Domain\Model\PhpName;
+
+class OptimizeUse
+{
+    private $codeAnalysis;
+    private $editor;
+    private $phpNameScanner;
+
+    public function __construct($codeAnalysis, $editor, $phpNameScanner)
+    {
+        $this->codeAnalysis = $codeAnalysis;
+        $this->editor = $editor;
+        $this->phpNameScanner = $phpNameScanner;
+    }
+
+    public function refactor(File $file)
+    {
+        $classes = $this->codeAnalysis->findClasses($file);
+        $names = $this->phpNameScanner->findNames($file);
+        $class = $classes[0];
+
+        $lastUseStatement = null;
+        $usedNames = array();
+        $fqcns = array();
+        foreach ($names as $name) {
+            if ($name->isUse()) {
+                $lastUseStatement = $name->parent();
+                $usedNames[] = $name->fullyQualifiedName();
+            } elseif ($name->isFullyQualified()) {
+                $fqcns[] = $name;
+            }
+        }
+        $lastUseStatementLine = null !== $lastUseStatement ? $lastUseStatement->getEndLine() : $class->getNamespaceDeclarationLine()+2;
+
+        if (count($fqcns) > 0) {
+
+            $buffer = $this->editor->openBuffer($file);
+            foreach ($fqcns as $name) {
+                $buffer->replaceString($name->declaredLine(), '\\'.$name->fullyQualifiedName(), $name->shortname());
+
+                if (!in_array($name->fullyQualifiedName(), $usedNames)) {
+                    $buffer->append($lastUseStatementLine, array(sprintf('use %s;', $name->fullyQualifiedName())));
+                    $lastUseStatementLine++;
+                }
+            }
+
+            $this->editor->save();
+        }
+    }
+}