Create ThrowableStringifier

Author: henriquemoody

src/Stringifiers/ThrowableStringifier.php

@@ -0,0 +1,84 @@
+<?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 getcwd;
+use function sprintf;
+use function str_replace;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Throwable;
+
+/**
+ * Converts an instance of Throwable into a string.
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class ThrowableStringifier 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 Throwable) {
+            return null;
+        }
+
+        return $this->quoter->quote(
+            sprintf(
+                '[throwable] (%s: %s)',
+                get_class($raw),
+                $this->stringifier->stringify($this->getData($raw), $depth + 1)
+            ),
+            $depth
+        );
+    }
+
+    private function getData(Throwable $throwable): array
+    {
+        return [
+            'message' => $throwable->getMessage(),
+            'code' => $throwable->getCode(),
+            'file' => sprintf(
+                '%s:%d',
+                str_replace(getcwd().'/', '', $throwable->getFile()),
+                $throwable->getLine()
+            ),
+        ];
+    }
+}

tests/unit/Stringifiers/ThrowableStringifierTest.php

@@ -0,0 +1,112 @@
+<?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 Error;
+use ErrorException;
+use Exception;
+use function get_class;
+use function sprintf;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+use Respect\Stringifier\Stringifiers\ThrowableStringifier;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Throwable;
+use TypeError;
+
+/**
+ * @covers \Respect\Stringifier\Stringifiers\ThrowableStringifier
+ *
+ * @author Henrique Moody <[email protected]>
+ */
+final class ThrowableStringifierTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @dataProvider validValuesProvider
+     *
+     * @param Throwable $raw
+     * @param int $line
+     */
+    public function shouldConvertThrowableToString(Throwable $raw, int $line): void
+    {
+        $depth = 1;
+
+        $stringifiedData = '-stringifed-';
+
+        $expectedValue = sprintf(
+            '[throwable] (%s: %s)',
+            get_class($raw),
+            $stringifiedData
+        );
+
+        $expectedData = [
+            'message' => $raw->getMessage(),
+            'code' => $raw->getCode(),
+            'file' => 'tests/unit/Stringifiers/ThrowableStringifierTest.php:'.$line,
+        ];
+
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->once())
+            ->method('stringify')
+            ->with($expectedData, $depth + 1)
+            ->willReturn($stringifiedData);
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->once())
+            ->method('quote')
+            ->with($expectedValue, $depth)
+            ->willReturn($expectedValue);
+
+        $throwableStringifier = new ThrowableStringifier($stringifierMock, $quoterMock);
+
+        self::assertSame($expectedValue, $throwableStringifier->stringify($raw, $depth));
+    }
+
+    public function validValuesProvider(): array
+    {
+        $line = 85;
+
+        return [
+            [new Exception('Message for Exception', 0), ++$line],
+            [new ErrorException('Message for ErrorException', 102), ++$line],
+            [new Error('Message for Error', 78), ++$line],
+            [new TypeError('Message for TypeError', 1009), ++$line],
+        ];
+    }
+
+    /**
+     * @test
+     */
+    public function shouldReturnNullWhenNotInstanceOfThrowable(): void
+    {
+        $stringifierMock = $this->createMock(Stringifier::class);
+        $stringifierMock
+            ->expects($this->never())
+            ->method('stringify');
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->never())
+            ->method('quote');
+
+        $throwableStringifier = new ThrowableStringifier($stringifierMock, $quoterMock);
+
+        self::assertNull($throwableStringifier->stringify(new stdClass(), 0));
+    }
+}