rename ArrayUtil::diffAssocRecursive to diffDeep / integer keyed values need not match key

Author: bkdotcom

src/Debug/Abstraction/Object/Abstraction.php

@@ -147,7 +147,7 @@ public function getInheritedValues()
      */
     public function getInstanceValues()
     {
-        return ArrayUtil::diffAssocRecursive(
+        return ArrayUtil::diffDeep(
             $this->values,
             $this->getInheritedValues()
         );

src/Debug/Utility/ArrayUtil.php

@@ -97,13 +97,13 @@ public static function copy(array $source, $deep = true)
      *
      * @throws InvalidArgumentException
      */
-    public static function diffAssocRecursive(array $array1, $array2) // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
+    public static function diffDeep(array $array1, $array2) // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
     {
         $arrays = \array_slice(\func_get_args(), 1);
         foreach ($arrays as $i => $array) {
             \bdk\Debug\Utility\PhpType::assertType($array, 'array', 'array' . ($i + 2));
         }
-        return \array_reduce($arrays, [__CLASS__, 'diffAssocRecursiveWalk'], $array1);
+        return \array_reduce($arrays, [__CLASS__, 'diffDeepWalk'], $array1);
     }
 
     /**

src/Debug/Utility/ArrayUtilHelperTrait.php

@@ -89,31 +89,38 @@ private static function assertCountable($value, array $path, $method)
      *
      * @return array An array containing all the values from array that are not present in array2
      */
-    private static function diffAssocRecursiveWalk(array $array, array $array2)
+    private static function diffDeepWalk(array $array, array $array2)
     {
         $diff = array();
+        $allInt = true;
         \array_walk(
             $array,
             /**
              * @param array-key $key
              */
-            static function ($value, $key) use (&$diff, $array2) {
+            static function ($value, $key) use (&$allInt, &$diff, $array2) {
+                $incl = false;
                 if (\array_key_exists($key, $array2) === false) {
-                    $diff[$key] = $value;
-                    return;
-                }
-                if (\is_array($value) && \is_array($array2[$key])) {
-                    $value = self::diffAssocRecursive($value, $array2[$key]);
-                    if ($value) {
-                        $diff[$key] = $value;
-                    }
-                    return;
+                    $incl = true;
+                } elseif (self::isNonMergeable($value) === false && self::isNonMergeable($array2[$key]) === false) {
+                    $value = self::diffDeep($value, $array2[$key]);
+                    $incl = !empty($value);
+                } elseif (\is_int($key)) {
+                    $foundIndex = \array_search($value, $array2, true);
+                    $incl = $foundIndex === false || \is_int($foundIndex) === false;
+                } elseif ($value !== $array2[$key]) {
+                    // not in $array2 or different value
+                    $incl = true;
                 }
-                if ($value !== $array2[$key]) {
+                if ($incl) {
+                    $allInt = $allInt && \is_int($key);
                     $diff[$key] = $value;
                 }
             }
         );
+        if ($allInt) {
+            $diff = \array_values($diff);
+        }
         return $diff;
     }
 

tests/Debug/Utility/ArrayUtilTest.php

@@ -48,9 +48,9 @@ public function testCopy()
     }
 
     /**
-     * @dataProvider providerDiffAssocRecursive
+     * @dataProvider providerDiffDeep
      */
-    public function testDiffAssocRecursive($argsAndExpect)
+    public function testDiffDeep($argsAndExpect)
     {
         $argsAndExpect = \func_get_args();
         $expect = \array_pop($argsAndExpect);
@@ -62,7 +62,7 @@ public function testDiffAssocRecursive($argsAndExpect)
         }
         self::assertSame(
             $expect,
-            \call_user_func_array('bdk\Debug\Utility\ArrayUtil::diffAssocRecursive', $argsAndExpect)
+            \call_user_func_array('bdk\Debug\Utility\ArrayUtil::diffDeep', $argsAndExpect)
         );
     }
 
@@ -325,7 +325,7 @@ public function testSpliceAssoc($array, $key, $length, $replace, $expectReturn,
         self::assertSame($expectArray, $array, 'updated array not as expected');
     }
 
-    public static function providerDiffAssocRecursive()
+    public static function providerDiffDeep()
     {
         return array(
             'test1' => array(
@@ -359,7 +359,7 @@ public static function providerDiffAssocRecursive()
                 array(
                     'colors' => array(
                         'b' => 'brown',
-                        'red',
+                        // 'red',
                     ),
                 ),
             ),
@@ -370,7 +370,7 @@ public static function providerDiffAssocRecursive()
                 false,
                 array(
                     'expectException' => 'InvalidArgumentException',
-                    'expectExceptionMessage' => 'bdk\Debug\Utility\ArrayUtil::diffAssocRecursive(): $array2 expects array.  bool provided',
+                    'expectExceptionMessage' => 'bdk\Debug\Utility\ArrayUtil::diffDeep(): $array2 expects array.  bool provided',
                 ),
             ),
         );