Skip to content

[6.2] [Yaml] Dumper fix and refactor #46731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed

[6.2] [Yaml] Dumper fix and refactor #46731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e6b216d
cs fix
donquixote Aug 3, 2022
7a9adb5
[Yaml] Restore two failing test methods in DumperTest.
donquixote Jun 21, 2022
f0805d2
Dumper: Refactor: Use early return to drop else.
donquixote Jun 21, 2022
0ab3441
Dumper: Refactor: Break long sprintf() calls to multiple lines.
donquixote Jun 21, 2022
2e07ea6
Dumper: Refactor: Use string concat instead of sprintf.
donquixote Jun 21, 2022
0f840dd
Dumper: Refactor: Move shared concat parts to shared place in code.
donquixote Jun 21, 2022
a144056
Dumper: Refactor: Drop some local variables when handling multi-line …
donquixote Jun 21, 2022
d2716a7
Dumper: Refactor: Simplify condition in multi-line literal block.
donquixote Jun 21, 2022
bec0946
Dumper: Refactor: Introduce $this->indentStr to reduce number of str_…
donquixote Jun 21, 2022
efaf8b1
Dumper + DumperTest: Fix and simplify TaggedValue dumping.
donquixote Jun 21, 2022
86f63c6
Dumper: Refactor: Move inline check to a separate method.
donquixote Jun 21, 2022
4c6cc7a
Dumper: Refactor inline check, part I.
donquixote Jun 21, 2022
2ebabca
Dumper: Refactor inline check, part II.
donquixote Jun 21, 2022
d4774da
Dumper: Refactor inline check, part III.
donquixote Jun 21, 2022
84cb847
Dumper + DumperTest: Fix TaggedValue in top level.
donquixote Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 88 additions & 68 deletions src/Symfony/Component/Yaml/Dumper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,19 @@ class Dumper
*/
private int $indentation;

/**
* String of spaces with length equal to $this->indentation.
*/
private string $indentStr;

public function __construct(int $indentation = 4)
{
if ($indentation < 1) {
throw new \InvalidArgumentException('The indentation must be greater than zero.');
}

$this->indentation = $indentation;
$this->indentStr = \str_repeat(' ', $indentation);
}

