Merge pull request #30 from VincentLanglet/staging

✨ Add new rules

Author: VincentLanglet

Symfony3Custom/Sniffs/Classes/ClassDeclarationSniff.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Symfony3Custom\Sniffs\Classes;
+
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Checks that there are not empty lines following class declaration.
+ */
+class ClassDeclarationSniff
+{
+    /**
+     * @return array
+     */
+    public function register()
+    {
+        return array(
+            T_CLASS,
+            T_INTERFACE,
+            T_TRAIT,
+        );
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param File $phpcsFile The file being scanned.
+     * @param int  $stackPtr  The position of the current token
+     *                        in the stack passed in $tokens.
+     *
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        // Just in case.
+        $tokens = $phpcsFile->getTokens();
+        $openingBrace = $tokens[$stackPtr]['scope_opener'];
+
+        if (isset($openingBrace) === false) {
+            return;
+        }
+
+        $nextElement = $phpcsFile->findNext(array(T_WHITESPACE), $openingBrace + 1, null, true);
+
+        if ($tokens[$openingBrace]['line'] + 1 < $tokens[$nextElement]['line']) {
+            $fix = $phpcsFile->addFixableError(
+                'The opening brace should not be followed by a blank line',
+                $openingBrace,
+                'Invalid'
+            );
+
+            if (true === $fix) {
+                $phpcsFile->fixer->replaceToken($openingBrace + 1, '');
+            }
+        }
+    }
+}

Symfony3Custom/Tests/Classes/ClassDeclarationUnitTest.inc

@@ -0,0 +1,17 @@
+<?php
+
+class ClassTest
+{
+
+}
+
+class ClassTest2
+{
+}
+
+class ClassTest3
+{
+
+
+    public $a = 1;
+}

Symfony3Custom/Tests/Classes/ClassDeclarationUnitTest.inc.fixed

@@ -0,0 +1,14 @@
+<?php
+
+class ClassTest
+{
+}
+
+class ClassTest2
+{
+}
+
+class ClassTest3
+{
+    public $a = 1;
+}

Symfony3Custom/Tests/Classes/ClassDeclarationUnitTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Symfony3Custom\Tests\Classes;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the ClassDeclaration sniff.
+ *
+ * @group Symfony3Custom
+ */
+class ClassDeclarationUnitTest 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(
+            4  => 1,
+            13 => 1,
+        );
+    }
+
+    /**
+     * 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 errors that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    public function getWarningList()
+    {
+        return array();
+    }
+}

docs/standards.md

@@ -101,6 +101,12 @@ we do not respect this rule:
 <rule ref="Symfony3Custom.WhiteSpace.OpenBracketSpacing"/>
 ```
 
+- Do not use blank lines after class openers `{`
+
+```
+<rule ref="Symfony3Custom.Classes.ClassDeclaration"/>
+```
+
 - Do not use multiple following blank lines
 
 ```