Merge pull request #10 from asm89/foreachable

Make it possible to consume the Option value using foreach

src/PhpOption/LazyOption.php

@@ -136,6 +136,11 @@ public function reject($value)
         return $this->option()->reject($value);
     }
 
+    public function getIterator()
+    {
+        return $this->option()->getIterator();
+    }
+
     /**
      * @return Option
      */

src/PhpOption/None.php

@@ -18,6 +18,8 @@
 
 namespace PhpOption;
 
+use EmptyIterator;
+
 final class None extends Option
 {
     private static $instance;
@@ -109,5 +111,10 @@ public function reject($value)
         return $this;
     }
 
+    public function getIterator()
+    {
+        return new EmptyIterator();
+    }
+
     private function __construct() { }
-}
+}

src/PhpOption/Option.php

@@ -18,12 +18,14 @@
 
 namespace PhpOption;
 
+use IteratorAggregate;
+
 /**
  * Base Option Class.
  *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
-abstract class Option
+abstract class Option implements IteratorAggregate
 {
     /**
      * Creates an option given a return value.

src/PhpOption/Some.php

@@ -18,6 +18,8 @@
 
 namespace PhpOption;
 
+use ArrayIterator;
+
 final class Some extends Option
 {
     private $value;
@@ -132,4 +134,9 @@ public function reject($value)
 
         return $this;
     }
+
+    public function getIterator()
+    {
+        return new ArrayIterator(array($this->value));
+    }
 }

tests/PhpOption/Tests/NoneTest.php

@@ -102,8 +102,20 @@ public function testReject()
         $this->assertSame($this->none, $this->none->reject(null));
     }
 
+    public function testForeach()
+    {
+        $none = \PhpOption\None::create();
+
+        $called = 0;
+        foreach ($none as $value) {
+            $called++;
+        }
+
+        $this->assertEquals(0, $called);
+    }
+
     protected function setUp()
     {
         $this->none = None::create();
     }
-}
+}

tests/PhpOption/Tests/SomeTest.php

@@ -105,6 +105,21 @@ public function testReject()
         $this->assertSame($some, $some->reject(true));
         $this->assertInstanceOf('PhpOption\None', $some->reject('foo'));
     }
+
+    public function testForeach()
+    {
+        $some = new Some('foo');
+
+        $called = 0;
+        $extractedValue = null;
+        foreach ($some as $value) {
+            $extractedValue = $value;
+            $called++;
+        }
+
+        $this->assertEquals('foo', $extractedValue);
+        $this->assertEquals(1, $called);
+    }
 }
 
 // For the interested reader of these tests, we have gone some great lengths