-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathDocument.php
More file actions
265 lines (230 loc) · 5.89 KB
/
Document.php
File metadata and controls
265 lines (230 loc) · 5.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<?php
/*
* Copyright 2025 Cloud Creativity Limited
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
*/
declare(strict_types=1);
namespace CloudCreativity\JsonApi\Testing;
use ArrayAccess;
use CloudCreativity\JsonApi\Testing\Concerns\HasDocumentAssertions;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use JsonException;
use JsonSerializable;
use PHPUnit\Framework\Assert as PHPUnitAssert;
use RuntimeException;
use function json_decode;
/**
* Class Document
*
* @package CloudCreativity\JsonApi\Testing
*/
class Document implements Arrayable, JsonSerializable, ArrayAccess
{
use HasDocumentAssertions;
/**
* @var array
*/
private array $document;
/**
* Safely create a document.
*
* @param Document|iterable|string $content
* @return Document|null
*/
public static function create($content): ?self
{
if (is_string($content)) {
return self::fromString($content);
}
return $content ? self::cast($content) : null;
}
/**
* Cast a document to an instance of this document class.
*
* @param Document|iterable|string $document
* @return Document
*/
public static function cast($document): self
{
if ($document instanceof self) {
return $document;
}
if (is_string($document)) {
return self::decode($document);
}
return self::fromIterable($document);
}
/**
* Create a document from an iterable.
*
* @param iterable $input
* @return Document
*/
public static function fromIterable(iterable $input): self
{
return self::decode(
Collection::make($input)->toJson()
);
}
/**
* Safely create a document from a string.
*
* @param string $json
* @return Document|null
*/
public static function fromString(string $json): ?self
{
try {
return self::decode($json);
} catch (RuntimeException $ex) {
return null;
}
}
/**
* Decode a JSON string into a document.
*
* @param string $json
* @return Document
* @throws RuntimeException
*/
public static function decode(string $json): self
{
try {
$document = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $ex) {
throw new RuntimeException('Failed to decode JSON string.', 0, $ex);
}
if (is_array($document)) {
return new self($document);
}
throw new RuntimeException('Expecting JSON to decode to an array.');
}
/**
* Document constructor.
*
* @param array $document
*/
public function __construct(array $document)
{
$this->document = $document;
}
/**
* @return string
*/
public function __toString(): string
{
return $this->toString();
}
/**
* @inheritDoc
*/
public function offsetExists($offset): bool
{
return Collection::make($this->document)->offsetExists($offset);
}
/**
* @inheritDoc
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return Collection::make($this->document)->offsetGet($offset);
}
/**
* @inheritDoc
*/
public function offsetSet($offset, $value): void
{
throw new \LogicException('Not implemented.');
}
/**
* @inheritDoc
*/
public function offsetUnset($offset): void
{
throw new \LogicException('Not implemented.');
}
/**
* Get a value from using a JSON pointer.
*
* @param string $pointer
* @param mixed|null $default
* @return mixed
*/
public function get(string $pointer, $default = null)
{
if (!$path = Compare::path($pointer)) {
return $this->document;
}
return Arr::get($this->document, $path, $default);
}
/**
* Check if an item exists using JSON pointers.
*
* @param string ...$pointers
* @return bool
*/
public function has(string ...$pointers): bool
{
$paths = Collection::make($pointers)->map(function ($pointer) {
return Compare::path($pointer);
})->filter()->all();
return Arr::has($this->document, $paths);
}
/**
* @return string
*/
public function toString(): string
{
return Compare::stringify($this->document);
}
/**
* @inheritDoc
*/
public function toArray()
{
return $this->document;
}
/**
* @inheritDoc
*/
public function jsonSerialize(): array
{
return Compare::sort($this->document);
}
/**
* Assert that all the provided members exist.
*
* @param string|string[] $pointers
* @param string $message
* @return $this
*/
public function assertExists($pointers, string $message = ''): self
{
$missing = Collection::make((array) $pointers)->reject(function ($pointer) {
return $this->has($pointer);
})->implode(', ');
PHPUnitAssert::assertEmpty($missing, $message ?: "Members [{$missing}] do not exist.");
return $this;
}
/**
* Assert that the provided members do not exist.
*
* @param string|string[] $pointers
* @param string $message
* @return Document
*/
public function assertNotExists($pointers, string $message = ''): self
{
$unexpected = Collection::make((array) $pointers)->filter(function ($pointer) {
return $this->has($pointer);
})->implode(', ');
PHPUnitAssert::assertEmpty($unexpected, $message ?: "Members [{$unexpected}] exist.");
return $this;
}
}