Fix comma spacing sniff.

Author: dereuromark

PhpCollective/Sniffs/WhiteSpace/CommaSpacingSniff.php

@@ -9,6 +9,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 
 /**
  * Ensures no whitespaces before and one whitespace after is placed around each comma.
@@ -50,9 +51,30 @@ public function process(File $phpcsFile, $stackPtr): void
             }
 
             $error = 'Space before comma, expected none, though';
+
+            $prevIndex = $phpcsFile->findPrevious(Tokens::$emptyTokens, $previous, null, true);
+            if (!$prevIndex) {
+                $phpcsFile->addError($error, $next, 'InvalidCommaBefore');
+
+                return;
+            }
+
             $fix = $phpcsFile->addFixableError($error, $next, 'InvalidCommaBefore');
             if ($fix) {
-                $phpcsFile->fixer->replaceToken($previous + 1, '');
+                $phpcsFile->fixer->beginChangeset();
+
+                $content = $tokens[$prevIndex]['content'];
+                $phpcsFile->fixer->replaceToken($prevIndex, $content . ',');
+                $phpcsFile->fixer->replaceToken($stackPtr, '');
+
+                $nextIndex = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+                if ($nextIndex) {
+                    for ($i = $stackPtr + 1; $i < $nextIndex; $i++) {
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+                }
+
+                $phpcsFile->fixer->endChangeset();
             }
         }
     }

tests/PhpCollective/Sniffs/WhiteSpace/CommaSpacingSniffTest.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PhpCollective\Test\PhpCollective\Sniffs\WhiteSpace;
+
+use PhpCollective\Sniffs\WhiteSpace\CommaSpacingSniff;
+use PhpCollective\Test\TestCase;
+
+class CommaSpacingSniffTest extends TestCase
+{
+    /**
+     * @return void
+     */
+    public function testDocBlockConstSniffer(): void
+    {
+        $this->assertSnifferFindsErrors(new CommaSpacingSniff(), 2);
+    }
+
+    /**
+     * @return void
+     */
+    public function testDocBlockConstFixer(): void
+    {
+        $this->assertSnifferCanFixErrors(new CommaSpacingSniff());
+    }
+}

tests/_data/CommaSpacing/after.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpCollective;
+
+class FixMe
+{
+    public function example(): array
+    {
+        return [
+            'url' => '/',
+            //, __('Preferences') => array('url' => '/preferences/index')
+            'Key' => ['value'],
+            __('Alerts') => ['url' => '/alerts/index'],
+        ];
+    }
+}

tests/_data/CommaSpacing/before.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpCollective;
+
+class FixMe
+{
+    public function example(): array
+    {
+        return [
+            'url' => '/'
+            //, __('Preferences') => array('url' => '/preferences/index')
+            , 'Key' => ['value']
+            , __('Alerts') => ['url' => '/alerts/index'],
+        ];
+    }
+}