feat: Implements additionalFailureDescription with relevant information.

Author: drupol

src/Constraint/IsIdenticalIterable.php

@@ -12,6 +12,7 @@
 use Iterator;
 use loophp\iterators\IterableIteratorAggregate;
 use loophp\iterators\MultipleIterableAggregate;
+use loophp\iterators\PackIterableAggregate;
 use MultipleIterator;
 use PHPUnit\Framework\Constraint\Constraint;
 
@@ -42,6 +43,45 @@ public function toString(): string
         return 'has exactly the same keys and values';
     }
 
+    protected function additionalFailureDescription($other): string
+    {
+        [$subject, $other] = array_map(
+            static fn (iterable $iterable): Iterator => (new IterableIteratorAggregate($iterable))->getIterator(),
+            [$this->subject, $other]
+        );
+
+        $mi = new PackIterableAggregate(
+            new MultipleIterableAggregate([$subject, $other], MultipleIterator::MIT_NEED_ALL)
+        );
+
+        foreach ($mi as $index => [$key, $value]) {
+            if (0 !== $this->limit && $index >= $this->limit) {
+                break;
+            }
+
+            if ($key[0] !== $key[1]) {
+                return sprintf('Expected iterable key is different from subject key at index %s', $index);
+            }
+
+            if ($value[0] !== $value[1]) {
+                return sprintf('Expected iterable value is different from subject value at index %s', $index);
+            }
+        }
+
+        $subjectValid = $subject->valid();
+        $otherValid = $other->valid();
+
+        if ($subjectValid !== $otherValid) {
+            if (true === $subjectValid) {
+                return 'Expected iterable has more items than subject.';
+            }
+
+            return 'Expected iterable has lesser items than subject.';
+        }
+
+        return '';
+    }
+
     /**
      * @param iterable<TKey, T> $other
      */
@@ -52,11 +92,11 @@ protected function matches($other): bool
             [$this->subject, $other]
         );
 
-        $mi = new MultipleIterableAggregate([$subject, $other], MultipleIterator::MIT_NEED_ALL);
-
-        $index = 0;
+        $mi = new PackIterableAggregate(
+            new MultipleIterableAggregate([$subject, $other], MultipleIterator::MIT_NEED_ALL)
+        );
 
-        foreach ($mi as $key => $value) {
+        foreach ($mi as $index => [$key, $value]) {
             if (0 !== $this->limit && $index >= $this->limit) {
                 break;
             }
@@ -68,8 +108,6 @@ protected function matches($other): bool
             if ($value[0] !== $value[1]) {
                 return false;
             }
-
-            ++$index;
         }
 
         if (0 === $this->limit) {

src/Constraint/IsNotIdenticalIterable.php

@@ -12,6 +12,7 @@
 use Iterator;
 use loophp\iterators\IterableIteratorAggregate;
 use loophp\iterators\MultipleIterableAggregate;
+use loophp\iterators\PackIterableAggregate;
 use MultipleIterator;
 use PHPUnit\Framework\Constraint\Constraint;
 
@@ -52,11 +53,11 @@ protected function matches($other): bool
             [$this->subject, $other]
         );
 
-        $mi = new MultipleIterableAggregate([$subject, $other], MultipleIterator::MIT_NEED_ALL);
-
-        $index = 0;
+        $mi = new PackIterableAggregate(
+            new MultipleIterableAggregate([$subject, $other], MultipleIterator::MIT_NEED_ALL)
+        );
 
-        foreach ($mi as $key => $value) {
+        foreach ($mi as $index => [$key, $value]) {
             if (0 !== $this->limit && $index >= $this->limit) {
                 break;
             }
@@ -68,8 +69,6 @@ protected function matches($other): bool
             if ($value[0] !== $value[1]) {
                 return true;
             }
-
-            ++$index;
         }
 
         if (0 === $this->limit) {