bug #48331 [Yaml] fix dumping top-level tagged values (xabbuh)

nicolas-grekas · nicolas-grekas · commit 2c24bbcf5716 · 2022-12-13T10:57:04.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Yaml] fix dumping top-level tagged values | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #46725 | License | MIT | Doc PR | Commits ------- cbc616a fix dumping top-level tagged values
diff --git a/src/Symfony/Component/Yaml/Dumper.php b/src/Symfony/Component/Yaml/Dumper.php
@@ -58,6 +58,8 @@ public function dump($input, int $inline = 0, int $indent = 0, int $flags = 0):
 
         if ($inline <= 0 || (!\is_array($input) && !$input instanceof TaggedValue && $dumpObjectAsInlineMap) || empty($input)) {
             $output .= $prefix.Inline::dump($input, $flags);
+        } elseif ($input instanceof TaggedValue) {
+            $output .= $this->dumpTaggedValue($input, $inline, $indent, $flags, $prefix);
         } else {
             $dumpAsMap = Inline::isHash($input);
 
@@ -137,4 +139,28 @@ public function dump($input, int $inline = 0, int $indent = 0, int $flags = 0):
 
         return $output;
     }
+
+    private function dumpTaggedValue(TaggedValue $value, int $inline, int $indent, int $flags, string $prefix): string
+    {
+        $output = sprintf('%s!%s', $prefix ? $prefix.' ' : '', $value->getTag());
+
+        if (Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK & $flags && \is_string($value->getValue()) && false !== strpos($value->getValue(), "\n") && false === strpos($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 = (' ' === substr($value->getValue(), 0, 1)) ? (string) $this->indentation : '';
+            $output .= sprintf(' |%s', $blockIndentationIndicator);
+
+            foreach (explode("\n", $value->getValue()) as $row) {
+                $output .= sprintf("\n%s%s%s", $prefix, str_repeat(' ', $this->indentation), $row);
+            }
+
+            return $output;
+        }
+
+        if ($inline - 1 <= 0 || null === $value->getValue() || \is_scalar($value->getValue())) {
+            return $output.' '.$this->dump($value->getValue(), $inline - 1, 0, $flags)."\n";
+        }
+
+        return $output."\n".$this->dump($value->getValue(), $inline - 1, $indent, $flags);
+    }
 }
diff --git a/src/Symfony/Component/Yaml/Tests/DumperTest.php b/src/Symfony/Component/Yaml/Tests/DumperTest.php
@@ -444,8 +444,11 @@ public function testDumpingTaggedValueTopLevelAssoc()
     {
         $data = new TaggedValue('user', ['name' => 'jane']);
 
-        // @todo Fix the dumper, the output should not be ''.
-        $expected = '';
+        $expected = <<<'YAML'
+!user
+name: jane
+
+YAML;
         $yaml = $this->dumper->dump($data, 2);
         $this->assertSame($expected, $yaml);
     }
@@ -454,9 +457,7 @@ public function testDumpingTaggedValueTopLevelMultiLine()
     {
         $data = new TaggedValue('text', "a\nb\n");
 
-        // @todo Fix the dumper, the output should not be ''.
-        $expected = '';
-        $this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
+        $this->assertSame("!text |\n    a\n    b\n    ", $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
     }
 
     public function testDumpingTaggedValueSpecialCharsInTag()

Original file line number	Diff line number	Diff line change
`@@ -444,8 +444,11 @@ public function testDumpingTaggedValueTopLevelAssoc()`
`444`	`444`	`{`
`445`	`445`	`$data = new TaggedValue('user', ['name' => 'jane']);`
`446`	`446`
`447`		`- // @todo Fix the dumper, the output should not be ''.`
`448`		`- $expected = '';`
	`447`	`+ $expected = <<<'YAML'`
	`448`	`+!user`
	`449`	`+name: jane`
	`450`	`+`
	`451`	`+YAML;`
`449`	`452`	`$yaml = $this->dumper->dump($data, 2);`
`450`	`453`	`$this->assertSame($expected, $yaml);`
`451`	`454`	`}`
`@@ -454,9 +457,7 @@ public function testDumpingTaggedValueTopLevelMultiLine()`
`454`	`457`	`{`
`455`	`458`	`$data = new TaggedValue('text', "a\nb\n");`
`456`	`459`
`457`		`- // @todo Fix the dumper, the output should not be ''.`
`458`		`- $expected = '';`
`459`		`- $this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));`
	`460`	`+ $this->assertSame("!text \|\n a\n b\n ", $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));`
`460`	`461`	`}`
`461`	`462`
`462`	`463`	`public function testDumpingTaggedValueSpecialCharsInTag()`