feat: Add phpdoc tags for static analysis.

Author: drupol

composer.json

@@ -28,7 +28,7 @@
     ],
     "require": {
         "php": ">= 7.4",
-        "loophp/iterators": "^1.0"
+        "loophp/iterators": "^1.1"
     },
     "require-dev": {
         "drupol/php-conventions": "^5",

phpstan-baseline.neon

@@ -0,0 +1,12 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$other \\(iterable\\<TKey, T\\>\\) of method loophp\\\\PhpUnitIterableAssertions\\\\Constraint\\\\IsIdenticalIterable\\:\\:matches\\(\\) should be contravariant with parameter \\$other \\(mixed\\) of method PHPUnit\\\\Framework\\\\Constraint\\\\Constraint\\:\\:matches\\(\\)$#"
+			count: 1
+			path: src/Constraint/IsIdenticalIterable.php
+
+		-
+			message: "#^Parameter \\#1 \\$other \\(iterable\\<TKey, T\\>\\) of method loophp\\\\PhpUnitIterableAssertions\\\\Constraint\\\\IsNotIdenticalIterable\\:\\:matches\\(\\) should be contravariant with parameter \\$other \\(mixed\\) of method PHPUnit\\\\Framework\\\\Constraint\\\\Constraint\\:\\:matches\\(\\)$#"
+			count: 1
+			path: src/Constraint/IsNotIdenticalIterable.php
+

phpstan.neon

@@ -0,0 +1,12 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$other \\(iterable\\<TKey, T\\>\\) of method loophp\\\\PhpUnitIterableAssertions\\\\Constraint\\\\IsIdenticalIterable\\:\\:matches\\(\\) should be contravariant with parameter \\$other \\(mixed\\) of method PHPUnit\\\\Framework\\\\Constraint\\\\Constraint\\:\\:matches\\(\\)$#"
+			count: 1
+			path: src/Constraint/IsIdenticalIterable.php
+
+		-
+			message: "#^Parameter \\#1 \\$other \\(iterable\\<TKey, T\\>\\) of method loophp\\\\PhpUnitIterableAssertions\\\\Constraint\\\\IsNotIdenticalIterable\\:\\:matches\\(\\) should be contravariant with parameter \\$other \\(mixed\\) of method PHPUnit\\\\Framework\\\\Constraint\\\\Constraint\\:\\:matches\\(\\)$#"
+			count: 1
+			path: src/Constraint/IsNotIdenticalIterable.php
+

psalm-baseline.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="v4.15.0@a1b5e489e6fcebe40cb804793d964e99fc347820">
+  <file src="src/Constraint/IsIdenticalIterable.php">
+    <MoreSpecificImplementedParamType occurrences="1">
+      <code>$other</code>
+    </MoreSpecificImplementedParamType>
+  </file>
+  <file src="src/Constraint/IsNotIdenticalIterable.php">
+    <MoreSpecificImplementedParamType occurrences="1">
+      <code>$other</code>
+    </MoreSpecificImplementedParamType>
+  </file>
+</files>

psalm.xml

@@ -3,6 +3,7 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    errorBaseline="psalm-baseline.xml"
 >
     <projectFiles>
         <directory name="./src" />

src/Constraint/IsIdenticalIterable.php

@@ -13,12 +13,22 @@
 use MultipleIterator;
 use PHPUnit\Framework\Constraint\Constraint;
 
+/**
+ * @template TKey
+ * @template T
+ */
 final class IsIdenticalIterable extends Constraint
 {
     private int $limit;
 
+    /**
+     * @var iterable<TKey, T>
+     */
     private iterable $subject;
 
+    /**
+     * @param iterable<TKey, T> $subject
+     */
     public function __construct(iterable $subject, int $limit = 0)
     {
         $this->subject = $subject;
@@ -31,7 +41,7 @@ public function toString(): string
     }
 
     /**
-     * @param iterable $other
+     * @param iterable<TKey, T> $other
      */
     protected function matches($other): bool
     {

src/Constraint/IsNotIdenticalIterable.php

@@ -13,12 +13,22 @@
 use MultipleIterator;
 use PHPUnit\Framework\Constraint\Constraint;
 
+/**
+ * @template TKey
+ * @template T
+ */
 final class IsNotIdenticalIterable extends Constraint
 {
     private int $limit;
 
+    /**
+     * @var iterable<TKey, T>
+     */
     private iterable $subject;
 
+    /**
+     * @param iterable<TKey, T> $subject
+     */
     public function __construct(iterable $subject, int $limit = 0)
     {
         $this->subject = $subject;
@@ -31,7 +41,7 @@ public function toString(): string
     }
 
     /**
-     * @param iterable $other
+     * @param iterable<TKey, T> $other
      */
     protected function matches($other): bool
     {

tests/unit/Constraint/IsIdenticalIterableTest.php

@@ -11,10 +11,9 @@
 
 use ArrayIterator;
 use ArrayObject;
-use IteratorAggregate;
+use loophp\iterators\ClosureIteratorAggregate;
 use loophp\PhpUnitIterableAssertions\Constraint\IsIdenticalIterable;
 use PHPUnit\Framework\TestCase;
-use Traversable;
 
 /**
  * @coversDefaultClass \loophp\PhpUnitIterableAssertions
@@ -49,28 +48,10 @@ public function dataProvider()
             range('c', 'a'),
         ];
 
-        $iterator = new class implements IteratorAggregate
-        {
-            private iterable $iterable;
-
-            public function withIterable(iterable $iterable): self
-            {
-                $clone = clone $this;
-                $clone->iterable = $iterable;
-
-                return $clone;
-            }
-
-            public function getIterator(): Traversable
-            {
-                yield from $this->iterable;
-            }
-        };
-
         yield [
-            $iterator->withIterable(range('a', 'c')),
-            $iterator->withIterable(range('a', 'c')),
-            range('c', 'a')
+            new ClosureIteratorAggregate(static fn () => yield from range('a', 'c')),
+            new ClosureIteratorAggregate(static fn () => yield from range('a', 'c')),
+            range('c', 'a'),
         ];
     }
 

tests/unit/Constraint/IsNotIdenticalIterableTest.php

@@ -11,10 +11,9 @@
 
 use ArrayIterator;
 use ArrayObject;
-use IteratorAggregate;
+use loophp\iterators\ClosureIteratorAggregate;
 use loophp\PhpUnitIterableAssertions\Constraint\IsNotIdenticalIterable;
 use PHPUnit\Framework\TestCase;
-use Traversable;
 
 /**
  * @coversDefaultClass \loophp\PhpUnitIterableAssertions
@@ -49,27 +48,9 @@ public function dataProvider()
             range('a', 'c'),
         ];
 
-        $iterator = new class implements IteratorAggregate
-        {
-            private iterable $iterable;
-
-            public function withIterable(iterable $iterable): self
-            {
-                $clone = clone $this;
-                $clone->iterable = $iterable;
-
-                return $clone;
-            }
-
-            public function getIterator(): Traversable
-            {
-                yield from $this->iterable;
-            }
-        };
-
         yield [
-            $iterator->withIterable(range('a', 'c')),
-            $iterator->withIterable(range('c', 'a')),
+            new ClosureIteratorAggregate(static fn () => yield from range('a', 'c')),
+            new ClosureIteratorAggregate(static fn () => yield from range('c', 'a')),
             range('a', 'c'),
         ];
     }