From 4c513c24c7e671ac72dbd203e5809aaa3a17f9a0 Mon Sep 17 00:00:00 2001
From: Christian Flothmann <christian.flothmann@sensiolabs.de>
Date: Sat, 2 Jan 2021 16:54:29 +0100
Subject: [PATCH] keep trailing newlines when dumping multi-line strings

---
 src/Symfony/Component/Yaml/Dumper.php         | 17 +++++++-
 .../Component/Yaml/Tests/DumperTest.php       | 40 ++++++++++++++++++-
 .../multiple_lines_as_literal_block.yml       |  2 +-
 3 files changed, 55 insertions(+), 4 deletions(-)

diff --git a/src/Symfony/Component/Yaml/Dumper.php b/src/Symfony/Component/Yaml/Dumper.php
index 5dec10945c..2de07d0231 100644
--- a/src/Symfony/Component/Yaml/Dumper.php
+++ b/src/Symfony/Component/Yaml/Dumper.php
@@ -72,10 +72,23 @@ class Dumper
                     // If the first line starts with a space character, the spec requires a blockIndicationIndicator
                     // http://www.yaml.org/spec/1.2/spec.html#id2793979
                     $blockIndentationIndicator = (' ' === substr($value, 0, 1)) ? (string) $this->indentation : '';
-                    $output .= sprintf('%s%s%s |%s-', $prefix, $dumpAsMap ? Inline::dump($key, $flags).':' : '-', '', $blockIndentationIndicator);
+
+                    if (isset($value[-2]) && "\n" === $value[-2] && "\n" === $value[-1]) {
+                        $blockChompingIndicator = '+';
+                    } elseif ("\n" === $value[-1]) {
+                        $blockChompingIndicator = '';
+                    } else {
+                        $blockChompingIndicator = '-';
+                    }
+
+                    $output .= sprintf('%s%s%s |%s%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags).':' : '-', '', $blockIndentationIndicator, $blockChompingIndicator);
 
                     foreach (explode("\n", $value) as $row) {
-                        $output .= sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
+                        if ('' === $row) {
+                            $output .= "\n";
+                        } else {
+                            $output .= sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
+                        }
                     }
 
                     continue;
diff --git a/src/Symfony/Component/Yaml/Tests/DumperTest.php b/src/Symfony/Component/Yaml/Tests/DumperTest.php
index ef449a4dfd..5bf0530220 100644
--- a/src/Symfony/Component/Yaml/Tests/DumperTest.php
+++ b/src/Symfony/Component/Yaml/Tests/DumperTest.php
@@ -567,7 +567,7 @@ YAML;
         ], 4, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
     }
 
-    public function testNoTrailingNewlineWhenDumpingAsMultiLineLiteralBlock()
+    public function testNoExtraTrailingNewlineWhenDumpingAsMultiLineLiteralBlock()
     {
         $data = [
             "a\nb",
@@ -579,6 +579,44 @@ YAML;
         $this->assertSame($data, Yaml::parse($yaml));
     }
 
+    public function testDumpTrailingNewlineInMultiLineLiteralBlocks()
+    {
+        $data = [
+            'clip 1' => "one\ntwo\n",
+            'clip 2' => "one\ntwo\n",
+            'keep 1' => "one\ntwo\n",
+            'keep 2' => "one\ntwo\n\n",
+            'strip 1' => "one\ntwo",
+            'strip 2' => "one\ntwo",
+        ];
+        $yaml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
+
+        $expected = <<<YAML
+'clip 1': |
+    one
+    two
+'clip 2': |
+    one
+    two
+'keep 1': |
+    one
+    two
+'keep 2': |+
+    one
+    two
+
+'strip 1': |-
+    one
+    two
+'strip 2': |-
+    one
+    two
+YAML;
+
+        $this->assertSame($expected, $yaml);
+        $this->assertSame($data, Yaml::parse($yaml));
+    }
+
     public function testZeroIndentationThrowsException()
     {
         $this->expectException('InvalidArgumentException');
diff --git a/src/Symfony/Component/Yaml/Tests/Fixtures/multiple_lines_as_literal_block.yml b/src/Symfony/Component/Yaml/Tests/Fixtures/multiple_lines_as_literal_block.yml
index 8c43bd4754..1f61eb1216 100644
--- a/src/Symfony/Component/Yaml/Tests/Fixtures/multiple_lines_as_literal_block.yml
+++ b/src/Symfony/Component/Yaml/Tests/Fixtures/multiple_lines_as_literal_block.yml
@@ -8,7 +8,7 @@ data:
         integer like line:
         123456789
         empty line:
-        
+
         baz
     multi_line_with_carriage_return: "foo\nbar\r\nbaz"
     nested_inlined_multi_line_string: { inlined_multi_line: "foo\nbar\r\nempty line:\n\nbaz" }