[PHPStan Baseline] Fix Errors Part 2 + Modify `Unfold` Operation #217

AlexandruGG · 2021-11-10T08:10:33Z

This PR:

Fixes more PHPStan baseline errors
Refactors the Unfold operation to make it more consistent in usage
Breaks backwards compatibility
Has unit tests
Has static analysis checks
Has documentation

Follows #216.

drupol · 2021-11-10T08:12:07Z

src/Iterator/TypedIterator.php

-
-                if ('object' !== $type) {
-                    return $type;
+                if (!is_object($variable)) {


#AutoFacepalm

turns out the previous comparison is not interpreted by PHPStan in the same way that the dedicated function comparison is

Great finding!

drupol · 2021-11-10T08:15:52Z

src/Operation/Unfold.php

             */
            static fn (...$parameters): Closure =>
                /**
-                 * @param callable(mixed|T...): (mixed|array<TKey, T>) $callback
+                 * @param callable(T...): (T|list<T>) $callback


I don't understand this change.

$callback is a user callback, so, it might return anything... no?

well, yes and no.

It's a bit tricky to type this one properly to be honest, so it's up to us if we want to put any restrictions on it or not.

From what I see, this is the behaviour:

the callback can return any value, let's call it "x"

in the next call, "x" is passed to the callback as parameter, with the following behaviour:
- if "x" is a list, it's unpacked and each item in the list will be a different parameter for the callback
- if "x" is not a list, then it means it will be the parameter for the callback, and the callback only takes one argument

Examples of each:

$fibonacci = static fn ($a = 0, $b = 1): array =>[$b, $a + $b]; Collection::unfold($fibonacci); $even = static fn (int $carry): int => $carry + 2; Collection::unfold($even, -2);

The change I made here means that we are linking the return type of the callback with the parameters that are passed in, but it does also mean that the parameters should be the same type. So we're saying that you can either return a list of parameters of the same type OR a single value which should be the same type as the callback param type.

I think this is fine for most use cases. However, if we want to allow more flexibility the only other option is to go full mixed:

@param callable(mixed ...): mixed $callback

I agree. The return type of the closure must be a list in order to fulfill the operation correctly.

Maybe we should then get rid of the (array) cast and array_values then ? WDYT ?

yeah those are not needed I think, I'll test it

I removed both now and introduced logic to check whether the $parameters is a list or a single value. Works the same way as before but makes the code more explicit than the (array) cast + array_values

Ok, I'll make the needed changes then. It will be a minor backwards compatibility break and will need to update the docs too

I think it might be better to do it now.

yeah I'll do it as part of this PR

I've updated the code and unit tests, have a look how the usage changes. If you're happy with this I can then go ahead and update the documentation and add some static analysis checks

yes definitely :)

drupol · 2021-11-10T15:04:08Z

src/Operation/Unfold.php

@@ -11,6 +11,7 @@

 use Closure;
 use Generator;
+


drupol · 2021-11-10T17:20:15Z

src/Operation/Unfold.php

                     */
                    static function () use ($parameters, $callback): Generator {
                        while (true) {
-                            /** @var T $parameters */
-                            $parameters = $callback(...array_values((array) $parameters));
+                            $parameters = $callback(...$parameters);


I think we should not create a local variable and yield directly the result of the callback.

that won't work the same way because the Generator uses the variable in the next yield iteration here:
$callback(...$parameters)

If there's no variable then it will continue to use the initial parameters

#TripleFacepalm ... damn I'm too tired!

#TripleFacepalm ... damn I'm too tired!

Don't worry about it 😄. I tried it as well haha, had the same idea initially

drupol · 2021-11-10T20:52:19Z

I'll wait for this to be done, then do the release, if you need some help, just let me know.

Tomorrow we're off in Belgium, I might do this tomorrow.

AlexandruGG · 2021-11-11T08:11:29Z

I'll wait for this to be done, then do the release, if you need some help, just let me know.

Tomorrow we're off in Belgium, I might do this tomorrow.

I'm not sure if I'll get this done today but we should definitely include it in the release, so I'll tag you when it's ready 😉

drupol · 2021-11-11T09:19:50Z

docs/pages/code/collatz-conjecture.php

+$collection = Collection::unfold($collatz, 10)
+    ->unwrap()
+    ->normalize()
+    ->until(static fn ($number): bool => 1 === $number);


We could simplify this as:

$collection = Collection::unfold($collatz, 10) ->unwrap() ->until(static fn (int $number): bool => 1 === $number);

right, that works now because all normalizes by default

AlexandruGG · 2021-11-11T10:14:19Z

docs/pages/api.rst

-Another example
-
-.. code-block:: php
-
-    $even = Collection::unfold(static function ($carry) {return $carry + 2;}, -2);
-    $odd = Collection::unfold(static function ($carry) {return $carry + 2;}, -1);
-    // Is the same as
-    $even = Collection::range(0, \INF, 2);
-    $odd = Collection::range(1, \INF, 2);
-


these were repeated in both the range section and the unfold section. I kept it for the latter

Fair enough.

AlexandruGG · 2021-11-11T10:17:41Z

@drupol this should be ready now :)

drupol · 2021-11-11T12:35:30Z

spec/loophp/collection/CollectionSpec.php

        };

        $this::unfold($collatz, 10)
+            ->unwrap()
+            ->normalize()


I think we can get rid of normalize here as well.

you're right although not without updating the test. I made the update now

drupol · 2021-11-11T12:38:11Z

docs/pages/api.rst

-            return 1 === $number;
-        });
+        ->unwrap()
+        ->normalize()


