feat(ReverseIterator): support better phpstan type

src/Iterators/README.md

@@ -115,14 +115,14 @@ $wait = new ActiveWait(0.3); // wait 0.3s = 300ms
 $wait->run(fn(): bool => random_int(1, 5) === 4);
 ```
 
-# ReverseArray
+# ReverseIterator
 
 Run array from end to begin.
 
 ```php
-use h4kuna\DataType\Iterators\ReverseArray;
+use h4kuna\DataType\Iterators\ReverseIterator;
 
-$iterator = new ReverseArray([1, 2, 3]);
+$iterator = new ReverseIterator([1, 2, 3]);
 
 foreach ($iterator as $item) {
     echo $item;

src/Iterators/ReverseIterator.php

@@ -0,0 +1,63 @@
+<?php declare(strict_types=1);
+
+namespace h4kuna\DataType\Iterators;
+
+use Iterator;
+
+/**
+ * @template TKey=int|string
+ * @template TValue=mixed
+ * @implements Iterator<TKey, TValue>
+ */
+final class ReverseIterator implements Iterator
+{
+	/**
+	 * @var TKey
+	 */
+	private mixed $key;
+
+
+	/**
+	 * @param array<TKey, TValue> $array
+	 */
+	public function __construct(
+		private array $array,
+	)
+	{
+	}
+
+
+	public function current(): mixed
+	{
+		/** @var TValue $value */
+		$value = current($this->array);
+
+		return $value;
+	}
+
+
+	public function next(): void
+	{
+		prev($this->array);
+	}
+
+
+	public function key(): mixed
+	{
+		return $this->key;
+	}
+
+
+	public function valid(): bool
+	{
+		$this->key = key($this->array); // @phpstan-ignore-line
+
+		return $this->key !== null;
+	}
+
+
+	public function rewind(): void
+	{
+		end($this->array);
+	}
+}

src/functions.php

@@ -1,8 +1,29 @@
 <?php declare(strict_types=1);
 
-if (!function_exists('_')) {
-	function _(string $message): string
-	{
-		return $message;
+namespace
+{
+	use h4kuna\DataType\Iterators\ReverseIterator;
+
+	if (!function_exists('_')) {
+		function _(string $message): string
+		{
+			return $message;
+		}
+	}
+
+	class_alias(ReverseIterator::class, 'h4kuna\\DataType\\Iterators\\ReverseArray');
+}
+
+namespace h4kuna\DataType\Iterators
+{
+
+	if (false) { // @phpstan-ignore-line
+		/**
+		 * @deprecated use ReverseIterator
+		 * @see ReverseIterator
+		 */
+		class ReverseArray
+		{
+		}
 	}
 }

tests/src/Unit/Iterators/ReverseArrayTest.php → tests/src/Unit/Iterators/ReverseIteratorTest.php

@@ -2,7 +2,7 @@
 
 namespace h4kuna\DataType\Tests\Unit\Iterators;
 
-use h4kuna\DataType\Iterators\ReverseArray;
+use h4kuna\DataType\Iterators\ReverseIterator;
 use Tester\Assert;
 use Tester\TestCase;
 
@@ -11,14 +11,18 @@
 /**
  * @testCase
  */
-final class ReverseArrayTest extends TestCase
+final class ReverseIteratorTest extends TestCase
 {
 	/**
 	 * @return array<mixed>
 	 */
 	protected function basicProvider(): array
 	{
 		return [
+			[
+				['a' => 1, 'b' => 2, 'c' => 3],
+				['c' => 3, 'b' => 2, 'a' => 1],
+			],
 			[
 				[1, 2, 3],
 				[2 => 3, 1 => 2, 0 => 1],
@@ -38,12 +42,15 @@ protected function basicProvider(): array
 	 */
 	public function testBasic(array $source, array $expected): void
 	{
+		$x = new \h4kuna\DataType\Iterators\ReverseIterator([]); // deprecated
+		Assert::type(ReverseIterator::class, $x);
+
 		$actual = [];
-		foreach (new ReverseArray($source) as $k => $v) {
+		foreach (new ReverseIterator($source) as $k => $v) {
 			$actual[$k] = $v;
 		}
 		Assert::same($expected, $actual);
 	}
 }
 
-(new ReverseArrayTest())->run();
+(new ReverseIteratorTest())->run();