Change how to stringify objects with __debugInfo()

That method intends to enable engineers to have a better overview of the
object when they want to debug it. That said, using that method when
it's present is better.

The representation is similar to the one I used on Stringeable objects,
in which we have clear that we're executing a specific method rather
than just showing the values.

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

Author: henriquemoody

src/Stringifiers/ClusterStringifier.php

@@ -40,15 +40,22 @@ public static function createDefault(): self
         $stringifier = new self();
 
         $jsonEncodableStringifier = new JsonEncodableStringifier();
+        $arrayStringifier = new ArrayStringifier(
+            $stringifier,
+            $quoter,
+            self::MAXIMUM_DEPTH,
+            self::MAXIMUM_NUMBER_OF_ITEMS
+        );
 
         $stringifier->setStringifiers([
             new IteratorObjectStringifier($stringifier, $quoter),
             new DateTimeStringifier($quoter, DateTimeInterface::ATOM),
             new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter),
             new StringableObjectStringifier($jsonEncodableStringifier, $quoter),
             new JsonSerializableObjectStringifier($jsonEncodableStringifier, $quoter),
+            new ObjectWithDebugInfoStringifier($arrayStringifier, $quoter),
             new ObjectStringifier($stringifier, $quoter, self::MAXIMUM_DEPTH, self::MAXIMUM_NUMBER_OF_PROPERTIES),
-            new ArrayStringifier($stringifier, $quoter, self::MAXIMUM_DEPTH, self::MAXIMUM_NUMBER_OF_ITEMS),
+            $arrayStringifier,
             new InfiniteNumberStringifier($quoter),
             new NotANumberStringifier($quoter),
             new ResourceStringifier($quoter),

src/Stringifiers/ObjectWithDebugInfoStringifier.php

@@ -0,0 +1,41 @@
+<?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\Stringifiers;
+
+use Respect\Stringifier\Helpers\ObjectHelper;
+use Respect\Stringifier\Quoter;
+use Respect\Stringifier\Stringifier;
+
+use function is_object;
+use function method_exists;
+
+final class ObjectWithDebugInfoStringifier implements Stringifier
+{
+    use ObjectHelper;
+
+    public function __construct(
+        private readonly Stringifier $stringifier,
+        private readonly Quoter $quoter
+    ) {
+    }
+
+    public function stringify(mixed $raw, int $depth): ?string
+    {
+        if (!(is_object($raw) && method_exists($raw, '__debugInfo'))) {
+            return null;
+        }
+
+        return $this->quoter->quote(
+            $this->format($raw, '__debugInfo() =>', $this->stringifier->stringify($raw->__debugInfo(), $depth + 1)),
+            $depth
+        );
+    }
+}

tests/fixtures/WithDebugInfo.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ * Copyright (c) Henrique Moody <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+final class WithDebugInfo
+{
+    /**
+     * @return array<string, string>
+     */
+    public function __debugInfo(): array
+    {
+        return ['info' => 'This is the return of __debugInfo()'];
+    }
+}

tests/integration/stringify-object-with-debug-info.phpt

@@ -0,0 +1,11 @@
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require 'vendor/autoload.php';
+
+output(new WithDebugInfo());
+?>
+--EXPECT--
+`WithDebugInfo { __debugInfo() => ["info": "This is the return of __debugInfo()"] }`

tests/unit/Stringifiers/ObjectWithDebugInfoStringifierTest.php

@@ -0,0 +1,59 @@
+<?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 PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
+use Respect\Stringifier\Stringifiers\ObjectWithDebugInfoStringifier;
+use Respect\Stringifier\Test\Double\FakeQuoter;
+use Respect\Stringifier\Test\Double\FakeStringifier;
+use stdClass;
+use WithDebugInfo;
+
+use function sprintf;
+
+#[CoversClass(ObjectHelper::class)]
+#[CoversClass(ObjectWithDebugInfoStringifier::class)]
+final class ObjectWithDebugInfoStringifierTest extends TestCase
+{
+    private const DEPTH = 0;
+
+    #[Test]
+    public function itShouldNotStringifyRawValueWhenItIsNotAnObjectWithDebugInfo(): void
+    {
+        $sut = new ObjectWithDebugInfoStringifier(new FakeStringifier(), new FakeQuoter());
+
+        self::assertNull($sut->stringify(new stdClass(), self::DEPTH));
+    }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnObjectWithDebugInfo(): void
+    {
+        $raw = new WithDebugInfo();
+
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $string = $stringifier->stringify($raw->__debugInfo(), self::DEPTH + 1);
+
+        $sut = new ObjectWithDebugInfoStringifier($stringifier, $quoter);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote(
+            sprintf('%s { __debugInfo() => %s }', WithDebugInfo::class, $string),
+            self::DEPTH
+        );
+
+        self::assertSame($expected, $actual);
+    }
+}