Feature: Iterate over an iterable (#31)

Signed-off-by: Nathanael Esayeas <nathanael.esayeas@protonmail.com>

Author: ghostwriter

composer.lock

@@ -4,17 +4,23 @@
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
     beStrictAboutCoverageMetadata="true"
     beStrictAboutOutputDuringTests="true"
+    beStrictAboutChangesToGlobalState="true"
+    beStrictAboutTestsThatDoNotTestAnything="true"
+    beStrictAboutTodoAnnotatedTests="true"
     bootstrap="vendor/autoload.php"
     cacheDirectory=".cache/phpunit"
     colors="true"
     executionOrder="depends,defects"
     failOnRisky="true"
     failOnWarning="true"
+    failOnEmptyTestSuite="true"
+    failOnIncomplete="true"
+    failOnSkipped="true"
     requireCoverageMetadata="true"
     testdox="true"
 >
   <testsuites>
-    <testsuite name="Test Suite">
+    <testsuite name="Option Test Suite">
       <directory>tests/Unit</directory>
     </testsuite>
   </testsuites>

phpunit.xml.dist

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.0.0@4e177bf0c9f03c17d2fbfd83b7cc9c47605274d8"/>
+<files psalm-version="5.8.0@9cf4f60a333f779ad3bc704a555920e81d4fdcda"/>

psalm-baseline.xml

@@ -5,11 +5,9 @@
 namespace Ghostwriter\Option\Contract;
 
 /**
- * @immutable
- *
- * @implements OptionInterface<TValue>
- *
  * @template TValue
+ *
+ * @extends OptionInterface<TValue>
  */
 interface NoneInterface extends OptionInterface
 {

src/Contract/NoneInterface.php

@@ -4,15 +4,15 @@
 
 namespace Ghostwriter\Option\Contract;
 
+use Generator;
 use Ghostwriter\Option\Exception\NullPointerException;
 use IteratorAggregate;
 use Throwable;
-use Traversable;
 
 /**
- * @implements IteratorAggregate<int,TValue>
- *
  * @template TValue
+ *
+ * @extends IteratorAggregate<int,TValue>
  */
 interface OptionInterface extends IteratorAggregate
 {
@@ -27,15 +27,15 @@ public function and(self $option): self;
      * @template TAndThen
      *
      * @param callable(TValue):TAndThen $function
-     *
-     * @return self<TAndThen|TValue>
      */
     public function andThen(callable $function): self;
 
     /**
      * Returns true if the option is a Some value containing the given $value.
      *
-     * @param TValue $value
+     * @template TContainsValue
+     *
+     * @param TContainsValue $value
      */
     public function contains(mixed $value): bool;
 
@@ -65,7 +65,7 @@ public function filter(callable $function): self;
      */
     public function flatten(): self;
 
-    public function getIterator(): Traversable;
+    public function getIterator(): Generator;
 
     /**
      * Returns true if the Option is an instance of None.
@@ -140,7 +140,7 @@ public function or(self $option): self;
      *
      * @template TCallableResultValue
      *
-     * @param callable(): OptionInterface<TCallableResultValue> $function
+     * @param callable(): self<TCallableResultValue> $function
      */
     public function orElse(callable $function): self;
 

src/Contract/OptionInterface.php

@@ -5,11 +5,9 @@
 namespace Ghostwriter\Option\Contract;
 
 /**
- * @immutable
- *
- * @implements OptionInterface<TValue>
- *
  * @template TValue
+ *
+ * @extends OptionInterface<TValue>
  */
 interface SomeInterface extends OptionInterface
 {

src/Contract/SomeInterface.php

@@ -5,14 +5,15 @@
 namespace Ghostwriter\Option;
 
 use Ghostwriter\Option\Contract\NoneInterface;
+use Ghostwriter\Option\Tests\Unit\NoneTest;
 use Ghostwriter\Option\Traits\OptionTrait;
 
 /**
- * @immutable
+ * @template TValue
  *
  * @implements NoneInterface<TValue>
  *
- * @template TValue
+ * @see NoneTest
  */
 final class None implements NoneInterface
 {

src/None.php

@@ -6,14 +6,15 @@
 
 use Ghostwriter\Option\Contract\SomeInterface;
 use Ghostwriter\Option\Exception\NullPointerException;
+use Ghostwriter\Option\Tests\Unit\SomeTest;
 use Ghostwriter\Option\Traits\OptionTrait;
 
 /**
- * @immutable
+ * @template TValue
  *
  * @implements SomeInterface<TValue>
  *
- * @template TValue
+ * @see SomeTest
  */
 final class Some implements SomeInterface
 {

src/Some.php

@@ -4,6 +4,7 @@
 
 namespace Ghostwriter\Option\Traits;
 
+use Generator;
 use Ghostwriter\Option\Contract\NoneInterface;
 use Ghostwriter\Option\Contract\OptionInterface;
 use Ghostwriter\Option\Contract\SomeInterface;
@@ -12,19 +13,16 @@
 use Ghostwriter\Option\None;
 use Ghostwriter\Option\Some;
 use Throwable;
-use Traversable;
 
 /**
  * @template TValue
- *
- * @immutable
- *
- * @implements OptionInterface<TValue>
  */
 trait OptionTrait
 {
+    private static ?NoneInterface $none = null;
+
     /**
-     * @param ?TValue $value
+     * @param TValue $value
      */
     private function __construct(
         private readonly mixed $value = null
@@ -87,10 +85,19 @@ public function flatten(): OptionInterface
         return $this->map(fn (mixed $value) => $value instanceof SomeInterface ? $value : $this);
     }
 
-    public function getIterator(): Traversable
+    public function getIterator(): Generator
     {
         if ($this instanceof SomeInterface) {
-            yield $this->value;
+            /**
+             * @var TValue $value
+             */
+            $value = $this->value;
+
+            if (is_iterable($value)) {
+                yield from $value;
+            } else {
+                yield $value;
+            }
         }
     }
 

src/Traits/OptionTrait.php

@@ -171,6 +171,9 @@ public function testGetIterator(): void
     {
         $some = Some::create('foo');
         self::assertCount(1, iterator_to_array($some));
+
+        $some = Some::create(['foo', 'bar']);
+        self::assertCount(2, iterator_to_array($some));
     }
 
     /**