Merge pull request #34444 from JosephSilber/take-until-timeout

[8.x] Add `takeUntilTimeout` method to the lazy collection

Author: taylorotwell

src/Illuminate/Collections/LazyCollection.php

@@ -4,6 +4,7 @@
 
 use ArrayIterator;
 use Closure;
+use DateTimeInterface;
 use Illuminate\Support\Traits\EnumeratesValues;
 use Illuminate\Support\Traits\Macroable;
 use IteratorAggregate;
@@ -1213,6 +1214,21 @@ public function takeUntil($value)
         });
     }
 
+    /**
+     * Take items in the collection until a given point in time.
+     *
+     * @param  \DateTimeInterface  $timeout
+     * @return static
+     */
+    public function takeUntilTimeout(DateTimeInterface $timeout)
+    {
+        $timeout = $timeout->getTimestamp();
+
+        return $this->takeWhile(function () use ($timeout) {
+            return $this->now() < $timeout;
+        });
+    }
+
     /**
      * Take items in the collection while the given condition is met.
      *
@@ -1385,4 +1401,14 @@ protected function passthru($method, array $params)
             yield from $this->collect()->$method(...$params);
         });
     }
+
+    /**
+     * Get the current time.
+     *
+     * @return int
+     */
+    protected function now()
+    {
+        return time();
+    }
 }

tests/Support/SupportLazyCollectionTest.php

@@ -2,8 +2,10 @@
 
 namespace Illuminate\Tests\Support;
 
+use Carbon\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\LazyCollection;
+use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class SupportLazyCollectionTest extends TestCase
@@ -154,6 +156,36 @@ public function testRememberWithDuplicateKeys()
         $this->assertSame([['key', 1], ['key', 2]], $results);
     }
 
+    public function testTakeUntilTimeout()
+    {
+        $timeout = Carbon::now();
+
+        $mock = m::mock(LazyCollection::class.'[now]');
+
+        $results = $mock
+            ->times(10)
+            ->pipe(function ($collection) use ($mock, $timeout) {
+                tap($collection)
+                    ->mockery_init($mock->mockery_getContainer())
+                    ->shouldAllowMockingProtectedMethods()
+                    ->shouldReceive('now')
+                    ->times(3)
+                    ->andReturn(
+                        (clone $timeout)->sub(2, 'minute')->getTimestamp(),
+                        (clone $timeout)->sub(1, 'minute')->getTimestamp(),
+                        $timeout->getTimestamp()
+                    );
+
+                return $collection;
+            })
+            ->takeUntilTimeout($timeout)
+            ->all();
+
+        $this->assertSame([1, 2], $results);
+
+        m::close();
+    }
+
     public function testTapEach()
     {
         $data = LazyCollection::times(10);