Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[12.x] Feature: Collection chunk without preserving keys #54916

Merged
merged 3 commits into from
Mar 6, 2025
Merged

[12.x] Feature: Collection chunk without preserving keys #54916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1388ad
add test
liamduckett Mar 5, 2025
5b39edf
implement chunking without preserving keys for support collection
liamduckett Mar 5, 2025
de14cb5
implement chunking without preserving keys for lazy collection
liamduckett Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/Illuminate/Collections/Collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1441,17 +1441,18 @@ public function firstOrFail($key = null, $operator = null, $value = null)
* Chunk the collection into chunks of the given size.
*
* @param int $size
* @param bool $preserveKeys
* @return static<int, static>
*/
public function chunk($size)
public function chunk($size, $preserveKeys = true)
{
if ($size <= 0) {
return new static;
}

$chunks = [];

foreach (array_chunk($this->items, $size, true) as $chunk) {
foreach (array_chunk($this->items, $size, $preserveKeys) as $chunk) {
$chunks[] = new static($chunk);
}

Expand Down
12 changes: 9 additions & 3 deletions src/Illuminate/Collections/LazyCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1376,22 +1376,28 @@ public function firstOrFail($key = null, $operator = null, $value = null)
* Chunk the collection into chunks of the given size.
*
* @param int $size
* @param bool $preserveKeys
* @return static<int, static>
*/
public function chunk($size)
public function chunk($size, $preserveKeys = true)
{
if ($size <= 0) {
return static::empty();
}

return new static(function () use ($size) {
$add = match ($preserveKeys) {
Copy link
Contributor Author

@liamduckett liamduckett Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My first pass looked more like:

return new static(function () use ($size, $preserveKeys) {
    $iterator = $this->getIterator();

    while ($iterator->valid()) {
        $chunk = [];

        while (true) {
            if ($preserveKeys === false) {
                $chunk[] = $iterator->current();
            } else {
                $chunk[$iterator->key()] = $iterator->current();
            }

            if (count($chunk) < $size) {
                $iterator->next();

                if (! $iterator->valid()) {
                    break;
                }
            } else {
                break;
            }
        }

        yield new static($chunk);

        $iterator->next();
    }
});

I opted for this (match) approach due to LazyCollections perfomance oriented nature (appreciate this is at the cost of readability).

true => fn (array &$chunk, Traversable $iterator) => $chunk[$iterator->key()] = $iterator->current(),
false => fn (array &$chunk, Traversable $iterator) => $chunk[] = $iterator->current(),
};

return new static(function () use ($size, $add) {
$iterator = $this->getIterator();

while ($iterator->valid()) {
$chunk = [];

while (true) {
$chunk[$iterator->key()] = $iterator->current();
$add($chunk, $iterator);

if (count($chunk) < $size) {
$iterator->next();
Expand Down
18 changes: 18 additions & 0 deletions tests/Support/SupportCollectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2145,6 +2145,24 @@ public function testChunkWhenGivenLessThanZero($collection)
);
}

#[DataProvider('collectionClassProvider')]
public function testChunkPreservingKeys($collection)
{
$data = new $collection([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

$this->assertEquals(
[[0 => 1, 1 => 2, 2 => 3], [3 => 4, 4 => 5, 5 => 6], [6 => 7, 7 => 8, 8 => 9], [9 => 10]],
$data->chunk(3)->toArray()
);

$data = new $collection([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

$this->assertEquals(
[[1, 2, 3], [4, 5, 6], [7, 8, 9], [10]],
$data->chunk(3, false)->toArray()
);
}

#[DataProvider('collectionClassProvider')]
public function testSplitIn($collection)
{
Expand Down
Loading