Static Analysis Checks: Common Operations (I) #106

AlexandruGG · 2021-06-12T21:57:31Z

This PR adds more static analysis checks for commonly-used methods, and fixes a few type hints in the process.

AlexandruGG · 2021-06-12T22:05:36Z

tests/static-analysis/contains.php

+// VALID failures below -> `current` can return `NULL` if the collection is empty
+
+/** @psalm-suppress InvalidArgument @phpstan-ignore-next-line */
+contains_checkBool(Collection::fromIterable([1, 2, 3])->contains(2)->current());
+/** @psalm-suppress InvalidArgument @phpstan-ignore-next-line */
+contains_checkBool(Collection::fromIterable(['foo' => 'bar', 'baz' => 'taz'])->contains('bar')->current());


these feel very awkward to me. current() returns T|null, with null being returned when the collection is empty. However, in the chaining contains()->current() this will never be null because contains() will always return a collection with a boolean

I guess in practice when used like this the analysers will not complain:

if (true === Collection::fromIterable([1, 2, 3])->contains(2)->current()) { // do stuff }

but if the comparison is not explicit PHPStan at least will complain because the return type is bool|null:

if (Collection::fromIterable([1, 2, 3])->contains(2)->current()) { // do stuff }

@drupol I'm not sure I can convince you to make contains just return bool 😛. But it would be so much easier 😅

It was like that in the early versions of the library then I changed. Maybe we should discuss about that in a dedicated PR ?

AlexandruGG · 2021-06-12T22:08:22Z

spec/loophp/collection/CollectionSpec.php

+        $this::fromIterable(['a' => 'b', 'c' => 'd'])
+            ->contains('d')
+            ->shouldIterateAs(['c' => true]);


this is another unexpected behaviour I discovered from contains, it doesn't always return a list, but rather keeps the key of the searched element

AlexandruGG · 2021-06-13T20:02:45Z

grumphp.yml

+  tasks.psalm.ignore_patterns:
+      - "/.github/"
+      - "/.idea/"
+      - "/build/"
+      - "/benchmarks/"
+      - "/node_modules/"
+      - "/resource/"
+      - "/spec/"
+      - "/var/"
+      - "/vendor/"


I realised in CI Psalm wasn't running in tests where the static analysis checks are, so removing that ignore pattern here. I was still running them on local 😄

AlexandruGG · 2021-06-13T20:03:21Z

src/Collection.php

-        // @todo: Rename this in next major version.
-        // We cannot use Match::class because PHP 8 has
-        // a new "match" function and we cannot use the same name.
-        // @See https://github.com/loophp/collection/issues/56


I don't think this @todo was needed here anymore, right? This method works in php 8

Indeed, it's a leftover.

…-common-methods

drupol

All good here, thanks !

AlexandruGG · 2021-06-13T20:09:19Z

@drupol let me know if this helps you understand how I approach these static analysis and if it's helpful towards adding one for when. The PR is ready on my side, I'm going to add some more for commonly-used methods but on future PRs

drupol · 2021-06-13T20:10:32Z

docs/pages/api.rst

@@ -448,17 +450,24 @@ Signature: ``Collection::compact(...$values);``
 contains
 ~~~~~~~~

-Check if the collection contains one or more values.
+Check if the collection contains one or more values. Note that if multiple values are passed the operation


Maybe we could copy paste the warning box that explain this? For example, see the DropWhile operation: https://loophp-collection.readthedocs.io/en/latest/pages/api.html#dropwhile

I thought I remembered a similar one! Sure can!

Is this valid across all operations btw? Variadic parameters acting as OR

Thanks !

And yeah, I'm trying to make all the variadic as OR indeed.

added now. Had to make a tweak to specify that in this case you cannot use it as a logical AND by calling in succession because the collection will have just a bool after the first call

drupol · 2021-06-13T20:23:16Z

@drupol let me know if this helps you understand how I approach these static analysis and if it's helpful towards adding one for when. The PR is ready on my side, I'm going to add some more for commonly-used methods but on future PRs

Yeah go ahead please, going to merge this right now.

drupol · 2021-06-13T20:23:48Z

Thanks again @AlexandruGG !!!!

AlexandruGG · 2021-06-13T20:29:43Z

@drupol btw the part with the variadic parameter made me think of writing a section in the documentation about Principles of working with Collection, with things like:

most of the time operations will return a new Collection
mentioning the logical OR behaviour with variadic parameters
many operations allow tweaking the behaviour by the user providing a custom callback
how to make the Collection behave eagerly via the squash operation
how to test methods that use Collection (might not be straightforward for many that are not used to lazy behaviour!)

I might have others come to mind as well 😄. What do you think?
Some of these are mentioned in the Readme or in the api documentation in different places but I'm thinking would be good to see them in one place

drupol · 2021-06-13T20:44:01Z

It would be a big plus indeed!

The more documentation we have, the better it is. There are indeed many behaviors that could be documented.

drupol · 2021-08-04T09:21:18Z

@drupol btw the part with the variadic parameter made me think of writing a section in the documentation about Principles of working with Collection, with things like:
* most of the time operations will return a new Collection

* mentioning the logical `OR` behaviour with variadic parameters

* many operations allow tweaking the behaviour by the user providing a custom callback

* how to make the Collection behave eagerly via the `squash` operation

* how to test methods that use Collection (might not be straightforward for many that are not used to lazy behaviour!)
I might have others come to mind as well smile. What do you think?
Some of these are mentioned in the Readme or in the api documentation in different places but I'm thinking would be good to see them in one place

Yes! These are definitely the ADN of the library and it worth to have mentions in the README.

AlexandruGG added 6 commits June 12, 2021 21:27

Correct docs

26efa31

Run Psalm in tests for static-analysis checks

e46732d

SA Check: Apply

161adef

Normalize $callbacks

33d8ddc

SA Check: Chunk

3b2fe22

SA Check: Contains

3013b71

AlexandruGG commented Jun 12, 2021

View reviewed changes

AlexandruGG added 2 commits June 13, 2021 20:56

SA Checks: Count + Current

0da0b97

Remove match todo

2e7a1ca

AlexandruGG commented Jun 13, 2021

View reviewed changes

AlexandruGG changed the title ~~Feature/sa checks common methods~~ Static Analysis Checks: Common Operations (I) Jun 13, 2021

Merge remote-tracking branch 'upstream/master' into feature/sa-checks…

7e42f05

…-common-methods

AlexandruGG marked this pull request as ready for review June 13, 2021 20:07

drupol previously approved these changes Jun 13, 2021

View reviewed changes

drupol reviewed Jun 13, 2021

View reviewed changes

Add Contains warning

08daeff

AlexandruGG dismissed drupol’s stale review via 08daeff June 13, 2021 20:21

drupol merged commit c45465b into loophp:master Jun 13, 2021

AlexandruGG deleted the feature/sa-checks-common-methods branch June 13, 2021 20:29

AlexandruGG mentioned this pull request Aug 4, 2021

Documentation: Collection Principles #174

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Static Analysis Checks: Common Operations (I) #106

Static Analysis Checks: Common Operations (I) #106

AlexandruGG commented Jun 12, 2021 •

edited

AlexandruGG Jun 12, 2021

AlexandruGG Jun 12, 2021 •

edited

AlexandruGG Jun 13, 2021

drupol Jun 13, 2021 •

edited

AlexandruGG Jun 12, 2021

AlexandruGG Jun 13, 2021

AlexandruGG Jun 13, 2021

drupol Jun 13, 2021

drupol left a comment

AlexandruGG commented Jun 13, 2021

drupol Jun 13, 2021

AlexandruGG Jun 13, 2021

drupol Jun 13, 2021

AlexandruGG Jun 13, 2021

drupol commented Jun 13, 2021 •

edited

drupol commented Jun 13, 2021

AlexandruGG commented Jun 13, 2021 •

edited

drupol commented Jun 13, 2021

drupol commented Aug 4, 2021

Static Analysis Checks: Common Operations (I) #106

Static Analysis Checks: Common Operations (I) #106

Conversation

AlexandruGG commented Jun 12, 2021 • edited

Choose a reason for hiding this comment

AlexandruGG Jun 12, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drupol Jun 13, 2021 • edited

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

drupol left a comment

Choose a reason for hiding this comment

AlexandruGG commented Jun 13, 2021

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

drupol commented Jun 13, 2021 • edited

drupol commented Jun 13, 2021

AlexandruGG commented Jun 13, 2021 • edited

drupol commented Jun 13, 2021

drupol commented Aug 4, 2021

AlexandruGG commented Jun 12, 2021 •

edited

AlexandruGG Jun 12, 2021 •

edited

drupol Jun 13, 2021 •

edited

drupol commented Jun 13, 2021 •

edited

AlexandruGG commented Jun 13, 2021 •

edited