/**
Expand All @@ -46,93 +52,107 @@ public function __construct(int $indentation = 4)
*/
public function dump(mixed $input, int $inline = 0, int $indent = 0, int $flags = 0): string
{
$output = '';
$prefix = $indent ? str_repeat(' ', $indent) : '';
$dumpObjectAsInlineMap = true;

if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($input instanceof \ArrayObject || $input instanceof \stdClass)) {
$dumpObjectAsInlineMap = empty((array) $input);
$tag = null;
if ($input instanceof TaggedValue) {
$tag = $input->getTag();
$input = $input->getValue();
if ($input instanceof TaggedValue) {
throw new \InvalidArgumentException('Nested tags are not supported.');
}
}

if ($inline <= 0 || (!\is_array($input) && !$input instanceof TaggedValue && $dumpObjectAsInlineMap) || empty($input)) {
$output .= $prefix.Inline::dump($input, $flags);
} else {
$dumpAsMap = Inline::isHash($input);

foreach ($input as $key => $value) {
if ('' !== $output && "\n" !== $output[-1]) {
$output .= "\n";
}

if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value) && str_contains($value, "\n") && !str_contains($value, "\r")) {
// 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 = str_starts_with($value, ' ') ? (string) $this->indentation : '';

if (isset($value[-2]) && "\n" === $value[-2] && "\n" === $value[-1]) {
$blockChompingIndicator = '+';
} elseif ("\n" === $value[-1]) {
$blockChompingIndicator = '';
} else {
$blockChompingIndicator = '-';
}
if ($this->shouldDumpAsInline($inline, $input, $flags)) {
return $prefix
. ($tag !== null ? '!' . $tag . ' ' : '')
. Inline::dump($input, $flags)
;
}

$output .= sprintf('%s%s%s |%s%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags).':' : '-', '', $blockIndentationIndicator, $blockChompingIndicator);
$dumpAsMap = Inline::isHash($input);

foreach (explode("\n", $value) as $row) {
if ('' === $row) {
$output .= "\n";
} else {
$output .= sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
}
}

continue;
}
$output = '';
foreach ($input as $key => $value) {
if ('' !== $output && "\n" !== $output[-1]) {
$output .= "\n";
}
$output .= $prefix;
$output .= $dumpAsMap ? Inline::dump($key, $flags).':' : '-';

$tagged = false;
if ($value instanceof TaggedValue) {
$output .= ' !' . $value->getTag();
$value = $value->getValue();
if ($value instanceof TaggedValue) {
$output .= sprintf('%s%s !%s', $prefix, $dumpAsMap ? Inline::dump($key, $flags).':' : '-', $value->getTag());
throw new \InvalidArgumentException('Nested tags are not supported.');
}
$tagged = true;
}

if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value->getValue()) && str_contains($value->getValue(), "\n") && !str_contains($value->getValue(), "\r\n")) {
// 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 = str_starts_with($value->getValue(), ' ') ? (string) $this->indentation : '';
$output .= sprintf(' |%s', $blockIndentationIndicator);
if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value) && str_contains($value, "\n") && !str_contains($value, "\r")) {
$output .= ' |';
// If the first line starts with a space character, the spec requires a blockIndicationIndicator
// http://www.yaml.org/spec/1.2/spec.html#id2793979
if (str_starts_with($value, ' ')) {
$output .= $this->indentation;
}

foreach (explode("\n", $value->getValue()) as $row) {
$output .= sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
}
if (isset($value[-2]) && "\n" === $value[-2] && "\n" === $value[-1]) {
$output .= '+';
} elseif ("\n" !== $value[-1]) {
$output .= '-';
}

continue;
foreach (explode("\n", $value) as $row) {
$output .= "\n";
if ('' !== $row) {
$output .= $prefix . $this->indentStr . $row;
}
}

if ($inline - 1 <= 0 || null === $value->getValue() || \is_scalar($value->getValue())) {
$output .= ' '.$this->dump($value->getValue(), $inline - 1, 0, $flags)."\n";
} else {
$output .= "\n";
$output .= $this->dump($value->getValue(), $inline - 1, $dumpAsMap ? $indent + $this->indentation : $indent + 2, $flags);
}
continue;
}

continue;
}
$willBeInlined = $this->shouldDumpAsInline($inline - 1, $value, $flags);

$output .= ($willBeInlined ? ' ' : "\n")
. $this->dump(
$value,
$inline - 1,
$willBeInlined
? 0
: $indent + ($tagged && !$dumpAsMap ? 2 : $this->indentation),
$flags,
)
. ($willBeInlined ? "\n" : '')
;
}

if ($tag !== null) {
$output = '!' . $tag . "\n" . $output;
}

$dumpObjectAsInlineMap = true;
return $output;
}

if (Yaml::DUMP_OBJECT_AS_MAP & $flags && ($value instanceof \ArrayObject || $value instanceof \stdClass)) {
$dumpObjectAsInlineMap = empty((array) $value);
}
private function shouldDumpAsInline(int $inline, $value, int $flags): bool
{
if ($inline <= 0 || empty($value)) {
return true;
}

$willBeInlined = $inline - 1 <= 0 || !\is_array($value) && $dumpObjectAsInlineMap || empty($value);
if (\is_array($value)) {
return false;
}

$output .= sprintf('%s%s%s%s',
$prefix,
$dumpAsMap ? Inline::dump($key, $flags).':' : '-',
$willBeInlined ? ' ' : "\n",
$this->dump($value, $inline - 1, $willBeInlined ? 0 : $indent + $this->indentation, $flags)
).($willBeInlined ? "\n" : '');
}
if (Yaml::DUMP_OBJECT_AS_MAP & $flags
&& ($value instanceof \ArrayObject || $value instanceof \stdClass)
&& !empty((array)$value)
) {
return false;
}

