fix: update various operations static analysis annotations.

Get rid of one psalm issue
loophp · Nov 7, 2022 · 473f105 · 473f105
1 parent c1998e9
commit 473f105
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 24 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -51,7 +51,7 @@ parameters:
 			path: src/Collection.php
 
 		-
-			message: "#^Parameter \\#1 \\$ of closure expects callable\\(mixed, mixed, mixed, iterable\\)\\: mixed, callable\\(T\\|V, T, TKey, Iterator\\<TKey, T\\>\\)\\: V given\\.$#"
+			message: "#^Parameter \\#1 \\$ of closure expects callable\\(mixed, mixed, mixed, iterable\\)\\: mixed, callable\\(T\\|V, T, TKey, Iterator\\<TKey, T\\>\\)\\: T\\|V given\\.$#"
 			count: 1
 			path: src/Collection.php
 
@@ -319,3 +319,13 @@ parameters:
 			message: "#^Parameter \\#1 \\$callable of method loophp\\\\collection\\\\Collection\\<int,string\\>\\:\\:groupBy\\(\\) expects callable\\(string, int\\=\\)\\: int, Closure\\(string, int\\)\\: int given\\.$#"
 			count: 1
 			path: tests/static-analysis/groupbyable.php
+
+		-
+			message: "#^While loop condition is always true\\.$#"
+			count: 1
+			path: tests/static-analysis/scanLeft1.php
+
+		-
+			message: "#^While loop condition is always true\\.$#"
+			count: 1
+			path: tests/static-analysis/scanRight1.php
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -17,11 +17,6 @@
       <code>Closure(bool): Closure(iterable&lt;TKey, T&gt;): (Generator&lt;int, T&gt;|Generator&lt;TKey, T&gt;)</code>
     </InvalidReturnType>
   </file>
-  <file src="src/Operation/Averages.php">
-    <InvalidScalarArgument occurrences="1">
-      <code>static fn (float $acc, float $value, int $key): float =&gt; ($acc * $key + $value) / ($key + 1)</code>
-    </InvalidScalarArgument>
-  </file>
   <file src="src/Operation/Inits.php">
     <InvalidArgument occurrences="2">
       <code>[]</code>

diff --git a/src/Contract/Operation/ScanLeft1able.php b/src/Contract/Operation/ScanLeft1able.php
@@ -21,9 +21,9 @@ interface ScanLeft1able
      *
      * @template V
      *
-     * @param callable((T|V), T, TKey, iterable<TKey, T>): V $callback
+     * @param callable((T|V), T, TKey, iterable<TKey, T>): (T|V) $callback
      *
-     * @return Collection<int|TKey, V>
+     * @return Collection<TKey, T|V>
      */
     public function scanLeft1(callable $callback): Collection;
 }
diff --git a/src/Contract/Operation/ScanRight1able.php b/src/Contract/Operation/ScanRight1able.php
@@ -22,9 +22,9 @@ interface ScanRight1able
      *
      * @template V
      *
-     * @param callable((T|V), T, TKey, Iterator<TKey, T>): V $callback
+     * @param callable((T|V), T, TKey, Iterator<TKey, T>): (T|V) $callback
      *
-     * @return Collection<int|TKey, V>
+     * @return Collection<TKey, T|V>
      */
     public function scanRight1(callable $callback): Collection;
 }
