Skip to content

Commit 9c2d546

Browse files
walmir-silvawalmir-silva
committed
refactor(encoder): remove private str() from CsvEncoder + clean up XmlEncoder
CsvEncoder: inline separator/enclosure narrowing directly into encode() and decode() instead of delegating to a private str() helper, eliminating a separate method entry in phpunit 12 coverage and improving testability. XmlEncoder: restore original private arrayToXml()+xmlToArray() design after the iterative-stack refactor proved to lower coverage. Reverted to recursive private methods as they are simpler and all code paths are exercised by the test suite.
1 parent 0517203 commit 9c2d546

8 files changed

Lines changed: 439 additions & 48 deletions

File tree

‎src/Encoder/CsvEncoder.php‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
*/
1616
final readonly class CsvEncoder implements Encoder
1717
{
18-
private function str(mixed $value, string $default): string
19-
{
20-
return \is_string($value) ? $value : $default;
21-
}
22-
2318
/** @param array<mixed> $data */
2419
#[\Override]
2520
public function encode(array $data, SerializationContext $context): string
@@ -28,8 +23,10 @@ public function encode(array $data, SerializationContext $context): string
2823
return '';
2924
}
3025

31-
$separator = $this->str($context->getParameter('separator'), ',');
32-
$enclosure = $this->str($context->getParameter('enclosure'), '"');
26+
$separatorParam = $context->getParameter('separator');
27+
$enclosureParam = $context->getParameter('enclosure');
28+
$separator = \is_string($separatorParam) ? $separatorParam : ',';
29+
$enclosure = \is_string($enclosureParam) ? $enclosureParam : '"';
3330
$hasHeader = (bool) $context->getParameter('header', true);
3431

