[7.x] Add until Collection method

[jasonmccreary]

This introduces a new until Collection method. It is similar to the take_while method in Ruby.

While this functionality may be achieved using combinations of the existing Collection methods or with custom logic, the code clarity provided by this single method brings value.

For example:

[$before, $after] = $primes->partition(function ($item) {
    return $item < 11;
});
$before->dump();

May simply be written as:

$primes->until(11)->dump();

This would be useful as a higher order method as well.

[jasonmccreary]

If accepted, I'd be glad to follow-up with the Higher Order Proxy for until as well as the update to the Docs.

[taylorotwell]

Curious to see some application examples of when this might be helpful in a typical Laravel app...

[jasonmccreary]

I needed to get a subset of Orders between a certain date and I had a sorted Eloquent collection of them.

filter and other methods could work, but felt something like until got it in a single go and was more expressive.

Chatted with @adamwathan and @reinink about it. They both hand macros that did something similar, so I figured I'd try to PR it.

[taylorotwell]

Interesting. Can you share that snippet of code?

[GrahamCampbell]

We probably want this on lazy collections too?

[jasonmccreary]

@taylorotwell, unfortunately, it was just a quick script to rebuild some lost order data. So I didn't keep it. However, I ended up doing a foreach just because finding the right combination of filter or short-circuiting each felt more verbose.

Glad to sit on it until I come across another need.

@GrahamCampbell, yeah, I think it'd be pretty nice as a Higher Order Proxy too. That way it's easier to pass custom logic.

$prs->until->unapproved();

Glad to add it to whatever. Just want to make sure it's merge-worthy first.

[taylorotwell]

I'm pretty good with it. Do you think there is merit to naming it takeWhile just so it has parity with the existing Ruby method people might already be familiar with?

[jasonmccreary]

Your call. I only changed it to have the nice single word method name.

Also, this stops when the condition is true. Whereas takeWhile might imply different logic, e.g. go while condition is true.

[taylorotwell]

OK, that's fine. Let's go ahead and wrap this up then with the HigherOrder support and LazyCollection support.

[taylorotwell]

@jasonmccreary ping me when you are done with this