diff --git a/src/Operation/ScanLeft1.php b/src/Operation/ScanLeft1.php
@@ -19,21 +19,21 @@ final class ScanLeft1 extends AbstractOperation
     /**
      * @template V
      *
-     * @return Closure(callable((T|V), T, TKey, iterable<TKey, T>): V): Closure(iterable<TKey, T>): Generator<int|TKey, V>
+     * @return Closure(callable((T|V), T, TKey, iterable<TKey, T>): (T|V)): Closure(iterable<TKey, T>): Generator<TKey, T|V>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @param callable((T|V), T, TKey, iterable<TKey, T>): V $callback
+             * @param callable((T|V), T, TKey, iterable<TKey, T>): (T|V) $callback
              *
-             * @return Closure(iterable<TKey, T>): Generator<int|TKey, V>
+             * @return Closure(iterable<TKey, T>): Generator<TKey, T|V>
              */
             static fn (callable $callback): Closure =>
                 /**
                  * @param iterable<TKey, T> $iterable
                  *
-                 * @return Generator<int|TKey, V>
+                 * @return Generator<TKey, T|V>
                  */
                 static function (iterable $iterable) use ($callback): Generator {
                     $iteratorAggregate = new IterableIteratorAggregate($iterable);
@@ -46,7 +46,7 @@ static function (iterable $iterable) use ($callback): Generator {
 
                     $initial = $iteratorInitial->current();
 
-                    /** @var Closure(iterable<TKey, T>): Generator<int|TKey, V> $pipe */
+                    /** @var Closure(iterable<TKey, T>): Generator<TKey, T|V> $pipe */
                     $pipe = (new Pipe())()(
                         (new Tail())(),
                         (new Reduction())()($callback)($initial),

diff --git a/src/Operation/ScanRight1.php b/src/Operation/ScanRight1.php
@@ -18,18 +18,18 @@ final class ScanRight1 extends AbstractOperation
     /**
      * @template V
      *
-     * @return Closure(callable((T|V), T, TKey, iterable<TKey, T>): V): Closure(iterable<TKey, T>): Generator<int|TKey, V>
+     * @return Closure(callable((T|V), T, TKey, iterable<TKey, T>): (T|V)): Closure(iterable<TKey, T>): Generator<TKey, T|V>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @param callable((T|V), T, TKey, iterable<TKey, T>): V $callback
+             * @param callable((T|V), T, TKey, iterable<TKey, T>): (T|V) $callback
              *
-             * @return Closure(iterable<TKey, T>): Generator<int|TKey, V>
+             * @return Closure(iterable<TKey, T>): Generator<TKey, T|V>
              */
             static function (callable $callback): Closure {
-                /** @var Closure(iterable<TKey, T>): Generator<int|TKey, V> $pipe */
+                /** @var Closure(iterable<TKey, T>): Generator<TKey, T|V> $pipe */
                 $pipe = (new Pipe())()(
                     (new Reverse())(),
                     (new ScanLeft1())()($callback),

diff --git a/tests/static-analysis/scanLeft1.php b/tests/static-analysis/scanLeft1.php
@@ -8,7 +8,11 @@
 use loophp\collection\Contract\Collection as CollectionInterface;
 
 $concat = static fn (string $carry, string $string): string => sprintf('%s%s', $carry, $string);
-$toString = static fn (int|string $carry, int $value): string => sprintf('%s', $value);
+$toString =
+    /**
+     * @param int|string $carry
+     */
+    static fn ($carry, int $value): string => sprintf('%s', $value);
 
 /**
  * @param CollectionInterface<int, string> $collection
@@ -18,12 +22,24 @@ function scanLeft1_checkListString(CollectionInterface $collection): void
 }
 
 /**
- * @param CollectionInterface<int, string> $collection
+ * @param CollectionInterface<int, int|string> $collection
  */
 function scanLeft1_checkListOfSize1String(CollectionInterface $collection): void
 {
 }
 
+$intGenerator =
+    /**
+     * @return Generator<int, int>
+     */
+    static function (): Generator {
+        while (true) {
+            $int = random_int(0, \PHP_INT_MAX);
+
+            yield $int => $int;
+        }
+    };
+
 // see Psalm bug: https://github.com/vimeo/psalm/issues/6108
 scanLeft1_checkListString(Collection::fromIterable(range('a', 'c'))->scanLeft1($concat));
-scanLeft1_checkListOfSize1String(Collection::fromIterable([10])->scanLeft1($toString));
+scanLeft1_checkListOfSize1String(Collection::fromIterable($intGenerator())->scanLeft1($toString));
diff --git a/tests/static-analysis/scanRight1.php b/tests/static-analysis/scanRight1.php
@@ -22,12 +22,24 @@ function scanRight1_checkListString(CollectionInterface $collection): void
 }
 
 /**
- * @param CollectionInterface<int, string> $collection
+ * @param CollectionInterface<int, int|string> $collection
  */
 function scanRight1_checkListOfSize1String(CollectionInterface $collection): void
 {
 }
 
+$intGenerator =
+    /**
+     * @return Generator<int, int>
+     */
+    static function (): Generator {
+        while (true) {
+            $int = random_int(0, \PHP_INT_MAX);
+
+            yield $int => $int;
+        }
+    };
+
 // see Psalm bug: https://github.com/vimeo/psalm/issues/6108
 scanRight1_checkListString(Collection::fromIterable(range('a', 'c'))->scanRight1($concat));
-scanRight1_checkListOfSize1String(Collection::fromIterable([10])->scanRight1($toString));
+scanRight1_checkListOfSize1String(Collection::fromIterable($intGenerator())->scanRight1($toString));