Add until Collection method

Author: jasonmccreary

src/Illuminate/Support/Collection.php

@@ -1326,11 +1326,37 @@ public function offsetSet($key, $value)
     /**
      * Unset the item at a given offset.
      *
-     * @param  string  $key
+     * @param string $key
      * @return void
      */
     public function offsetUnset($key)
     {
         unset($this->items[$key]);
     }
+
+    /**
+     * Take items in the collection until condition is met.
+     *
+     * @param  mixed  $key
+     * @return static
+     */
+    public function until($value)
+    {
+        $passed = [];
+
+        $callback = $this->useAsCallable($value) ? $value :
+            function ($item) use ($value) {
+                return $item === $value;
+            };
+
+        foreach ($this as $key => $item) {
+            if ($callback($item, $key)) {
+                break;
+            }
+
+            $passed[$key] = $item;
+        }
+
+        return new static($passed);
+    }
 }

tests/Support/SupportCollectionTest.php

@@ -4070,6 +4070,41 @@ public function testCollect($collection)
         ], $data->all());
     }
 
+    public function testUntilUsingValue()
+    {
+        $data = new Collection([1, 2, 3, 4]);
+
+        $data = $data->until(3);
+
+        $this->assertSame([1, 2], $data->toArray());
+    }
+
+    public function testUntilUsingCallback()
+    {
+        $data = new Collection([1, 2, 3, 4]);
+
+        $data = $data->until(function ($item) {
+            return $item >= 3;
+        });
+
+        $this->assertSame([1, 2], $data->toArray());
+    }
+
+    public function testUntilReturnsAllItemsForUnmetValue()
+    {
+        $data = new Collection([1, 2, 3, 4]);
+
+        $actual = $data->until(99);
+
+        $this->assertSame($data->toArray(), $actual->toArray());
+
+        $actual = $data->until(function ($item) {
+            return $item >= 99;
+        });
+
+        $this->assertSame($data->toArray(), $actual->toArray());
+    }
+
     /**
      * Provides each collection class, respectively.
      *