Merge pull request #117 from MarvinKlemp/feature/simple_output

MarvinKlemp · web-flow · commit b175242855b1 · 2016-06-13T17:23:00.000+02:00
Simple Console output
diff --git a/README.md b/README.md
@@ -97,6 +97,12 @@ You can get a list of all options and arguments by running
 $ deprecation-detector check --help
 ```
 
+The default output might not fit into the cli. If that is the case you can set the output to a list by setting `--output=simple`.
+
+```bash
+$ deprecation-detector check src/ vendor/ --output=simple
+```
+
 ## Excluding deprecated method calls
 
 You can exclude deprecated method calls by using the `filter-methods` option. This option takes a comma separated list of method references to exclude.
diff --git a/src/Configuration/Configuration.php b/src/Configuration/Configuration.php
@@ -44,6 +44,11 @@ class Configuration
      */
     private $logHtml;
 
+    /**
+     * @var string
+     */
+    private $output;
+
     /**
      * @param string $ruleSet
      * @param string $containerPath
@@ -53,6 +58,7 @@ class Configuration
      * @param bool   $fail
      * @param bool   $verbose
      * @param string $logHtml
+     * @param string $output
      */
     public function __construct(
         $ruleSet,
@@ -62,7 +68,8 @@ public function __construct(
         $filterMethodCalls,
         $fail,
         $verbose,
-        $logHtml)
+        $logHtml,
+        $output)
     {
         $this->ruleSet = $ruleSet;
         $this->containerPath = $containerPath;
@@ -72,6 +79,7 @@ public function __construct(
         $this->failOnDeprecation = $fail;
         $this->verbose = $verbose;
         $this->logHtml = $logHtml;
+        $this->output = $output;
     }
 
     public function overrideConfiguration()
@@ -138,4 +146,12 @@ public function logHtml()
     {
         return $this->logHtml;
     }
+
+    /**
+     * @return bool
+     */
+    public function isSimpleOutput()
+    {
+        return $this->output === 'simple';
+    }
 }
diff --git a/src/Console/Command/CheckCommand.php b/src/Console/Command/CheckCommand.php
@@ -38,6 +38,7 @@ protected function configure()
                     new InputOption('no-cache', null, InputOption::VALUE_NONE, 'Disable rule set cache'),
                     new InputOption('cache-dir', null, InputOption::VALUE_REQUIRED, 'Cache directory', '.rules/'),
                     new InputOption('log-html', null, InputOption::VALUE_REQUIRED, 'Generate HTML report'),
+                    new InputOption('output', null, InputOption::VALUE_REQUIRED, 'Change the output mode'),
                     new InputOption('filter-methods', null, InputOption::VALUE_OPTIONAL, 'Filter methods', ''),
                     new InputOption('fail', null, InputOption::VALUE_NONE, 'Fails, if any deprecation is detected'),
                 )
@@ -113,7 +114,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $input->getOption('filter-methods'),
             $input->getOption('fail'),
             $input->getOption('verbose'),
-            $input->getOption('log-html')
+            $input->getOption('log-html'),
+            $input->getOption('output')
         );
 
         $factory = new DetectorFactory();
diff --git a/src/DetectorFactory.php b/src/DetectorFactory.php
@@ -35,7 +35,7 @@
 use SensioLabs\DeprecationDetector\TypeGuessing\SymbolTable\SymbolTable;
 use SensioLabs\DeprecationDetector\TypeGuessing\SymbolTable\Visitor\SymbolTableVariableResolverVisitor;
 use SensioLabs\DeprecationDetector\TypeGuessing\Symfony\ContainerReader;
-use SensioLabs\DeprecationDetector\Violation\Renderer\ConsoleOutputRenderer;
+use SensioLabs\DeprecationDetector\Violation\Renderer\Console\DefaultRenderer;
 use SensioLabs\DeprecationDetector\Violation\Renderer\Html\RendererFactory;
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\Message\ClassViolationMessage;
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\Message\FunctionViolationMessage;
@@ -45,6 +45,7 @@
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\Message\MethodViolationMessage;
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\Message\SuperTypeViolationMessage;
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\MessageHelper;
+use SensioLabs\DeprecationDetector\Violation\Renderer\Console\SimpleRenderer;
 use SensioLabs\DeprecationDetector\Violation\ViolationChecker\ClassViolationChecker;
 use SensioLabs\DeprecationDetector\Violation\ViolationChecker\ComposedViolationChecker;
 use SensioLabs\DeprecationDetector\Violation\ViolationChecker\FunctionViolationChecker;
@@ -293,7 +294,7 @@ private function getViolationFilter(Configuration $configuration)
      * @param Configuration   $configuration
      * @param OutputInterface $output
      *
-     * @return ConsoleOutputRenderer|Violation\Renderer\Html\Renderer
+     * @return DefaultRenderer|Violation\Renderer\Html\Renderer
      */
     private function getRenderer(Configuration $configuration, OutputInterface $output)
     {
@@ -305,7 +306,11 @@ private function getRenderer(Configuration $configuration, OutputInterface $outp
             return $factory->createHtmlOutputRenderer($logFilePath);
         }
 
-        return new ConsoleOutputRenderer($output, $messageHelper);
+        if ($configuration->isSimpleOutput()) {
+            return new SimpleRenderer($output, $messageHelper);
+        }
+
+        return new DefaultRenderer($output, $messageHelper);
     }
 
     /**
diff --git a/src/FileInfo/PhpFileInfo.php b/src/FileInfo/PhpFileInfo.php
@@ -280,7 +280,7 @@ public function hasClassDeprecation($className)
      */
     public function getClassDeprecation($className)
     {
-        return ($this->hasClassDeprecation($className) ? $this->classDeprecations[$className] : null);
+        return $this->hasClassDeprecation($className) ? $this->classDeprecations[$className] : null;
     }
 
     /**
@@ -324,7 +324,7 @@ public function hasInterfaceDeprecation($interfaceName)
      */
     public function getInterfaceDeprecation($interfaceName)
     {
-        return ($this->hasInterfaceDeprecation($interfaceName) ? $this->interfaceDeprecations[$interfaceName] : null);
+        return $this->hasInterfaceDeprecation($interfaceName) ? $this->interfaceDeprecations[$interfaceName] : null;
     }
 
     /**
diff --git a/src/TypeGuessing/SymbolTable/Resolver/SymfonyResolver.php b/src/TypeGuessing/SymbolTable/Resolver/SymfonyResolver.php
@@ -121,6 +121,6 @@ protected function getType($context, $methodName, Node $node = null)
      */
     protected function isController($type)
     {
-        return (substr($type, -10) === 'Controller');
+        return substr($type, -10) === 'Controller';
     }
 }
diff --git a/src/Violation/Renderer/Console/BaseRenderer.php b/src/Violation/Renderer/Console/BaseRenderer.php
@@ -0,0 +1,68 @@
+<?php
+
+namespace SensioLabs\DeprecationDetector\Violation\Renderer\Console;
+
+use PhpParser\Error;
+use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\MessageHelper;
+use SensioLabs\DeprecationDetector\Violation\Renderer\RendererInterface;
+use SensioLabs\DeprecationDetector\Violation\Violation;
+use Symfony\Component\Console\Output\OutputInterface;
+
+abstract class BaseRenderer implements RendererInterface
+{
+    /**
+     * @var OutputInterface
+     */
+    protected $output;
+
+    /**
+     * @var MessageHelper
+     */
+    protected $messageHelper;
+
+    /**
+     * @param OutputInterface $output
+     * @param MessageHelper   $messageHelper
+     */
+    public function __construct(OutputInterface $output, MessageHelper $messageHelper)
+    {
+        $this->output = $output;
+        $this->messageHelper = $messageHelper;
+    }
+
+    /**
+     * @param Violation[] $violations
+     * @param Error[]     $errors
+     */
+    public function renderViolations(array $violations, array $errors)
+    {
+        $this->printViolations($violations);
+        $this->printErrors($errors);
+    }
+
+    /**
+     * @param Violation[] $violations
+     */
+    abstract protected function printViolations(array $violations);
+
+    /**
+     * @param Error[] $errors
+     */
+    protected function printErrors(array $errors)
+    {
+        if (0 === count($errors)) {
+            return;
+        }
+
+        $this->output->writeln('');
+        $this->output->writeln('<error>Your project contains invalid code:</error>');
+        foreach ($errors as $error) {
+            $this->output->writeln(
+                sprintf(
+                    '<error>%s</error>',
+                    $error->getRawMessage()
+                )
+            );
+        }
+    }
+}
diff --git a/src/Violation/Renderer/Console/DefaultRenderer.php b/src/Violation/Renderer/Console/DefaultRenderer.php
@@ -1,8 +1,7 @@
 <?php
 
-namespace SensioLabs\DeprecationDetector\Violation\Renderer;
+namespace SensioLabs\DeprecationDetector\Violation\Renderer\Console;
 
-use PhpParser\Error;
 use SensioLabs\DeprecationDetector\FileInfo\PhpFileInfo;
 use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\MessageHelper;
 use SensioLabs\DeprecationDetector\Violation\Violation;
@@ -11,42 +10,21 @@
 use Symfony\Component\Console\Helper\TableSeparator;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class ConsoleOutputRenderer implements RendererInterface
+class DefaultRenderer extends BaseRenderer
 {
-    /**
-     * @var OutputInterface
-     */
-    protected $output;
-
-    /**
-     * @var MessageHelper
-     */
-    private $messageHelper;
-
     /**
      * @param OutputInterface $output
      * @param MessageHelper   $messageHelper
      */
     public function __construct(OutputInterface $output, MessageHelper $messageHelper)
     {
-        $this->output = $output;
-        $this->messageHelper = $messageHelper;
+        parent::__construct($output, $messageHelper);
     }
 
     /**
      * @param Violation[] $violations
-     * @param Error[]     $errors
      */
-    public function renderViolations(array $violations, array $errors)
-    {
-        $this->printViolations($violations);
-        $this->printErrors($errors);
-    }
-
-    /**
-     * @param Violation[] $violations
-     */
-    private function printViolations(array $violations)
+    protected function printViolations(array $violations)
     {
         if (0 === count($violations)) {
             return;
@@ -77,26 +55,6 @@ private function printViolations(array $violations)
         $table->render();
     }
 
-    /**
-     * @param Error[] $errors
-     */
-    private function printErrors(array $errors)
-    {
-        if (0 === count($errors)) {
-            return;
-        }
-
-        $this->output->writeln('<error>Your project contains invalid code:</error>');
-        foreach ($errors as $error) {
-            $this->output->writeln(
-                sprintf(
-                    '<error>%s</error>',
-                    $error->getRawMessage()
-                )
-            );
-        }
-    }
-
     /**
      * @param PhpFileInfo $file
      *
diff --git a/src/Violation/Renderer/Console/SimpleRenderer.php b/src/Violation/Renderer/Console/SimpleRenderer.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace SensioLabs\DeprecationDetector\Violation\Renderer\Console;
+
+use SensioLabs\DeprecationDetector\Violation\Renderer\MessageHelper\MessageHelper;
+use SensioLabs\DeprecationDetector\Violation\Violation;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class SimpleRenderer extends BaseRenderer
+{
+    /**
+     * @param OutputInterface $output
+     * @param MessageHelper   $messageHelper
+     */
+    public function __construct(OutputInterface $output, MessageHelper $messageHelper)
+    {
+        parent::__construct($output, $messageHelper);
+    }
+
+    /**
+     * @param Violation[] $violations
+     */
+    protected function printViolations(array $violations)
+    {
+        if (0 === count($violations)) {
+            return;
+        }
+
+        $tmpFile = null;
+        foreach ($violations as $i => $violation) {
+            if ($tmpFile !== $violation->getFile()) {
+                $tmpFile = $violation->getFile();
+                if (0 !== $i) {
+                    $this->output->writeln('');
+                }
+                $this->output->writeln($tmpFile->getRelativePathname());
+            }
+
+            $this->output->writeln(sprintf(
+                'Nr. %d line %d: %s',
+                ++$i,
+                $violation->getLine(),
+                $this->messageHelper->getViolationMessage($violation)
+            ));
+        }
+    }
+}
diff --git a/tests/Configuration/ConfigurationTest.php b/tests/Configuration/ConfigurationTest.php
@@ -16,13 +16,14 @@ public function testClassIsInitializable()
             '',
             true,
             true,
-            'html.log'
+            'html.log',
+            null
         );
 
         $this->assertInstanceOf('SensioLabs\DeprecationDetector\Configuration\Configuration', $configuration);
     }
 
-    public function testRuleSet()
+    public function testConfiguration()
     {
         $configuration = new Configuration(
             'path/to/rule_set',
@@ -32,7 +33,8 @@ public function testRuleSet()
             '',
             true,
             true,
-            'html.log'
+            'html.log',
+            null
         );
 
         $this->assertEquals('path/to/rule_set', $configuration->ruleSet());
@@ -43,5 +45,6 @@ public function testRuleSet()
         $this->assertTrue($configuration->failOnDeprecation());
         $this->assertTrue($configuration->isVerbose());
         $this->assertEquals('html.log', $configuration->logHtml());
+        $this->assertNull(null, $configuration->isSimpleOutput());
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ public function hasClassDeprecation($className)`
`280`	`280`	`*/`
`281`	`281`	`public function getClassDeprecation($className)`
`282`	`282`	`{`
`283`		`- return ($this->hasClassDeprecation($className) ? $this->classDeprecations[$className] : null);`
	`283`	`+ return $this->hasClassDeprecation($className) ? $this->classDeprecations[$className] : null;`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`/**`
`@@ -324,7 +324,7 @@ public function hasInterfaceDeprecation($interfaceName)`
`324`	`324`	`*/`
`325`	`325`	`public function getInterfaceDeprecation($interfaceName)`
`326`	`326`	`{`
`327`		`- return ($this->hasInterfaceDeprecation($interfaceName) ? $this->interfaceDeprecations[$interfaceName] : null);`
	`327`	`+ return $this->hasInterfaceDeprecation($interfaceName) ? $this->interfaceDeprecations[$interfaceName] : null;`
`328`	`328`	`}`
`329`	`329`
`330`	`330`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,6 @@ protected function getType($context, $methodName, Node $node = null)`
`121`	`121`	`*/`
`122`	`122`	`protected function isController($type)`
`123`	`123`	`{`
`124`		`- return (substr($type, -10) === 'Controller');`
	`124`	`+ return substr($type, -10) === 'Controller';`
`125`	`125`	`}`
`126`	`126`	`}`