feat: Add `Find` operation #204

Radiergummi · 2021-10-20T10:19:28Z

This PR:

Provides a find() operation
Has unit tests (phpspec)
Has static analysis tests (psalm, phpstan)
Has documentation

Fixes #198.

drupol · 2021-10-20T10:21:29Z

Hey hi !

That's a nice start! I'm going to review it carefully today in the evening :)

drupol · 2021-10-20T20:21:36Z

Could you give me write access to the repo so I can push the code-review changes?

I pushed my local branch here: https://github.com/loophp/collection/tree/feature/add-find-helper but I prefer to push my changes on your branch, so you can continue to push things if needed.

I did some changes in your Find operation, find them here: f97ee42

Radiergummi · 2021-10-21T06:08:44Z

Ah, of course. For some reason GitHub won't allow access to PR branches for org repos. I'll migrate it to my personal one.
Edit: Done.
Edit 2: Nice, appending the default after the filter is an elegant solution! 🙂

drupol · 2021-10-21T07:28:06Z

Edit 2: Nice, appending the default after the filter is an elegant solution! slightly_smiling_face

Yeah I'm trying to avoid repeating the same code all over the place. Using simple operations allows you to "compose" a new operation with a custom behavior without rewriting anything (almost).

…ons.

drupol · 2021-10-21T07:35:45Z

I just added 4 commits, it should fix the implementation and the code-style.

Let me know if you plan to continue your work on this.

Thanks for your contribution!

Radiergummi · 2021-10-21T09:27:26Z

No, I'm done. Thank you!

drupol · 2021-10-21T09:30:38Z

Do you think you could provide the changes in api.rst containing an explanation of what the operation you introduce is doing?

For the rest, I'll do it myself if you don't have time.

drupol · 2021-10-22T06:16:35Z

Thanks, much appreciated!

Radiergummi · 2021-10-22T06:29:19Z

I hope its okay style-wise - I'm not happy with the examples, it's hard to come up with something not too contrived, find really only makes sense at the end of a longer chain of operations...

drupol · 2021-10-22T06:46:37Z

The code style can be fixed automatically by doing: ./vendor/bin/grumphp run --tasks=phpcsfixer,phpcs

I quickly checked the example file and I think it's nice, it definitely shows how this find command could be useful with Doctrine.

WDYT @AlexandruGG ?

docs/pages/code/operations/find.php

AlexandruGG · 2021-10-24T07:53:09Z

The code style can be fixed automatically by doing: ./vendor/bin/grumphp run --tasks=phpcsfixer,phpcs

I quickly checked the example file and I think it's nice, it definitely shows how this find command could be useful with Doctrine.

WDYT @AlexandruGG ?

Overall looks good, there's a few things to improve on the documentation and tests side but we can make the additions. Do you want me to take care of it @drupol?

drupol · 2021-10-24T07:54:32Z

As you wish, if you have time to do it, go ahead, or else I'll take care myself next week.

AlexandruGG · 2021-10-24T08:03:30Z

As you wish, if you have time to do it, go ahead, or else I'll take care myself next week.

Happy to do it, leave it with me :)

- variable and param naming consistency - default value - update operation typing

- add static analysis checks - fix typing - add more unit tests

AlexandruGG · 2021-10-24T19:16:58Z

tests/static-analysis/find.php

+/*
+PHP 8 - using named parameters and the default `null` value -> these should legitimately fail,
+but Psalm reports no issue and PHPStan is reporting a different error than expected:
+"Parameter #1 $value of function find_checkNullableInt expects int|null, (Closure)|int given."
+
+find_checkNullableInt(Collection::fromIterable([1, 2, 3])->find(callbacks: $intValueCallback));
+find_checkNullableString(Collection::fromIterable(['foo' => 'a', 'bar' => 'b'])->find(callbacks: $stringValueCallback));
+*/
+
+/*
+PHP 8 - using named parameters and the default `null` value -> these should legitimately fail,
+but Psalm reports no issue and the current PHPStan failures are due to the error mentioned above.
+
+find_checkIntElement(Collection::fromIterable([1, 2, 3])->find(callbacks: $intValueCallback));
+find_checkStringElement(Collection::fromIterable(['foo' => 'a', 'bar' => 'b'])->find(callbacks: $stringValueCallback));
+*/


I put these here for info, but we cannot turn them on because the CI checks will fail on 7.4.

The issue reported by PHPstan is weird; it might be a bug but I can't be bothered to reproduce it in the playground right now

Thanks for providing the documentation and examples!

drupol · 2021-10-24T19:25:09Z

💯 !

AlexandruGG · 2021-10-24T19:36:19Z

@drupol this is ready for review!

@Radiergummi thank you for the contribution, have a look at the latest code and let me know if everything's as you expected :)

drupol

I followed the commits and I'm ok with everything! Thanks for spotting all the things!

