diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bug #39683 [Yaml] keep trailing newlines when dumping multi-line strings (xabbuh)

Browse Source 
This PR was merged into the 4.4 branch.

Discussion
----------

[Yaml] keep trailing newlines when dumping multi-line strings

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix https://github.com/symfony/symfony/pull/39668#issuecomment-753484545
| License       | MIT
| Doc PR        |

Commits
-------

4c513c24c7 keep trailing newlines when dumping multi-line strings
This commit is contained in:
Fabien Potencier 2021-01-03 09:28:04 +01:00
commit a902dd8a1b
3 changed files with 55 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/Symfony/Component/Yaml/Dumper.php
View File

@ -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;

40
src/Symfony/Component/Yaml/Tests/DumperTest.php
View File

@ -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');

2
src/Symfony/Component/Yaml/Tests/Fixtures/multiple_lines_as_literal_block.yml
View File

@ -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" }