Change how to stringify throwable objects

I'm matching the recent format changes, using "{}" to represent objects.
In the case of throwables, I thought it would make more sense to have
the message and the location, which is the exact behavior of the first
line of the output of the `__toString()` method of an exception. That
means we no longer include the exception code.

Also, for optimization, I'm changing the stringifier that the
`ThrowableObjectStringifier` uses because I know it only stringifies a
string, hence using the `JsonEncodableStringifier` improves performance
as we don't need to call all other stringifies.

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

Author: henriquemoody

src/Stringifiers/ClusterStringifier.php

@@ -43,7 +43,7 @@ public static function createDefault(): self
         $stringifier->setStringifiers([
             new IteratorObjectStringifier($stringifier, $quoter),
             new DateTimeStringifier($quoter, DateTimeInterface::ATOM),
-            new ThrowableStringifier($stringifier, $quoter),
+            new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter),
             new StringableObjectStringifier($jsonEncodableStringifier, $quoter),
             new JsonSerializableObjectStringifier($jsonEncodableStringifier, $quoter),
             new ObjectStringifier($stringifier, $quoter),

src/Stringifiers/ThrowableStringifier.php …ingifiers/ThrowableObjectStringifier.phpsrc/Stringifiers/ThrowableStringifier.php renamed to src/Stringifiers/ThrowableObjectStringifier.php src/Stringifiers/ThrowableStringifier.php renamed to src/Stringifiers/ThrowableObjectStringifier.php

@@ -18,7 +18,7 @@
 use function sprintf;
 use function str_replace;
 
-final class ThrowableStringifier implements Stringifier
+final class ThrowableObjectStringifier implements Stringifier
 {
     public function __construct(
         private readonly Stringifier $stringifier,
@@ -32,29 +32,26 @@ public function stringify(mixed $raw, int $depth): ?string
             return null;
         }
 
+        if ($raw->getMessage() === '') {
+            return $this->quoter->quote(
+                sprintf('%s { in %s }', $raw::class, $this->getSource($raw)),
+                $depth
+            );
+        }
+
         return $this->quoter->quote(
             sprintf(
-                '[throwable] (%s: %s)',
+                '%s { %s in %s }',
                 $raw::class,
-                $this->stringifier->stringify($this->getData($raw), $depth + 1)
+                $this->stringifier->stringify($raw->getMessage(), $depth + 1),
+                $this->getSource($raw),
             ),
             $depth
         );
     }
 
-    /**
-     * @return mixed[]
-     */
-    private function getData(Throwable $throwable): array
+    private function getSource(Throwable $throwable): string
     {
-        return [
-            'message' => $throwable->getMessage(),
-            'code' => $throwable->getCode(),
-            'file' => sprintf(
-                '%s:%d',
-                str_replace(getcwd() . '/', '', $throwable->getFile()),
-                $throwable->getLine()
-            ),
-        ];
+        return str_replace(getcwd() . '/', '', $throwable->getFile()) . ':' . $throwable->getLine();
     }
 }

tests/integration/stringify-object-throwable.phpt

@@ -6,6 +6,8 @@ declare(strict_types=1);
 require 'vendor/autoload.php';
 
 output(new InvalidArgumentException());
+output(new InvalidArgumentException('My exception message'));
 ?>
 --EXPECTF--
-`[throwable] (InvalidArgumentException: ["message": "", "code": 0, "file": "%s:%d"])`
+`InvalidArgumentException { in %s:%d }`
+`InvalidArgumentException { "My exception message" in %s:%d }`

tests/unit/Stringifiers/ThrowableObjectStringifierTest.php

@@ -0,0 +1,114 @@
+<?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 DomainException;
+use Error;
+use ErrorException;
+use Exception;
+use InvalidArgumentException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Stringifiers\ThrowableObjectStringifier;
+use Respect\Stringifier\Test\Double\FakeQuoter;
+use Respect\Stringifier\Test\Double\FakeStringifier;
+use RuntimeException;
+use stdClass;
+use Throwable;
+use TypeError;
+
+use function sprintf;
+
+#[CoversClass(ThrowableObjectStringifier::class)]
+final class ThrowableObjectStringifierTest extends TestCase
+{
+    private const DEPTH = 0;
+
+    #[Test]
+    public function isShouldNotStringifyRawValueWhenItIsNotThrowable(): void
+    {
+        $sut = new ThrowableObjectStringifier(new FakeStringifier(), new FakeQuoter());
+
+        self::assertNull($sut->stringify(new stdClass(), self::DEPTH));
+    }
+
+    #[Test]
+    #[DataProvider('throwableWithMessageProvider')]
+    public function itShouldStringifyRawValueWhenItIsThrowableWithMessage(Throwable $raw): void
+    {
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $sut = new ThrowableObjectStringifier($stringifier, $quoter);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expectedValue = $quoter->quote(
+            sprintf(
+                '%s { %s in tests/unit/Stringifiers/ThrowableObjectStringifierTest.php:%d }',
+                $raw::class,
+                $stringifier->stringify($raw->getMessage(), self::DEPTH + 1),
+                $raw->getLine(),
+            ),
+            self::DEPTH
+        );
+
+        self::assertSame($expectedValue, $actual);
+    }
+
+    #[Test]
+    #[DataProvider('throwableWithoutMessageProvider')]
+    public function itShouldStringifyRawValueWhenItIsThrowableWithoutMessage(Throwable $raw): void
+    {
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $sut = new ThrowableObjectStringifier($stringifier, $quoter);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expectedValue = $quoter->quote(
+            sprintf(
+                '%s { in tests/unit/Stringifiers/ThrowableObjectStringifierTest.php:%d }',
+                $raw::class,
+                $raw->getLine(),
+            ),
+            self::DEPTH
+        );
+
+        self::assertSame($expectedValue, $actual);
+    }
+
+    /**
+     * @return array<array{0: Throwable}>
+     */
+    public static function throwableWithMessageProvider(): array
+    {
+        return [
+            [new Exception('Message for Exception')],
+            [new ErrorException('Message for ErrorException')],
+            [new Error('Message for Error')],
+            [new TypeError('Message for TypeError')],
+        ];
+    }
+
+    /**
+     * @return array<array{0: Throwable}>
+     */
+    public static function throwableWithoutMessageProvider(): array
+    {
+        return [
+            [new InvalidArgumentException()],
+            [new RuntimeException()],
+            [new DomainException()],
+        ];
+    }
+}