Fix issue where nowdocs with whitespace before labels are not detected

lkrms · Jan 20, 2025 · 46f7109 · 46f7109
1 parent 7b1f97a
commit 46f7109
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 16 deletions.
diff --git a/src/Filter/EvaluateStrings.php b/src/Filter/EvaluateStrings.php
@@ -6,7 +6,6 @@
 use Lkrms\PrettyPHP\Contract\Filter;
 use Lkrms\PrettyPHP\TokenUtil;
 use Salient\Utility\Exception\ShouldNotHappenException;
-use Salient\Utility\Regex;
 
 /**
  * Evaluate strings for comparison
@@ -67,17 +66,12 @@ public function filterTokens(array $tokens): array
                 $text = TokenUtil::unescapeBackticks($token->text);
                 eval("\$string = \"{$text}\";");
             } elseif ($lastString->id === \T_START_HEREDOC) {
-                $start = trim($lastString->text);
-                // Remove prefix if present, e.g. `b<<<EOF`
-                if ($start[0] !== '<') {
-                    /** @var string */
-                    $start = substr($start, 1);
-                }
+                $start = rtrim($lastString->text);
                 // Ignore nowdocs
-                if (substr($start, 0, 4) === "<<<'") {
+                if ($start[-1] === "'") {
                     continue;
                 }
-                $end = Regex::replace('/[^a-zA-Z0-9_]+/', '', $start);
+                $end = trim(ltrim($start, 'bB'), "< \t\"'");
                 eval("\$string = {$start}\n{$token->text}\n{$end};");
             } else {
                 // @codeCoverageIgnoreStart

diff --git a/src/Rule/NormaliseStrings.php b/src/Rule/NormaliseStrings.php
@@ -10,7 +10,6 @@
 use Lkrms\PrettyPHP\TokenUtil;
 use Salient\Utility\Exception\ShouldNotHappenException;
 use Salient\Utility\Regex;
-use Salient\Utility\Str;
 
 /**
  * Normalise strings
@@ -75,12 +74,10 @@ public function processTokens(array $tokens): void
             if ($token->id === \T_ENCAPSED_AND_WHITESPACE) {
                 /** @var Token */
                 $openedBy = $token->String;
-                if ($openedBy->id === \T_START_HEREDOC && (
-                    Str::startsWith($openedBy->text, "<<<'") || (
-                        $openedBy->text[0] !== '<'
-                        && Str::startsWith(substr($openedBy->text, 1), "<<<'")
-                    )
-                )) {
+                if (
+                    $openedBy->id === \T_START_HEREDOC
+                    && rtrim($openedBy->text)[-1] === "'"
+                ) {
                     continue;
                 }
             } else {

diff --git a/tests/fixtures/Formatter/in/issues/0195-nowdoc-with-space.php b/tests/fixtures/Formatter/in/issues/0195-nowdoc-with-space.php
@@ -0,0 +1,7 @@
+<?php
+$str = sprintf(
+    <<< 'EOP'
+        Lorem ipsum... %1$s
+        EOP,
+    'You know'
+);
diff --git a/tests/fixtures/Formatter/out/01-default/issues/0195-nowdoc-with-space.php b/tests/fixtures/Formatter/out/01-default/issues/0195-nowdoc-with-space.php
diff --git a/tests/fixtures/Formatter/out/02-aligned/issues/0195-nowdoc-with-space.php b/tests/fixtures/Formatter/out/02-aligned/issues/0195-nowdoc-with-space.php
diff --git a/tests/fixtures/Formatter/out/03-tab/issues/0195-nowdoc-with-space.php b/tests/fixtures/Formatter/out/03-tab/issues/0195-nowdoc-with-space.php
diff --git a/tests/fixtures/Formatter/out/04-psr12/issues/0195-nowdoc-with-space.php b/tests/fixtures/Formatter/out/04-psr12/issues/0195-nowdoc-with-space.php