Merge pull request #9 from mediact/feature/iterable-data-container

2.7.1 Let data container interface be iterable

src/DataContainerDecoratorTrait.php

@@ -6,6 +6,8 @@
 
 namespace Mediact\DataContainer;
 
+use Traversable;
+
 /**
  * Implements DataContainerInterface
  */
@@ -194,6 +196,17 @@ public function move(string $pattern, string $replacement)
             ->move($pattern, $replacement);
     }
 
+    /**
+     * Retrieve an external iterator.
+     *
+     * @return Traversable
+     */
+    public function getIterator(): Traversable
+    {
+        return $this->getStorage()
+            ->getIterator();
+    }
+
     /**
      * Prepare the object for cloning.
      *

src/DataContainerInterface.php

@@ -6,10 +6,12 @@
 
 namespace Mediact\DataContainer;
 
+use IteratorAggregate;
+
 /**
  * Contains any data which can be accessed using dot-notation.
  */
-interface DataContainerInterface
+interface DataContainerInterface extends IteratorAggregate
 {
     /**
      * The separator used in paths.

src/DataContainerIteratorAggregateTrait.php

@@ -11,6 +11,8 @@
 
 /**
  * Implements IteratorAggregate
+ *
+ * @deprecated IteratorAggregate is implemented by DataContainerDecoratorTrait.
  */
 trait DataContainerIteratorAggregateTrait
 {

src/IterableDataContainerInterface.php

@@ -6,12 +6,13 @@
 
 namespace Mediact\DataContainer;
 
-use IteratorAggregate;
 use Traversable;
 
+/**
+ * @deprecated DataContainerInterface is iterable.
+ */
 interface IterableDataContainerInterface extends
-    DataContainerInterface,
-    IteratorAggregate
+    DataContainerInterface
 {
     /**
      * Retrieve an external iterator.

tests/DataContainerDecoratorTraitTest.php

@@ -6,6 +6,7 @@
 
 namespace Mediact\DataContainer\Tests;
 
+use ArrayIterator;
 use Mediact\DataContainer\DataContainer;
 use Mediact\DataContainer\DataContainerInterface;
 use Mediact\DataContainer\Tests\TestDouble\DataContainerImplementationDouble;
@@ -262,6 +263,26 @@ public function testMove()
         $double->move($pattern, $destination);
     }
 
+    /**
+     * @return void
+     *
+     * @covers ::getIterator
+     */
+    public function testGetIterator()
+    {
+        $data     = ['some_data'];
+        $iterator = new ArrayIterator($data);
+        $storage  = $this->createMock(DataContainerInterface::class);
+
+        $storage
+            ->expects(self::once())
+            ->method('getIterator')
+            ->willReturn($iterator);
+
+        $double = new DataContainerImplementationDouble($storage);
+        $this->assertSame($data, iterator_to_array($double));
+    }
+
     /**
      * @return void
      *

tests/DataContainerIteratorAggregateTraitTest.php

@@ -6,8 +6,9 @@
 
 namespace Mediact\DataContainer\Tests;
 
+use IteratorAggregate;
 use Mediact\DataContainer\DataContainerInterface;
-use Mediact\DataContainer\Tests\TestDouble\DataContainerImplementationDouble;
+use Mediact\DataContainer\DataContainerIteratorAggregateTrait;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -30,7 +31,34 @@ public function testGetIterator()
             ->method('all')
             ->willReturn($data);
 
-        $double = new DataContainerImplementationDouble($storage);
+        $double = new class ($storage) implements IteratorAggregate
+        {
+            use DataContainerIteratorAggregateTrait;
+
+            /** @var DataContainerInterface */
+            private $storage;
+
+            /**
+             * Constructor.
+             *
+             * @param DataContainerInterface $storage
+             */
+            public function __construct(DataContainerInterface $storage)
+            {
+                $this->storage = $storage;
+            }
+
+            /**
+             * Get the storage.
+             *
+             * @return DataContainerInterface
+             */
+            protected function getStorage(): DataContainerInterface
+            {
+                return $this->storage;
+            }
+        };
+
         $this->assertEquals($data, iterator_to_array($double));
     }
 }

tests/TestDouble/DataContainerImplementationDouble.php

@@ -12,10 +12,9 @@
 use Mediact\DataContainer\DataContainerInterface;
 use Mediact\DataContainer\DataContainerIteratorAggregateTrait;
 
-class DataContainerImplementationDouble implements DataContainerInterface, IteratorAggregate
+class DataContainerImplementationDouble implements DataContainerInterface
 {
     use DataContainerDecoratorTrait;
-    use DataContainerIteratorAggregateTrait;
 
     /**
      * Constructor.

tests/TestDouble/IterableImplementationDouble.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright MediaCT. All rights reserved.
+ * https://www.mediact.nl
+ */
+
+namespace Mediact\DataContainer\Tests\TestDouble;
+
+use IteratorAggregate;
+use Mediact\DataContainer\DataContainer;
+use Mediact\DataContainer\DataContainerDecoratorTrait;
+use Mediact\DataContainer\DataContainerInterface;
+use Mediact\DataContainer\DataContainerIteratorAggregateTrait;
+
+class IterableImplementationDouble implements IteratorAggregate
+{
+    use DataContainerIteratorAggregateTrait;
+
+    /** @var DataContainerInterface */
+    private $storage;
+
+    /**
+     * Constructor.
+     *
+     * @param DataContainerInterface $storage
+     */
+    public function __construct(DataContainerInterface $storage)
+    {
+        $this->storage = $storage;
+    }
+
+    /**
+     * Get the storage.
+     *
+     * @return DataContainerInterface
+     */
+    protected function getStorage(): DataContainerInterface
+    {
+        return $this->storage;
+    }
+}