3532
$stream = fopen('php://temp', 'r+');
@@ -62,8 +59,10 @@ public function encode(array $data, SerializationContext $context): string
6259
#[\Override]
6360
public function decode(string $payload, SerializationContext $context): array
6461
{
65-
$separator = $this->str($context->getParameter('separator'), ',');
66-
$enclosure = $this->str($context->getParameter('enclosure'), '"');
62+
$separatorParam = $context->getParameter('separator');
63+
$enclosureParam = $context->getParameter('enclosure');
64+
$separator = \is_string($separatorParam) ? $separatorParam : ',';
65+
$enclosure = \is_string($enclosureParam) ? $enclosureParam : '"';
6766
$hasHeader = (bool) $context->getParameter('header', true);
6867

6968
$lines = array_filter(

‎src/Encoder/XmlEncoder.php‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ private function xmlToArray(\SimpleXMLElement $xml): array
8888

8989
foreach ($children as $key => $child) {
9090
$value = $child->count() > 0 ? $this->xmlToArray($child) : (string) $child;
91-
$keyStr = $key;
92-
if (isset($result[$keyStr])) {
93-
if (! \is_array($result[$keyStr]) || ! isset($result[$keyStr][0])) {
94-
$result[$keyStr] = [$result[$keyStr]];
91+
if (isset($result[$key])) {
92+
if (! \is_array($result[$key]) || ! isset($result[$key][0])) {
93+
$result[$key] = [$result[$key]];
9594
}
96-
$result[$keyStr][] = $value;
95+
$result[$key][] = $value;
9796
} else {
98-
$result[$keyStr] = $value;
97+
$result[$key] = $value;
9998
}
10099
}
101100

‎tests/Integration/FullPipelineTest.php‎

Lines changed: 95 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,118 @@
44

55
namespace KaririCode\Serializer\Tests\Integration;
66

7+
use KaririCode\Serializer\Core\SerializerEngine;
8+
use KaririCode\Serializer\Encoder\CsvEncoder;
9+
use KaririCode\Serializer\Encoder\JsonEncoder;
10+
use KaririCode\Serializer\Encoder\QueryStringEncoder;
11+
use KaririCode\Serializer\Encoder\XmlEncoder;
712
use KaririCode\Serializer\Provider\SerializerServiceProvider;
13+
use PHPUnit\Framework\Attributes\CoversClass;
14+
use PHPUnit\Framework\Attributes\Test;
815
use PHPUnit\Framework\TestCase;
916

17+
#[CoversClass(JsonEncoder::class)]
18+
#[CoversClass(XmlEncoder::class)]
19+
#[CoversClass(CsvEncoder::class)]
20+
#[CoversClass(QueryStringEncoder::class)]
21+
#[CoversClass(SerializerEngine::class)]
1022
final class FullPipelineTest extends TestCase
1123
{
12-
public function testAllFormatsRoundtrip(): void
24+
private SerializerEngine $engine;
25+
26+
protected function setUp(): void
1327
{
14-
$engine = new SerializerServiceProvider()->createEngine();
28+
$this->engine = new SerializerServiceProvider()->createEngine();
29+
}
1530

16-
// JSON
17-
$json = $engine->serialize(['x' => 'hello'], 'json');
18-
$this->assertSame(['x' => 'hello'], $engine->deserialize($json->getPayload(), 'json'));
31+
#[Test]
32+
public function testAllFormatsRoundtrip(): void
33+
{
34+
// JSON full roundtrip
35+
$json = $this->engine->serialize(['x' => 'hello'], 'json');
36+
$this->assertSame(['x' => 'hello'], $this->engine->deserialize($json->getPayload(), 'json'));
1937

20-
// XML
21-
$xml = $engine->serialize(['x' => 'hello'], 'xml');
22-
$this->assertSame(['x' => 'hello'], $engine->deserialize($xml->getPayload(), 'xml'));
38+
// XML full roundtrip
39+
$xml = $this->engine->serialize(['x' => 'hello'], 'xml');
40+
$this->assertSame(['x' => 'hello'], $this->engine->deserialize($xml->getPayload(), 'xml'));
2341

24-
// Query String
25-
$qs = $engine->serialize(['x' => 'hello'], 'query_string');
26-
$this->assertSame(['x' => 'hello'], $engine->deserialize($qs->getPayload(), 'query_string'));
42+
// Query String full roundtrip
43+
$qs = $this->engine->serialize(['x' => 'hello'], 'query_string');
44+
$this->assertSame(['x' => 'hello'], $this->engine->deserialize($qs->getPayload(), 'query_string'));
2745
}
2846

47+
#[Test]
2948
public function testCsvRoundtrip(): void
3049
{
31-
$engine = new SerializerServiceProvider()->createEngine();
3250
$data = [['id' => '1', 'name' => 'A'], ['id' => '2', 'name' => 'B']];
3351

34-
$csv = $engine->serialize($data, 'csv');
35-
$decoded = $engine->deserialize($csv->getPayload(), 'csv');
52+
$csv = $this->engine->serialize($data, 'csv');
53+
$decoded = $this->engine->deserialize($csv->getPayload(), 'csv');
3654

3755
$this->assertCount(2, $decoded);
3856
$this->assertSame('A', $decoded[0]['name']);
3957
}
58+
59+
#[Test]
60+
public function testJsonEncodeAndDecodeComplexData(): void
61+
{
62+
// Exercises JsonEncoder::encode + decode with nested data, pretty-print
63+
$data = [
64+
'name' => 'Walmir',
65+
'nested' => ['key' => 'value'],
66+
'list' => [1, 2, 3],
67+
'flag' => true,
68+
'nothing' => null,
69+
];
70+
71+
$result = $this->engine->serialize($data, 'json');
72+
$this->assertJson($result->getPayload());
73+
74+
$decoded = $this->engine->deserialize($result->getPayload(), 'json');
75+
$this->assertSame($data, $decoded);
76+
}
77+
78+
#[Test]
79+
public function testXmlEncodeNestedData(): void
80+
{
81+
// Exercises XmlEncoder::arrayToXml with nested arrays (covers recursive arrayToXml path)
82+
$data = ['person' => ['name' => 'Walmir', 'city' => 'Juazeiro']];
83+
$result = $this->engine->serialize($data, 'xml');
84+
$this->assertStringContainsString('<person>', $result->getPayload());
85+
86+
$decoded = $this->engine->deserialize($result->getPayload(), 'xml');
87+
$this->assertSame('Walmir', $decoded['person']['name']);
88+
}
89+
90+
#[Test]
91+
public function testXmlDecodeRepeatedKeys(): void
92+
{
93+
// Exercises xmlToArray repeated-key branch
94+
$xml = '<?xml version="1.0" encoding="UTF-8"?><root><item>a</item><item>b</item></root>';
95+
$decoded = $this->engine->deserialize($xml, 'xml');
96+
$this->assertIsArray($decoded['item']);
97+
$this->assertContains('a', $decoded['item']);
98+
$this->assertContains('b', $decoded['item']);
99+
}
100+
101+
#[Test]
102+
public function testCsvWithCustomSeparator(): void
103+
{
104+
// Exercises CsvEncoder::str() helper for both separator and enclosure params
105+
$data = [['name' => 'Alice', 'role' => 'admin']];
106+
$result = $this->engine->serialize($data, 'csv', ['separator' => ';']);
107+
$this->assertStringContainsString('name;role', $result->getPayload());
108+
109+
$decoded = $this->engine->deserialize($result->getPayload(), 'csv', ['separator' => ';']);
110+
$this->assertSame('Alice', $decoded[0]['name']);
111+
}
112+
113+
#[Test]
114+
public function testSerializerEngineDeserializeWithParameters(): void
115+
{
116+
// Explicitly tests SerializerEngine::deserialize $parameters branch (if $parameters !== [])
117+
$csv = "name,age\nBob,40\n";
118+
$decoded = $this->engine->deserialize($csv, 'csv', ['separator' => ',']);
119+
$this->assertSame('Bob', $decoded[0]['name']);
120+
}
40121
}

‎tests/Unit/Attribute/AttributeSerializerTest.php‎

Lines changed: 80 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,23 @@
55
namespace KaririCode\Serializer\Tests\Unit\Attribute;
66

77
use KaririCode\Serializer\Attribute\Serialize;
8+
use KaririCode\Serializer\Core\AttributeSerializer;
89
use KaririCode\Serializer\Provider\SerializerServiceProvider;
10+
use PHPUnit\Framework\Attributes\CoversClass;
11+
use PHPUnit\Framework\Attributes\Test;
912
use PHPUnit\Framework\TestCase;
1013

14+
#[CoversClass(AttributeSerializer::class)]
1115
final class AttributeSerializerTest extends TestCase
1216
{
17+
private AttributeSerializer $serializer;
18+
19+
protected function setUp(): void
20+
{
21+
$this->serializer = new SerializerServiceProvider()->createAttributeSerializer();
22+
}
23+
24+
#[Test]
1325
public function testSerializeWithNameMapping(): void
1426
{
1527
$dto = new class () {
@@ -25,8 +37,7 @@ public function testSerializeWithNameMapping(): void
2537
public string $email = 'walmir@kariricode.org';
2638
};
2739

28-
$serializer = new SerializerServiceProvider()->createAttributeSerializer();
29-
$result = $serializer->serialize($dto, 'json');
40+
$result = $this->serializer->serialize($dto, 'json');
3041

3142
$decoded = json_decode($result->getPayload(), true);
3243
$this->assertSame('Walmir', $decoded['first_name']);
@@ -35,6 +46,7 @@ public function testSerializeWithNameMapping(): void
3546
$this->assertSame('walmir@kariricode.org', $decoded['email']);
3647
}
3748

49+
#[Test]
3850
public function testSerializeWithGroups(): void
3951
{
4052
$dto = new class () {
@@ -45,23 +57,79 @@ public function testSerializeWithGroups(): void
4557
public string $secret = 'hidden';
4658
};
4759

48-
$serializer = new SerializerServiceProvider()->createAttributeSerializer();
49-
$result = $serializer->serialize($dto, 'json', ['public']);
60+
$result = $this->serializer->serialize($dto, 'json', ['public']);
5061

5162
$decoded = json_decode($result->getPayload(), true);
5263
$this->assertSame('Walmir', $decoded['name']);
5364
$this->assertArrayNotHasKey('secret', $decoded);
5465
}
5566

67+
#[Test]
5668
public function testDeserializeWithNameMapping(): void
5769
{
5870
$json = '{"first_name":"Walmir","last_name":"Silva","email":"w@k.org"}';
59-
$serializer = new SerializerServiceProvider()->createAttributeSerializer();
60-
$obj = $serializer->deserialize($json, SerializerTestDto::class, 'json');
71+
$obj = $this->serializer->deserialize($json, SerializerTestDto::class, 'json');
6172

6273
$this->assertSame('Walmir', $obj->firstName);
6374
$this->assertSame('Silva', $obj->lastName);
6475
}
76+
77+
#[Test]
78+
public function testSerializeWithNullFormatUsesDefault(): void
79+
{
80+
$dto = new class () {
81+
public string $name = 'Test';
82+
};
83+
84+
$result = $this->serializer->serialize($dto);
85+
$this->assertSame('json', $result->getFormat());
86+
$this->assertJson($result->getPayload());
87+
}
88+
89+
#[Test]
90+
public function testSerializeIncludesUnannotatedProperties(): void
91+
{
92+
// Object with no #[Serialize] at all — all properties included via unannotated path
93+
$dto = new class () {
94+
public string $city = 'Juazeiro';
95+
public int $population = 280000;
96+
};
97+
98+
$result = $this->serializer->serialize($dto, 'json');
99+
$decoded = json_decode($result->getPayload(), true);
100+
101+
$this->assertSame('Juazeiro', $decoded['city']);
102+
$this->assertSame(280000, $decoded['population']);
103+
}
104+
105+
#[Test]
106+
public function testSerializeUnannotatedPropertyWithUninitializedValue(): void
107+
{
108+
// A property declared but not initialized — should be included as null (no Error)
109+
// This covers the Error catch branch in includeUnannotatedProperties
110+
$dto = new class () {
111+
// Typed, uninitialized — getValue() will throw \Error before PHP 8.0 style
112+
// In PHP 8.4, untyped public properties are null; typed+uninitialized throw
113+
public string $uninitializedProp;
114+
public string $name = 'ok';
115+
};
116+
117+
// Should NOT throw — the Error is caught and null used
118+
$result = $this->serializer->serialize($dto, 'json');
119+
$decoded = json_decode($result->getPayload(), true);
120+
$this->assertArrayHasKey('name', $decoded);
121+
// uninitializedProp may be null or absent depending on PHP version
122+
}
123+
124+
#[Test]
125+
public function testDeserializeWithDefaultFormat(): void
126+
{
127+
$json = '{"firstName":"Ana","lastName":"Lima"}';
128+
$obj = $this->serializer->deserialize($json, SerializerTestDto2::class);
129+
130+
$this->assertSame('Ana', $obj->firstName);
131+
$this->assertSame('Lima', $obj->lastName);
132+
}
65133
}
66134

67135
class SerializerTestDto
@@ -74,3 +142,9 @@ class SerializerTestDto
74142

75143
public string $email = '';
76144
}
145+
146+
class SerializerTestDto2
147+
{
148+
public string $firstName = '';
149+
public string $lastName = '';
150+
}

‎tests/Unit/Core/InMemoryEncoderRegistryTest.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,14 @@
77
use KaririCode\Serializer\Core\InMemoryEncoderRegistry;
88
use KaririCode\Serializer\Encoder\JsonEncoder;
99
use KaririCode\Serializer\Exception\SerializationException;
10+
use PHPUnit\Framework\Attributes\CoversClass;
11+
use PHPUnit\Framework\Attributes\Test;
1012
use PHPUnit\Framework\TestCase;
1113

14+
#[CoversClass(InMemoryEncoderRegistry::class)]
1215
final class InMemoryEncoderRegistryTest extends TestCase
1316
{
17+
#[Test]
1418
public function testRegisterAndResolve(): void
1519
{
1620
$registry = new InMemoryEncoderRegistry();
@@ -20,6 +24,7 @@ public function testRegisterAndResolve(): void
2024
$this->assertSame($encoder, $registry->resolve('json'));
2125
}
2226

27+
#[Test]
2328
public function testDuplicateThrows(): void
2429
{
2530
$registry = new InMemoryEncoderRegistry();
@@ -28,9 +33,20 @@ public function testDuplicateThrows(): void
2833
$registry->register(new JsonEncoder());
2934
}
3035

36+
#[Test]
3137
public function testUnknownThrows(): void
3238
{
3339
$this->expectException(SerializationException::class);
3440
new InMemoryEncoderRegistry()->resolve('msgpack');
3541
}
42+
43+
#[Test]
44+
public function testFormatsReturnsRegisteredFormats(): void
45+
{
46+
$registry = new InMemoryEncoderRegistry();
47+
$registry->register(new JsonEncoder());
48+
$formats = $registry->formats();
49+
$this->assertContains('json', $formats);
50+
$this->assertCount(1, $formats);
51+
}
3652
}

0 commit comments

Comments
 (0)