The normalize can be removed I think.

drupol

I'll fix the tests :)

drupol · 2021-11-11T18:54:36Z

All good for you @AlexandruGG ? I can merge it ?

AlexandruGG added 2 commits November 10, 2021 08:00

Fix Unfoldable + docs on Timesable, Unwordsable

7e00706

Fix TypedIterator

2193dad

drupol reviewed Nov 10, 2021

View reviewed changes

AlexandruGG added 2 commits November 10, 2021 15:00

Improve types further and remove array operations

d60c330

PHPCS

6d9ff41

drupol reviewed Nov 10, 2021

View reviewed changes

src/Operation/Unfold.php Outdated

@@ -11,6 +11,7 @@

use Closure;

use Generator;

Copy link

Collaborator

drupol Nov 10, 2021

Choose a reason for hiding this comment

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

😆

AlexandruGG reacted with laugh emoji

Refactor Unfold to yield list<T>

49571e2

AlexandruGG added the backward breaking change label Nov 10, 2021

drupol reviewed Nov 10, 2021

View reviewed changes

drupol added the enhancement New feature or request label Nov 10, 2021

drupol assigned AlexandruGG Nov 10, 2021

AlexandruGG added 2 commits November 11, 2021 08:32

Add static analysis tests

807653b

Update documentation

1b5a219

AlexandruGG changed the title ~~[PHPStan Baseline] Fix Errors Part 2~~ [PHPStan Baseline] Fix Errors Part 2 + Modify Unfold Operation Nov 11, 2021

drupol reviewed Nov 11, 2021

View reviewed changes

Remove redundant normalize

1da4811

AlexandruGG commented Nov 11, 2021

View reviewed changes

AlexandruGG marked this pull request as ready for review November 11, 2021 10:17

drupol reviewed Nov 11, 2021

View reviewed changes

Remove more usages of normalize

ea730d9

drupol approved these changes Nov 11, 2021

View reviewed changes

Fix tests.

5908068

drupol merged commit 52dee56 into master Nov 11, 2021

drupol deleted the feature/more-phpstan-fixes branch November 11, 2021 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PHPStan Baseline] Fix Errors Part 2 + Modify `Unfold` Operation #217

[PHPStan Baseline] Fix Errors Part 2 + Modify `Unfold` Operation #217

AlexandruGG commented Nov 10, 2021 •

edited

drupol Nov 10, 2021

AlexandruGG Nov 10, 2021

drupol Nov 10, 2021

drupol Nov 10, 2021

AlexandruGG Nov 10, 2021

drupol Nov 10, 2021 •

edited

AlexandruGG Nov 10, 2021

AlexandruGG Nov 10, 2021

AlexandruGG Nov 10, 2021 •

edited

drupol Nov 10, 2021

AlexandruGG Nov 10, 2021

AlexandruGG Nov 10, 2021

drupol Nov 10, 2021

drupol Nov 10, 2021

drupol Nov 10, 2021

AlexandruGG Nov 10, 2021

drupol Nov 10, 2021

AlexandruGG Nov 10, 2021

drupol Nov 10, 2021

drupol commented Nov 10, 2021 •

edited

AlexandruGG commented Nov 11, 2021

drupol Nov 11, 2021

AlexandruGG Nov 11, 2021

drupol Nov 11, 2021

AlexandruGG Nov 11, 2021

drupol Nov 11, 2021

AlexandruGG commented Nov 11, 2021

drupol Nov 11, 2021

AlexandruGG Nov 11, 2021

drupol Nov 11, 2021

drupol left a comment •

edited

drupol commented Nov 11, 2021

[PHPStan Baseline] Fix Errors Part 2 + Modify Unfold Operation #217

[PHPStan Baseline] Fix Errors Part 2 + Modify Unfold Operation #217

Conversation

AlexandruGG commented Nov 10, 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 Nov 10, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexandruGG Nov 10, 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

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

drupol commented Nov 10, 2021 • edited

AlexandruGG commented Nov 11, 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

Choose a reason for hiding this comment

AlexandruGG commented Nov 11, 2021

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 • edited

Choose a reason for hiding this comment

drupol commented Nov 11, 2021

[PHPStan Baseline] Fix Errors Part 2 + Modify `Unfold` Operation #217

[PHPStan Baseline] Fix Errors Part 2 + Modify `Unfold` Operation #217

AlexandruGG commented Nov 10, 2021 •

edited

drupol Nov 10, 2021 •

edited

AlexandruGG Nov 10, 2021 •

edited

drupol commented Nov 10, 2021 •

edited

drupol left a comment •

edited