Change how to stringify arrays

Currently, we're using "{}" around arrays, but that's not intuitive
since we declare arrays with "[]" on PHP.

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

Author: henriquemoody

src/Stringifiers/ArrayStringifier.php

@@ -22,11 +22,13 @@
 
 final class ArrayStringifier implements Stringifier
 {
+    private const LIMIT_EXCEEDED_PLACEHOLDER = '...';
+
     public function __construct(
         private readonly Stringifier $stringifier,
         private readonly Quoter $quoter,
         private readonly int $maximumDepth,
-        private readonly int $itemsLimit
+        private readonly int $maximumNumberOfItems
     ) {
     }
 
@@ -37,30 +39,40 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         if (empty($raw)) {
-            return $this->quoter->quote('{ }', $depth);
+            return $this->quoter->quote('[]', $depth);
         }
 
         if ($depth >= $this->maximumDepth) {
-            return '...';
+            return $this->quoter->quote(self::LIMIT_EXCEEDED_PLACEHOLDER, $depth);
         }
 
         $items = [];
-        $itemsCount = 0;
         $isSequential = $this->isSequential($raw);
         foreach ($raw as $key => $value) {
-            if (++$itemsCount > $this->itemsLimit) {
-                $items[$itemsCount] = '...';
+            if (count($items) >= $this->maximumNumberOfItems) {
+                $items[] = self::LIMIT_EXCEEDED_PLACEHOLDER;
                 break;
             }
 
-            $items[$itemsCount] = '';
-            if ($isSequential === false) {
-                $items[$itemsCount] .= sprintf('%s: ', $this->stringifier->stringify($key, $depth + 1));
+            $stringifiedValue = $this->stringifyKeyValue($value, $depth + 1);
+            if ($isSequential === true) {
+                $items[] = $stringifiedValue;
+                continue;
             }
-            $items[$itemsCount] .= $this->stringifier->stringify($value, $depth + 1);
+
+            $items[] = sprintf('%s: %s', $this->stringifier->stringify($key, $depth + 1), $stringifiedValue);
+        }
+
+        return $this->quoter->quote(sprintf('[%s]', implode(', ', $items)), $depth);
+    }
+
+    private function stringifyKeyValue(mixed $value, int $depth): ?string
+    {
+        if (is_array($value)) {
+            return $this->stringify($value, $depth);
         }
 
-        return $this->quoter->quote(sprintf('{ %s }', implode(', ', $items)), $depth);
+        return $this->stringifier->stringify($value, $depth);
     }
 
     /**

src/Stringifiers/ClusterStringifier.php

@@ -15,6 +15,9 @@
 
 final class ClusterStringifier implements Stringifier
 {
+    private const MAXIMUM_DEPTH = 3;
+    private const MAXIMUM_NUMBER_OF_ITEMS = 5;
+
     /**
      * @var Stringifier[]
      */
@@ -40,7 +43,7 @@ public static function createDefault(): self
             new StringableObjectStringifier($stringifier),
             new JsonSerializableStringifier($stringifier, $quoter),
             new ObjectStringifier($stringifier, $quoter),
-            new ArrayStringifier($stringifier, $quoter, 3, 5),
+            new ArrayStringifier($stringifier, $quoter, self::MAXIMUM_DEPTH, self::MAXIMUM_NUMBER_OF_ITEMS),
             new InfiniteStringifier($quoter),
             new NanStringifier($quoter),
             new ResourceStringifier($quoter),

tests/integration/stringify-array.phpt

@@ -25,4 +25,4 @@ output([
 ]);
 ?>
 --EXPECT--
-`{ 1, NULL, { 1.0, { [resource] (stream), ..., { } } }, FALSE, [object] (stdClass: { }), ... }`
+`[1, NULL, [1.0, [[resource] (stream), ..., []]], FALSE, [object] (stdClass: []), ...]`

tests/integration/stringify-object-jsonSerializable.phpt

@@ -8,4 +8,4 @@ require 'vendor/autoload.php';
 output(new Respect\Stringifier\Test\MyJsonSerializable());
 ?>
 --EXPECT--
-`[json-serializable] (Respect\Stringifier\Test\MyJsonSerializable: { 1, 2, 3 })`
+`[json-serializable] (Respect\Stringifier\Test\MyJsonSerializable: [1, 2, 3])`

tests/integration/stringify-object-throwable.phpt

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

tests/integration/stringify-object-traversable.phpt

@@ -8,4 +8,4 @@ require 'vendor/autoload.php';
 output(new Respect\Stringifier\Test\MyTraversable());
 ?>
 --EXPECT--
-`[traversable] (Respect\Stringifier\Test\MyTraversable: { 1, 2, 3 })`
+`[traversable] (Respect\Stringifier\Test\MyTraversable: [1, 2, 3])`

tests/integration/stringify-object.phpt

@@ -8,4 +8,4 @@ require 'vendor/autoload.php';
 output(new Respect\Stringifier\Test\MyObject());
 ?>
 --EXPECT--
-`[object] (Respect\Stringifier\Test\MyObject: { "foo": TRUE })`
+`[object] (Respect\Stringifier\Test\MyObject: ["foo": TRUE])`

tests/src/Double/FakeQuoter.php

@@ -0,0 +1,25 @@
+<?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\Double;
+
+use Respect\Stringifier\Quoter;
+
+use function sprintf;
+
+final class FakeQuoter implements Quoter
+{
+    private const SYMBOL = '#';
+
+    public function quote(string $string, int $depth): string
+    {
+        return sprintf('%1$s%2$s%1$s%3$d', self::SYMBOL, $string, $depth);
+    }
+}

tests/src/Double/FakeStringifier.php

@@ -0,0 +1,25 @@
+<?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\Double;
+
+use Respect\Stringifier\Stringifier;
+
+use function hash;
+use function implode;
+use function serialize;
+
+final class FakeStringifier implements Stringifier
+{
+    public function stringify(mixed $raw, int $depth): ?string
+    {
+        return implode('.', ['fake', $depth, hash('crc32', serialize($raw))]);
+    }
+}