Improve the reusability of the concrete API

Even though this library is extensible, I acknowledge that combining a
custom stringifier with the existing ones takes work.

I made the API a bit more reusable and created a `Stringify` class that
could facilitate engineers to use this library from a DIC.

There were also a couple of name changes because "cluster" always
bothered me a little.

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

Author: henriquemoody

composer.json

@@ -28,7 +28,7 @@
             "Respect\\Stringifier\\": "src/"
         },
         "files": [
-            "src/stringify.php"
+            "stringify.php"
         ]
     },
     "autoload-dev": {

src/Stringifiers/ClusterStringifier.php

@@ -0,0 +1,94 @@
+<?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 DateTimeInterface;
+use Respect\Stringifier\Quoters\CodeQuoter;
+use Respect\Stringifier\Stringifier;
+
+use function array_unshift;
+
+final class CompositeStringifier implements Stringifier
+{
+    private const MAXIMUM_DEPTH = 3;
+    private const MAXIMUM_NUMBER_OF_ITEMS = 5;
+    private const MAXIMUM_NUMBER_OF_PROPERTIES = self::MAXIMUM_NUMBER_OF_ITEMS;
+
+    /**
+     * @var Stringifier[]
+     */
+    private array $stringifiers = [];
+
+    public function __construct(Stringifier ...$stringifiers)
+    {
+        $this->stringifiers = $stringifiers;
+    }
+
+    public static function createDefault(): self
+    {
+        $quoter = new CodeQuoter();
+
+        $stringifier = new self(
+            new InfiniteNumberStringifier($quoter),
+            new NotANumberStringifier($quoter),
+            new ResourceStringifier($quoter),
+            new BoolStringifier($quoter),
+            new NullStringifier($quoter),
+            $jsonEncodableStringifier = new JsonEncodableStringifier(),
+        );
+        $stringifier->prependStringifier(
+            $arrayStringifier = new ArrayStringifier(
+                $stringifier,
+                $quoter,
+                self::MAXIMUM_DEPTH,
+                self::MAXIMUM_NUMBER_OF_ITEMS,
+            )
+        );
+        $stringifier->prependStringifier(
+            new ObjectStringifier(
+                $stringifier,
+                $quoter,
+                self::MAXIMUM_DEPTH,
+                self::MAXIMUM_NUMBER_OF_PROPERTIES
+            )
+        );
+        $stringifier->prependStringifier($callableStringifier = new CallableStringifier($stringifier, $quoter));
+        $stringifier->prependStringifier(new FiberObjectStringifier($callableStringifier, $quoter));
+        $stringifier->prependStringifier(new EnumerationStringifier($quoter));
+        $stringifier->prependStringifier(new ObjectWithDebugInfoStringifier($arrayStringifier, $quoter));
+        $stringifier->prependStringifier(new JsonSerializableObjectStringifier($jsonEncodableStringifier, $quoter));
+        $stringifier->prependStringifier(new StringableObjectStringifier($jsonEncodableStringifier, $quoter));
+        $stringifier->prependStringifier(new ThrowableObjectStringifier($jsonEncodableStringifier, $quoter));
+        $stringifier->prependStringifier(new DateTimeStringifier($quoter, DateTimeInterface::ATOM));
+        $stringifier->prependStringifier(new IteratorObjectStringifier($stringifier, $quoter));
+
+        return $stringifier;
+    }
+
+    public function prependStringifier(Stringifier $stringifier): void
+    {
+         array_unshift($this->stringifiers, $stringifier);
+    }
+
+    public function stringify(mixed $raw, int $depth): ?string
+    {
+        foreach ($this->stringifiers as $stringifier) {
+            $string = $stringifier->stringify($raw, $depth);
+            if ($string === null) {
+                continue;
+            }
+
+            return $string;
+        }
+
+        return null;
+    }
+}

src/Stringifiers/CompositeStringifier.php

@@ -0,0 +1,40 @@
+<?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;
+
+use Respect\Stringifier\Stringifiers\CompositeStringifier;
+
+use function print_r;
+
+final class Stringify
+{
+    public const STARTING_DEPTH = 0;
+
+    public function __construct(
+        private readonly Stringifier $stringifier
+    ) {
+    }
+
+    public static function createDefault(): self
+    {
+        return new self(CompositeStringifier::createDefault());
+    }
+
+    public function value(mixed $value): string
+    {
+        return $this->stringifier->stringify($value, self::STARTING_DEPTH) ?? print_r($value, true);
+    }
+
+    public function __invoke(mixed $value): string
+    {
+        return $this->value($value);
+    }
+}

src/Stringify.php

@@ -10,15 +10,13 @@
 
 namespace Respect\Stringifier;
 
-use Respect\Stringifier\Stringifiers\ClusterStringifier;
-
 function stringify(mixed $value): string
 {
-    static $stringifier;
+    static $stringify;
 
-    if ($stringifier === null) {
-        $stringifier = ClusterStringifier::createDefault();
+    if ($stringify === null) {
+        $stringify = Stringify::createDefault();
     }
 
-    return $stringifier->stringify($value, 0) ?? '#ERROR#';
+    return $stringify->value($value);
 }

src/stringify.php stringify.phpsrc/stringify.php renamed to stringify.php

@@ -0,0 +1,21 @@
+<?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;
+
+final class LameStringifier implements Stringifier
+{
+    public function stringify(mixed $raw, int $depth): ?string
+    {
+        return null;
+    }
+}