return $output;
return true;
}
}
40 changes: 28 additions & 12 deletions src/Symfony/Component/Yaml/Tests/DumperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,25 @@ public function testDumpingTaggedValueTopLevelAssocInline()
$this->assertSameData($data, $this->parser->parse($yaml, Yaml::PARSE_CUSTOM_TAGS));
}

public function testDumpingTaggedValueTopLevelAssoc()
{
$data = new TaggedValue('user', ['name' => 'jane']);
$expected = <<<'YAML'
!user
name: jane

YAML;
$this->assertSame($expected, $this->dumper->dump($data, 2));
}

public function testDumpingTaggedValueTopLevelMultiLine()
{
$data = new TaggedValue('text', "a\nb\n");
$expected = '!text "a\\nb\\n"';
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
$this->assertEquals($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
}

public function testDumpingTaggedValueSpecialCharsInTag()
{
// @todo Validate the tag name in the TaggedValue constructor.
Expand Down Expand Up @@ -569,15 +588,15 @@ public function testDumpingMultiLineStringAsScalarBlockTaggedValue()
$data = [
'foo' => new TaggedValue('bar', "foo\nline with trailing spaces:\n \nbar\ninteger like line:\n123456789\nempty line:\n\nbaz"),
];
$expected = "foo: !bar |\n".
$expected = "foo: !bar |-\n".
" foo\n".
" line with trailing spaces:\n".
" \n".
" bar\n".
" integer like line:\n".
" 123456789\n".
" empty line:\n".
" \n".
"\n".
' baz';

$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
Expand All @@ -589,12 +608,12 @@ public function testDumpingTaggedMultiLineInList()
$data = [
new TaggedValue('bar', "a\nb"),
];
$expected = "- !bar |\n a\n b";
$expected = "- !bar |-\n a\n b";
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));

// @todo Fix the parser, eliminate these exceptions.
$this->expectException(ParseException::class);
$this->expectExceptionMessage('Unable to parse at line 3 (near "!bar |").');
$this->expectExceptionMessage('Unable to parse at line 3 (near "!bar |-").');

$this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS);
}
Expand All @@ -604,14 +623,11 @@ public function testDumpingTaggedMultiLineTrailingNewlinesInMap()
$data = [
'foo' => new TaggedValue('bar', "a\nb\n\n\n"),
];
$expected = "foo: !bar |\n a\n b\n \n \n ";
$expected = "foo: !bar |+\n a\n b\n\n\n";
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));

// @todo Fix the parser, the result should be identical to $data.
$this->assertSameData(
[
'foo' => new TaggedValue('bar', "a\nb\n"),
],
$data,
$this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
}

Expand All @@ -620,12 +636,12 @@ public function testDumpingTaggedMultiLineTrailingNewlinesInList()
$data = [
new TaggedValue('bar', "a\nb\n\n\n"),
];
$expected = "- !bar |\n a\n b\n \n \n ";
$expected = "- !bar |+\n a\n b\n\n\n";
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));

// @todo Fix the parser, eliminate these exceptions.
$this->expectException(ParseException::class);
$this->expectExceptionMessage('Unable to parse at line 6 (near "!bar |").');
$this->expectExceptionMessage('Unable to parse at line 6 (near "!bar |+").');

$this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS);
}
Expand Down Expand Up @@ -677,7 +693,7 @@ public function testDumpMultiLineStringAsScalarBlock()
nested_inlined_multi_line_string: { inlined_multi_line: "foo\nbar\r\nempty line:\n\nbaz" }

YAML
);
);
$this->assertSame($expected, $yml);
$this->assertSame($data, $this->parser->parse($yml));
}
Expand Down