NoWhitespaceBeforeCommaInArrayFixer - fix comma after heredoc-end (php 7.3)

Author: gharlan

README.rst

@@ -1173,6 +1173,11 @@ Choose from the list of available rules:
 
   In array declaration, there MUST NOT be a whitespace before each comma.
 
+  Configuration options:
+
+  - ``after_heredoc`` (``bool``): whether the whitespace between heredoc end and
+    comma should be removed; defaults to ``false``
+
 * **no_whitespace_in_blank_line** [@Symfony, @PhpCsFixer]
 
   Remove trailing whitespace at the end of blank lines.

src/Fixer/ArrayNotation/NoWhitespaceBeforeCommaInArrayFixer.php

@@ -13,15 +13,22 @@
 namespace PhpCsFixer\Fixer\ArrayNotation;
 
 use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
+use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
+use PhpCsFixer\FixerConfiguration\InvalidOptionsForEnvException;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\VersionSpecification;
+use PhpCsFixer\FixerDefinition\VersionSpecificCodeSample;
 use PhpCsFixer\Tokenizer\CT;
 use PhpCsFixer\Tokenizer\Tokens;
+use Symfony\Component\OptionsResolver\Options;
 
 /**
  * @author Adam Marczuk <adam@marczuk.info>
  */
-final class NoWhitespaceBeforeCommaInArrayFixer extends AbstractFixer
+final class NoWhitespaceBeforeCommaInArrayFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface
 {
     /**
      * {@inheritdoc}
@@ -30,7 +37,23 @@ public function getDefinition()
     {
         return new FixerDefinition(
             'In array declaration, there MUST NOT be a whitespace before each comma.',
-            [new CodeSample("<?php \$x = array(1 , \"2\");\n")]
+            [
+                new CodeSample("<?php \$x = array(1 , \"2\");\n"),
+                new VersionSpecificCodeSample(
+                    <<<'SAMPLE'
+<?php
+    $x = [<<<EOD
+foo
+EOD
+        , 'bar'
+    ];
+
+SAMPLE
+                    ,
+                    new VersionSpecification(70300),
+                    ['after_heredoc' => true]
+                ),
+            ]
         );
     }
 
@@ -54,6 +77,26 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function createConfigurationDefinition()
+    {
+        return new FixerConfigurationResolver([
+            (new FixerOptionBuilder('after_heredoc', 'Whether the whitespace between heredoc end and comma should be removed.'))
+                ->setAllowedTypes(['bool'])
+                ->setDefault(false)
+                ->setNormalizer(static function (Options $options, $value) {
+                    if (\PHP_VERSION_ID < 70300 && $value) {
+                        throw new InvalidOptionsForEnvException('"after_heredoc" option can only be enabled with PHP 7.3+.');
+                    }
+
+                    return $value;
+                })
+                ->getOption(),
+        ]);
+    }
+
     /**
      * Method to fix spacing in array declaration.
      *
@@ -74,7 +117,11 @@ private function fixSpacing($index, Tokens $tokens)
             $i = $this->skipNonArrayElements($i, $tokens);
             $currentToken = $tokens[$i];
             $prevIndex = $tokens->getPrevNonWhitespace($i - 1);
-            if ($currentToken->equals(',') && !$tokens[$prevIndex]->equals([T_END_HEREDOC]) && !$tokens[$prevIndex]->isComment()) {
+
+            if (
+                $currentToken->equals(',') && !$tokens[$prevIndex]->isComment() &&
+                ($this->configuration['after_heredoc'] || !$tokens[$prevIndex]->equals([T_END_HEREDOC]))
+            ) {
                 $tokens->removeLeadingWhitespace($i);
             }
         }

tests/Fixer/ArrayNotation/NoWhitespaceBeforeCommaInArrayFixerTest.php

@@ -140,4 +140,39 @@ public function provideFixCases()
             ],
         ];
     }
+
+    /**
+     * @param string      $expected
+     * @param null|string $input
+     *
+     * @dataProvider provideFix73Cases
+     * @requires PHP 7.3
+     */
+    public function testFix73($expected, $input = null, array $config = [])
+    {
+        $this->fixer->configure($config);
+        $this->doTest($expected, $input);
+    }
+
+    public function provideFix73Cases()
+    {
+        return [
+            [
+                "<?php \$x = array(<<<'EOF'
+<?php \$a = '\\foo\\bar\\\\';
+EOF, <<<'EOF'
+<?php \$a = \"\\foo\\bar\\\\\";
+EOF
+                    );",
+                "<?php \$x = array(<<<'EOF'
+<?php \$a = '\\foo\\bar\\\\';
+EOF
+                , <<<'EOF'
+<?php \$a = \"\\foo\\bar\\\\\";
+EOF
+                    );",
+                ['after_heredoc' => true],
+            ],
+        ];
+    }
 }

tests/Fixtures/Integration/misc/PHP7_3.test

@@ -14,6 +14,7 @@ PHP 7.3 test.
     "native_function_invocation": {"include": ["get_class"]},
     "no_unset_cast": true,
     "no_unset_on_property": true,
+    "no_whitespace_before_comma_in_array": {"after_heredoc": true},
     "php_unit_dedicate_assert": true,
     "php_unit_expectation": true,
     "php_unit_mock": true,
@@ -86,12 +87,19 @@ in_array($b, $c, true, ); // `strict_param` rule
 foo(null === $a, ); // `yoda_style` rule
 $a = null; // `no_unset_cast` rule
 $foo->bar = null; // `no_unset_on_property` rule
-// `heredoc_indentation` rule
+
+// https://wiki.php.net/rfc/flexible_heredoc_nowdoc_syntaxes
     $a = <<<'EOD'
         abc
             def
             ghi
         EOD;
+$a = [<<<'EOD'
+    foo
+    EOD, <<<'EOD'
+    bar
+    EOD
+];
 
 --INPUT--
 <?php
@@ -153,9 +161,17 @@ trigger_error('Warning.', E_USER_DEPRECATED, ); // `error_suppression` rule
 foo($a === null, ); // `yoda_style` rule
 $a =(unset)$z; // `no_unset_cast` rule
 unset($foo->bar,); // `no_unset_on_property` rule
-// `heredoc_indentation` rule
+
+// https://wiki.php.net/rfc/flexible_heredoc_nowdoc_syntaxes
     $a = <<<'EOD'
 abc
     def
     ghi
 EOD;
+$a = [<<<'EOD'
+foo
+EOD
+    , <<<'EOD'
+bar
+EOD
+];