✨ Add check arounf (, {, ) and }

Author: Vincent Langlet

Symfony3Custom/Sniffs/WhiteSpace/CloseBracketSpacingSniff.php

@@ -0,0 +1,73 @@
+<?php
+
+/**
+ * Checks that there is no white space before a closing bracket, for ")" and "}".
+ * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
+ */
+class Symfony3Custom_Sniffs_WhiteSpace_CloseBracketSpacingSniff implements PHP_CodeSniffer_Sniff
+{
+    /**
+     * A list of tokenizers this sniff supports.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = array(
+        'PHP',
+        'JS',
+    );
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(
+            T_CLOSE_CURLY_BRACKET,
+            T_CLOSE_PARENTHESIS,
+        );
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param PHP_CodeSniffer_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(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        // Ignore curly brackets in javascript files.
+        if ($tokens[$stackPtr]['code'] === T_CLOSE_CURLY_BRACKET
+            && $phpcsFile->tokenizerType === 'JS'
+        ) {
+            return;
+        }
+
+        if (isset($tokens[($stackPtr - 1)]) === true
+            && $tokens[($stackPtr - 1)]['code'] === T_WHITESPACE
+        ) {
+            $before = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true);
+            if ($before !== false
+                && $tokens[$stackPtr]['line'] === $tokens[$before]['line']
+            ) {
+                $error = 'There should be no space before a closing "%s"';
+                $fix = $phpcsFile->addFixableError(
+                    $error,
+                    ($stackPtr - 1),
+                    'ClosingWhitespace',
+                    array($tokens[$stackPtr]['content'])
+                );
+
+                if ($fix === true) {
+                    $phpcsFile->fixer->replaceToken($stackPtr - 1, '');
+                }
+            }
+        }
+    }
+}

Symfony3Custom/Sniffs/WhiteSpace/OpenBracketSpacingSniff.php

@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * Checks that there is no white space after an opening bracket, for "(" and "{".
+ * Square Brackets are handled by Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff.
+ */
+class Symfony3Custom_Sniffs_WhiteSpace_OpenBracketSpacingSniff implements PHP_CodeSniffer_Sniff
+{
+    /**
+     * A list of tokenizers this sniff supports.
+     *
+     * @var array
+     */
+    public $supportedTokenizers = array(
+        'PHP',
+        'JS',
+    );
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @return array
+     */
+    public function register()
+    {
+        return array(
+            T_OPEN_CURLY_BRACKET,
+            T_OPEN_PARENTHESIS,
+        );
+
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param PHP_CodeSniffer_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(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        // Ignore curly brackets in javascript files.
+        if ($tokens[$stackPtr]['code'] === T_OPEN_CURLY_BRACKET
+            && $phpcsFile->tokenizerType === 'JS'
+        ) {
+            return;
+        }
+
+        if (isset($tokens[($stackPtr + 1)]) === true
+            && $tokens[($stackPtr + 1)]['code'] === T_WHITESPACE
+            && strpos($tokens[($stackPtr + 1)]['content'], $phpcsFile->eolChar) === false
+        ) {
+            $error = 'There should be no space after an opening "%s"';
+            $phpcsFile->addError(
+                $error,
+                ($stackPtr + 1),
+                'OpeningWhitespace',
+                array($tokens[$stackPtr]['content'])
+            );
+        }
+    }
+}

Symfony3Custom/Tests/WhiteSpace/CloseBracketSpacingUnitTest.inc

@@ -0,0 +1,7 @@
+<?php
+
+testFunction( args1, args2 );
+
+function f( ) { };
+
+$array = array( 1, 2 );

Symfony3Custom/Tests/WhiteSpace/CloseBracketSpacingUnitTest.inc.fixed

@@ -0,0 +1,7 @@
+<?php
+
+testFunction( args1, args2);
+
+function f() {};
+
+$array = array( 1, 2);

Symfony3Custom/Tests/WhiteSpace/CloseBracketSpacingUnitTest.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Unit test class for the CloseBracketSpacing sniff.
+ *
+ * A sniff unit test checks a .inc file for expected violations of a single
+ * coding standard. Expected errors and warnings are stored in this class.
+ */
+class Symfony3Custom_Tests_WhiteSpace_CloseBracketSpacingUnitTest 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(
+            3 => 1,
+            5 => 2,
+            7 => 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 warnings that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    protected function getWarningList()
+    {
+        return array();
+    }
+}

Symfony3Custom/Tests/WhiteSpace/OpenBracketSpacingUnitTest.inc

@@ -0,0 +1,7 @@
+<?php
+
+testFunction( args1, args2 );
+
+function f( ) { };
+
+$array = array( 1, 2 );

Symfony3Custom/Tests/WhiteSpace/OpenBracketSpacingUnitTest.inc.fixed

@@ -0,0 +1,7 @@
+<?php
+
+testFunction(args1, args2 );
+
+function f() {};
+
+$array = array(1, 2 );

Symfony3Custom/Tests/WhiteSpace/OpenBracketSpacingUnitTest.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Unit test class for the OpenBracketSpacing sniff.
+ *
+ * A sniff unit test checks a .inc file for expected violations of a single
+ * coding standard. Expected errors and warnings are stored in this class.
+ */
+class Symfony3Custom_Tests_WhiteSpace_OpenBracketSpacingUnitTest 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(
+            3 => 1,
+            5 => 2,
+            7 => 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 warnings that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    protected function getWarningList()
+    {
+        return array();
+    }
+}