drupol

LGTM

AlexandruGG · 2021-10-25T18:22:53Z

@Radiergummi this is ready to go. If you have any comments let me know, otherwise I will merge it tomorrow

drupol · 2021-10-26T10:10:24Z

I guess we can merge...

Radiergummi · 2021-10-26T10:26:36Z

Yup, LGTM. Thank you so much! :)

AlexandruGG · 2021-10-26T18:03:47Z

@Radiergummi @drupol thank you both for the work on this!

feat: Add Find operation

7c6a91d

drupol added the enhancement New feature or request label Oct 20, 2021

drupol added 2 commits October 21, 2021 09:32

code-review: Update Find operation - reuse already existing operati…

d6dd4b1

…ons.

code-review: Update code-style.

869174d

fix: Fix SA annotations.

4567b33

drupol force-pushed the feature/add-find-helper branch from 2e54861 to 4567b33 Compare October 21, 2021 07:41

fix: Fix SA annotations.

d943174

Added API description

13841cb

AlexandruGG reviewed Oct 24, 2021

View reviewed changes

docs/pages/code/operations/find.php Outdated Show resolved Hide resolved

AlexandruGG reviewed Oct 24, 2021

View reviewed changes

docs/pages/code/operations/find.php Outdated Show resolved Hide resolved

AlexandruGG added 5 commits October 24, 2021 18:54

Apply fixer

194139c

Clean up implementation

0acc6a9

- variable and param naming consistency - default value - update operation typing

Improve testing:

33e0c0d

- add static analysis checks - fix typing - add more unit tests

Improve documentation + examples

698c28b

Remove PHP 8 specific code

5c74d89

AlexandruGG reviewed Oct 24, 2021

View reviewed changes

Tweaks and fixes

eb80484

AlexandruGG marked this pull request as ready for review October 24, 2021 19:35

drupol approved these changes Oct 24, 2021

View reviewed changes

Fix find static analysis PHP 8 comment

0b9a521

drupol approved these changes Oct 25, 2021

View reviewed changes

Merge master into feature branch

f3f8362

AlexandruGG merged commit c2189f4 into loophp:master Oct 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `Find` operation #204

feat: Add `Find` operation #204

Radiergummi commented Oct 20, 2021 •

edited by AlexandruGG

drupol commented Oct 20, 2021

drupol commented Oct 20, 2021 •

edited

Radiergummi commented Oct 21, 2021 •

edited

drupol commented Oct 21, 2021

drupol commented Oct 21, 2021 •

edited

Radiergummi commented Oct 21, 2021

drupol commented Oct 21, 2021 •

edited

drupol commented Oct 22, 2021

Radiergummi commented Oct 22, 2021

drupol commented Oct 22, 2021

AlexandruGG commented Oct 24, 2021

drupol commented Oct 24, 2021

AlexandruGG commented Oct 24, 2021

AlexandruGG Oct 24, 2021

drupol Oct 24, 2021

drupol commented Oct 24, 2021

AlexandruGG commented Oct 24, 2021

drupol left a comment

drupol left a comment

AlexandruGG commented Oct 25, 2021

drupol commented Oct 26, 2021

Radiergummi commented Oct 26, 2021

AlexandruGG commented Oct 26, 2021

feat: Add Find operation #204

feat: Add Find operation #204

Conversation

Radiergummi commented Oct 20, 2021 • edited by AlexandruGG

drupol commented Oct 20, 2021

drupol commented Oct 20, 2021 • edited

Radiergummi commented Oct 21, 2021 • edited

drupol commented Oct 21, 2021

drupol commented Oct 21, 2021 • edited

Radiergummi commented Oct 21, 2021

drupol commented Oct 21, 2021 • edited

drupol commented Oct 22, 2021

Radiergummi commented Oct 22, 2021

drupol commented Oct 22, 2021

AlexandruGG commented Oct 24, 2021

drupol commented Oct 24, 2021

AlexandruGG commented Oct 24, 2021

AlexandruGG Oct 24, 2021

Choose a reason for hiding this comment

drupol Oct 24, 2021

Choose a reason for hiding this comment

drupol commented Oct 24, 2021

AlexandruGG commented Oct 24, 2021

drupol left a comment

Choose a reason for hiding this comment

drupol left a comment

Choose a reason for hiding this comment

AlexandruGG commented Oct 25, 2021

drupol commented Oct 26, 2021

Radiergummi commented Oct 26, 2021

AlexandruGG commented Oct 26, 2021

feat: Add `Find` operation #204

feat: Add `Find` operation #204

Radiergummi commented Oct 20, 2021 •

edited by AlexandruGG

drupol commented Oct 20, 2021 •

edited

Radiergummi commented Oct 21, 2021 •

edited

drupol commented Oct 21, 2021 •

edited

drupol commented Oct 21, 2021 •

edited