Implement IteratorAggregate

Author: sebastianbergmann

ChangeLog.md

@@ -11,6 +11,11 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 * `SebastianBergmann\Diff\Line::content()` and `SebastianBergmann\Diff\Diff::type()`
 * `SebastianBergmann\Diff\Line::isAdded()`,`SebastianBergmann\Diff\Line::isRemoved()`, and `SebastianBergmann\Diff\Line::isUnchanged()`
 
+### Changed
+
+* `SebastianBergmann\Diff\Diff` now implements `IteratorAggregate`, iterating over it yields the aggregated `SebastianBergmann\Diff\Chunk` objects
+* `SebastianBergmann\Diff\Chunk` now implements `IteratorAggregate`, iterating over it yields the aggregated `SebastianBergmann\Diff\Line` objects
+
 ### Deprecated
 
 * `SebastianBergmann\Diff\Chunk::getStart()`, `SebastianBergmann\Diff\Chunk::getStartRange()`, `SebastianBergmann\Diff\Chunk::getEnd()`, `SebastianBergmann\Diff\Chunk::getEndRange()`, and `SebastianBergmann\Diff\Chunk::getLines()`

src/Chunk.php

@@ -9,7 +9,14 @@
  */
 namespace SebastianBergmann\Diff;
 
-final class Chunk
+use ArrayIterator;
+use IteratorAggregate;
+use Traversable;
+
+/**
+ * @template-implements IteratorAggregate<int, Line>
+ */
+final class Chunk implements IteratorAggregate
 {
     private int $start;
     private int $startRange;
@@ -109,4 +116,9 @@ public function getLines(): array
     {
         return $this->lines;
     }
+
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->lines);
+    }
 }

src/Diff.php

@@ -9,7 +9,14 @@
  */
 namespace SebastianBergmann\Diff;
 
-final class Diff
+use ArrayIterator;
+use IteratorAggregate;
+use Traversable;
+
+/**
+ * @template-implements IteratorAggregate<int, Chunk>
+ */
+final class Diff implements IteratorAggregate
 {
     /**
      * @psalm-var non-empty-string
@@ -99,4 +106,9 @@ public function getChunks(): array
     {
         return $this->chunks;
     }
+
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->chunks);
+    }
 }

tests/ChunkTest.php

@@ -59,6 +59,17 @@ public function testLinesCanBeSet(): void
         $this->assertSame($lines, $chunk->lines());
     }
 
+    public function testCanBeIterated(): void
+    {
+        $line  = new Line;
+        $chunk = new Chunk(lines: [$line]);
+
+        foreach ($chunk as $index => $_line) {
+            $this->assertSame(0, $index);
+            $this->assertSame($line, $_line);
+        }
+    }
+
     private function chunk(): Chunk
     {
         return new Chunk(

tests/DiffTest.php

@@ -64,4 +64,15 @@ public function testSetChunksAfterConstruction(): void
         $this->assertSame($chunks, $diff->chunks(), 'Expect chunks to be passed value.');
         $this->assertSame($chunks, $diff->getChunks(), 'Expect chunks to be passed value.');
     }
+
+    public function testCanBeIterated(): void
+    {
+        $chunk = new Chunk;
+        $diff  = new Diff('from', 'to', [$chunk]);
+
+        foreach ($diff as $index => $_chunk) {
+            $this->assertSame(0, $index);
+            $this->assertSame($chunk, $_chunk);
+        }
+    }
 }