Squiz/FunctionDeclarationArgumentSpacing: bug fix / SpaceBeforeEquals + SpaceAfterEquals vs comments

When there is a comment between the parameter variable and the equal sign or the equal sign and the default value, the fixer would previously unintentionally and incorrectly remove most of these comments.

For the tests added in this commit, the fixer would previously result in the following - note that three out of the four comments have been removed..
```php
function newlineBeforeAndAfterEqualsSignFixedRespectsComments(
    $param=true
) {}

function commentBeforeAndAfterEqualsSignFixedRespectsComments(
    $param=/*comment*/ true
) {}
```

In this commit, I'm changing the sniff to still allow for flagging the spacing issue when there are comments, but to no longer auto-fix these to prevent the sniff removing the comments.

Includes tests.

Author: jrfnl

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

@@ -215,13 +215,18 @@ public function processBracket($phpcsFile, $openBracket)
                         $spacesBefore,
                     ];
 
-                    $fix = $phpcsFile->addFixableError($error, $equalToken, 'SpaceBeforeEquals', $data);
-                    if ($fix === true) {
-                        $padding = str_repeat(' ', $this->equalsSpacing);
-                        if ($spacesBefore === 0) {
-                            $phpcsFile->fixer->addContentBefore($equalToken, $padding);
-                        } else {
-                            $phpcsFile->fixer->replaceToken(($equalToken - 1), $padding);
+                    $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($param['token'] + 1), $equalToken, true);
+                    if ($nextNonWhitespace !== false) {
+                        $phpcsFile->addError($error, $equalToken, 'SpaceBeforeEquals', $data);
+                    } else {
+                        $fix = $phpcsFile->addFixableError($error, $equalToken, 'SpaceBeforeEquals', $data);
+                        if ($fix === true) {
+                            $padding = str_repeat(' ', $this->equalsSpacing);
+                            if ($spacesBefore === 0) {
+                                $phpcsFile->fixer->addContentBefore($equalToken, $padding);
+                            } else {
+                                $phpcsFile->fixer->replaceToken(($equalToken - 1), $padding);
+                            }
                         }
                     }
                 }//end if
@@ -240,13 +245,18 @@ public function processBracket($phpcsFile, $openBracket)
                         $spacesAfter,
                     ];
 
-                    $fix = $phpcsFile->addFixableError($error, $equalToken, 'SpaceAfterEquals', $data);
-                    if ($fix === true) {
-                        $padding = str_repeat(' ', $this->equalsSpacing);
-                        if ($spacesAfter === 0) {
-                            $phpcsFile->fixer->addContent($equalToken, $padding);
-                        } else {
-                            $phpcsFile->fixer->replaceToken(($equalToken + 1), $padding);
+                    $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, ($equalToken + 1), $param['default_token'], true);
+                    if ($nextNonWhitespace !== false) {
+                        $phpcsFile->addError($error, $equalToken, 'SpaceAfterEquals', $data);
+                    } else {
+                        $fix = $phpcsFile->addFixableError($error, $equalToken, 'SpaceAfterEquals', $data);
+                        if ($fix === true) {
+                            $padding = str_repeat(' ', $this->equalsSpacing);
+                            if ($spacesAfter === 0) {
+                                $phpcsFile->fixer->addContent($equalToken, $padding);
+                            } else {
+                                $phpcsFile->fixer->replaceToken(($equalToken + 1), $padding);
+                            }
                         }
                     }
                 }//end if

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

@@ -150,3 +150,19 @@ function newlineBeforeAndAfterEqualsSignShouldBeFixedForSpacing0(
 
     true
 ) {}
+
+function commentBeforeOrAfterEqualsSignShouldBeFlaggedNotFixed(
+    $param   /*comment*/   =   /*comment*/ true
+) {}
+
+function newlineAndCommentBeforeAndAfterEqualsSignShouldBeFlaggedNotFixed(
+    $param
+
+    //comment
+
+        =
+
+    //comment
+
+    true
+) {}

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

@@ -135,3 +135,19 @@ function newlineAfterVariadicFixerRespectsComment(
 function newlineBeforeAndAfterEqualsSignShouldBeFixedForSpacing0(
     $param=true
 ) {}
+
+function commentBeforeOrAfterEqualsSignShouldBeFlaggedNotFixed(
+    $param   /*comment*/   =   /*comment*/ true
+) {}
+
+function newlineAndCommentBeforeAndAfterEqualsSignShouldBeFlaggedNotFixed(
+    $param
+
+    //comment
+
+        =
+
+    //comment
+
+    true
+) {}

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

@@ -75,6 +75,8 @@ public function getErrorList()
             135 => 1,
             141 => 1,
             149 => 2,
+            155 => 2,
+            163 => 2,
         ];
 
     }//end getErrorList()