Merge pull request #79 from KevinVanSonsbeek/feat/make-collections-support-iterables

Add support to the collection for iterables

Author: aeviiq

src/Collection.php

@@ -4,6 +4,7 @@
 
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 use Aeviiq\Collection\Exception\LogicException;
+use Traversable;
 
 /**
  * @template TKey as array-key
@@ -33,17 +34,12 @@ class Collection implements CollectionInterface
     private $iteratorClass;
 
     /**
-     * @param array<TKey, TValue> $elements
-     * @phpstan-param array<TKey, TValue> $elements
-     *
+     * @param iterable<TKey, TValue> $elements
      * @param class-string<\ArrayAccess>|string $iteratorClass
-     * @phpstan-param class-string<\ArrayAccess>|string $iteratorClass
-     *
-     * @param array<string|int, mixed> $elements
-     * @param string $iteratorClass
      */
-    final public function __construct(array $elements = [], string $iteratorClass = \ArrayIterator::class)
+    final public function __construct(iterable $elements = [], string $iteratorClass = \ArrayIterator::class)
     {
+        $elements = $elements instanceof Traversable ? iterator_to_array($elements) : $elements;
         $this->validateElements($elements);
         $this->elements = $elements;
         $this->setIteratorClass($iteratorClass);

tests/CollectionTest.php

@@ -4,6 +4,7 @@
 
 use Aeviiq\Collection\Collection;
 use Aeviiq\Collection\Exception\LogicException;
+use ArrayIterator;
 use PHPUnit\Framework\TestCase;
 
 class CollectionTest extends TestCase
@@ -25,6 +26,13 @@ public function testInstanceCreation(): void
         $this->assertSame($expected, $collection->toArray());
     }
 
+    public function testInstanceCreationWithIterator(): void
+    {
+        $expected = $this->getFirstThreeValidValues();
+        $collection = $this->createCollectionWithElements(new ArrayIterator($expected));
+        self::assertSame($expected, $collection->toArray());
+    }
+
     public function testAppend(): void
     {
         $collection = $this->createEmptyCollection();
@@ -343,7 +351,7 @@ protected function createEmptyCollection(): Collection
     /**
      * @param mixed[] $elements
      */
-    protected function createCollectionWithElements(array $elements): Collection
+    protected function createCollectionWithElements(iterable $elements): Collection
     {
         $collectionClass = $this->getCollectionClass();