TextStrings::getCompleteTextString(): remove newline at end of heredoc/nowdoc

PHP itself does not include the last new line in a heredoc/nowdoc text string when handling it, so this method shouldn't either.

Included adjusted unit tests.

Author: jrfnl

PHPCSUtils/Utils/TextStrings.php

@@ -62,17 +62,21 @@ public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQ
             }
         }
 
+        $stripNewline = false;
+
         switch ($tokens[$stackPtr]['code']) {
             case \T_START_HEREDOC:
-                $stripQuotes = false;
-                $targetType  = \T_HEREDOC;
-                $current     = ($stackPtr + 1);
+                $stripQuotes  = false;
+                $stripNewline = true;
+                $targetType   = \T_HEREDOC;
+                $current      = ($stackPtr + 1);
                 break;
 
             case \T_START_NOWDOC:
-                $stripQuotes = false;
-                $targetType  = \T_NOWDOC;
-                $current     = ($stackPtr + 1);
+                $stripQuotes  = false;
+                $stripNewline = true;
+                $targetType   = \T_NOWDOC;
+                $current      = ($stackPtr + 1);
                 break;
 
             default:
@@ -87,6 +91,11 @@ public static function getCompleteTextString(File $phpcsFile, $stackPtr, $stripQ
             ++$current;
         } while (isset($tokens[$current]) && $tokens[$current]['code'] === $targetType);
 
+        if ($stripNewline === true) {
+            // Heredoc/nowdoc: strip the new line at the end of the string to emulate how PHP sees the string.
+            $string = rtrim($string, "\r\n");
+        }
+
         if ($stripQuotes === true) {
             return self::stripQuotes($string);
         }

Tests/Utils/TextStrings/GetCompleteTextStringTest.php

@@ -156,26 +156,22 @@ public function dataGetCompleteTextString()
                 'first line
 second $line
 third line
-fourth line
-',
+fourth line',
                 'first line
 second $line
 third line
-fourth line
-',
+fourth line',
             ],
             'nowdoc' => [
                 '/* testNowdocString */',
                 'first line
 second line
 third line
-fourth line
-',
+fourth line',
                 'first line
 second line
 third line
-fourth line
-',
+fourth line',
             ],
             'text-string-at-end-of-file' => [
                 '/* testTextStringAtEndOfFile */',