-
Notifications
You must be signed in to change notification settings - Fork 3
/
Mime.php
458 lines (377 loc) · 9.89 KB
/
Mime.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<?php namespace Dotink\Parody {
/**
* Mime provides a simple API for defining and crafting mock classes and objects, called
* "Jests".
*
* @copyright Copyright (c) 2012 - 2013, Matthew J. Sahagian
* @author Matthew J. Sahagian [mjs] <gent@dotink.org>
*
* @license Please reference the LICENSE.txt file at the root of this distribution
*
* @package Parody
*/
class Mime extends Jest
{
/**
* Parent class relationships for defined classes
*
* @static
* @access private
* @var array
*/
static private $parents = array();
/**
* Interfaces for defined classes
*
* @static
* @access private
* @var array
*/
static private $interfaces = array();
/**
* Traits for defined classes
*
* @static
* @access private
* @var array
*/
static private $traits = array();
/**
* The class for the jest that mime is working on
*
* @access private
* @var string
*/
private $class = NULL;
/**
* A representation of a "fake" object which is manipulated
*
* @access private
* @var Jest
*/
private $jest = NULL;
/**
* The currently open method
*
* @access private
* @var string
*/
private $openMethod = FALSE;
/**
* The currently open property
*
* @access private
* @var string
*/
private $openProperty = FALSE;
/**
* Create a new jest (mock) object of a particular class to work on.
*
* @static
* @access public
* @param string $class The class from which to build the object
* @return Mime The mime object for developing the object.
*/
static public function create($class)
{
if (!class_exists($class)) {
self::make($class);
}
$class = self::qualify($class);
return new self(new $class());
}
/**
* Define a new jest (mock) class to work on.
*
* @static
* @access public
* @param string $class The class to define
* @return Mime The mime object for defining the class
*/
static public function define($class)
{
return new self($class);
}
/**
* Literally makes (evals) a class.
*
* @static
* @access private
* @param string $class The class to make
* @return string The qualfied class
*/
static private function make($class)
{
//
// We need to dequalify the class first
//
$class = ltrim($class, '\\');
$parent = isset(self::$parents[$class])
? self::$parents[$class]
: self::qualify(__NAMESPACE__ . '\Jest');
if ($parent && !class_exists($parent)) {
self::make($parent);
}
$interfaces = isset(self::$interfaces[$class])
? self::$interfaces[$class]
: array();
$traits = isset(self::$traits[$class])
? self::$traits[$class]
: array();
$ns_parts = explode('\\', $class);
$class = array_pop($ns_parts);
$ns = implode('\\', $ns_parts);
eval(call_user_func(function() use ($ns, $class, $parent, $interfaces, $traits) {
ob_start() ?>
namespace <?= $ns ?>
{
class <?= $class ?>
<?php if ($parent) { ?>
extends <?= $parent ?>
<?php } ?>
<?php if (count($interfaces)) { ?>
implements <?= implode(', ', $interfaces) ?>
<?php } ?>
{
}
}
<?php return ob_get_clean();
}));
}
/**
* Qualifies a class for the global namespace by ensuring it has a \ in front.
*
* @static
* @access private
* @param string $class The class to qualify
* @return string The qualfied class
*/
static protected function qualify($class)
{
return $class[0] != '\\'
? '\\' . $class
: $class;
}
/**
* Create a new mime. If the Mime is given an object, it will verify it's a jest.
*
* @access public
* @param string|object $target
* @return void
*/
public function __construct($target = NULL)
{
if (is_object($target)) {
if (!is_subclass_of($target, get_parent_class(__CLASS__))) {
throw new \Exception(sprintf(
'Mime cannot work with non-Jest object of class %s',
get_class($target)
));
}
$this->class = get_class($target);
$this->jest = $target;
self::$objects[$this->class] = $target;
} else {
$this->class = $target;
}
}
/**
* Tell an open method what to expect
*
* @access public
* @param mixed The expected parameter for the mocked method
* @param ...
* @return Mime The mime for method chaining
*/
public function expect()
{
if (!$this->openMethod) {
throw new \Exception(sprintf(
'Cannot set argument expectations without first opening a call'
));
}
$this->jest->expectation = func_get_args();
return $this;
}
/**
* Tells the class we're defining to extend a parent class, creating it if it does not
* exist.
*
* @access public
* @param string $parent_class The parent class to define
* @return Mime A new mime for defining the parent
*/
public function extending($parent_class)
{
self::$parents[$this->class] = self::qualify($parent_class);
return self::define($parent_class);
}
/**
* Define a value to give for the open method or property
*
* @access public
* @param mixed $value The value to return for the open method or property
* @return Mime For method chaining
*/
public function give($value = NULL)
{
if (is_callable($value)) {
$value = call_user_func($value);
}
if ($this->openMethod) {
$this->jest->methods[$this->openMethod][] = [
'expectation' => $this->jest->expectation,
'value' => $value
];
//
// Reset our open method an expectation
//
$this->openMethod = FALSE;
$this->jest->expectation = array();
} elseif ($this->openProperty) {
$this->jest->properties[$this->openProperty] = $value;
//
// Reset our open property
//
$this->openProperty = FALSE;
} else {
throw new \Exception(sprintf(
'Cannot give() anything here. There is no open method or property'
));
}
return $this;
}
/**
* Tells the class we're defining to implement interfaces, creating it if it does not
* exist.
*
* @access public
* @param string $interface The interface to implement
* @return Mime The mime for method chaining
*/
public function implementing($interface)
{
foreach (func_get_args() as $interface) {
//
// We want to create the interface if it doesn't exist yet. We don't want to
// qualify the namespace until below.
//
if (!interface_exists($interface)) {
eval(call_user_func(function() use ($interface) {
ob_start() ?>
interface <?= $interface ?> {}
<?php return ob_get_clean();
}));
}
self::$interfaces[$this->class][] = self::qualify($interface);
}
return $this;
}
/**
* Opens a method on the jest object
*
* @access public
* @param string $method The name of the method to open
* @return Mime The mime for method chaining
*/
public function onCall($method)
{
if ($this->jest && ($this->openMethod || $this->openProperty)) {
throw new \Exception(sprintf(
'Cannot open method %s without first give()-ing a return for %s',
$method,
$this->openMethod ?: $this->openProperty
));
}
//
// Allocate space for the method in the jest object and open
// a method on it.
//
$this->jest->methods[$method] = array();
$this->openMethod = $method;
return $this;
}
/**
* Opens a property on the jest object
*
* @access public
* @param string $property The name of the property to open
* @return Mime The mime for method chaining
*/
public function onGet($property)
{
if ($this->jest && ($this->openMethod || $this->openProperty)) {
throw new \Exception(sprintf(
'Cannot mimick property %s without first give()-ing a return for %s',
$property,
$this->openMethod ?: $this->openProperty
));
}
$this->openProperty = $property;
return $this;
}
/**
* Register a factory for adding methods/property mocks to objects instantiated later.
*
* This is useful if the code you are testing has a call such as new Class(). Since the
* code is dependent on that object, but it is not injected we essentially want to delay
* our method/property configuration for the mock till after that call. Once the factory
* is run it is removed from the stack automatically.
*
* @access public
* @param mixed An optional expected constructor parameter
* @param mixed ...
* @param Closure A closure which will be passed the newly instantiated jest to work with
* @return Mime The mime for method chaining
*/
public function onNew()
{
$expectation = array_slice(func_get_args(), 0, -1);
$factory = array_slice(func_get_args(), -1)[0];
if (!isset(self::$factories[$this->class])) {
self::$factories[$this->class] = array();
}
self::$factories[$this->class][] = [
'expectation' => $expectation,
'factory' => $factory
];
return $this;
}
/**
* Gets the current working jest object (for injection)
*
* @access public
* @return Jest The jest object, whose class will actually be whatever class you're mocking
*/
public function resolve()
{
return $this->jest;
}
/**
* Tell the class we're defining to use a given trait and if it doesn't exist, create it
*
* @access public
* @param string $trait The trait to use
* @param ...
* @return Mime The mime for method chaining
*/
public function using($trait)
{
foreach (func_get_args() as $trait) {
//
// We want to create the trait if it doesn't exist yet. We don't want to
// qualify the namespace until below.
//
if (!trait_exists($trait)) {
eval(call_user_func(function() use ($trait) {
ob_start() ?>
trait <?= $trait ?> {}
<?php return ob_get_clean();
}));
}
self::$traits[$this->class][] = self::qualify($trait);
}
return $this;
}
}
}