|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Chadicus; |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* Trait for adding asserts for arrays |
|
7
|
|
|
*/ |
|
8
|
|
|
trait ArrayAssertsTrait |
|
9
|
|
|
{ |
|
10
|
|
|
/** |
|
11
|
|
|
* Asserts the given $actual array is the same as the $expected array disregarding index order |
|
12
|
|
|
* |
|
13
|
|
|
* @param array $expected The expected array. |
|
14
|
|
|
* @param mixed $actual The actual array. |
|
15
|
|
|
* @param string|null $prefix Prefix to use with error messages. Useful for nested arrays. |
|
16
|
|
|
* |
|
17
|
|
|
* @return void |
|
18
|
|
|
*/ |
|
19
|
|
|
public function assertSameArray(array $expected, $actual, $prefix = null) |
|
20
|
|
|
{ |
|
21
|
|
|
//assert that the actual value is an array |
|
22
|
|
|
$this->assertInternalType('array', $actual, '$actual was not an array'); |
|
|
|
|
|
|
23
|
|
|
|
|
24
|
|
|
$expectedKeys = array_keys($expected); |
|
25
|
|
|
$actualKeys = array_keys($actual); |
|
26
|
|
|
|
|
27
|
|
|
//find any keys in the expected array that are not present in the actual array |
|
28
|
|
|
$missingExpectedKeys = array_diff($expectedKeys, $actualKeys); |
|
29
|
|
|
$this->assertCount( |
|
|
|
|
|
|
30
|
|
|
0, |
|
31
|
|
|
$missingExpectedKeys, |
|
32
|
|
|
sprintf( |
|
33
|
|
|
'$actual array is missing %d keys: %s', |
|
34
|
|
|
count($missingExpectedKeys), |
|
35
|
|
|
implode(', ', $missingExpectedKeys) |
|
36
|
|
|
) |
|
37
|
|
|
); |
|
38
|
|
|
|
|
39
|
|
|
//find any keys in the actual array that are not expected in the expected array |
|
40
|
|
|
$unexpectedKeys = array_diff($actualKeys, $expectedKeys); |
|
41
|
|
|
$this->assertCount( |
|
|
|
|
|
|
42
|
|
|
0, |
|
43
|
|
|
$unexpectedKeys, |
|
44
|
|
|
sprintf( |
|
45
|
|
|
'$actual contains %d unexpected keys: %s', |
|
46
|
|
|
count($unexpectedKeys), |
|
47
|
|
|
implode(', ', $unexpectedKeys) |
|
48
|
|
|
) |
|
49
|
|
|
); |
|
50
|
|
|
|
|
51
|
|
|
//Assert all values are the same value and type. |
|
52
|
|
|
//Recursively call assertSameArray on array values |
|
53
|
|
|
foreach ($expectedArray as $key => $value) { |
|
|
|
|
|
|
54
|
|
|
if (!is_array($value)) { |
|
55
|
|
|
$this->assertSameArray($value, $actual[$key], "{$prefix}{$key}."); |
|
56
|
|
|
} |
|
57
|
|
|
|
|
58
|
|
|
$this->assertSame( |
|
|
|
|
|
|
59
|
|
|
$value, |
|
60
|
|
|
$actual[$key], |
|
61
|
|
|
sprintf( |
|
62
|
|
|
"{$prefix}{$key} value is not correct expected %s\nfound %s", |
|
63
|
|
|
var_export($value, 1), |
|
64
|
|
|
var_export($actual[$key], 1) |
|
65
|
|
|
) |
|
66
|
|
|
); |
|
67
|
|
|
} |
|
68
|
|
|
} |
|
69
|
|
|
} |
|
70
|
|
|
|
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idableprovides a methodequalsIdthat in turn relies on the methodgetId(). If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()as an abstract method to the trait will make sure it is available.