Merge pull request #1133 from Blacksmoke16/and-yield

Add method that allows defining a set of arguments the mock should yield

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 1.4.4 (TBC)
+* Add method that allows defining a set of arguments the mock should yield #1133
+
 ## 1.4.3 (2021-02-24)
 * Fixes calls to fetchMock before initialisation #1113
 * Allow shouldIgnoreMissing() to behave in a recursive fashion #1097

library/Mockery/Expectation.php

@@ -664,6 +664,25 @@ public function andSet($name, ...$values)
         return $this;
     }
 
+    /**
+     * Sets up a closure that will yield each of the provided args
+     *
+     * @param mixed ...$args
+     * @return self
+     */
+    public function andYield(...$args)
+    {
+        $this->_closureQueue = [
+            static function () use ($args) {
+                foreach ($args as $arg) {
+                    yield $arg;
+                }
+            },
+        ];
+
+        return $this;
+    }
+
     /**
      * Alias to andSet(). Allows the natural English construct
      * - set('foo', 'bar')->andReturn('bar')

tests/Mockery/ExpectationTest.php

@@ -285,6 +285,12 @@ public function testReturnsValuesSetAsArray()
         $this->assertEquals(3, $this->mock->foo());
     }
 
+    public function testAndYield(): void
+    {
+        $this->mock->shouldReceive('foo')->andYield(1, 2, 3);
+        self::assertSame([1, 2, 3], iterator_to_array($this->mock->foo()));
+    }
+
     public function testThrowsException()
     {
         $this->mock->shouldReceive('foo')->andThrow(new OutOfBoundsException());