#18: changed files for PHPStan analysis

Author: MaxGoryunov

composer.json

@@ -2,7 +2,7 @@
     "name": "maxgoryunov/saving-iterator",
     "description": "True Caching Iterator for PHP",
     "require": {
-        "php": ">=7.4"
+        "php": ">=8.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^0.12.91",

fakes/Indifferent.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace MaxGoryunov\SavingIterator\Fakes;
+
+/**
+ * Interface for objects on which any methods can be called.
+ * @template T of object
+ * @mixin T
+ */
+interface Indifferent
+{
+
+    /**
+     * Returns result of any called method.
+     *
+     * @param string       $name
+     * @param array<mixed> $arguments
+     * @return mixed
+     */
+    public function __call(string $name, array $arguments): mixed;
+}

fakes/TimesCalled.php

@@ -4,10 +4,11 @@
 
 /**
  * This class checks how many times a specified method was called.
- * @template T
+ * @template T of object
  * @mixin T
+ * @implements Indifferent<T>
  */
-class TimesCalled
+class TimesCalled implements Indifferent
 {
     /**
      * Original object.
@@ -33,9 +34,10 @@ class TimesCalled
     /**
      * Ctor.
      *
-     * @param T $origin
+     * @param T      $origin
+     * @param string $method
      */
-    public function __construct($origin, string $method)
+    public function __construct(object $origin, string $method)
     {
         $this->origin = $origin;
         $this->method = $method;
@@ -53,10 +55,7 @@ public function value(): int
 
     /**
      * Sends calls through itself and counts how many times a specific method was called.
-     *
-     * @param string $name
-     * @param array  $arguments
-     * @return mixed
+     * {@inheritDoc}
      */
     public function __call(string $name, array $arguments): mixed
     {

fakes/TransparentIterator.php

@@ -4,6 +4,13 @@
 
 use Iterator;
 
+/**
+ * Wraps objects which are not interators.
+ * 
+ * @template TKey
+ * @template TValue
+ * @implements Iterator<TKey, TValue>
+ */
 class TransparentIterator implements Iterator
 {
 
@@ -12,16 +19,16 @@ class TransparentIterator implements Iterator
      * 
      * This is NOT necessarily an iterator
      * 
-     * @var object
+     * @var Iterator<TKey, TValue>|Indifferent<Iterator<TKey, TValue>>
      */
-    private object $origin;
+    private Iterator|Indifferent $origin;
 
     /**
      * Ctor.
      *
-     * @param object $iterable
+     * @param Iterator<TKey, TValue>|Indifferent<Iterator<TKey, TValue>> $iterable
      */
-    public function __construct(object $iterable)
+    public function __construct(Iterator|Indifferent $iterable)
     {
         $this->origin = $iterable;
     }

phpstan.neon

@@ -2,4 +2,7 @@ parameters:
 	level: 8
 	paths:
 		- src
-		- tests
+		- fakes
+		- tests
+includes:
+		- vendor/phpstan/phpstan/conf/bleedingEdge.neon

psalm.xml

@@ -7,6 +7,9 @@
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 >
     <projectFiles>
+        <directory name="src" />
+        <directory name="fakes" />
+        <directory name="tests" />
         <file name="vendor/autoload.php" />
         <file name="vendor/composer/autoload_classmap.php" />
         <file name="vendor/composer/autoload_files.php" />

tests/fakes/TimesCalledTest.php

@@ -49,7 +49,6 @@ public function testCountsHowManyTimesTheMethodWasCalled(): void
     public function testCountsHowManyTimesTheMethodWasCalledAlongWIthOtherMethods(): void
     {
         $method = "key";
-        $other  = "current";
         $called = new TimesCalled(
             new ArrayIterator([16, 14, 13, 15, 12, 18]),
             $method
@@ -60,7 +59,7 @@ public function testCountsHowManyTimesTheMethodWasCalledAlongWIthOtherMethods():
             $called->$method();
 
             if (($i % 2 === 0) or ($i % 3 === 0)) {
-                $called->$other();
+                $called->current();
             }
         }
 

tests/src/SavingIteratorTest.php

@@ -2,6 +2,7 @@
 
 namespace MaxGoryunov\SavingIterator\Tests\Src;
 
+use Iterator;
 use ArrayIterator;
 use Generator;
 use MaxGoryunov\SavingIterator\Fakes\TimesCalled;
@@ -60,10 +61,8 @@ public function testDoesNotCallOriginIfValuesAreInCache(): void
             new ArrayIterator($input),
             "next"
         );
-        $iterator = new SavingIterator(
-            new TransparentIterator(
-                $called
-            )
+        $iterator = new SavingIterator(/* @phpstan-ignore-next-line */
+            new TransparentIterator($called)
         );
         for ($i = 0; $i < rand(0, 10); $i++) {
             foreach ($iterator as $key => $value) {
@@ -179,7 +178,7 @@ public function testContinuesSuccessfullyAfterBeingInterrupted(): void
             new ArrayIterator($input)
         );
         foreach ($iterator as $value) {
-            if ($value === 90) {
+            if ($value === $input[3]) {
                 break;
             }
         }