Skip to content

Allow setting yamlInline for ObjectDriver #212

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

Merged
merged 2 commits into from
May 8, 2025
Merged

Allow setting yamlInline for ObjectDriver #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9a5f9c
allow setting yamlInline for ObjectDriver
tassilogroeper Apr 23, 2025
f4ac407
Refactor ObjectDriver to accept yamlConfig array in constructor and u…
tassilogroeper Apr 26, 2025
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
25 changes: 20 additions & 5 deletions src/Drivers/ObjectDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@

class ObjectDriver implements Driver
{
private const DEFAULT_YAML_CONFIG = [
'yaml_inline' => 2,
'yaml_indent' => 4,
'yaml_flags' => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,
];

/**
* @param array{
* yaml_inline: int,
* yaml_indent: int,
* yaml_flags: int
* } $yamlConfig
*/
public function __construct(
Copy link
Member

@freekmurze freekmurze Apr 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of this single parameter, let's allow passing an array with options.

The default options should be

  'yaml_inline' => 2,
  'yaml_indent' => 4,
  'yaml_flags' => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,

Any options passed should be merged with the defaults.

Copy link
Contributor Author

@tassilogroeper tassilogroeper Apr 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also thought about it. fine with me.
However, I had a hard time, testing the indentation. The dedent function does behave, like I expected.
E.g. When setting the intent to 2 only the first line is corrected, but the others are still indented by 4 ?!

If you are fine to have a test for only the inline var, I can do it in my PR.

Copy link
Member

@freekmurze freekmurze Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are fine to have a test for only the inline var, I can do it in my PR.

That's ok!

Copy link
Contributor Author

@tassilogroeper tassilogroeper Apr 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! Requested changes are done!

protected array $yamlConfig = [],
) {
$this->yamlConfig = array_merge(self::DEFAULT_YAML_CONFIG, $yamlConfig);
}

public function serialize($data): string
{
$normalizers = [
Expand All @@ -26,11 +45,7 @@ public function serialize($data): string
$serializer = new Serializer($normalizers, $encoders);

return $this->dedent(
$serializer->serialize($data, 'yaml', [
'yaml_inline' => 2,
'yaml_indent' => 4,
'yaml_flags' => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,
])
$serializer->serialize($data, 'yaml', $this->yamlConfig)
);
}

Expand Down
23 changes: 23 additions & 0 deletions tests/Unit/Drivers/ObjectDriverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,29 @@ public function it_can_serialize_a_class_instance()

$this->assertEquals($expected, $driver->serialize(new Obj));
}

#[Test]
public function it_can_serialize_with_custom_parameters()
{
$driver = new ObjectDriver([
'yaml_inline' => 3,
]);

$nestedObject = (object) [
'foo' => (object) [
'bar' => (object) [
'baz' => ['qux', 'quux'],
],
],
];
$expected = implode("\n", [
'foo:',
' bar:',
' baz: [qux, quux]',
'',
]);
$this->assertEquals($expected, $driver->serialize($nestedObject));
}
}

class Obj
Expand Down