855 lines
25 KiB
PHP
Executable File
855 lines
25 KiB
PHP
Executable File
<?php
|
||
|
||
/*
|
||
* This file is part of the Symfony package.
|
||
*
|
||
* (c) Fabien Potencier <fabien@symfony.com>
|
||
*
|
||
* For the full copyright and license information, please view the LICENSE
|
||
* file that was distributed with this source code.
|
||
*/
|
||
|
||
namespace Symfony\Component\Yaml\Tests;
|
||
|
||
use PHPUnit\Framework\TestCase;
|
||
use Symfony\Component\Yaml\Dumper;
|
||
use Symfony\Component\Yaml\Exception\DumpException;
|
||
use Symfony\Component\Yaml\Exception\ParseException;
|
||
use Symfony\Component\Yaml\Parser;
|
||
use Symfony\Component\Yaml\Tag\TaggedValue;
|
||
use Symfony\Component\Yaml\Yaml;
|
||
|
||
class DumperTest extends TestCase
|
||
{
|
||
protected $parser;
|
||
protected $dumper;
|
||
protected $path;
|
||
|
||
protected $array = [
|
||
'' => 'bar',
|
||
'foo' => '#bar',
|
||
'foo\'bar' => [],
|
||
'bar' => [1, 'foo', ['a' => 'A']],
|
||
'foobar' => [
|
||
'foo' => 'bar',
|
||
'bar' => [1, 'foo'],
|
||
'foobar' => [
|
||
'foo' => 'bar',
|
||
'bar' => [1, 'foo'],
|
||
],
|
||
],
|
||
];
|
||
|
||
protected function setUp(): void
|
||
{
|
||
$this->parser = new Parser();
|
||
$this->dumper = new Dumper();
|
||
$this->path = __DIR__.'/Fixtures';
|
||
}
|
||
|
||
protected function tearDown(): void
|
||
{
|
||
$this->parser = null;
|
||
$this->dumper = null;
|
||
$this->path = null;
|
||
$this->array = null;
|
||
}
|
||
|
||
public function testIndentationInConstructor()
|
||
{
|
||
$dumper = new Dumper(7);
|
||
$expected = <<<'EOF'
|
||
'': bar
|
||
foo: '#bar'
|
||
'foo''bar': { }
|
||
bar:
|
||
- 1
|
||
- foo
|
||
-
|
||
a: A
|
||
foobar:
|
||
foo: bar
|
||
bar:
|
||
- 1
|
||
- foo
|
||
foobar:
|
||
foo: bar
|
||
bar:
|
||
- 1
|
||
- foo
|
||
|
||
EOF;
|
||
$this->assertSame($expected, $dumper->dump($this->array, 4, 0));
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
}
|
||
|
||
public function testSpecifications()
|
||
{
|
||
$files = $this->parser->parse(file_get_contents($this->path.'/index.yml'));
|
||
foreach ($files as $file) {
|
||
$yamls = file_get_contents($this->path.'/'.$file.'.yml');
|
||
|
||
// split YAMLs documents
|
||
foreach (preg_split('/^---( %YAML\:1\.0)?/m', $yamls) as $yaml) {
|
||
if (!$yaml) {
|
||
continue;
|
||
}
|
||
|
||
$test = $this->parser->parse($yaml);
|
||
if ($test['dump_skip'] ?? false) {
|
||
continue;
|
||
}
|
||
|
||
if ($test['todo'] ?? false) {
|
||
// TODO
|
||
continue;
|
||
}
|
||
|
||
$expected = eval('return '.trim($test['php']).';');
|
||
$this->assertSame($expected, $this->parser->parse($this->dumper->dump($expected, 10)), $test['test']);
|
||
}
|
||
}
|
||
}
|
||
|
||
public function testInlineLevel()
|
||
{
|
||
$expected = <<<'EOF'
|
||
{ '': bar, foo: '#bar', 'foo''bar': { }, bar: [1, foo, { a: A }], foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } } }
|
||
EOF;
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, -10), '->dump() takes an inline level argument');
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 0), '->dump() takes an inline level argument');
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
|
||
$expected = <<<'EOF'
|
||
'': bar
|
||
foo: '#bar'
|
||
'foo''bar': { }
|
||
bar: [1, foo, { a: A }]
|
||
foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } }
|
||
|
||
EOF;
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 1), '->dump() takes an inline level argument');
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
|
||
$expected = <<<'EOF'
|
||
'': bar
|
||
foo: '#bar'
|
||
'foo''bar': { }
|
||
bar:
|
||
- 1
|
||
- foo
|
||
- { a: A }
|
||
foobar:
|
||
foo: bar
|
||
bar: [1, foo]
|
||
foobar: { foo: bar, bar: [1, foo] }
|
||
|
||
EOF;
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 2), '->dump() takes an inline level argument');
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
|
||
$expected = <<<'EOF'
|
||
'': bar
|
||
foo: '#bar'
|
||
'foo''bar': { }
|
||
bar:
|
||
- 1
|
||
- foo
|
||
-
|
||
a: A
|
||
foobar:
|
||
foo: bar
|
||
bar:
|
||
- 1
|
||
- foo
|
||
foobar:
|
||
foo: bar
|
||
bar: [1, foo]
|
||
|
||
EOF;
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 3), '->dump() takes an inline level argument');
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
|
||
$expected = <<<'EOF'
|
||
'': bar
|
||
foo: '#bar'
|
||
'foo''bar': { }
|
||
bar:
|
||
- 1
|
||
- foo
|
||
-
|
||
a: A
|
||
foobar:
|
||
foo: bar
|
||
bar:
|
||
- 1
|
||
- foo
|
||
foobar:
|
||
foo: bar
|
||
bar:
|
||
- 1
|
||
- foo
|
||
|
||
EOF;
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 4), '->dump() takes an inline level argument');
|
||
$this->assertSame($expected, $this->dumper->dump($this->array, 10), '->dump() takes an inline level argument');
|
||
$this->assertSameData($this->array, $this->parser->parse($expected));
|
||
}
|
||
|
||
public function testObjectSupportEnabled()
|
||
{
|
||
$dump = $this->dumper->dump(['foo' => new A(), 'bar' => 1], 0, 0, Yaml::DUMP_OBJECT);
|
||
|
||
$this->assertSame('{ foo: !php/object \'O:30:"Symfony\Component\Yaml\Tests\A":1:{s:1:"a";s:3:"foo";}\', bar: 1 }', $dump, '->dump() is able to dump objects');
|
||
}
|
||
|
||
public function testObjectSupportDisabledButNoExceptions()
|
||
{
|
||
$dump = $this->dumper->dump(['foo' => new A(), 'bar' => 1]);
|
||
|
||
$this->assertSame('{ foo: null, bar: 1 }', $dump, '->dump() does not dump objects when disabled');
|
||
}
|
||
|
||
public function testObjectSupportDisabledWithExceptions()
|
||
{
|
||
$this->expectException(DumpException::class);
|
||
$this->dumper->dump(['foo' => new A(), 'bar' => 1], 0, 0, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE);
|
||
}
|
||
|
||
/**
|
||
* @dataProvider getEscapeSequences
|
||
*/
|
||
public function testEscapedEscapeSequencesInQuotedScalar($input, $expected)
|
||
{
|
||
$this->assertSame($expected, $this->dumper->dump($input));
|
||
$this->assertSameData($input, $this->parser->parse($expected));
|
||
}
|
||
|
||
public function getEscapeSequences()
|
||
{
|
||
return [
|
||
'empty string' => ['', "''"],
|
||
'null' => ["\x0", '"\\0"'],
|
||
'bell' => ["\x7", '"\\a"'],
|
||
'backspace' => ["\x8", '"\\b"'],
|
||
'horizontal-tab' => ["\t", '"\\t"'],
|
||
'line-feed' => ["\n", '"\\n"'],
|
||
'vertical-tab' => ["\v", '"\\v"'],
|
||
'form-feed' => ["\xC", '"\\f"'],
|
||
'carriage-return' => ["\r", '"\\r"'],
|
||
'escape' => ["\x1B", '"\\e"'],
|
||
'space' => [' ', "' '"],
|
||
'double-quote' => ['"', "'\"'"],
|
||
'slash' => ['/', '/'],
|
||
'backslash' => ['\\', '\\'],
|
||
'del' => ["\x7f", '"\x7f"'],
|
||
'next-line' => ["\xC2\x85", '"\\N"'],
|
||
'non-breaking-space' => ["\xc2\xa0", '"\\_"'],
|
||
'line-separator' => ["\xE2\x80\xA8", '"\\L"'],
|
||
'paragraph-separator' => ["\xE2\x80\xA9", '"\\P"'],
|
||
'colon' => [':', "':'"],
|
||
];
|
||
}
|
||
|
||
public function testBinaryDataIsDumpedBase64Encoded()
|
||
{
|
||
$binaryData = file_get_contents(__DIR__.'/Fixtures/arrow.gif');
|
||
$expected = '{ data: !!binary '.base64_encode($binaryData).' }';
|
||
|
||
$this->assertSame($expected, $this->dumper->dump(['data' => $binaryData]));
|
||
}
|
||
|
||
public function testNonUtf8DataIsDumpedBase64Encoded()
|
||
{
|
||
// "für" (ISO-8859-1 encoded)
|
||
$this->assertSame('!!binary ZsM/cg==', $this->dumper->dump("f\xc3\x3fr"));
|
||
}
|
||
|
||
/**
|
||
* @dataProvider objectAsMapProvider
|
||
*/
|
||
public function testDumpObjectAsMap($object, $expected)
|
||
{
|
||
$yaml = $this->dumper->dump($object, 0, 0, Yaml::DUMP_OBJECT_AS_MAP);
|
||
|
||
$this->assertSameData($expected, $this->parser->parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP));
|
||
}
|
||
|
||
public function objectAsMapProvider()
|
||
{
|
||
$tests = [];
|
||
|
||
$bar = new \stdClass();
|
||
$bar->class = 'classBar';
|
||
$bar->args = ['bar'];
|
||
$zar = new \stdClass();
|
||
$foo = new \stdClass();
|
||
$foo->bar = $bar;
|
||
$foo->zar = $zar;
|
||
$object = new \stdClass();
|
||
$object->foo = $foo;
|
||
$tests['stdClass'] = [$object, $object];
|
||
|
||
$arrayObject = new \ArrayObject();
|
||
$arrayObject['foo'] = 'bar';
|
||
$arrayObject['baz'] = 'foobar';
|
||
$parsedArrayObject = new \stdClass();
|
||
$parsedArrayObject->foo = 'bar';
|
||
$parsedArrayObject->baz = 'foobar';
|
||
$tests['ArrayObject'] = [$arrayObject, $parsedArrayObject];
|
||
|
||
$a = new A();
|
||
$tests['arbitrary-object'] = [$a, null];
|
||
|
||
return $tests;
|
||
}
|
||
|
||
public function testDumpingArrayObjectInstancesRespectsInlineLevel()
|
||
{
|
||
$deep = new \ArrayObject(['deep1' => 'd', 'deep2' => 'e']);
|
||
$inner = new \ArrayObject(['inner1' => 'b', 'inner2' => 'c', 'inner3' => $deep]);
|
||
$outer = new \ArrayObject(['outer1' => 'a', 'outer2' => $inner]);
|
||
|
||
$yaml = $this->dumper->dump($outer, 2, 0, Yaml::DUMP_OBJECT_AS_MAP);
|
||
|
||
$expected = <<<YAML
|
||
outer1: a
|
||
outer2:
|
||
inner1: b
|
||
inner2: c
|
||
inner3: { deep1: d, deep2: e }
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
}
|
||
|
||
public function testDumpingArrayObjectInstancesWithNumericKeysInlined()
|
||
{
|
||
$deep = new \ArrayObject(['d', 'e']);
|
||
$inner = new \ArrayObject(['b', 'c', $deep]);
|
||
$outer = new \ArrayObject(['a', $inner]);
|
||
|
||
$yaml = $this->dumper->dump($outer, 0, 0, Yaml::DUMP_OBJECT_AS_MAP);
|
||
$expected = <<<YAML
|
||
{ 0: a, 1: { 0: b, 1: c, 2: { 0: d, 1: e } } }
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
}
|
||
|
||
public function testDumpingArrayObjectInstancesWithNumericKeysRespectsInlineLevel()
|
||
{
|
||
$deep = new \ArrayObject(['d', 'e']);
|
||
$inner = new \ArrayObject(['b', 'c', $deep]);
|
||
$outer = new \ArrayObject(['a', $inner]);
|
||
$yaml = $this->dumper->dump($outer, 2, 0, Yaml::DUMP_OBJECT_AS_MAP);
|
||
$expected = <<<YAML
|
||
0: a
|
||
1:
|
||
0: b
|
||
1: c
|
||
2: { 0: d, 1: e }
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
}
|
||
|
||
public function testDumpEmptyArrayObjectInstanceAsMap()
|
||
{
|
||
$this->assertSame('{ }', $this->dumper->dump(new \ArrayObject(), 2, 0, Yaml::DUMP_OBJECT_AS_MAP));
|
||
}
|
||
|
||
public function testDumpEmptyStdClassInstanceAsMap()
|
||
{
|
||
$this->assertSame('{ }', $this->dumper->dump(new \stdClass(), 2, 0, Yaml::DUMP_OBJECT_AS_MAP));
|
||
}
|
||
|
||
public function testDumpingStdClassInstancesRespectsInlineLevel()
|
||
{
|
||
$deep = new \stdClass();
|
||
$deep->deep1 = 'd';
|
||
$deep->deep2 = 'e';
|
||
|
||
$inner = new \stdClass();
|
||
$inner->inner1 = 'b';
|
||
$inner->inner2 = 'c';
|
||
$inner->inner3 = $deep;
|
||
|
||
$outer = new \stdClass();
|
||
$outer->outer1 = 'a';
|
||
$outer->outer2 = $inner;
|
||
|
||
$yaml = $this->dumper->dump($outer, 2, 0, Yaml::DUMP_OBJECT_AS_MAP);
|
||
|
||
$expected = <<<YAML
|
||
outer1: a
|
||
outer2:
|
||
inner1: b
|
||
inner2: c
|
||
inner3: { deep1: d, deep2: e }
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSameData($outer, $this->parser->parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP));
|
||
}
|
||
|
||
public function testDumpingTaggedValueSequenceRespectsInlineLevel()
|
||
{
|
||
$data = [
|
||
new TaggedValue('user', [
|
||
'username' => 'jane',
|
||
]),
|
||
new TaggedValue('names', [
|
||
'john',
|
||
'claire',
|
||
]),
|
||
];
|
||
|
||
$yaml = $this->dumper->dump($data, 2);
|
||
|
||
$expected = <<<YAML
|
||
- !user
|
||
username: jane
|
||
- !names
|
||
- john
|
||
- claire
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueTopLevelScalar()
|
||
{
|
||
$data = new TaggedValue('user', 'jane');
|
||
|
||
$yaml = $this->dumper->dump($data);
|
||
|
||
$expected = '!user jane';
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSameData($data, $this->parser->parse($yaml, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueTopLevelAssocInline()
|
||
{
|
||
$data = new TaggedValue('user', ['name' => 'jane']);
|
||
|
||
$yaml = $this->dumper->dump($data);
|
||
|
||
$expected = '!user { name: jane }';
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSameData($data, $this->parser->parse($yaml, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueTopLevelAssoc()
|
||
{
|
||
$data = new TaggedValue('user', ['name' => 'jane']);
|
||
|
||
// @todo Fix the dumper, the output should not be ''.
|
||
$expected = '';
|
||
$yaml = $this->dumper->dump($data, 2);
|
||
$this->assertSame($expected, $yaml);
|
||
}
|
||
|
||
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));
|
||
}
|
||
|
||
public function testDumpingTaggedValueSpecialCharsInTag()
|
||
{
|
||
// @todo Validate the tag name in the TaggedValue constructor.
|
||
$data = new TaggedValue('a b @ c', 5);
|
||
$expected = '!a b @ c 5';
|
||
$this->assertSame($expected, $this->dumper->dump($data));
|
||
// The data changes after a round trip, due to the illegal tag name.
|
||
$data = new TaggedValue('a', 'b @ c 5');
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueSequenceWithInlinedTagValues()
|
||
{
|
||
$data = [
|
||
new TaggedValue('user', [
|
||
'username' => 'jane',
|
||
]),
|
||
new TaggedValue('names', [
|
||
'john',
|
||
'claire',
|
||
]),
|
||
new TaggedValue('number', 5),
|
||
];
|
||
|
||
$yaml = $this->dumper->dump($data, 1);
|
||
|
||
$expected = <<<YAML
|
||
- !user { username: jane }
|
||
- !names [john, claire]
|
||
- !number 5
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
// @todo Fix the parser, preserve numbers.
|
||
$data[2] = new TaggedValue('number', '5');
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueMapRespectsInlineLevel()
|
||
{
|
||
$data = [
|
||
'user1' => new TaggedValue('user', [
|
||
'username' => 'jane',
|
||
]),
|
||
'names1' => new TaggedValue('names', [
|
||
'john',
|
||
'claire',
|
||
]),
|
||
'count' => new TaggedValue('number', 5),
|
||
];
|
||
|
||
$yaml = $this->dumper->dump($data, 2);
|
||
|
||
$expected = <<<YAML
|
||
user1: !user
|
||
username: jane
|
||
names1: !names
|
||
- john
|
||
- claire
|
||
count: !number 5
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
// @todo Fix the parser, preserve numbers.
|
||
$data['count'] = new TaggedValue('number', '5');
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedValueMapWithInlinedTagValues()
|
||
{
|
||
$data = [
|
||
'user1' => new TaggedValue('user', [
|
||
'username' => 'jane',
|
||
]),
|
||
'names1' => new TaggedValue('names', [
|
||
'john',
|
||
'claire',
|
||
]),
|
||
];
|
||
|
||
$yaml = $this->dumper->dump($data, 1);
|
||
|
||
$expected = <<<YAML
|
||
user1: !user { username: jane }
|
||
names1: !names [john, claire]
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingNotInlinedScalarTaggedValue()
|
||
{
|
||
$data = [
|
||
'user1' => new TaggedValue('user', 'jane'),
|
||
'user2' => new TaggedValue('user', 'john'),
|
||
];
|
||
$expected = <<<YAML
|
||
user1: !user jane
|
||
user2: !user john
|
||
|
||
YAML;
|
||
|
||
$this->assertSame($expected, $this->dumper->dump($data, 2));
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingNotInlinedNullTaggedValue()
|
||
{
|
||
$data = [
|
||
'foo' => new TaggedValue('bar', null),
|
||
];
|
||
$expected = <<<YAML
|
||
foo: !bar null
|
||
|
||
YAML;
|
||
|
||
$this->assertSame($expected, $this->dumper->dump($data, 2));
|
||
|
||
// @todo Fix the parser, don't stringify null.
|
||
$data['foo'] = new TaggedValue('bar', 'null');
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS | Yaml::PARSE_CONSTANT));
|
||
}
|
||
|
||
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".
|
||
" foo\n".
|
||
" line with trailing spaces:\n".
|
||
" \n".
|
||
" bar\n".
|
||
" integer like line:\n".
|
||
" 123456789\n".
|
||
" empty line:\n".
|
||
" \n".
|
||
' baz';
|
||
|
||
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedMultiLineInList()
|
||
{
|
||
$data = [
|
||
new TaggedValue('bar', "a\nb"),
|
||
];
|
||
$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->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS);
|
||
}
|
||
|
||
public function testDumpingTaggedMultiLineTrailingNewlinesInMap()
|
||
{
|
||
$data = [
|
||
'foo' => new TaggedValue('bar', "a\nb\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"),
|
||
],
|
||
$this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpingTaggedMultiLineTrailingNewlinesInList()
|
||
{
|
||
$data = [
|
||
new TaggedValue('bar', "a\nb\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->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS);
|
||
}
|
||
|
||
public function testDumpingInlinedMultiLineIfRnBreakLineInTaggedValue()
|
||
{
|
||
$data = [
|
||
'data' => [
|
||
'foo' => new TaggedValue('bar', "foo\r\nline with trailing spaces:\n \nbar\ninteger like line:\n123456789\nempty line:\n\nbaz"),
|
||
],
|
||
];
|
||
$expected = <<<'YAML'
|
||
data:
|
||
foo: !bar "foo\r\nline with trailing spaces:\n \nbar\ninteger like line:\n123456789\nempty line:\n\nbaz"
|
||
|
||
YAML;
|
||
$yml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||
$this->assertSame($expected, $yml);
|
||
$this->assertSameData($data, $this->parser->parse($expected, Yaml::PARSE_CUSTOM_TAGS));
|
||
}
|
||
|
||
public function testDumpMultiLineStringAsScalarBlock()
|
||
{
|
||
$data = [
|
||
'data' => [
|
||
'single_line' => 'foo bar baz',
|
||
'multi_line' => "foo\nline with trailing spaces:\n \nbar\ninteger like line:\n123456789\nempty line:\n\nbaz",
|
||
'multi_line_with_carriage_return' => "foo\nbar\r\nbaz",
|
||
'nested_inlined_multi_line_string' => [
|
||
'inlined_multi_line' => "foo\nbar\r\nempty line:\n\nbaz",
|
||
],
|
||
],
|
||
];
|
||
$yml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||
$expected = str_replace("@\n", "\n", <<<'YAML'
|
||
data:
|
||
single_line: 'foo bar baz'
|
||
multi_line: |-
|
||
foo
|
||
line with trailing spaces:
|
||
@
|
||
bar
|
||
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" }
|
||
|
||
YAML
|
||
);
|
||
$this->assertSame($expected, $yml);
|
||
$this->assertSame($data, $this->parser->parse($yml));
|
||
}
|
||
|
||
public function testDumpMultiLineStringAsScalarBlockWhenFirstLineHasLeadingSpace()
|
||
{
|
||
$data = [
|
||
'data' => [
|
||
'multi_line' => " the first line has leading spaces\nThe second line does not.",
|
||
],
|
||
];
|
||
|
||
$expected = "data:\n multi_line: |4-\n the first line has leading spaces\n The second line does not.";
|
||
|
||
$yml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||
$this->assertSame($expected, $yml);
|
||
$this->assertSame($data, $this->parser->parse($yml));
|
||
}
|
||
|
||
public function testCarriageReturnFollowedByNewlineIsMaintainedWhenDumpingAsMultiLineLiteralBlock()
|
||
{
|
||
$data = ["a\r\nb\nc"];
|
||
$expected = "- \"a\\r\\nb\\nc\"\n";
|
||
$this->assertSame($expected, $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
|
||
$this->assertSame($data, $this->parser->parse($expected));
|
||
}
|
||
|
||
public function testCarriageReturnNotFollowedByNewlineIsPreservedWhenDumpingAsMultiLineLiteralBlock()
|
||
{
|
||
$data = [
|
||
'parent' => [
|
||
'foo' => "bar\n\rbaz: qux",
|
||
],
|
||
];
|
||
$expected = <<<'YAML'
|
||
parent:
|
||
foo: "bar\n\rbaz: qux"
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $this->dumper->dump($data, 4, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK));
|
||
$this->assertSame($data, $this->parser->parse($expected));
|
||
}
|
||
|
||
public function testNoExtraTrailingNewlineWhenDumpingAsMultiLineLiteralBlock()
|
||
{
|
||
$data = [
|
||
"a\nb",
|
||
"c\nd",
|
||
];
|
||
$yaml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||
|
||
$this->assertSame("- |-\n a\n b\n- |-\n c\n d", $yaml);
|
||
$this->assertSame($data, $this->parser->parse($yaml));
|
||
}
|
||
|
||
public function testTopLevelMultiLineStringLiteral()
|
||
{
|
||
$data = "a\nb\n";
|
||
$yaml = $this->dumper->dump($data, 2, 0, Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK);
|
||
$this->assertSame('"a\nb\n"', $yaml);
|
||
$this->assertSame($data, $this->parser->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",
|
||
'keep 3' => "one\ntwo\n\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
|
||
|
||
'keep 3': |+
|
||
one
|
||
two
|
||
|
||
|
||
'strip 1': |-
|
||
one
|
||
two
|
||
'strip 2': |-
|
||
one
|
||
two
|
||
YAML;
|
||
|
||
$this->assertSame($expected, $yaml);
|
||
$this->assertSame($data, $this->parser->parse($yaml));
|
||
}
|
||
|
||
public function testZeroIndentationThrowsException()
|
||
{
|
||
$this->expectException(\InvalidArgumentException::class);
|
||
$this->expectExceptionMessage('The indentation must be greater than zero');
|
||
new Dumper(0);
|
||
}
|
||
|
||
public function testNegativeIndentationThrowsException()
|
||
{
|
||
$this->expectException(\InvalidArgumentException::class);
|
||
$this->expectExceptionMessage('The indentation must be greater than zero');
|
||
new Dumper(-4);
|
||
}
|
||
|
||
public function testDumpNullAsTilde()
|
||
{
|
||
$this->assertSame('{ foo: ~ }', $this->dumper->dump(['foo' => null], 0, 0, Yaml::DUMP_NULL_AS_TILDE));
|
||
}
|
||
|
||
public function testDumpIdeographicSpaces()
|
||
{
|
||
$expected = <<<YAML
|
||
alone: ' '
|
||
within_string: 'a b'
|
||
regular_space: 'a b'
|
||
|
||
YAML;
|
||
$this->assertSame($expected, $this->dumper->dump([
|
||
'alone' => ' ',
|
||
'within_string' => 'a b',
|
||
'regular_space' => 'a b',
|
||
], 2));
|
||
}
|
||
|
||
private function assertSameData($expected, $actual)
|
||
{
|
||
$this->assertEquals($expected, $actual);
|
||
$this->assertSame(
|
||
var_export($expected, true),
|
||
var_export($actual, true)
|
||
);
|
||
}
|
||
}
|
||
|
||
class A
|
||
{
|
||
public $a = 'foo';
|
||
}
|