Fixed bug #2511 : PSR2 standard not checking if closing paren of single-line function declaration is on new line

Author: gsherwood

package.xml

@@ -75,6 +75,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #2498 : Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed autofix breaks heredoc
   - Fixed bug #2502 : Generic.WhiteSpace.ScopeIndent false positives with nested switch indentation and case fall-through
   - Fixed bug #2504 : Generic.WhiteSpace.ScopeIndent false positives with nested arrays and nowdoc string
+  - Fixed bug #2511 : PSR2 standard not checking if closing paren of single-line function declaration is on new line
  </notes>
  <contents>
   <dir name="/">

src/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php

@@ -93,6 +93,54 @@ public function isMultiLineDeclaration($phpcsFile, $stackPtr, $openBracket, $tok
     }//end isMultiLineDeclaration()
 
 
+    /**
+     * Processes single-line declarations.
+     *
+     * Just uses the Generic BSD-Allman brace sniff.
+     *
+     * @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.
+     * @param array                       $tokens    The stack of tokens that make up
+     *                                               the file.
+     *
+     * @return void
+     */
+    public function processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens)
+    {
+        // We do everything the parent sniff does, and a bit more because we
+        // define multi-line declarations a bit differently.
+        parent::processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens);
+
+        $openingBracket = $tokens[$stackPtr]['parenthesis_opener'];
+        $closingBracket = $tokens[$stackPtr]['parenthesis_closer'];
+
+        $prevNonWhiteSpace = $phpcsFile->findPrevious(T_WHITESPACE, ($closingBracket - 1), $openingBracket, true);
+        if ($tokens[$prevNonWhiteSpace]['line'] !== $tokens[$closingBracket]['line']) {
+            $error = 'There must not be a newline before the closing parenthesis of a single-line function declaration';
+
+            if (isset(Tokens::$emptyTokens[$tokens[$prevNonWhiteSpace]['code']]) === true) {
+                $phpcsFile->addError($error, $closingBracket, 'CloseBracketNewLine');
+            } else {
+                $fix = $phpcsFile->addFixableError($error, $closingBracket, 'CloseBracketNewLine');
+                if ($fix === true) {
+                    $phpcsFile->fixer->beginChangeset();
+                    for ($i = ($closingBracket - 1); $i > $openingBracket; $i--) {
+                        if ($tokens[$i]['code'] !== T_WHITESPACE) {
+                            break;
+                        }
+
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+
+                    $phpcsFile->fixer->endChangeset();
+                }
+            }
+        }//end if
+
+    }//end processSingleLineDeclaration()
+
+
     /**
      * Processes multi-line declarations.
      *

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.inc

@@ -177,3 +177,15 @@ function __construct(
     $foo,   // phpcs:ignore Standard.Category.Sniff -- for reasons.
     $bar
 ) {}
+
+public function hello(string $greeting
+) {
+}
+
+public function hello(string $greeting // cant fix this
+) {
+}
+
+public function hello(string $greeting // phpcs:ignore Standard.Category.Sniff -- for reasons.
+) {
+}

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.inc.fixed

@@ -189,3 +189,17 @@ function __construct(
     $foo,   // phpcs:ignore Standard.Category.Sniff -- for reasons.
     $bar
 ) {}
+
+public function hello(string $greeting)
+{
+}
+
+public function hello(string $greeting // cant fix this
+)
+{
+}
+
+public function hello(string $greeting // phpcs:ignore Standard.Category.Sniff -- for reasons.
+)
+{
+}

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.php

@@ -50,6 +50,9 @@ public function getErrorList($testFile='MultiLineFunctionDeclarationUnitTest.inc
                 142 => 1,
                 158 => 1,
                 160 => 1,
+                182 => 2,
+                186 => 2,
+                190 => 2,
             ];
         } else {
             $errors = [