-
Notifications
You must be signed in to change notification settings - Fork 15
/
MapDiffer.php
181 lines (151 loc) · 4.15 KB
/
MapDiffer.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
<?php
declare( strict_types = 1 );
namespace Diff\Differ;
use Diff\Comparer\StrictComparer;
use Diff\Comparer\ValueComparer;
use Diff\DiffOp\Diff\Diff;
use Diff\DiffOp\DiffOp;
use Diff\DiffOp\DiffOpAdd;
use Diff\DiffOp\DiffOpChange;
use Diff\DiffOp\DiffOpRemove;
use Exception;
use LogicException;
/**
* Differ that does an associative diff between two arrays,
* with the option to do this recursively.
*
* @since 0.4
*
* @license BSD-3-Clause
* @author Jeroen De Dauw < [email protected] >
*/
class MapDiffer implements Differ {
/**
* @var bool
*/
private $recursively;
/**
* @var Differ
*/
private $listDiffer;
/**
* @var ValueComparer
*/
private $valueComparer;
/**
* The third argument ($comparer) was added in 3.0
*/
public function __construct( bool $recursively = false, Differ $listDiffer = null, ValueComparer $comparer = null ) {
$this->recursively = $recursively;
$this->listDiffer = $listDiffer ?? new ListDiffer();
$this->valueComparer = $comparer ?? new StrictComparer();
}
/**
* @see Differ::doDiff
*
* Computes the diff between two associate arrays.
*
* @since 0.4
*
* @param array $oldValues The first array
* @param array $newValues The second array
*
* @throws Exception
* @return DiffOp[]
*/
public function doDiff( array $oldValues, array $newValues ): array {
$newSet = $this->arrayDiffAssoc( $newValues, $oldValues );
$oldSet = $this->arrayDiffAssoc( $oldValues, $newValues );
$diffSet = [];
foreach ( $this->getAllKeys( $oldSet, $newSet ) as $key ) {
$diffOp = $this->getDiffOpForElement( $key, $oldSet, $newSet );
if ( $diffOp !== null ) {
$diffSet[$key] = $diffOp;
}
}
return $diffSet;
}
private function getAllKeys( array $oldSet, array $newSet ): array {
return array_unique( array_merge(
array_keys( $oldSet ),
array_keys( $newSet )
) );
}
private function getDiffOpForElement( $key, array $oldSet, array $newSet ) {
if ( $this->recursively ) {
$diffOp = $this->getDiffOpForElementRecursively( $key, $oldSet, $newSet );
if ( $diffOp !== null ) {
if ( $diffOp->isEmpty() ) {
// there is no (relevant) difference
return null;
} else {
return $diffOp;
}
}
}
$hasOld = array_key_exists( $key, $oldSet );
$hasNew = array_key_exists( $key, $newSet );
if ( $hasOld && $hasNew ) {
return new DiffOpChange( $oldSet[$key], $newSet[$key] );
}
elseif ( $hasOld ) {
return new DiffOpRemove( $oldSet[$key] );
}
elseif ( $hasNew ) {
return new DiffOpAdd( $newSet[$key] );
}
// @codeCoverageIgnoreStart
throw new LogicException( 'The element needs to exist in either the old or new list to compare' );
// @codeCoverageIgnoreEnd
}
private function getDiffOpForElementRecursively( $key, array $oldSet, array $newSet ) {
$old = array_key_exists( $key, $oldSet ) ? $oldSet[$key] : [];
$new = array_key_exists( $key, $newSet ) ? $newSet[$key] : [];
if ( is_array( $old ) && is_array( $new ) ) {
return $this->getDiffForArrays( $old, $new );
}
return null;
}
private function getDiffForArrays( array $old, array $new ): Diff {
if ( $this->isAssociative( $old ) || $this->isAssociative( $new ) ) {
return new Diff( $this->doDiff( $old, $new ), true );
}
return new Diff( $this->listDiffer->doDiff( $old, $new ), false );
}
/**
* Returns if an array is associative or not.
*
* @param array $array
*
* @return bool
*/
private function isAssociative( array $array ): bool {
foreach ( $array as $key => $value ) {
if ( is_string( $key ) ) {
return true;
}
}
return false;
}
/**
* Similar to the native array_diff_assoc function, except that it will
* spot differences between array values. Very weird the native
* function just ignores these...
*
* @see http://php.net/manual/en/function.array-diff-assoc.php
*
* @param array $from
* @param array $to
*
* @return array
*/
private function arrayDiffAssoc( array $from, array $to ): array {
$diff = [];
foreach ( $from as $key => $value ) {
if ( !array_key_exists( $key, $to ) || !$this->valueComparer->valuesAreEqual( $to[$key], $value ) ) {
$diff[$key] = $value;
}
}
return $diff;
}
}