Change how to stringify ArrayObject objects

Right now, the object stringifier takes care of ArrayObjects, but it is
a bit ugly because of its property's name.

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

Author: henriquemoody

README.md

@@ -145,6 +145,9 @@ echo stringify(new ConcreteJsonSerializable()) . PHP_EOL;
 echo stringify(new WithDebugInfo()) . PHP_EOL;
 // `WithDebugInfo { __debugInfo() => ["info": "This is the return of __debugInfo()"] }`
 
+echo stringify(new ArrayObject([1, 2, 3])) . PHP_EOL;
+// `ArrayObject { getArrayCopy() => [1, 2, 3] }`
+
 echo stringify(new RuntimeException()) . PHP_EOL;
 // `RuntimeException { in file.php:119 }`
 

src/Stringifiers/ArrayObjectStringifier.php

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

src/Stringifiers/CompositeStringifier.php

@@ -65,6 +65,7 @@ public static function createDefault(): self
         $stringifier->prependStringifier(new FiberObjectStringifier($callableStringifier, $quoter));
         $stringifier->prependStringifier(new EnumerationStringifier($quoter));
         $stringifier->prependStringifier(new ObjectWithDebugInfoStringifier($arrayStringifier, $quoter));
+        $stringifier->prependStringifier(new ArrayObjectStringifier($arrayStringifier, $quoter));
         $stringifier->prependStringifier(new JsonSerializableObjectStringifier($jsonEncodableStringifier, $quoter));
         $stringifier->prependStringifier(new StringableObjectStringifier($jsonEncodableStringifier, $quoter));
         $stringifier->prependStringifier(new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter));

tests/integration/stringify-array-object.phpt

@@ -0,0 +1,15 @@
+--FILE--
+<?php
+
+declare(strict_types=1);
+
+require 'vendor/autoload.php';
+
+outputMultiple(
+    new ArrayObject([]),
+    new ArrayObject([1, 2, 3]),
+);
+?>
+--EXPECT--
+`ArrayObject { getArrayCopy() => [] }`
+`ArrayObject { getArrayCopy() => [1, 2, 3] }`

tests/unit/Stringifiers/ArrayObjectStringifierTest.php

@@ -0,0 +1,57 @@
+<?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 ArrayObject;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Stringifiers\ArrayObjectStringifier;
+use Respect\Stringifier\Test\Double\FakeQuoter;
+use Respect\Stringifier\Test\Double\FakeStringifier;
+use stdClass;
+
+use function sprintf;
+
+#[CoversClass(ArrayObjectStringifier::class)]
+final class ArrayObjectStringifierTest extends TestCase
+{
+    private const DEPTH = 0;
+
+    #[Test]
+    public function itShouldNotStringifyRawValueWhenItIsNotAnArrayObject(): void
+    {
+        $sut = new ArrayObjectStringifier(new FakeStringifier(), new FakeQuoter());
+
+        self::assertNull($sut->stringify(new stdClass(), self::DEPTH));
+    }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnArrayObject(): void
+    {
+        $raw = new ArrayObject([1, 2, 3]);
+
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $string = $stringifier->stringify($raw->getArrayCopy(), self::DEPTH + 1);
+
+        $sut = new ArrayObjectStringifier($stringifier, $quoter);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote(
+            sprintf('ArrayObject { getArrayCopy() => %s }', $string),
+            self::DEPTH
+        );
+
+        self::assertSame($expected, $actual);
+    }
+}