Adds tap() - allows shorter syntax for chaining no side effects operations

[ddebowczyk]

More convenient than apply() for chaining no side effect operations like logging or event dispatching.
Allows for shorter notation:

$collection->tap(fn($item) => Event::dispatch(new ItemReceived($item)))

versus

$collection->apply(function($item) {
   Event::dispatch(new ItemReceived($item));
   return true;
})

This PR:

• [+] Provides shorter notation for no side effect operations
• [-] It breaks backward compatibility
• [+] Is covered by unit tests
• [+] Has static analysis tests (psalm, phpstan)
• [+] Has documentation
• [-] Is an experimental thing

[what-the-diff]

PR Summary

• New 'tap' operation added to the Collection class
  Our software's Collection class got an enhancement with a new operation called 'tap'. Its corresponding agreement (also known as a 'contract') and its implementation have also been added.

• New file additions related to 'tap' operation
  Three new files are added in various directories related to the new 'tap' operation. These are 'Tappable.php' in the 'Contract/Operation' directory, 'Tap.php' in the 'Operation' directory, and 'tap.php' in the 'tests/static-analysis' directory.

• New test case for 'tap' operation
  To ensure that the new 'tap' operation works properly, a new test case has been added to CollectionSpecificOperationTest.php. It helps us to confirm that the new feature behaves as expected.

[drupol]

Hi,

Thanks for the PR, it LGTM ! I wasn't aware that apply could be a burden to use and I don't mind adding tap into it. I agree that the syntax is simpler.

However, let's make sure tests are passing ;)

Let me know if you need some help.

[ddebowczyk]

Frankly, i just copied tests from apply and removed irrelevant fragment relying on boolean results. Not sure why they don't pass - any idea? W dniu wt., 2.04.2024 o 08:06 Pol Dellaiera ***@***.***> napisał(a):

…

Hi, Thanks for the PR, it LGTM ! I wasn't aware that apply could be a burden to use and I don't mind adding tap into it. I agree that the syntax is simpler. However, let's make sure tests are passing ;) Let me know if you need some help. — Reply to this email directly, view it on GitHub <#340 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABM6RJW3K3JCK2IMQYDGIDY3JDGJAVCNFSM6AAAAABFSW7JOKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMZRGE2DIMRVG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[drupol]

There's a fundamental difference between apply and tap. Of course, they can do the same things, but since apply must returns a boolean, it can have a different way of working than tap... I guess the tests you've implemented are not reflecting that.

Also, it seems that there's an issue with the syntax.

To fix the code style:

./vendor/bin/grumphp run --tasks=phpcsfixer

To run the unit tests:

./vendor/bin/grumphp run --tasks=phpunit

To run the static analysis tests:

./vendor/bin/grumphp run --tasks=psalm.phpstan

[ddebowczyk]

I cannot install pcov on my machine currently, so my composer install fails = I can't execute code checks, tests, etc on my local env. For the time being I will continue using my fork. I will try getting back to it when I find some time to set everything up properly. Thanks for quick replies.

[drupol]

I understand. I wish I could help more concretely but right now, I'm busy on some other projects sadly.

If I can give a piece of advice to have an environment ready to use to develop in loophp/collection is to install nix (more info at https://zero-to-nix.com/):

curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

To make it short, Nix is a universal package manager working on any Linux and Mac.

Once it is installed, go in the loophp/collection directory and do:

nix shell github:loophp/nix-shell#env-php81 --impure

This will take 2 to 3 minutes. Once it's done, a new temporary shell will be created where you'll have PHP 8.1 running with PCOV and everything you need to contribute to loophp/collection locally without interfering with your local PHP installation (if any). No container will be involved.

To exit the shell, just type exit and you're done.

[ddebowczyk]

Thanks again for the suggestion. I will get back with the fixes when I get tests running locally.

[drupol]

That was fast! Did you use Nix in the end?

[ddebowczyk]

Yes, Nix did the job. Thanks for suggesting it, saved me probably hours of install/config time.

[drupol]

Excellent, hope you'll use it for some other stuff too !!!

[drupol]

LGTM, I'll merge it as it is and maybe do some optimisations later on.

Thank you very much for your contribution!

[drupol]

This feature is available in the newly released version 7.6.0.