-
Notifications
You must be signed in to change notification settings - Fork 16
/
Context.php
299 lines (275 loc) 路 8.28 KB
/
Context.php
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<?php
namespace Castor;
class Context implements \ArrayAccess
{
public readonly string $currentDirectory;
/**
* @phpstan-param ContextData $data The input parameter accepts an array or an Object
*
* @param array<string, string|\Stringable|int> $environment A list of environment variables to add to the task
*/
public function __construct(
public readonly array $data = [],
public readonly array $environment = [],
?string $currentDirectory = null,
public readonly bool $tty = false,
public readonly bool $pty = true,
public readonly ?float $timeout = null,
public readonly bool $quiet = false,
public readonly bool $allowFailure = false,
public readonly bool $notify = false,
public readonly VerbosityLevel $verbosityLevel = VerbosityLevel::NOT_CONFIGURED,
// Do not use this argument, it is only used internally by the application
public readonly string $name = '',
) {
$this->currentDirectory = $currentDirectory ?? PathHelper::getRoot();
}
public function __debugInfo()
{
return [
'name' => $this->name,
'data' => $this->data,
'environment' => $this->environment,
'currentDirectory' => $this->currentDirectory,
'tty' => $this->tty,
'pty' => $this->pty,
'timeout' => $this->timeout,
'quiet' => $this->quiet,
'allowFailure' => $this->allowFailure,
'notify' => $this->notify,
'verbosityLevel' => $this->verbosityLevel,
];
}
/**
* @param array<(int|string), mixed> $data
*
* @throws \Exception
*/
public function withData(array $data, bool $keepExisting = true, bool $recursive = true): self
{
if (false === $keepExisting && true === $recursive) {
throw new \Exception('You cannot use the recursive option without keeping the existing data');
}
if ($keepExisting) {
if ($recursive) {
/* @var array<(int|string), mixed> */
$data = $this->arrayMergeRecursiveDistinct($this->data, $data);
} else {
/* @var array<(int|string), mixed> */
$data = array_merge($this->data, $data);
}
}
return new self(
$data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
/** @param array<string, string|\Stringable|int> $environment */
public function withEnvironment(array $environment, bool $keepExisting = true): self
{
return new self(
$this->data,
$keepExisting ? [...$this->environment, ...$environment] : $environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withPath(string $path): self
{
return new self(
$this->data,
$this->environment,
str_starts_with($path, '/') ? $path : PathHelper::realpath($this->currentDirectory . '/' . $path),
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withTty(bool $tty = true): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withPty(bool $pty = true): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withTimeout(?float $timeout): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withQuiet(bool $quiet = true): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withAllowFailure(bool $allowFailure = true): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$allowFailure,
$this->notify,
$this->verbosityLevel,
$this->name,
);
}
public function withNotify(bool $notify = true): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$notify,
$this->verbosityLevel,
$this->name,
);
}
public function withVerbosityLevel(VerbosityLevel $verbosityLevel): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$verbosityLevel,
$this->name,
);
}
public function withName(string $name): self
{
return new self(
$this->data,
$this->environment,
$this->currentDirectory,
$this->tty,
$this->pty,
$this->timeout,
$this->quiet,
$this->allowFailure,
$this->notify,
$this->verbosityLevel,
$name,
);
}
public function offsetExists(mixed $offset): bool
{
return \array_key_exists($offset, $this->data);
}
public function offsetGet(mixed $offset): mixed
{
if (!\array_key_exists($offset, $this->data)) {
throw new \OutOfBoundsException(sprintf('The property "%s" does not exist in the current context.', $offset));
}
return $this->data[$offset];
}
public function offsetSet(mixed $offset, mixed $value): void
{
throw new \LogicException('Context is immutable');
}
public function offsetUnset(mixed $offset): void
{
throw new \LogicException('Context is immutable');
}
/**
* @param array<(int|string), mixed> $array1
* @param array<(int|string), mixed> $array2
*
* @return array<(int|string), mixed>
*/
private function arrayMergeRecursiveDistinct(array $array1, array $array2): array
{
/** @var array<(int|string), mixed> $merged */
$merged = $array1;
foreach ($array2 as $key => $value) {
if (\is_array($value) && isset($merged[$key]) && \is_array($merged[$key])) {
$merged[$key] = $this->arrayMergeRecursiveDistinct($merged[$key], $value);
} else {
$merged[$key] = $value;
}
}
return $merged;
}
}