PEAR.Functions.FunctionCallSignature now throws an error if the opening statement is not indented correctly (ref #1759)

If the opening statement is not indented to an exact tab stop, it can throw out the indent of the closing parenthesis, which can end up conflicting with the scope indent sniff.

Author: gsherwood

package.xml

@@ -98,7 +98,9 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Override the 'requiredSpacesBeforeColon' setting in a ruleset.xml file to change
     -- Default remains at 1
     -- Thanks to Nikola Kovacs for the patch
-  - PEAR.Functions.FunctionCallSignature now requires the function keyword to be indented to an exact tab stop
+  - PEAR.Functions.FunctionCallSignature now requires the function name to be indented to an exact tab stop
+    -- If the function name is not the start of the statement, the opening statement must be indented correctly instead
+    -- Added a new fixable error code PEAR.Functions.FunctionCallSignature.OpeningIndent for this error
   - The Squiz standard now ensures array keys are indented 4 spaces from the main statement
     -- Previously, this standard aligned keys 1 space from the start of the array keyword
   - The Squiz standard now ensures array end braces are aligned with the main statement

src/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

@@ -338,40 +338,53 @@ public function processMultiLineCall(File $phpcsFile, $stackPtr, $openBracket, $
         // We need to work out how far indented the function
         // call itself is, so we can work out how far to
         // indent the arguments.
-        $start = $phpcsFile->findStartOfStatement($stackPtr);
-        foreach (['stackPtr', 'start'] as $checkToken) {
-            $x = $$checkToken;
-            for ($i = ($x - 1); $i >= 0; $i--) {
-                if ($tokens[$i]['line'] !== $tokens[$x]['line']) {
-                    $i++;
-                    break;
-                }
-            }
+        $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true);
+        if ($tokens[$first]['code'] === T_CONSTANT_ENCAPSED_STRING
+            && $tokens[($first - 1)]['code'] === T_CONSTANT_ENCAPSED_STRING
+        ) {
+            // We are in a multi-line string, so find the start and use
+            // the indent from there.
+            $prev  = $phpcsFile->findPrevious(T_CONSTANT_ENCAPSED_STRING, ($first - 2), null, true);
+            $first = $phpcsFile->findFirstOnLine(Tokens::$emptyTokens, $prev, true);
+        }
 
-            if ($i <= 0) {
-                $functionIndent = 0;
-            } else if ($tokens[$i]['code'] === T_WHITESPACE) {
-                $functionIndent = strlen($tokens[$i]['content']);
-            } else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) {
-                $functionIndent = 0;
-            } else {
-                $trimmed = ltrim($tokens[$i]['content']);
+        $foundIndent = 0;
+        if ($first !== false) {
+            if ($tokens[$first]['code'] === T_INLINE_HTML) {
+                $trimmed = ltrim($tokens[$first]['content']);
                 if ($trimmed === '') {
-                    if ($tokens[$i]['code'] === T_INLINE_HTML) {
-                        $functionIndent = strlen($tokens[$i]['content']);
-                    } else {
-                        $functionIndent = ($tokens[$i]['column'] - 1);
-                    }
+                    $foundIndent = strlen($tokens[$first]['content']);
                 } else {
-                    $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
+                    $foundIndent = (strlen($tokens[$first]['content']) - strlen($trimmed));
                 }
+            } else {
+                $foundIndent = ($tokens[$first]['column'] - 1);
             }
+        }
 
-            $varName  = $checkToken.'Indent';
-            $$varName = $functionIndent;
-        }//end foreach
+        // Make sure the function indent is divisible by the indent size.
+        // We round down here because this accounts for times when the
+        // surrounding code is indented a little too far in, and not correctly
+        // at a tab stop. Without this, the function will be indented a further
+        // $indent spaces to the right.
+        $functionIndent = (int) (floor($foundIndent / $this->indent) * $this->indent);
+        if ($foundIndent !== $functionIndent) {
+            $error = 'Opening statement of multi-line function call not indented correctly; expected %s spaces but found %s';
+            $data  = [
+                $functionIndent,
+                $foundIndent,
+            ];
 
-        $functionIndent = max($startIndent, $stackPtrIndent);
+            $fix = $phpcsFile->addFixableError($error, $first, 'OpeningIndent', $data);
+            if ($fix === true) {
+                $padding = str_repeat(' ', $functionIndent);
+                if ($foundIndent === 0) {
+                    $phpcsFile->fixer->addContentBefore($first, $padding);
+                } else {
+                    $phpcsFile->fixer->replaceToken(($first - 1), $padding);
+                }
+            }
+        }
 
         $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($openBracket + 1), null, true);
         if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {
@@ -470,13 +483,6 @@ public function processMultiLineCall(File $phpcsFile, $stackPtr, $openBracket, $
                         $expectedIndent = ($functionIndent + $this->indent);
                     }
 
-                    // Make sure the expected indent is divisible by the indent size.
-                    // We round down here because this accounts for times when the
-                    // surrounding code is indented a little too far in, and not correctly
-                    // at a tab stop. Without this, the function will be indented a further
-                    // $indent spaces to the right.
-                    $expectedIndent = (int) (floor($expectedIndent / $this->indent) * $this->indent);
-
                     if ($tokens[$i]['code'] !== T_WHITESPACE
                         && $tokens[$i]['code'] !== T_DOC_COMMENT_WHITESPACE
                     ) {

src/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc

@@ -379,3 +379,19 @@ function foo()
         }
     );
 }
+
+$deprecated_functions = [
+    'the_category_ID'
+       => function_call( // 7 spaces, not 8. This is the problem line.
+        $a,
+        $b
+    ),
+];
+
+$deprecated_functions = [
+    'the_category_ID'
+         => function_call( // 7 spaces, not 8. This is the problem line.
+        $a,
+        $b
+    ),
+];

src/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc.fixed

@@ -387,8 +387,24 @@ class Foo
 
 function foo()
 {
-     Bar(
+    Bar(
         function () {
         }
     );
 }
+
+$deprecated_functions = [
+    'the_category_ID'
+    => function_call( // 7 spaces, not 8. This is the problem line.
+        $a,
+        $b
+    ),
+];
+
+$deprecated_functions = [
+    'the_category_ID'
+        => function_call( // 7 spaces, not 8. This is the problem line.
+            $a,
+            $b
+        ),
+];

src/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.php

@@ -99,6 +99,12 @@ public function getErrorList($testFile='FunctionCallSignatureUnitTest.inc')
             353 => 1,
             354 => 1,
             355 => 2,
+            377 => 1,
+            385 => 1,
+            393 => 1,
+            394 => 1,
+            395 => 1,
+            396 => 1,
         ];
 
     }//end getErrorList()