Add chunk to collection #35

tdashton · 2024-11-15T13:01:31Z

Description

The objective of this PR is to allow the user of the library to break a Collection into smaller chunks and optionally to operate on these chunks with an anonymous function.

e.g.

$myUuids = MyUuidCollection::fromIterable([
    'a96d520d-bfb7-4a91-ac37-9f6fc3c3963a',
    '35bb7a38-abb7-4ebc-bb6a-d256cb0b1337',
    '89535491-bb46-429d-98f0-683d657b1cc8',
    '45ae5ce5-1840-4fea-a93f-342e0c9b12d1'
]);

$myUuids->eachChunk(
    2, // size
    function(Uuids $myUuidChunk) {
        $this->publisher->publish(
            $myUuidChunk
        );
    }
);

hugo-goncalves-kununu · 2024-11-18T09:17:23Z

README.md

@@ -33,6 +33,12 @@ composer install
 composer test-coverage
 ```

+To run tests in a docker container (without coverage):


This is not a tutorial on docker. Remove this part please

I do not mind one way or the other, if you desire I shall remove it: however I thought it could help next person who would like to contribute to this repository. I found it easier to test the different versions of php with docker using this command instead of having to manually install them on the host machine.

hugo-goncalves-kununu · 2024-11-18T11:32:40Z

docs/collection-interfaces.md

+public function chunk(int $size): array
+```
+
+This method [mirrors the behavior of `array_chunk`](https://www.php.net/manual/function.array-chunk.php) and returns a zero indexed numeric array of the current Collection based on the chunk size provided.


of the current collection <- This is english, we don't need to capitalize the nouns (we can but here it doesn't make sense)

It was meant as a proper noun, which in English is capitalized, however you are right: in the context of this documentation we can strive for consistency.

hugo-goncalves-kununu · 2024-11-18T11:34:51Z

docs/collection-trait.md

@@ -95,6 +95,10 @@ $collection->toArray();

 Internally it is call the `ArrayIterator::append` and returning the instance to allow fluent calls.

