feat: Simplify closing marker when possible in `heredoc_closing_marke…

…r` fixer (PHP-CS-Fixer#7676)
maxhelias · Jan 9, 2024 · 41be952 · 41be952
1 parent d2906cd
commit 41be952
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 28 deletions.
diff --git a/src/Fixer/StringNotation/HeredocClosingMarkerFixer.php b/src/Fixer/StringNotation/HeredocClosingMarkerFixer.php
@@ -139,7 +139,18 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
                     }
                 }
 
-                $newClosingMarker = $reservedClosingMarkersMap[mb_strtoupper($existingClosingMarker)] ?? $this->configuration['closing_marker'];
+                $existingClosingMarker = mb_strtoupper($existingClosingMarker);
+                do {
+                    $newClosingMarker = $reservedClosingMarkersMap[$existingClosingMarker] ?? null;
+                    if (!str_ends_with($existingClosingMarker, '_')) {
+                        break;
+                    }
+                    $existingClosingMarker = substr($existingClosingMarker, 0, -1);
+                } while (null === $newClosingMarker);
+
+                if (null === $newClosingMarker) {
+                    $newClosingMarker = $this->configuration['closing_marker'];
+                }
 
                 $content = $tokens->generatePartialCode($startIndex + 1, $index - 1);
                 while (Preg::match('~(^|[\r\n])\s*'.preg_quote($newClosingMarker, '~').'(?!\w)~', $content)) {

diff --git a/tests/Fixer/StringNotation/HeredocClosingMarkerFixerTest.php b/tests/Fixer/StringNotation/HeredocClosingMarkerFixerTest.php
@@ -45,13 +45,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOD
                 xxx EOD xxx
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 xxx EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -60,13 +58,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<'EOD'
                 xxx EOD xxx
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<'TEST'
                 xxx EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -75,13 +71,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOF
                 xxx
                 EOF;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 xxx
                 TEST;
-
                 PHP,
             ['closing_marker' => 'EOF'],
         ];
@@ -97,7 +91,6 @@ public static function provideFixCases(): iterable
                 $b = <<<'EOD'
                 xxx3
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
@@ -109,7 +102,6 @@ public static function provideFixCases(): iterable
                 $b = <<<'TEST'
                 xxx3
                 TEST;
-
                 PHP,
             ['explicit_heredoc_style' => true],
         ];
@@ -119,13 +111,11 @@ public static function provideFixCases(): iterable
                 <?php $a = b<<<EOD
                 xxx EOD xxx
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = b<<<TEST
                 xxx EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -134,13 +124,11 @@ public static function provideFixCases(): iterable
                 <?php $a = B<<<EOD
                 xxx EOD xxx
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = B<<<TEST
                 xxx EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -149,7 +137,6 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<PHP
                 xxx
                 PHP;
-
                 PHP_,
         ];
 
@@ -160,15 +147,13 @@ public static function provideFixCases(): iterable
                 PHP;
                 $a = <<<PHP
                 PHP;
-
                 PHP_,
             <<<'PHP'
                 <?php $a = <<<php
                 xxx
                 php;
                 $a = <<<Php
                 Php;
-
                 PHP,
         ];
 
@@ -189,7 +174,6 @@ public static function provideFixCases(): iterable
                 $c = <<<EOD
                 xxx3
                 EOD;
-
                 PHP,
             <<<'PHP_'
                 <?php $a = <<<Žlutý
@@ -207,23 +191,49 @@ public static function provideFixCases(): iterable
                 $c = <<<PHP
                 xxx3
                 PHP;
-
                 PHP_,
             ['reserved_closing_markers' => ['Žlutý']],
         ];
 
+        yield 'no longer colliding reserved marker recovery' => [
+            <<<'PHP'
+                <?php
+                $a = <<<CSS
+                    CSS;
+                $a = <<<CSS
+                    CSS;
+                $a = <<<CSS_
+                    CSS
+                    CSS_;
+                $a = <<<CSS
+                    CSS_
+                    CSS;
+                PHP,
+            <<<'PHP'
+                <?php
+                $a = <<<CSS_
+                    CSS_;
+                $a = <<<CSS__
+                    CSS__;
+                $a = <<<CSS__
+                    CSS
+                    CSS__;
+                $a = <<<CSS__
+                    CSS_
+                    CSS__;
+                PHP,
+        ];
+
         yield 'heredoc /w content starting with preferred closing marker' => [
             <<<'PHP'
                 <?php $a = <<<EOD_
                 EOD xxx
                 EOD_;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -232,13 +242,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOD_
                  EOD xxx
                 EOD_;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                  EOD xxx
                 TEST;
-
                 PHP,
         ];
 
@@ -247,13 +255,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOD_
                 EOD'
                 EOD_;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 EOD'
                 TEST;
-
                 PHP,
         ];
 
@@ -262,13 +268,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOD_
                 EOD;
                 EOD_;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 EOD;
                 TEST;
-
                 PHP,
         ];
 
@@ -277,13 +281,11 @@ public static function provideFixCases(): iterable
                 <?php $a = <<<EOD
                 xxx EOD
                 EOD;
-
                 PHP,
             <<<'PHP'
                 <?php $a = <<<TEST
                 xxx EOD
                 TEST;
-
                 PHP,
         ];
     }