Create TraversableStringifier

Author: henriquemoody

src/Stringifiers/TraversableStringifier.php

@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ *
+ * (c) Henrique Moody <[email protected]>
+ *
+ * For the full copyright and license information, please view the "LICENSE.md"
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Stringifier\Stringifiers;
+
+use function get_class;
+use function iterator_to_array;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Traversable;
+
+/**
+ * Converts an instance of Traversable into a string.
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class TraversableStringifier implements Stringifier
+{
+    /**
+     * @var Stringifier
+     */
+    private $stringifier;
+
+    /**
+     * @var Quoter
+     */
+    private $quoter;
+
+    /**
+     * Initializes the stringifier.
+     *
+     * @param Stringifier $stringifier
+     * @param Quoter $quoter
+     */
+    public function __construct(Stringifier $stringifier, Quoter $quoter)
+    {
+        $this->stringifier = $stringifier;
+        $this->quoter = $quoter;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stringify($raw, int $depth): ?string
+    {
+        if (!$raw instanceof Traversable) {
+            return null;
+        }
+
+        return $this->quoter->quote(
+            sprintf(
+                '[traversable] (%s: %s)',
+                get_class($raw),
+                $this->stringifier->stringify(iterator_to_array($raw), $depth + 1)
+            ),
+            $depth
+        );
+    }
+}

tests/unit/Stringifiers/TraversableStringifierTest.php

@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ *
+ * (c) Henrique Moody <[email protected]>
+ *
+ * For the full copyright and license information, please view the "LICENSE.md"
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Stringifier\Test\Stringifiers;
+
+use ArrayIterator;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Respect\Stringifier\Stringifiers\TraversableStringifier;
+
+/**
+ * @covers \Respect\Stringifier\Stringifiers\TraversableStringifier
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class TraversableStringifierTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldConvertToStringWhenValueIsTraversable(): void
+    {
+        $raw = new ArrayIterator([1, 2, 3]);
+        $depth = 0;
+
+        $stringifiedData = '-stringified-';
+
+        $expectedValue = '[traversable] (ArrayIterator: '.$stringifiedData.')';
+
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->once())
+            ->method('stringify')
+            ->with($raw->getArrayCopy(), $depth + 1)
+            ->willReturn($stringifiedData);
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->once())
+            ->method('quote')
+            ->with($expectedValue, $depth)
+            ->willReturn($expectedValue);
+
+        $traversableStringifier = new TraversableStringifier($stringifierMock, $quoterMock);
+
+        self::assertSame($expectedValue, $traversableStringifier->stringify($raw, $depth));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldNotConvertToStringWhenRawValueIsNotTraversable(): void
+    {
+        $raw = [1, 2, 3, 4];
+        $depth = 123;
+
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->never())
+            ->method('stringify');
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->never())
+            ->method('quote');
+
+        $traversableStringifier = new TraversableStringifier($stringifierMock, $quoterMock);
+
+        self::assertNull($traversableStringifier->stringify($raw, $depth));
+    }
+}