Change how to stringify JsonSerializable objects

We can only convert those objects into JSON via the `jsonSerialize()`
method. Being more descriptive that the JSON we see is the result of
that method will make it more straightforward.

Besides that, it's better to directly use a stringifier that converts
data to JSON instead of calling the whole stringifier cluster to
stringify the result of `jsonSerialize()`.

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

Author: henriquemoody

composer.json

@@ -33,6 +33,7 @@
     },
     "autoload-dev": {
         "psr-4": {
+            "": "tests/fixtures/",
             "Respect\\Stringifier\\Test\\": "tests/src/",
             "Respect\\Stringifier\\Test\\Unit\\": "tests/unit"
         },

phpcs.xml.dist

@@ -13,4 +13,8 @@
     <file>tests/</file>
 
     <rule ref="Respect" />
+
+    <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
+        <exclude-pattern>tests/fixtures/</exclude-pattern>
+    </rule>
 </ruleset>

src/Stringifiers/ClusterStringifier.php

@@ -37,20 +37,23 @@ public static function createDefault(): self
         $quoter = new CodeQuoter();
 
         $stringifier = new self();
+
+        $jsonParsableStringifier = new JsonParsableStringifier();
+
         $stringifier->setStringifiers([
             new TraversableStringifier($stringifier, $quoter),
             new DateTimeStringifier($quoter, DateTimeInterface::ATOM),
             new ThrowableStringifier($stringifier, $quoter),
             new StringableObjectStringifier($stringifier),
-            new JsonSerializableStringifier($stringifier, $quoter),
+            new JsonSerializableObjectStringifier($jsonParsableStringifier, $quoter),
             new ObjectStringifier($stringifier, $quoter),
             new ArrayStringifier($stringifier, $quoter, self::MAXIMUM_DEPTH, self::MAXIMUM_NUMBER_OF_ITEMS),
             new InfiniteStringifier($quoter),
             new NanStringifier($quoter),
             new ResourceStringifier($quoter),
             new BoolStringifier($quoter),
             new NullStringifier($quoter),
-            new JsonParsableStringifier(),
+            $jsonParsableStringifier,
         ]);
 
         return $stringifier;

…ngifiers/JsonSerializableStringifier.php …rs/JsonSerializableObjectStringifier.phpsrc/Stringifiers/JsonSerializableStringifier.php renamed to src/Stringifiers/JsonSerializableObjectStringifier.php src/Stringifiers/JsonSerializableStringifier.php renamed to src/Stringifiers/JsonSerializableObjectStringifier.php

@@ -16,7 +16,7 @@
 
 use function sprintf;
 
-final class JsonSerializableStringifier implements Stringifier
+final class JsonSerializableObjectStringifier implements Stringifier
 {
     public function __construct(
         private readonly Stringifier $stringifier,
@@ -32,7 +32,7 @@ public function stringify(mixed $raw, int $depth): ?string
 
         return $this->quoter->quote(
             sprintf(
-                '[json-serializable] (%s: %s)',
+                '%s { jsonSerialize() => %s }',
                 $raw::class,
                 $this->stringifier->stringify($raw->jsonSerialize(), $depth + 1)
             ),

tests/src/MyJsonSerializable.php …ts/fixtures/ConcreteJsonSerializable.phptests/src/MyJsonSerializable.php renamed to tests/fixtures/ConcreteJsonSerializable.php tests/src/MyJsonSerializable.php renamed to tests/fixtures/ConcreteJsonSerializable.php

@@ -8,16 +8,12 @@
 
 declare(strict_types=1);
 
-namespace Respect\Stringifier\Test;
-
-use JsonSerializable;
-
-final class MyJsonSerializable implements JsonSerializable
+final class ConcreteJsonSerializable implements JsonSerializable
 {
-    public const JSON_VALUE = [1, 2, 3];
+    public const JSON_VALUE = [1, 2, 3, 'foo' => true];
 
     /**
-     * @return int[]
+     * @return array<mixed, mixed>
      */
     public function jsonSerialize(): array
     {

tests/integration/stringify-object-jsonSerializable.phpt

@@ -5,7 +5,7 @@ declare(strict_types=1);
 
 require 'vendor/autoload.php';
 
-output(new Respect\Stringifier\Test\MyJsonSerializable());
+output(new ConcreteJsonSerializable());
 ?>
 --EXPECT--
-`[json-serializable] (Respect\Stringifier\Test\MyJsonSerializable: [1, 2, 3])`
+`ConcreteJsonSerializable { jsonSerialize() => {"0":1,"1":2,"2":3,"foo":true} }`

tests/unit/Stringifiers/JsonSerializableObjectStringifierTest.php

@@ -0,0 +1,56 @@
+<?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 ConcreteJsonSerializable;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Stringifiers\JsonSerializableObjectStringifier;
+use Respect\Stringifier\Test\Double\FakeQuoter;
+use Respect\Stringifier\Test\Double\FakeStringifier;
+use stdClass;
+
+use function sprintf;
+
+#[CoversClass(JsonSerializableObjectStringifier::class)]
+final class JsonSerializableObjectStringifierTest extends TestCase
+{
+    private const DEPTH = 0;
+
+    #[Test]
+    public function itShouldNotStringifyRawValueWhenItIsNotAnInstanceOfJsonSerializable(): void
+    {
+        $sut = new JsonSerializableObjectStringifier(new FakeStringifier(), new FakeQuoter());
+
+        self::assertNull($sut->stringify(new stdClass(), self::DEPTH));
+    }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnInstanceOfJsonSerializable(): void
+    {
+        $raw = new ConcreteJsonSerializable();
+
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $jsonString = $stringifier->stringify($raw->jsonSerialize(), self::DEPTH + 1);
+
+        $sut = new JsonSerializableObjectStringifier($stringifier, $quoter);
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote(
+            sprintf('%s { jsonSerialize() => %s }', ConcreteJsonSerializable::class, $jsonString),
+            self::DEPTH
+        );
+
+        self::assertSame($expected, $actual);
+    }
+}