Merge pull request #20 from MaxGoryunov/feature/18

Feature/18

Author: MaxGoryunov

.github/workflows/php.yml

@@ -23,4 +23,7 @@ jobs:
       with:
         bootstrap: vendor/autoload.php
         configuration: phpunit.xml
-        args: --coverage-text
+        args: --coverage-text
+
+    - name: PHPStan analysis
+      run: ./vendor/bin/phpstan analyse

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

@@ -2,12 +2,18 @@
 
 namespace MaxGoryunov\SavingIterator\Fakes;
 
-class TimesCalled
+/**
+ * This class checks how many times a specified method was called.
+ * @template T of object
+ * @mixin T
+ * @implements Indifferent<T>
+ */
+class TimesCalled implements Indifferent
 {
     /**
      * Original object.
      * 
-     * @var object
+     * @var T
      */
     private object $origin;
 
@@ -28,7 +34,8 @@ class TimesCalled
     /**
      * Ctor.
      *
-     * @param object $origin
+     * @param T      $origin
+     * @param string $method
      */
     public function __construct(object $origin, string $method)
     {
@@ -48,22 +55,13 @@ 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
     {
         if ($name === $this->method) {
             $this->times++;
         }
-
-        if ($arguments === []) {
-            $result = $this->origin->$name();
-        } else {
-            $result = $this->origin->$name($arguments);
-        }
-        return $result;
+        return $this->origin->$name(...$arguments);
     }
 }

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" />

src/SavingIterator.php

@@ -4,26 +4,33 @@
 
 use Iterator;
 
+/**
+ * Iterator which stores iterated values.
+ * 
+ * @template TKey
+ * @template TValue
+ * @implements Iterator<TKey, TValue>
+ */
 class SavingIterator implements Iterator
 {
 
     /**
      * Original iterator
      * 
-     * @var Iterator
+     * @var Iterator<TKey, TValue>
      */
     private Iterator $origin;
 
     /**
      * Cached values from the inner iterator
      * 
-     * @var array
+     * @var array<TKey, TValue>
      */
     private array $saved = [];
     /**
      * Ctor.
      *
-     * @param Iterator $iterator
+     * @param Iterator<TKey, TValue> $iterator
      */
     public function __construct(Iterator $iterator)
     {
@@ -32,6 +39,7 @@ public function __construct(Iterator $iterator)
 
     /**
      * {@inheritDoc}
+     * @return TValue|false
      */
     public function current(): mixed
     {
@@ -43,6 +51,7 @@ public function current(): mixed
 
     /**
      * {@inheritDoc}
+     * @return TKey|null
      */
     public function key(): mixed
     {

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;
             }
         }