AssertableJson.php
4.1 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
<?php
namespace Illuminate\Testing\Fluent;
use Closure;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Arr;
use Illuminate\Support\Traits\Macroable;
use Illuminate\Support\Traits\Tappable;
use Illuminate\Testing\AssertableJsonString;
use PHPUnit\Framework\Assert as PHPUnit;
class AssertableJson implements Arrayable
{
use Concerns\Has,
Concerns\Matching,
Concerns\Debugging,
Concerns\Interaction,
Macroable,
Tappable;
/**
* The properties in the current scope.
*
* @var array
*/
private $props;
/**
* The "dot" path to the current scope.
*
* @var string|null
*/
private $path;
/**
* Create a new fluent, assertable JSON data instance.
*
* @param array $props
* @param string|null $path
* @return void
*/
protected function __construct(array $props, string $path = null)
{
$this->path = $path;
$this->props = $props;
}
/**
* Compose the absolute "dot" path to the given key.
*
* @param string $key
* @return string
*/
protected function dotPath(string $key = ''): string
{
if (is_null($this->path)) {
return $key;
}
return rtrim(implode('.', [$this->path, $key]), '.');
}
/**
* Retrieve a prop within the current scope using "dot" notation.
*
* @param string|null $key
* @return mixed
*/
protected function prop(string $key = null)
{
return Arr::get($this->props, $key);
}
/**
* Instantiate a new "scope" at the path of the given key.
*
* @param string $key
* @param \Closure $callback
* @return $this
*/
protected function scope(string $key, Closure $callback): self
{
$props = $this->prop($key);
$path = $this->dotPath($key);
PHPUnit::assertIsArray($props, sprintf('Property [%s] is not scopeable.', $path));
$scope = new static($props, $path);
$callback($scope);
$scope->interacted();
return $this;
}
/**
* Instantiate a new "scope" on the first child element.
*
* @param \Closure $callback
* @return $this
*/
public function first(Closure $callback): self
{
$props = $this->prop();
$path = $this->dotPath();
PHPUnit::assertNotEmpty($props, $path === ''
? 'Cannot scope directly onto the first element of the root level because it is empty.'
: sprintf('Cannot scope directly onto the first element of property [%s] because it is empty.', $path)
);
$key = array_keys($props)[0];
$this->interactsWith($key);
return $this->scope($key, $callback);
}
/**
* Instantiate a new "scope" on each child element.
*
* @param \Closure $callback
* @return $this
*/
public function each(Closure $callback): self
{
$props = $this->prop();
$path = $this->dotPath();
PHPUnit::assertNotEmpty($props, $path === ''
? 'Cannot scope directly onto each element of the root level because it is empty.'
: sprintf('Cannot scope directly onto each element of property [%s] because it is empty.', $path)
);
foreach (array_keys($props) as $key) {
$this->interactsWith($key);
$this->scope($key, $callback);
}
return $this;
}
/**
* Create a new instance from an array.
*
* @param array $data
* @return static
*/
public static function fromArray(array $data): self
{
return new static($data);
}
/**
* Create a new instance from a AssertableJsonString.
*
* @param \Illuminate\Testing\AssertableJsonString $json
* @return static
*/
public static function fromAssertableJsonString(AssertableJsonString $json): self
{
return static::fromArray($json->json());
}
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray()
{
return $this->props;
}
}