fix(console): avoid multiple new line when message already ends with a new line

joelwurtz · joelwurtz · commit b8c26754b144 · 2023-08-14T11:20:28.000+02:00
diff --git a/src/Symfony/Component/Console/Output/ConsoleSectionOutput.php b/src/Symfony/Component/Console/Output/ConsoleSectionOutput.php
@@ -168,6 +168,13 @@ public function addNewLineOfInputSubmit(): void
      */
     protected function doWrite(string $message, bool $newline)
     {
+        // if there is a new line at the end of message, but we do not add a new line, then simulate if without new line and add new line
+        // a lot of code relies on the newline bool to correctly format the output, it avoid a lot of new logic to handle both cases which are roughly the same
+        if (!$newline && str_ends_with($message, \PHP_EOL)) {
+            $message = substr($message, 0, -\strlen(\PHP_EOL));
+            $newline = true;
+        }
+
         if (!$this->isDecorated()) {
             parent::doWrite($message, $newline);
 
diff --git a/src/Symfony/Component/Console/Tests/Output/ConsoleSectionOutputTest.php b/src/Symfony/Component/Console/Tests/Output/ConsoleSectionOutputTest.php
@@ -158,7 +158,7 @@ public function testMaxHeightMultipleSections()
         $expected .= 'Two'.\PHP_EOL.'Three'.\PHP_EOL.'Four'.\PHP_EOL;
 
         // cause overflow of first section (redraw whole section, without first line)
-        $firstSection->writeln("Four\nFive\nSix");
+        $firstSection->writeln('Four'.\PHP_EOL.'Five'.\PHP_EOL.'Six');
         $expected .= "\x1b[6A\x1b[0J";
         $expected .= 'Four'.\PHP_EOL.'Five'.\PHP_EOL.'Six'.\PHP_EOL;
         $expected .= 'Two'.\PHP_EOL.'Three'.\PHP_EOL.'Four'.\PHP_EOL;
@@ -290,4 +290,16 @@ public function testClearSectionContainingQuestion()
         rewind($output->getStream());
         $this->assertSame('What\'s your favorite super hero?'.\PHP_EOL."\x1b[2A\x1b[0J", stream_get_contents($output->getStream()));
     }
+
+    public function testWriteWithoutNewLine()
+    {
+        $sections = [];
+        $output = new ConsoleSectionOutput($this->stream, $sections, OutputInterface::VERBOSITY_NORMAL, true, new OutputFormatter());
+
+        $output->write('Foo'.\PHP_EOL);
+        $output->write('Bar');
+
+        rewind($output->getStream());
+        $this->assertEquals(escapeshellcmd('Foo'.\PHP_EOL.'Bar'.\PHP_EOL), escapeshellcmd(stream_get_contents($output->getStream())));
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php b/src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php
@@ -212,15 +212,15 @@ public function testAskAndClearExpectFullSectionCleared()
 
         rewind($output->getStream());
         $this->assertEquals($answer, $givenAnswer);
-        $this->assertEquals(
+        $this->assertEquals(escapeshellcmd(
             'start'.\PHP_EOL. // write start
             'foo'.\PHP_EOL. // write foo
             "\x1b[1A\x1b[0Jfoo and bar".\PHP_EOL. // complete line
-            \PHP_EOL.\PHP_EOL." \033[32mDummy question?\033[39m:".\PHP_EOL.' > '.\PHP_EOL.\PHP_EOL.\PHP_EOL. // question
-            'foo2'.\PHP_EOL.\PHP_EOL. // write foo2
+            \PHP_EOL." \033[32mDummy question?\033[39m:".\PHP_EOL.' > '.\PHP_EOL.\PHP_EOL. // question
+            'foo2'.\PHP_EOL. // write foo2
             'bar2'.\PHP_EOL. // write bar
-            "\033[12A\033[0J", // clear 12 lines (11 output lines and one from the answer input return)
-            stream_get_contents($output->getStream())
+            "\033[9A\033[0J"), // clear 9 lines (8 output lines and one from the answer input return)
+            escapeshellcmd(stream_get_contents($output->getStream()))
         );
     }
 }
