Skip to content

Commit c4f2677

Browse files
f3athf3ath
authored
Improved Full Linkage check (#18)
1 parent 0fe2f3a commit c4f2677

File tree

7 files changed

+95
-61
lines changed

7 files changed

+95
-61
lines changed

‎src/Document/Document.php‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -117,24 +117,22 @@ private function enforceFullLinkage()
117117

118118
private function hasLinkTo(IdentifiableResource $resource): bool
119119
{
120-
/** @var ResourceObject $my_resource */
121-
foreach ($this->toResourceObjects() as $my_resource) {
122-
if ($my_resource->hasRelationTo($resource)) {
120+
/** @var IdentifiableResource $my_resource */
121+
foreach ($this->toResources() as $my_resource) {
122+
if ($my_resource->identifies($resource)) {
123123
return true;
124124
}
125125
}
126126
return false;
127127
}
128128

129-
private function toResourceObjects(): \Generator
129+
private function toResources(): \Generator
130130
{
131-
if ($this->data instanceof ResourceObject) {
131+
if ($this->data instanceof IdentifiableResource) {
132132
yield $this->data;
133133
} elseif (is_array($this->data)) {
134134
foreach ($this->data as $datum) {
135-
if ($datum instanceof ResourceObject) {
136-
yield $datum;
137-
}
135+
yield $datum;
138136
}
139137
}
140138
}

‎src/Document/Resource/IdentifiableResource.php‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ abstract class IdentifiableResource implements \JsonSerializable
1717
protected $id;
1818
protected $type;
1919

20+
/**
21+
* Does this resource identify
22+
* @param IdentifiableResource $that
23+
* @return bool
24+
*/
25+
abstract public function identifies(IdentifiableResource $that): bool;
26+
2027
public function isEqualTo(IdentifiableResource $that): bool
2128
{
2229
return $this->type === $that->type && $this->id === $that->id;

‎src/Document/Resource/NullData.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,9 @@ public function jsonSerialize()
2525
{
2626
return null;
2727
}
28+
29+
public function identifies(IdentifiableResource $that): bool
30+
{
31+
return $this->isEqualTo($that);
32+
}
2833
}

‎src/Document/Resource/Relationship/Relationship.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public static function fromLinkage(Linkage $linkage): self
6060
return $r;
6161
}
6262

63-
public function isLinkedTo(IdentifiableResource $resource): bool
63+
public function hasLinkageTo(IdentifiableResource $resource): bool
6464
{
6565
return ($this->linkage && $this->linkage->isLinkedTo($resource));
6666
}

‎src/Document/Resource/ResourceId.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,9 @@ function ($v) {
4242
}
4343
);
4444
}
45+
46+
public function identifies(IdentifiableResource $that): bool
47+
{
48+
return $this->isEqualTo($that);
49+
}
4550
}

‎src/Document/Resource/ResourceObject.php‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,6 @@ public function setRelationship(string $name, Relationship $relationship)
5151
$this->relationships[$name] = $relationship;
5252
}
5353

54-
public function hasRelationTo(IdentifiableResource $resource): bool
55-
{
56-
if ($this->relationships) {
57-
/** @var Relationship $relationship */
58-
foreach ($this->relationships as $relationship) {
59-
if ($relationship->isLinkedTo($resource)) {
60-
return true;
61-
}
62-
}
63-
}
64-
return false;
65-
}
66-
6754
public function toId(): ResourceId
6855
{
6956
return new ResourceId($this->type, $this->id);
@@ -85,4 +72,22 @@ function ($v) {
8572
}
8673
);
8774
}
75+
76+
public function identifies(IdentifiableResource $that): bool
77+
{
78+
return $this->isEqualTo($that) || $this->isRelatedTo($that);
79+
}
80+
81+
private function isRelatedTo(IdentifiableResource $resource): bool
82+
{
83+
if ($this->relationships) {
84+
/** @var Relationship $relationship */
85+
foreach ($this->relationships as $relationship) {
86+
if ($relationship->hasLinkageTo($resource)) {
87+
return true;
88+
}
89+
}
90+
}
91+
return false;
92+
}
8893
}

‎test/Document/CompoundDocumentTest.php‎

