VincentLanglet · VincentLanglet · May 24, 2019 · May 24, 2019
diff --git a/TwigCS/Command/TwigCSCommand.php b/TwigCS/Command/TwigCSCommand.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Command;
 
+use \Exception;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -65,7 +66,7 @@ protected function configure()
      *
      * @return int
      *
-     * @throws \Exception
+     * @throws Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {

diff --git a/TwigCS/Config/Config.php b/TwigCS/Config/Config.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Config;
 
+use \Exception;
 use Symfony\Component\Finder\Finder;
 
 /**
@@ -43,6 +44,8 @@ public function __construct()
      * Find all files to process, based on a file or directory and exclude patterns.
      *
      * @return array
+     *
+     * @throws Exception
      */
     public function findFiles()
     {
@@ -74,11 +77,13 @@ public function findFiles()
      * @param string $key
      *
      * @return mixed
+     *
+     * @throws Exception
      */
     public function get($key)
     {
         if (!isset($this->config[$key])) {
-            throw new \Exception(sprintf('Configuration key "%s" does not exist', $key));
+            throw new Exception(sprintf('Configuration key "%s" does not exist', $key));
         }
 
         return $this->config[$key];

diff --git a/TwigCS/Environment/StubbedEnvironment.php b/TwigCS/Environment/StubbedEnvironment.php
@@ -2,6 +2,13 @@
 
 namespace TwigCS\Environment;
 
+use \Closure;
+use Symfony\Bridge\Twig\TokenParser\DumpTokenParser;
+use Symfony\Bridge\Twig\TokenParser\FormThemeTokenParser;
+use Symfony\Bridge\Twig\TokenParser\StopwatchTokenParser;
+use Symfony\Bridge\Twig\TokenParser\TransChoiceTokenParser;
+use Symfony\Bridge\Twig\TokenParser\TransDefaultDomainTokenParser;
+use Symfony\Bridge\Twig\TokenParser\TransTokenParser;
 use Twig\Environment;
 use Twig\Loader\LoaderInterface;
 use Twig\TwigFilter;
@@ -31,7 +38,7 @@ class StubbedEnvironment extends Environment
     private $stubTests;
 
     /**
-     * @var \Closure
+     * @var Closure
      */
     private $stubCallable;
 
@@ -43,6 +50,13 @@ public function __construct(LoaderInterface $loader = null, $options = [])
     {
         parent::__construct($loader, $options);
 
+        $this->addTokenParser(new DumpTokenParser());
+        $this->addTokenParser(new FormThemeTokenParser());
+        $this->addTokenParser(new StopwatchTokenParser(false));
+        $this->addTokenParser(new TransChoiceTokenParser());
+        $this->addTokenParser(new TransDefaultDomainTokenParser());
+        $this->addTokenParser(new TransTokenParser());
+
         $this->stubCallable  = function () {
             /* This will be used as stub filter, function or test */
         };

diff --git a/TwigCS/Linter.php b/TwigCS/Linter.php
@@ -2,6 +2,8 @@
 
 namespace TwigCS;
 
+use \Exception;
+use \Traversable;
 use Twig\Environment;
 use Twig\Error\Error;
 use Twig\Source;
@@ -12,7 +14,7 @@
 use TwigCS\Sniff\PostParserSniffInterface;
 use TwigCS\Sniff\PreParserSniffInterface;
 use TwigCS\Sniff\SniffInterface;
-use TwigCS\Token\TokenizerInterface;
+use TwigCS\Token\Tokenizer;
 
 /**
  * Linter is the main class and will process twig files against a set of rules.
@@ -30,17 +32,18 @@ class Linter
     protected $sniffsExtension;
 
     /**
-     * @var TokenizerInterface
+     * @var Tokenizer
      */
     protected $tokenizer;
 
     /**
-     * @param Environment        $env
-     * @param TokenizerInterface $tokenizer
+     * @param Environment $env
+     * @param Tokenizer   $tokenizer
      */
-    public function __construct(Environment $env, TokenizerInterface $tokenizer)
+    public function __construct(Environment $env, Tokenizer $tokenizer)
     {
         $this->env = $env;
+
         $this->sniffsExtension = $this->env->getExtension('TwigCS\Extension\SniffsExtension');
         $this->tokenizer = $tokenizer;
     }
@@ -52,15 +55,17 @@ public function __construct(Environment $env, TokenizerInterface $tokenizer)
      * @param Ruleset      $ruleset Set of rules to check.
      *
      * @return Report an object with all violations and stats.
+     *
+     * @throws Exception
      */
     public function run($files, Ruleset $ruleset)
     {
-        if (!is_array($files) && !$files instanceof \Traversable) {
+        if (!is_array($files) && !$files instanceof Traversable) {
             $files = [$files];
         }
 
         if (empty($files)) {
-            throw new \Exception('No files to process, provide at least one file to be linted');
+            throw new Exception('No files to process, provide at least one file to be linted');
         }
 
         // setUp
@@ -70,8 +75,8 @@ public function run($files, Ruleset $ruleset)
                 $sniffViolation = new SniffViolation(
                     SniffInterface::MESSAGE_TYPE_NOTICE,
                     $msg,
-                    '',
-                    ''
+                    null,
+                    null
                 );
 
                 $report->addMessage($sniffViolation);
@@ -139,11 +144,11 @@ public function processTemplate($file, $ruleset, $report)
         // Tokenizer.
         try {
             $stream = $this->tokenizer->tokenize($twigSource);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $sniffViolation = new SniffViolation(
                 SniffInterface::MESSAGE_TYPE_ERROR,
-                sprintf('Unable to tokenize file "%s"', (string) $file),
-                '',
+                sprintf('Unable to tokenize file'),
+                null,
                 (string) $file
             );
 

diff --git a/TwigCS/Report/SniffViolation.php b/TwigCS/Report/SniffViolation.php
@@ -91,10 +91,9 @@ public function getLevelAsString()
             case SniffInterface::MESSAGE_TYPE_WARNING:
                 return 'WARNING';
             case SniffInterface::MESSAGE_TYPE_ERROR:
+            default:
                 return 'ERROR';
         }
-
-        throw new \Exception(sprintf('Unknown level "%s"', $this->level));
     }
 
     /**
@@ -112,10 +111,9 @@ public static function getLevelAsInt($level)
             case 'WARNING':
                 return SniffInterface::MESSAGE_TYPE_WARNING;
             case 'ERROR':
+            default:
                 return SniffInterface::MESSAGE_TYPE_ERROR;
         }
-
-        throw new \Exception(sprintf('Unknown level "%s"', $level));
     }
 
     /**

diff --git a/TwigCS/Report/TextFormatter.php b/TwigCS/Report/TextFormatter.php
@@ -46,33 +46,40 @@ public function display(Report $report, $level = null)
                 'level' => $level,
             ]);
 
-            $this->io->text((count($fileMessages) > 0 ? '<fg=red>KO</fg=red>' : '<info>OK</info>').' '.$file);
+            if (count($fileMessages) > 0) {
+                $this->io->text('<fg=red>KO</fg=red> '.$file);
+            }
 
             $rows = [];
             foreach ($fileMessages as $message) {
                 $lines = $this->getContext(file_get_contents($file), $message->getLine(), $this::ERROR_CONTEXT_LIMIT);
 
                 $formattedText = [];
+                if (!$message->getLine()) {
+                    $formattedText[] = $this->formatErrorMessage($message);
+                }
+
                 foreach ($lines as $no => $code) {
                     $formattedText[] = sprintf($this::ERROR_LINE_FORMAT, $no, wordwrap($code, $this::ERROR_LINE_WIDTH));
 
                     if ($no === $message->getLine()) {
-                        $formattedText[] = sprintf(
-                            '<fg=red>'.$this::ERROR_LINE_FORMAT.'</fg=red>',
-                            $this::ERROR_CURSOR_CHAR,
-                            wordwrap($message->getMessage(), $this::ERROR_LINE_WIDTH)
-                        );
+                        $formattedText[] = $this->formatErrorMessage($message);
                     }
                 }
 
+                if (count($rows) > 0) {
+                    $rows[] = new TableSeparator();
+                }
+
                 $rows[] = [
-                    new TableCell('<comment>'.$message->getLevelAsString().'</comment>', ['rowspan' => 2]),
+                    new TableCell('<comment>'.$message->getLevelAsString().'</comment>'),
                     implode("\n", $formattedText),
                 ];
-                $rows[] = new TableSeparator();
             }
 
-            $this->io->table([], $rows);
+            if (count($rows) > 0) {
+                $this->io->table([], $rows);
+            }
         }
 
         $summaryString = sprintf(
@@ -131,4 +138,18 @@ protected function getContext($template, $line, $context)
 
         return $result;
     }
+
+    /**
+     * @param SniffViolation $message
+     *
+     * @return string
+     */
+    protected function formatErrorMessage(SniffViolation $message)
+    {
+        return sprintf(
+            '<fg=red>'.$this::ERROR_LINE_FORMAT.'</fg=red>',
+            $this::ERROR_CURSOR_CHAR,
+            wordwrap($message->getMessage(), $this::ERROR_LINE_WIDTH)
+        );
+    }
 }
diff --git a/TwigCS/Ruleset/Ruleset.php b/TwigCS/Ruleset/Ruleset.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Ruleset;
 
+use \Exception;
 use TwigCS\Sniff\PostParserSniffInterface;
 use TwigCS\Sniff\PreParserSniffInterface;
 use TwigCS\Sniff\SniffInterface;
@@ -69,6 +70,8 @@ public function addPostParserSniff(PostParserSniffInterface $sniff)
      * @param SniffInterface $sniff
      *
      * @return $this
+     *
+     * @throws Exception
      */
     public function addSniff(SniffInterface $sniff)
     {
@@ -88,7 +91,7 @@ public function addSniff(SniffInterface $sniff)
             return $this;
         }
 
-        throw new \Exception(sprintf(
+        throw new Exception(sprintf(
             'Unknown type of sniff "%s", expected one of: "%s"',
             $sniff->getType(),
             implode(', ', [SniffInterface::TYPE_PRE_PARSER, SniffInterface::TYPE_POST_PARSER])

diff --git a/TwigCS/Ruleset/RulesetFactory.php b/TwigCS/Ruleset/RulesetFactory.php
@@ -2,6 +2,8 @@
 
 namespace TwigCS\Ruleset;
 
+use \Exception;
+use \SplFileInfo;
 use Symfony\Component\Finder\Finder;
 
 /**
@@ -13,14 +15,16 @@ class RulesetFactory
      * Create a new set of rule.
      *
      * @return Ruleset
+     *
+     * @throws Exception
      */
     public function createStandardRuleset()
     {
         $ruleset = new Ruleset();
 
         $finder = Finder::create()->in(__DIR__.'/../Sniff/Standard')->files();
 
-        /** @var \SplFileInfo $file */
+        /** @var SplFileInfo $file */
         foreach ($finder as $file) {
             $class = 'TwigCS\Sniff\Standard\\'.explode('.', $file->getFilename())[0];
             $ruleset->addSniff(new $class());

diff --git a/TwigCS/Sniff/AbstractPostParserSniff.php b/TwigCS/Sniff/AbstractPostParserSniff.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Sniff;
 
+use \Exception;
 use Twig\Node\Expression\Binary\ConcatBinary;
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\FilterExpression;
@@ -38,6 +39,8 @@ public function getType()
      * @param Node   $node
      *
      * @return self
+     *
+     * @throws Exception
      */
     public function addMessage($messageType, $message, Node $node)
     {
@@ -56,7 +59,7 @@ public function addMessage($messageType, $message, Node $node)
     /**
      * @param Node $node
      *
-     * @return string
+     * @return int|null
      */
     public function getTemplateLine(Node $node)
     {
@@ -68,7 +71,7 @@ public function getTemplateLine(Node $node)
             return $node->getLine();
         }
 
-        return '';
+        return null;
     }
 
     /**

diff --git a/TwigCS/Sniff/AbstractPreParserSniff.php b/TwigCS/Sniff/AbstractPreParserSniff.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Sniff;
 
+use \Exception;
 use TwigCS\Report\SniffViolation;
 use TwigCS\Token\Token;
 
@@ -46,6 +47,8 @@ public function isTokenMatching(Token $token, $type, $value = null)
      * @param Token  $token
      *
      * @return self
+     *
+     * @throws Exception
      */
     public function addMessage($messageType, $message, Token $token)
     {

diff --git a/TwigCS/Sniff/AbstractSniff.php b/TwigCS/Sniff/AbstractSniff.php
@@ -2,6 +2,7 @@
 
 namespace TwigCS\Sniff;
 
+use \Exception;
 use TwigCS\Report\Report;
 
 /**
@@ -51,11 +52,13 @@ public function disable()
 
     /**
      * @return Report
+     *
+     * @throws Exception
      */
     public function getReport()
     {
         if (null === $this->report) {
-            throw new \Exception('Sniff is disabled!');
+            throw new Exception('Sniff is disabled!');
         }
 
         return $this->report;