Verticle empty lines

Author: louisl

CodeIgniter4/Sniffs/WhiteSpace/VerticalEmptyLinesSniff.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * Vertical Empty Lines
+ *
+ * @package   CodeIgniter4-Standard
+ * @author    Louis Linehan <louis.linehan@gmail.com>
+ * @copyright 2017 Louis Linehan
+ * @license   https://github.com/louisl/CodeIgniter4-Standard/blob/master/LICENSE MIT License
+ */
+
+namespace CodeIgniter4\Sniffs\WhiteSpace;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+use CodeIgniter4\Util\Common;
+
+/**
+ * Vertical Empty Lines Sniff
+ *
+ * Checks for consecutive empty vertical lines.
+ *
+ * @author Louis Linehan <louis.linehan@gmail.com>
+ */
+class VerticalEmptyLinesSniff implements Sniff
+{
+
+    /**
+     * Consecutive empty vertical lines allowed.
+     *
+     * @var integer
+     */
+    public $allowed = 1;
+
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_OPEN_TAG);
+
+    }//end register()
+
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+     * @param int                         $stackPtr  The position of the current token in
+     *                                               the stack passed in $tokens.
+     *
+     * @return int
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $errors = array();
+        $tokens = $phpcsFile->getTokens();
+        for ($i = 1; $i < $phpcsFile->numTokens; $i++) {
+            $nextContentPtr = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true);
+
+            $lines     = ($tokens[$nextContentPtr]['line'] - $tokens[$i]['line'] - 1);
+            $errorLine = (($nextContentPtr - $lines) + $this->allowed - 1);
+
+            if ($lines > ($this->allowed) && in_array($errorLine, $errors) === false) {
+                $errors[] = $errorLine;
+
+                $data  = array(
+                          $this->allowed,
+                          Common::pluralize('line', $this->allowed),
+                         );
+                $error = 'Expected only %s empty %s';
+                $fix   = $phpcsFile->addFixableError($error, $errorLine, 'VerticalEmptyLines', $data);
+                if ($fix === true) {
+                    $phpcsFile->fixer->replaceToken($errorLine, '');
+                }
+            }
+        }
+
+        // Ignore the rest of the file.
+        return ($phpcsFile->numTokens + 1);
+
+    }//end process()
+
+
+}//end class

CodeIgniter4/Tests/WhiteSpace/VerticalEmptyLinesUnitTest.inc

@@ -0,0 +1,49 @@
+<?php
+
+class Test
+{
+
+    public function test()
+    {
+        $a = 1;
+
+        $b = 2;
+    }
+
+
+    public function test2()
+    {
+        $a = 1;
+        $b = 2;
+
+
+        $b = 3;
+    }
+
+
+
+    public function test3()
+    {
+        $a = 1;
+        $b = 2;
+
+        
+        $c = 3;
+    }
+
+}
+
+$a = 1;
+$b = 2;
+
+
+$c = 3;
+
+
+$d = 4;
+
+
+
+
+
+$e = 5;

CodeIgniter4/Tests/WhiteSpace/VerticalEmptyLinesUnitTest.inc.fixed

@@ -0,0 +1,38 @@
+<?php
+
+class Test
+{
+
+    public function test()
+    {
+        $a = 1;
+
+        $b = 2;
+    }
+
+    public function test2()
+    {
+        $a = 1;
+        $b = 2;
+
+        $b = 3;
+    }
+
+    public function test3()
+    {
+        $a = 1;
+        $b = 2;
+
+        $c = 3;
+    }
+
+}
+
+$a = 1;
+$b = 2;
+
+$c = 3;
+
+$d = 4;
+
+$e = 5;

CodeIgniter4/Tests/WhiteSpace/VerticalEmptyLinesUnitTest.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Vertical Empty Lines Unit Test
+ *
+ * @package   CodeIgniter4-Standard
+ * @author    Louis Linehan <louis.linehan@gmail.com>
+ * @copyright 2017 Louis Linehan
+ * @license   https://github.com/louisl/CodeIgniter4-Standard/blob/master/LICENSE MIT License
+ */
+
+namespace CodeIgniter4\Tests\WhiteSpace;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class VerticalEmptyLinesUnitTest extends AbstractSniffUnitTest
+{
+
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList()
+    {
+        return array(
+                13 => 1,
+                19 => 1,
+                23 => 1,
+                24 => 1,
+                30 => 1,
+                38 => 1,
+                41 => 1,
+                44 => 1,
+                45 => 1,
+                46 => 1,
+                47 => 1,
+               );
+
+    }//end getErrorList()
+
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of warnings that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    public function getWarningList()
+    {
+        return array();
+
+    }//end getWarningList()
+
+
+}//end class

CodeIgniter4/ruleset.xml

@@ -135,6 +135,10 @@
     -->
     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
     <!--
+    Checks for more than one consecutive empty line.
+    -->
+    <rule ref="CodeIgniter4.WhiteSpace.VerticalEmptyLines"/>
+    <!--
     There should be one class per file, execept for cases where
     breaking this rule makes more sense.
     'Exception.php',
@@ -229,25 +233,13 @@
         </properties>
     </rule>
     <!--
-    <rule ref="Squiz.WhiteSpace.FunctionSpacing">                     
-        <properties>
-            <property name="spacing" value="1" />
-        </properties>
-    </rule>
-    @todo Clash here with function scopes using if (function_exists.
-    -->
-    <!--
     Checks there are no blank lines after a function opening brace.
     -->
     <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
     <!--
     Checks there are no blank lines before a function closing brace.
     -->
-    <rule ref="CodeIgniter4.WhiteSpace.FunctionClosingBraceSpace">
-        <properties>
-            <property name="allowedLines" value="0" />
-        </properties>
-    </rule>
+    <rule ref="CodeIgniter4.WhiteSpace.FunctionClosingBraceSpace"/>
     <!--
     Checks for each declarations are styled properly.
     -->