💄 Improvements

Author: VincentLanglet

TwigCS/Linter.php

@@ -27,7 +27,7 @@ class Linter
     /**
      * @var SniffsExtension
      */
-    protected $sniffExtension;
+    protected $sniffsExtension;
 
     /**
      * @var TokenizerInterface
@@ -41,7 +41,7 @@ class Linter
     public function __construct(Environment $env, TokenizerInterface $tokenizer)
     {
         $this->env = $env;
-        $this->sniffExtension = $this->env->getExtension('TwigCS\Extension\SniffsExtension');
+        $this->sniffsExtension = $this->env->getExtension('TwigCS\Extension\SniffsExtension');
         $this->tokenizer = $tokenizer;
     }
 
@@ -80,7 +80,7 @@ public function run($files, Ruleset $ruleset)
 
         foreach ($ruleset->getSniffs() as $sniff) {
             if ($sniff instanceof PostParserSniffInterface) {
-                $this->sniffExtension->addSniff($sniff);
+                $this->sniffsExtension->addSniff($sniff);
             }
 
             $sniff->enable($report);
@@ -98,7 +98,7 @@ public function run($files, Ruleset $ruleset)
         restore_error_handler();
         foreach ($ruleset->getSniffs() as $sniff) {
             if ($sniff instanceof PostParserSniffInterface) {
-                $this->sniffExtension->removeSniff($sniff);
+                $this->sniffsExtension->removeSniff($sniff);
             }
 
             $sniff->disable();

TwigCS/Report/Report.php

@@ -77,7 +77,7 @@ public function addMessage(SniffViolation $sniffViolation)
      */
     public function getMessages($filters = [])
     {
-        if (!$filters) {
+        if (empty($filters)) {
             // Return all messages, without filtering.
             return $this->messages;
         }

TwigCS/Sniff/AbstractPostParserSniff.php

@@ -116,7 +116,6 @@ public function isNodeMatching(Node $node, $type, $name = null)
             },
             'tag'      => function (Node $node, $type, $name) {
                 return $node->getNodeTag() === $name;
-                /* && $node->hasAttribute('name') && $name === $node->getAttribute('name') */
             },
         ];
 

TwigCS/Sniff/AbstractPreParserSniff.php

@@ -8,7 +8,7 @@
 /**
  * Base for all pre-parser sniff.
  *
- * A post parser sniff should be useful to check code formatting mainly such as:
+ * A pre parser sniff should be useful to check code formatting mainly such as:
  * whitespaces, too many blank lines or trailing commas;
  *
  * Use `AbstractPostParserSniff` for higher-order checks.
@@ -24,7 +24,7 @@ public function getType()
     }
 
     /**
-     * Helper method to match a token of a given $type and $value.
+     * Helper method to match a token of a given type and value.
      *
      * @param Token  $token
      * @param int    $type

TwigCS/Sniff/AbstractSniff.php

@@ -9,20 +9,6 @@
  */
 abstract class AbstractSniff implements SniffInterface
 {
-    /**
-     * Default options for all sniffs.
-     *
-     * @var array
-     */
-    protected static $defaultOptions = [];
-
-    /**
-     * Computed options of this sniffs.
-     *
-     * @var array
-     */
-    protected $options;
-
     /**
      * When process is called, it will fill this report with the potential violations.
      *
@@ -35,26 +21,10 @@ abstract class AbstractSniff implements SniffInterface
      */
     protected $messages;
 
-    /**
-     * @param array $options Each sniff can defined its options.
-     */
-    public function __construct($options = [])
+    public function __construct()
     {
         $this->messages = [];
         $this->report   = null;
-        $this->options  = array_merge(self::$defaultOptions, $options);
-
-        $this->configure();
-    }
-
-    /**
-     * Configure this sniff based on its options.
-     *
-     * @return void
-     */
-    public function configure()
-    {
-        // Nothing.
     }
 
     /**

TwigCS/Sniff/Standard/EnsureBlankAtEOFSniff.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace TwigCS\Sniff\Standard;
+
+use TwigCS\Sniff\AbstractPreParserSniff;
+use TwigCS\Token\Token;
+
+/**
+ * Ensure that files ends with one blank line.
+ */
+class EnsureBlankAtEOFSniff extends AbstractPreParserSniff
+{
+    /**
+     * @param Token   $token
+     * @param int     $tokenPosition
+     * @param Token[] $tokens
+     *
+     * @return Token
+     */
+    public function process(Token $token, $tokenPosition, $tokens)
+    {
+        if ($this->isTokenMatching($token, Token::EOF_TYPE)) {
+            $i = 0;
+            while (isset($tokens[$tokenPosition - ($i + 1)])
+                && $this->isTokenMatching($tokens[$tokenPosition - ($i + 1)], Token::EOL_TYPE)
+            ) {
+                ++$i;
+            }
+
+            if (1 !== $i) {
+                // Either 0 or 2+ blank lines.
+                $this->addMessage(
+                    $this::MESSAGE_TYPE_ERROR,
+                    sprintf('A file must end with 1 blank line; found %d', $i),
+                    $token
+                );
+            }
+        }
+
+        return $token;
+    }
+}

TwigCS/Tests/AbstractSniffTest.php

@@ -44,11 +44,11 @@ public function setUp()
     /**
      * @param string         $filename
      * @param SniffInterface $sniff
-     * @param string[]       $expects
+     * @param array          $expects
      *
      * @throws \Exception
      */
-    protected function checkGenericSniff($filename, SniffInterface $sniff, $expects)
+    protected function checkGenericSniff($filename, SniffInterface $sniff, array $expects)
     {
         $file = __DIR__.'/Fixtures/'.$filename;
 

TwigCS/Tests/Fixtures/ensureBlankAtEOF.twig

@@ -0,0 +1,3 @@
+<div class="error">
+</div>
+

TwigCS/Tests/Sniff/EnsureBlankAtEOFTest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace TwigCS\Tests\Sniff;
+
+use TwigCS\Sniff\Standard\EnsureBlankAtEOFSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class EnsureBlankAtEOFTest
+ */
+class EnsureBlankAtEOFTest extends AbstractSniffTest
+{
+    public function testSniff1()
+    {
+        $this->checkGenericSniff('ensureBlankAtEOF.twig', new EnsureBlankAtEOFSniff(), [
+            [4, 1],
+        ]);
+    }
+}