Lines changed: 53 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,26 @@
2222
use JsonApiPhp\JsonApi\Test\HasAssertEqualsAsJson;
2323
use PHPUnit\Framework\TestCase;
2424

25+
/**
26+
* To reduce the number of HTTP requests, servers MAY allow responses that include related resources
27+
* along with the requested primary resources. Such responses are called “compound documents”.
28+
*
29+
* In a compound document, all included resources MUST be represented as an array
30+
* of resource objects in a top-level included member.
31+
*
32+
* Compound documents require “full linkage”, meaning that every included resource
33+
* MUST be identified by at least one resource identifier object in the same document.
34+
* These resource identifier objects could either be primary data or represent resource linkage
35+
* contained within primary or included resources.
36+
*
37+
* The only exception to the full linkage requirement is when relationship fields
38+
* that would otherwise contain linkage data are excluded via sparse fieldsets.
39+
*
40+
* Note: Full linkage ensures that included resources are related to either the primary data
41+
* (which could be resource objects or resource identifier objects) or to each other.
42+
*
43+
* @link http://jsonapi.org/format/#document-compound-documents
44+
*/
2545
class CompoundDocumentTest extends TestCase
2646
{
2747
use HasAssertEqualsAsJson;
@@ -44,45 +64,24 @@ public function testIncludedResourcesRepresentedAsArray()
4464
);
4565
$doc = Document::fromResource($basket);
4666
$doc->setIncluded($apple, $orange);
47-
$this->assertEqualsAsJson(
67+
$this->assertEquals(
4868
[
49-
'data' => [
50-
'type' => 'basket',
69+
[
70+
'type' => 'apples',
5171
'id' => '1',
52-
'relationships' => [
53-
'fruits' => [
54-
'data' => [
55-
[
56-
'type' => 'apples',
57-
'id' => '1',
58-
],
59-
[
60-
'type' => 'oranges',
61-
'id' => '1',
62-
],
63-
]
64-
]
72+
'attributes' => [
73+
'color' => 'red',
6574
],
6675
],
67-
'included' => [
68-
[
69-
'type' => 'apples',
70-
'id' => '1',
71-
'attributes' => [
72-
'color' => 'red',
73-
],
74-
],
75-
[
76-
'type' => 'oranges',
77-
'id' => '1',
78-
'attributes' => [
79-
'color' => 'orange',
80-
],
76+
[
77+
'type' => 'oranges',
78+
'id' => '1',
79+
'attributes' => [
80+
'color' => 'orange',
8181
],
82-
]
83-
82+
],
8483
],
85-
$doc
84+
$this->convertToArray($doc)['included']
8685
);
8786
}
8887

@@ -93,19 +92,34 @@ public function testIncludedResourcesRepresentedAsArray()
9392
public function testFullLinkageIsRequired()
9493
{
9594
$doc = Document::fromResource(new NullData);
96-
$doc->setIncluded(
97-
new ResourceObject('apples', '1')
98-
);
95+
$doc->setIncluded(new ResourceObject('apples', '1'));
9996
json_encode($doc);
10097
}
10198

10299
public function testFullLinkageIsNotRequiredIfSparse()
103100
{
104101
$doc = Document::fromResource(new NullData);
105102
$doc->markSparse();
106-
$doc->setIncluded(
107-
new ResourceObject('apples', '1')
108-
);
103+
$doc->setIncluded(new ResourceObject('apples', '1'));
104+
$this->assertCanBeBuilt($doc);
105+
}
106+
107+
public function testIncludedResourceMayBeIdentifiedByPrimaryData()
108+
{
109+
$apple = new ResourceObject('apples', '1');
110+
$apple->setAttribute('color', 'red');
111+
$doc = Document::fromResource($apple->toId());
112+
$doc->setIncluded($apple);
113+
$this->assertCanBeBuilt($doc);
114+
}
115+
116+
private function convertToArray($object): array
117+
{
118+
return json_decode(json_encode($object), true);
119+
}
120+
121+
private function assertCanBeBuilt($doc)
122+
{
109123
$this->assertInternalType('string', json_encode($doc));
110124
}
111125
}

0 commit comments

Comments
 (0)