Create ObjectStringifier

Author: henriquemoody

src/Stringifiers/ObjectStringifier.php

@@ -0,0 +1,70 @@
+<?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 get_object_vars;
+use function is_object;
+use function sprintf;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+
+/**
+ * Converts an object into a string.
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class ObjectStringifier 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 (!is_object($raw)) {
+            return null;
+        }
+
+        return $this->quoter->quote(
+            sprintf(
+                '[object] (%s: %s)',
+                get_class($raw),
+                $this->stringifier->stringify(get_object_vars($raw), $depth + 1)
+            ),
+            $depth
+        );
+    }
+}

tests/unit/Stringifiers/ObjectStringifierTest.php

@@ -0,0 +1,83 @@
+<?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 Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Respect\Stringifier\Stringifiers\ObjectStringifier;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Respect\Stringifier\Stringifiers\ObjectStringifier
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class ObjectStringifierTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldConvertToStringWhenRawValueIsAnObject(): void
+    {
+        $data = ['foo' => 1, 'bar' => false];
+
+        $raw = (object) $data;
+        $depth = 0;
+
+        $stringifiedData = '-stringified-';
+
+        $expectedValue = '[object] (stdClass: '.$stringifiedData.')';
+
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->once())
+            ->method('stringify')
+            ->with($data, $depth + 1)
+            ->willReturn($stringifiedData);
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->once())
+            ->method('quote')
+            ->with($expectedValue, $depth)
+            ->willReturn($expectedValue);
+
+        $objectStringifier = new ObjectStringifier($stringifierMock, $quoterMock);
+
+        self::assertSame($expectedValue, $objectStringifier->stringify($raw, $depth));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldNotConvertToStringWhenRawValueIsNotTraversable(): void
+    {
+        $raw = true;
+        $depth = 123;
+
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->never())
+            ->method('stringify');
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->never())
+            ->method('quote');
+
+        $objectStringifier = new ObjectStringifier($stringifierMock, $quoterMock);
+
+        self::assertNull($objectStringifier->stringify($raw, $depth));
+    }
+}