Generic/UnnecessaryHeredoc: bug fix - fixer changes indentation type

src/Standards/Generic/Sniffs/Strings/UnnecessaryHeredocSniff.php

@@ -128,9 +128,13 @@ public function process(File $phpcsFile, int $stackPtr)
             $phpcsFile->fixer->replaceToken($stackPtr, $replacement);
 
             for ($i = ($stackPtr + 1); $i < $closer; $i++) {
-                $content = $tokens[$i]['content'];
-                $content = str_replace(['\\$', '\\\\'], ['$', '\\'], $content);
-                if ($tokens[$i]['content'] !== $content) {
+                $origContent = $tokens[$i]['content'];
+                if (isset($tokens[$i]['orig_content']) === true) {
+                    $origContent = $tokens[$i]['orig_content'];
+                }
+
+                $content = str_replace(['\\$', '\\\\'], ['$', '\\'], $origContent);
+                if ($origContent !== $content) {
                     $phpcsFile->fixer->replaceToken($i, $content);
                 }
             }

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.1.inc

@@ -1,10 +1,14 @@
 <?php
 
 /*
- * Test file 1 and 2 mirror each other, with file 1 containing non-indented cross-version compatible heredoc/nowdoc syntax,
- * while the code samples in file 2 use PHP 7.3+ flexible heredoc/nowdoc syntax.
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
  *
- * These two files should be kept in sync!
+ * These files should be kept in sync!
  */
 
 $nowdoc = <<<'EOD'

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.1.inc.fixed

@@ -1,10 +1,14 @@
 <?php
 
 /*
- * Test file 1 and 2 mirror each other, with file 1 containing non-indented cross-version compatible heredoc/nowdoc syntax,
- * while the code samples in file 2 use PHP 7.3+ flexible heredoc/nowdoc syntax.
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
  *
- * These two files should be kept in sync!
+ * These files should be kept in sync!
  */
 
 $nowdoc = <<<'EOD'

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.2.inc

@@ -1,10 +1,14 @@
 <?php
 
 /*
- * Test file 1 and 2 mirror each other, with file 1 containing non-indented cross-version compatible heredoc/nowdoc syntax,
- * while the code samples in file 2 use PHP 7.3+ flexible heredoc/nowdoc syntax.
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
  *
- * These two files should be kept in sync!
+ * These files should be kept in sync!
  */
 
 $nowdoc = <<<'EOD'

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.2.inc.fixed

@@ -1,10 +1,14 @@
 <?php
 
 /*
- * Test file 1 and 2 mirror each other, with file 1 containing non-indented cross-version compatible heredoc/nowdoc syntax,
- * while the code samples in file 2 use PHP 7.3+ flexible heredoc/nowdoc syntax.
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
  *
- * These two files should be kept in sync!
+ * These files should be kept in sync!
  */
 
 $nowdoc = <<<'EOD'

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.4.inc

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
+ *
+ * These files should be kept in sync!
+ */
+
+$nowdoc = <<<'EOD'
+    some text
+EOD;
+
+$heredoc = <<<END
+    some $foo text
+END;
+
+$heredoc = <<<"END"
+    some {$foo[0]} text
+END;
+
+$heredoc = <<<END
+    {$foo?->bar}
+END;
+
+$heredoc = <<<    "END"
+    some ${beers::softdrink}
+END;
+
+$heredoc = <<< END
+    {${$object->getName()}} text
+END;
+
+$heredoc = <<<"END"
+    some {${getName()}}
+END;
+
+$heredoc = <<<END
+    ${substr('laruence', 0, 2)}
+END;
+
+$heredoc = <<<"END"
+    some {$foo['bar']->baz()()}
+END;
+
+$heredoc = <<<END
+    {$obj->values[3]->name} text
+END;
+
+$heredoc = <<<"END"
+    some ${$bar}
+END;
+
+$heredoc = <<<END
+    ${foo->bar} text
+END;
+
+$heredoc = <<<"END"
+    ${foo["${bar}"]} text
+END;
+
+$heredoc = <<<END
+    some ${foo["${bar[\'baz\']}"]}
+END;
+
+$heredoc = <<<"END"
+    ${foo->{${'a'}}} text
+END;
+
+$heredoc = <<<END
+    some {$foo->{$baz[1]}}
+END;
+
+$heredoc = <<<END
+    some text
+    {${beers::$ale}}
+    some text
+END;
+
+$heredoc = <<<"END"
+    $people->john's wife greeted $people->robert.
+END;
+
+$heredoc = <<<END
+    Let's make sure it also works with this: {$arr[foo][3]}
+END;
+
+$heredoc = <<<END
+    Testing ${foo["${bar
+      ['baz']
+    }"]} and more testing
+END;
+
+$heredoc = <<<"END"
+    Testing {${foo["${bar
+      ['baz']
+    }"]}} and more testing
+END;
+
+$heredoc = <<<END
+    some text
+END;
+
+$heredoc = <<< "END"
+    some text
+    some \$text
+    some text \\ including a backslash
+END;
+
+$heredoc = <<<EOD
+    <?php
+    echo 'The below line contains escape characters and should be recognized as needing heredoc';
+    echo "aa\xC3\xC3	\xC3\xB8aa";
+EOD;
+
+echo <<<EOT
+    This should print a capital 'A': \x41
+EOT;
+
+echo <<<EOT
+    Here we should have a tab and 2 'A's: \t \101 \u{41}
+EOT;

src/Standards/Generic/Tests/Strings/UnnecessaryHeredocUnitTest.4.inc.fixed

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * Test files 1, 2, 4, 5 and 6 mirror each other for the test cases, with slight syntax variations.
+ * - File 1 contains non-indented cross-version compatible heredoc/nowdoc syntax with a non-indented heredoc/nowdoc body.
+ * - File 2 contains PHP 7.3+ flexible heredoc/nowdoc syntax with space indented heredoc/nowdoc body and scope closer.
+ * - File 4 contains non-indented cross-version compatible heredoc/nowdoc syntax with a space indented heredoc/nowdoc body.
+ * - File 5 contains non-indented cross-version compatible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body.
+ * - File 6 contains PHP 7.3+ flexible heredoc/nowdoc syntax with a tab indented heredoc/nowdoc body and scope closer.
+ *
+ * These files should be kept in sync!
+ */
+
+$nowdoc = <<<'EOD'
+    some text
+EOD;
+
+$heredoc = <<<END
+    some $foo text
+END;
+
+$heredoc = <<<"END"
+    some {$foo[0]} text
+END;
+
+$heredoc = <<<END
+    {$foo?->bar}
+END;
+
+$heredoc = <<<    "END"
+    some ${beers::softdrink}
+END;
+
+$heredoc = <<< END
+    {${$object->getName()}} text
+END;
+
+$heredoc = <<<"END"
+    some {${getName()}}
+END;
+
+$heredoc = <<<END
+    ${substr('laruence', 0, 2)}
+END;
+
+$heredoc = <<<"END"
+    some {$foo['bar']->baz()()}
+END;
+
+$heredoc = <<<END
+    {$obj->values[3]->name} text
+END;
+
+$heredoc = <<<"END"
+    some ${$bar}
+END;
+
+$heredoc = <<<END
+    ${foo->bar} text
+END;
+
+$heredoc = <<<"END"
+    ${foo["${bar}"]} text
+END;
+
+$heredoc = <<<END
+    some ${foo["${bar[\'baz\']}"]}
+END;
+
+$heredoc = <<<"END"
+    ${foo->{${'a'}}} text
+END;
+
+$heredoc = <<<END
+    some {$foo->{$baz[1]}}
+END;
+
+$heredoc = <<<END
+    some text
+    {${beers::$ale}}
+    some text
+END;
+
+$heredoc = <<<"END"
+    $people->john's wife greeted $people->robert.
+END;
+
+$heredoc = <<<END
+    Let's make sure it also works with this: {$arr[foo][3]}
+END;
+
+$heredoc = <<<END
+    Testing ${foo["${bar
+      ['baz']
+    }"]} and more testing
+END;
+
+$heredoc = <<<"END"
+    Testing {${foo["${bar
+      ['baz']
+    }"]}} and more testing
+END;
+
+$heredoc = <<<'END'
+    some text
+END;
+
+$heredoc = <<< 'END'
+    some text
+    some $text
+    some text \ including a backslash
+END;
+
+$heredoc = <<<EOD
+    <?php
+    echo 'The below line contains escape characters and should be recognized as needing heredoc';
+    echo "aa\xC3\xC3	\xC3\xB8aa";
+EOD;
+
+echo <<<EOT
+    This should print a capital 'A': \x41
+EOT;
+
+echo <<<EOT
+    Here we should have a tab and 2 'A's: \t \101 \u{41}
+EOT;