refactor: Update CacheIterator

Signed-off-by: Pol Dellaiera <pol.dellaiera@protonmail.com>
loophp · Oct 27, 2020 · 02dc0a4 · 02dc0a4
1 parent 7386746
commit 02dc0a4
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 46 deletions.
diff --git a/src/Iterator/CacheIterator.php b/src/Iterator/CacheIterator.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Iterator;
 
 use Iterator;
-use OuterIterator;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
 
@@ -14,21 +13,15 @@
  * @psalm-template TKey of array-key
  * @psalm-template T
  *
- * @implements Iterator<TKey, T>
+ * @extends ProxyIterator<TKey, T>
  */
-final class CacheIterator implements Iterator, OuterIterator
+final class CacheIterator extends ProxyIterator
 {
     /**
      * @var CacheItemPoolInterface
      */
     private $cache;
 
-    /**
-     * @var Iterator
-     * @psalm-var Iterator<TKey, T>
-     */
-    private $inner;
-
     /**
      * @var int
      */
@@ -39,7 +32,7 @@ final class CacheIterator implements Iterator, OuterIterator
      */
     public function __construct(Iterator $iterator, CacheItemPoolInterface $cache)
     {
-        $this->inner = $iterator;
+        $this->iterator = $iterator;
         $this->cache = $cache;
         $this->key = 0;
     }
@@ -55,11 +48,6 @@ public function current()
         return $data[1];
     }
 
-    public function getInnerIterator(): Iterator
-    {
-        return $this->inner;
-    }
-
     /**
      * @psalm-return TKey
      */
@@ -74,7 +62,7 @@ public function key()
     public function next(): void
     {
         ++$this->key;
-        $this->inner->next();
+        parent::next();
     }
 
     public function rewind(): void
@@ -84,7 +72,7 @@ public function rewind(): void
 
     public function valid(): bool
     {
-        return $this->cache->hasItem((string) $this->key) || $this->inner->valid();
+        return $this->cache->hasItem((string) $this->key) || parent::valid();
     }
 
     private function getItemOrSave(string $key): CacheItemInterface
@@ -93,8 +81,8 @@ private function getItemOrSave(string $key): CacheItemInterface
 
         if (false === $item->isHit()) {
             $item->set([
-                $this->inner->key(),
-                $this->inner->current(),
+                parent::key(),
+                parent::current(),
             ]);
 
             $this->cache->save($item);

diff --git a/src/Iterator/ProxyIterator.php b/src/Iterator/ProxyIterator.php
@@ -12,10 +12,9 @@
  * @psalm-template TKey
  * @psalm-template T
  *
- * @implements Iterator<TKey, T>
  * @implements OuterIterator<TKey, T>
  */
-abstract class ProxyIterator implements Iterator, OuterIterator
+abstract class ProxyIterator implements OuterIterator
 {
     /**
      * @psalm-var Generator<TKey, T>|Iterator<TKey, T>

diff --git a/src/Iterator/RandomIterator.php b/src/Iterator/RandomIterator.php
@@ -6,65 +6,59 @@
 
 use ArrayIterator;
 use Iterator;
-use OuterIterator;
 
 /**
  * @psalm-template TKey
  * @psalm-template TKey of array-key
  * @psalm-template T of string
  *
- * @implements Iterator<TKey, T>
+ * @extends ProxyIterator<TKey, T>
  */
-final class RandomIterator implements Iterator, OuterIterator
+final class RandomIterator extends ProxyIterator
 {
-    /**
-     * @var array<int, int>
-     */
-    private $indexes;
-
     /**
      * @var Iterator
      * @psalm-var Iterator<TKey, T>
      */
-    private $inner;
+    protected $iterator;
 
     /**
-     * @var ArrayIterator
-     * @psalm-var ArrayIterator<int, array{0: TKey, 1: T}>
+     * @var array<int, int>
      */
-    private $iterator;
+    private $indexes;
 
     /**
      * @var int
      */
     private $key;
 
+    /**
+     * @var ArrayIterator
+     * @psalm-var ArrayIterator<int, array{0: TKey, 1: T}>
+     */
+    private $wrappedIterator;
+
     /**
      * @psalm-param Iterator<TKey, T> $iterator
      */
     public function __construct(Iterator $iterator)
     {
-        $this->inner = $iterator;
-        $this->iterator = $this->buildArrayIterator($iterator);
-        $this->indexes = array_keys($this->iterator->getArrayCopy());
+        $this->iterator = $iterator;
+        $this->wrappedIterator = $this->buildArrayIterator($iterator);
+        $this->indexes = array_keys($this->wrappedIterator->getArrayCopy());
         $this->key = array_rand($this->indexes);
     }
 
     public function current()
     {
-        $value = $this->iterator[$this->key];
+        $value = $this->wrappedIterator[$this->key];
 
         return $value[1];
     }
 
-    public function getInnerIterator()
-    {
-        return $this->inner;
-    }
-
     public function key()
     {
-        $value = $this->iterator[$this->key];
+        $value = $this->wrappedIterator[$this->key];
 
         return $value[0];
     }
@@ -78,10 +72,10 @@ public function next(): void
         }
     }
 
-    public function rewind()
+    public function rewind(): void
     {
-        $this->indexes = array_keys($this->iterator->getArrayCopy());
-        $this->iterator->rewind();
+        parent::rewind();
+        $this->indexes = array_keys($this->wrappedIterator->getArrayCopy());
     }
 
     public function valid(): bool