Simple Console output

Author: MarvinKlemp

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,11 @@ public function logHtml()
     {
         return $this->logHtml;
     }
+
+    /**
+     * @return bool
+     */
+    public function isSimpleOutput() {
+        return $this->output === 'simple';
+    }
 }

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();

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);
     }
 
     /**

src/Violation/Renderer/Console/BaseRenderer.php

@@ -0,0 +1,32 @@
+<?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;
+    }
+}

src/Violation/Renderer/ConsoleOutputRenderer.php renamed to src/Violation/Renderer/Console/DefaultRenderer.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace SensioLabs\DeprecationDetector\Violation\Renderer;
+namespace SensioLabs\DeprecationDetector\Violation\Renderer\Console;
 
 use PhpParser\Error;
 use SensioLabs\DeprecationDetector\FileInfo\PhpFileInfo;
@@ -11,26 +11,15 @@
 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);
     }
 
     /**

src/Violation/Renderer/Console/SimpleRenderer.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace SensioLabs\DeprecationDetector\Violation\Renderer\Console;
+
+use PhpParser\Error;
+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
+     * @param Error[]     $errors
+     */
+    public function renderViolations(array $violations, array $errors)
+    {
+        $this->printViolations($violations);
+        $this->printErrors($errors);
+    }
+
+    /**
+     * @param Violation[] $violations
+     */
+    private 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)
+            ));
+        }
+    }
+
+    /**
+     * @param Error[] $errors
+     */
+    private function printErrors(array $errors)
+    {
+        if (0 === count($errors)) {
+            return;
+        }
+
+    }
+}

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());
     }
 }