Skip to content

Commit 8c8b714

Browse files
penovicpenovic
authored
Merge pull request #3 from undabot/feat/relationships-meta
Relationships meta
2 parents 562000b + 6299299 commit 8c8b714

File tree

3 files changed

+58
-91
lines changed

3 files changed

+58
-91
lines changed

‎src/Model/Resource/FlatResource.php

+26-4
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
*/
2323
class FlatResource
2424
{
25-
/** @var ResourceInterface */
26-
private $resource;
25+
/** @var array<string,array> */
26+
private array $relationshipMetas;
2727

28-
public function __construct(ResourceInterface $resource)
28+
public function __construct(private ResourceInterface $resource)
2929
{
30-
$this->resource = $resource;
30+
$this->relationshipMetas = [];
3131
}
3232

3333
/**
@@ -62,6 +62,7 @@ public function getRelationships(): array
6262

6363
/** @var RelationshipInterface $relationship */
6464
foreach ($this->resource->getRelationships() as $relationship) {
65+
$this->buildRelationshipMeta($relationship);
6566
$relationshipData = $relationship->getData();
6667

6768
if (null === $relationshipData) {
@@ -79,6 +80,7 @@ public function getRelationships(): array
7980
if ($relationshipData instanceof ToOneRelationshipDataInterface && false === $relationshipData->isEmpty()) {
8081
/** @var ResourceIdentifierInterface $data */
8182
$data = $relationshipData->getData();
83+
8284
$flatRelationships[$relationship->getName()] = $data->getId();
8385

8486
continue;
@@ -129,4 +131,24 @@ public function getIndexedRelationshipObjects(): array
129131

130132
return $flatRelationships;
131133
}
134+
135+
/** @return array<string,array<mixed,mixed>> */
136+
public function getRelationshipMetas(): array
137+
{
138+
if (true === empty($this->relationshipMetas)) {
139+
/** @var RelationshipInterface $relationship */
140+
foreach ($this->resource->getRelationships() as $relationship) {
141+
$this->buildRelationshipMeta($relationship);
142+
}
143+
}
144+
145+
return $this->relationshipMetas;
146+
}
147+
148+
private function buildRelationshipMeta(RelationshipInterface $relationship): void
149+
{
150+
$this->relationshipMetas[$relationship->getName() . 'Meta'] = null === $relationship->getMeta()
151+
? []
152+
: $relationship->getMeta()->getData();
153+
}
132154
}

‎src/Service/Resource/Denormalizer/ResourceDenormalizer.php

+6-11
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,10 @@
1818

1919
class ResourceDenormalizer
2020
{
21-
/** @var ResourceMetadataFactoryInterface */
22-
private $metadataFactory;
23-
24-
/** @var DenormalizerInterface */
25-
private $denormalizer;
26-
27-
public function __construct(ResourceMetadataFactoryInterface $metadataFactory, DenormalizerInterface $denormalizer)
28-
{
29-
$this->metadataFactory = $metadataFactory;
30-
$this->denormalizer = $denormalizer;
21+
public function __construct(
22+
private ResourceMetadataFactoryInterface $metadataFactory,
23+
private DenormalizerInterface $denormalizer
24+
) {
3125
}
3226

3327
/**
@@ -50,7 +44,7 @@ public function denormalize(ResourceInterface $resource, string $class): ApiMode
5044
try {
5145
/** @var ApiModel $result */
5246
$result = $this->denormalizer->denormalize($data, $class, null, [
53-
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
47+
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => true,
5448
]);
5549
} catch (MissingConstructorArgumentsException $e) {
5650
throw new MissingDataValueResourceDenormalizationException(
@@ -85,6 +79,7 @@ private function prepareData(ResourceInterface $resource, string $class): array
8579
];
8680
$data = array_merge($data, $flatResource->getAttributes());
8781
$data = array_merge($data, $flatResource->getRelationships());
82+
$data = array_merge($data, $flatResource->getRelationshipMetas());
8883

8984
/*
9085
* Resource has attribute and relationship names that can be different from the property name in the class.

‎tests/Integration/Resource/Denormalizer/ResourceWithAliasesDenormalizerTest.php

+26-76
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
use Undabot\SymfonyJsonApi\Service\Resource\Builder\ResourceAttributesBuilder;
1717
use Undabot\SymfonyJsonApi\Service\Resource\Builder\ResourceRelationshipsBuilder;
1818
use Undabot\SymfonyJsonApi\Service\Resource\Denormalizer\Exception\MissingDataValueResourceDenormalizationException;
19-
use Undabot\SymfonyJsonApi\Service\Resource\Denormalizer\Exception\ResourceDenormalizationException;
2019
use Undabot\SymfonyJsonApi\Service\Resource\Denormalizer\ResourceDenormalizer;
2120
use Undabot\SymfonyJsonApi\Service\Resource\Factory\ResourceMetadataFactory;
2221
use Undabot\SymfonyJsonApi\Service\Resource\Validation\Constraint\ResourceType;
@@ -26,80 +25,29 @@
2625
*/
2726
class AliasedResourceDto implements ApiModel
2827
{
29-
/**
30-
* @var string
31-
*/
32-
private $id;
33-
34-
/**
35-
* @var string
36-
* @JsonApi\Attribute(name="name")
37-
*/
38-
private $title;
39-
40-
/**
41-
* @var null|string
42-
* @JsonApi\Attribute(name="description")
43-
*/
44-
private $summary;
45-
46-
/**
47-
* @var array
48-
* @JsonApi\ToMany(name="tags", type="tag")
49-
*/
50-
private $tagIds;
51-
52-
/**
53-
* @var null|string
54-
* @JsonApi\ToOne(name="owner", type="person")
55-
*/
56-
private $ownerId;
57-
58-
public function __construct(string $id, string $title, ?string $summary, array $tagIds, ?string $ownerId)
59-
{
60-
$this->id = $id;
61-
$this->title = $title;
62-
$this->summary = $summary;
63-
$this->tagIds = $tagIds;
64-
$this->ownerId = $ownerId;
65-
}
66-
67-
public function getId(): string
68-
{
69-
return $this->id;
70-
}
71-
72-
public function getTitle(): string
73-
{
74-
return $this->title;
75-
}
76-
77-
public function getSummary(): ?string
78-
{
79-
return $this->summary;
80-
}
81-
82-
public function getTagIds(): array
83-
{
84-
return $this->tagIds;
85-
}
86-
87-
public function getOwnerId(): ?string
88-
{
89-
return $this->ownerId;
28+
public function __construct(
29+
public string $id,
30+
/** @JsonApi\Attribute(name="name") */
31+
public string $title,
32+
/** @JsonApi\Attribute(name="description") */
33+
public ?string $summary,
34+
/** @JsonApi\ToMany(name="tags", type="tag") */
35+
public array $tagIds,
36+
/** @JsonApi\ToOne(name="owner", type="person") */
37+
public ?string $ownerId
38+
) {
9039
}
9140
}
9241

9342
/**
9443
* @internal
95-
* @coversNothing
44+
* @covers \Undabot\SymfonyJsonApi\Service\Resource\Denormalizer\ResourceDenormalizer
9645
*
9746
* @small
9847
*/
9948
final class ResourceWithAliasesDenormalizerTest extends TestCase
10049
{
101-
/** @var ResourceDenormalizer */
102-
private $serializer;
50+
private ResourceDenormalizer $serializer;
10351

10452
protected function setUp(): void
10553
{
@@ -133,10 +81,10 @@ public function testSimpleResourceCanBeDenormalized(): void
13381
$dto = $this->serializer->denormalize($resource, AliasedResourceDto::class);
13482
static::assertInstanceOf(AliasedResourceDto::class, $dto);
13583

136-
static::assertSame('This is my title', $dto->getTitle());
137-
static::assertSame('This is my summary', $dto->getSummary());
138-
static::assertSame('p1', $dto->getOwnerId());
139-
static::assertSame(['t1', 't2', 't3'], $dto->getTagIds());
84+
static::assertSame('This is my title', $dto->title);
85+
static::assertSame('This is my summary', $dto->summary);
86+
static::assertSame('p1', $dto->ownerId);
87+
static::assertSame(['t1', 't2', 't3'], $dto->tagIds);
14088
}
14189

14290
public function testDenormalizationOfInvalidResourceResultsWithException(): void
@@ -158,7 +106,7 @@ public function testDenormalizationOfInvalidResourceResultsWithException(): void
158106
$this->serializer->denormalize($resource, AliasedResourceDto::class);
159107
}
160108

161-
public function testDenormalizationOfResourceWithExtraAttributeResultsWithException(): void
109+
public function testDenormalizeWillReturnCorrectApiModelWithExtraAttributesIgnored(): void
162110
{
163111
$resource = new Resource(
164112
'1',
@@ -174,11 +122,12 @@ public function testDenormalizationOfResourceWithExtraAttributeResultsWithExcept
174122
->get()
175123
);
176124

177-
$this->expectException(ResourceDenormalizationException::class);
178-
$this->serializer->denormalize($resource, AliasedResourceDto::class);
125+
$model = $this->serializer->denormalize($resource, AliasedResourceDto::class);
126+
static::assertInstanceOf(AliasedResourceDto::class, $model);
127+
static::assertObjectNotHasAttribute('extra', $model);
179128
}
180129

181-
public function testDenormalizationOfResourceWithExtraRelationshipResultsWithException(): void
130+
public function testDenormalizeWillReturnCorrectApiModelWithExtraRelationshipsIgnored(): void
182131
{
183132
$resource = new Resource(
184133
'1',
@@ -194,8 +143,9 @@ public function testDenormalizationOfResourceWithExtraRelationshipResultsWithExc
194143
->get()
195144
);
196145

197-
$this->expectException(ResourceDenormalizationException::class);
198-
$this->serializer->denormalize($resource, AliasedResourceDto::class);
146+
$model = $this->serializer->denormalize($resource, AliasedResourceDto::class);
147+
static::assertInstanceOf(AliasedResourceDto::class, $model);
148+
static::assertObjectNotHasAttribute('extras', $model);
199149
}
200150

201151
public function testResourceWithAliasedOptionalToOneRelationshipCanBeDenormalized(): void
@@ -216,6 +166,6 @@ public function testResourceWithAliasedOptionalToOneRelationshipCanBeDenormalize
216166
/** @var AliasedResourceDto $dto */
217167
$dto = $this->serializer->denormalize($resource, AliasedResourceDto::class);
218168
static::assertInstanceOf(AliasedResourceDto::class, $dto);
219-
static::assertNull($dto->getOwnerId());
169+
static::assertNull($dto->ownerId);
220170
}
221171
}

0 commit comments

Comments
 (0)