Change how to stringify Iterator objects

I'm changing the notation to ensure we keep consistency with the recent
changes, so I'm using "{}" to represent the body and "current()" to make
it explicit that it's a method call.

I changed the behavior of this stringifier. After all, it might be
unwanted to iterate over the whole object to stringify it because it
might do an expensive operation.

Signed-off-by: Henrique Moody <[email protected]>

Author: henriquemoody

src/Stringifiers/ClusterStringifier.php

@@ -41,7 +41,7 @@ public static function createDefault(): self
         $jsonParsableStringifier = new JsonParsableStringifier();
 
         $stringifier->setStringifiers([
-            new TraversableStringifier($stringifier, $quoter),
+            new IteratorObjectStringifier($stringifier, $quoter),
             new DateTimeStringifier($quoter, DateTimeInterface::ATOM),
             new ThrowableStringifier($stringifier, $quoter),
             new StringableObjectStringifier($jsonParsableStringifier, $quoter),

…/Stringifiers/TraversableStringifier.php …ringifiers/IteratorObjectStringifier.phpsrc/Stringifiers/TraversableStringifier.php renamed to src/Stringifiers/IteratorObjectStringifier.php src/Stringifiers/TraversableStringifier.php renamed to src/Stringifiers/IteratorObjectStringifier.php

@@ -10,14 +10,13 @@
 
 namespace Respect\Stringifier\Stringifiers;
 
+use Iterator;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
-use Traversable;
 
-use function iterator_to_array;
 use function sprintf;
 
-final class TraversableStringifier implements Stringifier
+final class IteratorObjectStringifier implements Stringifier
 {
     public function __construct(
         private readonly Stringifier $stringifier,
@@ -27,15 +26,15 @@ public function __construct(
 
     public function stringify(mixed $raw, int $depth): ?string
     {
-        if (!$raw instanceof Traversable) {
+        if (!$raw instanceof Iterator) {
             return null;
         }
 
         return $this->quoter->quote(
             sprintf(
-                '[traversable] (%s: %s)',
+                '%s { current() => %s }',
                 $raw::class,
-                $this->stringifier->stringify(iterator_to_array($raw), $depth + 1)
+                $this->stringifier->stringify($raw->current(), $depth + 1)
             ),
             $depth
         );

tests/fixtures/ConcreteIterator.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ * Copyright (c) Henrique Moody <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+/**
+ * @implements Iterator<int>
+ */
+final class ConcreteIterator implements Iterator
+{
+    private const VALUES = [1, 2, 3];
+
+    private int $position = 0;
+
+    public function current(): int
+    {
+        return self::VALUES[$this->position];
+    }
+
+    public function next(): void
+    {
+        $this->position++;
+    }
+
+    public function key(): int
+    {
+        return $this->position;
+    }
+
+    public function valid(): bool
+    {
+        return array_key_exists($this->position, self::VALUES);
+    }
+
+    public function rewind(): void
+    {
+        $this->position = 0;
+    }
+}

tests/integration/stringify-iterator-object.phpt

@@ -0,0 +1,17 @@
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require 'vendor/autoload.php';
+
+outputMultiple(
+    new ConcreteIterator(),
+    new ArrayIterator([4, 5, 6]),
+    (static fn(int $number) => yield $number)(7),
+);
+?>
+--EXPECT--
+`ConcreteIterator { current() => 1 }`
+`ArrayIterator { current() => 4 }`
+`Generator { current() => 7 }`

tests/integration/stringify-object-traversable.phpt

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ * Copyright (c) Henrique Moody <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Stringifier\Test\Unit\Stringifiers;
+
+use ConcreteIterator;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Stringifiers\IteratorObjectStringifier;
+use Respect\Stringifier\Test\Double\FakeQuoter;
+use Respect\Stringifier\Test\Double\FakeStringifier;
+
+use function sprintf;
+
+#[CoversClass(IteratorObjectStringifier::class)]
+final class IteratorObjectStringifierTest extends TestCase
+{
+    private const DEPTH = 0;
+
+    #[Test]
+    public function itShouldNotStringifyRawValueWhenItIsNotTraversable(): void
+    {
+        $sut = new IteratorObjectStringifier(new FakeStringifier(), new FakeQuoter());
+
+        self::assertNull($sut->stringify([1, 2, 3, 4], self::DEPTH));
+    }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnInstanceOfIterator(): void
+    {
+        $raw = new ConcreteIterator();
+
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $sut = new IteratorObjectStringifier($stringifier, $quoter);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote(
+            sprintf(
+                'ConcreteIterator { current() => %s }',
+                $stringifier->stringify($raw->current(), self::DEPTH + 1),
+            ),
+            self::DEPTH
+        );
+
+        self::assertSame($expected, $actual);
+    }
+}