+## chunk
+
+This method [mirrors the behavior of `array_chunk`](https://www.php.net/manual/function.array-chunk.php) and returns a zero indexed numeric array of the current Collection based on the chunk size provided.


This comment is the same of the interface and is not giving any detail of the implementation done in the trait (and also the same "Collection With Uppercase On The First Letter")

Will update!

hugo-goncalves-kununu · 2024-11-18T11:38:46Z

src/CollectionTrait.php

+
+        return array_map(
+            static fn(array $chunk) => self::fromIterable($chunk),
+            array_chunk($this->toArray(), $size)


You can not just assume that user toArray implementation will yield a valid array that can be used on the fromIterable method (which will call the append method for each member of the iterable).

You need to chunk the result of $this->getArrayCopy() instead, as that method will return an array with all the items in the collection, which should be valid "entries" for the append method.

array_chunk($this->getArrayCopy(), $size)

Thanks for the tip!

hugo-goncalves-kununu · 2024-11-18T11:39:30Z

tests/CollectionTest.php

+    public function testChunkEach(Collection $collectionToChunk, int $chunkSize, array $expectedChunks): void
+    {
+        $expectedLambda = function(CollectionStub $collection) use ($expectedChunks): void {
+            static $i = 0;


I am not a fan of static variables. Also this is not the "expected" lambda, This is the lambda (anonymous) function.

So please redo this to not depend on static vars on the anonymous function and instead pass it by reference

$i = 0; $collection->eachChunk( $chunkSize, function(CollectionStub $collection) use (&$i, $expectedChunks): void { self::assertEquals($collection, $expectedChunks[$i++]); } );

Will refactor.

hugo-goncalves-kununu · 2024-11-18T11:43:46Z

tests/CollectionTest.php

@@ -485,6 +485,55 @@ public function testReverse(): void
        self::assertEquals([5, 4, 3, 2, 1], CollectionStub::fromIterable([1, 2, 3, 4, 5])->reverse()->toArray());
    }

+    #[DataProvider('chunkDataProvider')]
+    public function testChunk(Collection $collectionToChunk, int $chunkSize, array $expectedChunks): void


No need to be verbose. $collection is a valid name as we are TESTING the CHUNKING of a COLLECTION (so no ambiguity here, let's keep it simple):

#[DataProvider('chunkDataProvider')] public function testChunk(Collection $collection, int $chunkSize, array $expectedChunks): void { self::assertEquals($expectedChunks, $collection->chunk($chunkSize)); }

Will de-verbose it.

hugo-goncalves-kununu · 2024-11-18T11:44:10Z

tests/CollectionTest.php

@@ -553,6 +602,57 @@ public static function eachDataProvider(): array
        ];
    }

+    #[DataProvider('chunkEachDataProvider')]
+    public function testChunkEach(Collection $collectionToChunk, int $chunkSize, array $expectedChunks): void


Same comment as on testChunk. Rename to $collection please.

hugo-goncalves-kununu · 2024-11-18T11:47:43Z

docs/collection-trait.md

@@ -117,6 +121,10 @@ Finally, it will return the duplicated collection, optionally calling the `uniqu

 Internally, this method will iterate through each item of a collection, optionally rewind it at the end of the iteration, calling the anonymous function for each element.

+## eachChunk
+
+This method chunks the collection and executes the given anonymous function with each chunk.


Same thing here.

…able

hugo-goncalves-kununu · 2024-11-18T12:30:21Z

docs/collection-trait.md

@@ -95,6 +95,10 @@ $collection->toArray();

 Internally it is call the `ArrayIterator::append` and returning the instance to allow fluent calls.

+## chunk
+
+Internally this method chunks [a copy](https://www.php.net/manual/arrayobject.getarraycopy.php) of the collection with the [`array_chunk` php function](https://www.php.net/manual/function.array-chunk.php), returning a zero indexed array of collections of the same type as the initial one.


To be aligned with the rest of the docs, change the way the PHP function is linked. Also you are linking the getArrayCopy of the wrong class.

Suggestion:

Internally this method chunks the collection (by getting a copy with [getArrayCopy](https://www.php.net/manual/en/arrayiterator.getarraycopy.php) method) with the PHP [array_chunk](https://www.php.net/manual/function.array-chunk.php) function, returning a zero indexed array of collections of the same type as the initial one.

hugo-goncalves-kununu · 2024-11-18T12:31:52Z

tests/CollectionTest.php

+    #[DataProvider('chunkDataProvider')]
+    public function testChunk(Collection $collection, int $chunkSize, array $expectedChunks): void
+    {
+        self::assertEquals(


Single line

sonarqubecloud · 2024-11-18T12:50:05Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

add chunk, eachChunk and tests for chunk

db12b6f

tdashton requested a review from a team as a code owner November 15, 2024 13:01

github-actions bot assigned tdashton Nov 15, 2024

update docs, test chunkEach method

f92e273

tdashton requested a review from hugo-goncalves-kununu November 15, 2024 13:28

tdashton added 4 commits November 15, 2024 14:29

update docs

3f78ea5

remove unused variable

f6a9b99

Update README, rename var in chunk method

d323276

Use an arrow function in chunk method

2979365

hugo-goncalves-kununu requested changes Nov 18, 2024

View reviewed changes

tdashton added 3 commits November 18, 2024 13:14

Merge remote-tracking branch 'origin/master' into makeCollectionChunk…

36f9d99

…able

Update based on PR feedback

9e974f6

fix typo

1a43ac2

tdashton requested a review from hugo-goncalves-kununu November 18, 2024 12:28

hugo-goncalves-kununu requested changes Nov 18, 2024

View reviewed changes

tdashton added 2 commits November 18, 2024 13:42

Update docs for eachChunk

8201081

update w/ PR feedback

7e50443

tdashton requested a review from hugo-goncalves-kununu November 18, 2024 13:23

hugo-goncalves-kununu approved these changes Nov 18, 2024

View reviewed changes

tdashton merged commit f41e949 into master Nov 18, 2024
8 checks passed

tdashton deleted the makeCollectionChunkable branch November 18, 2024 14:38

tdashton mentioned this pull request Nov 18, 2024

Backport chunk to v1.11 #38

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add chunk to collection #35

Add chunk to collection #35

tdashton commented Nov 15, 2024 •

edited

Loading

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024 •

edited

Loading

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

tdashton Nov 18, 2024 •

edited

Loading

hugo-goncalves-kununu Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

hugo-goncalves-kununu Nov 18, 2024

sonarqubecloud bot commented Nov 18, 2024

Add chunk to collection #35

Add chunk to collection #35

Conversation

tdashton commented Nov 15, 2024 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdashton Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdashton Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 18, 2024

Quality Gate passed

tdashton commented Nov 15, 2024 •

edited

Loading

tdashton Nov 18, 2024 •

edited

Loading

tdashton Nov 18, 2024 •

edited

Loading