Change how to stringify anonymous classes

henriquemoody · henriquemoody · commit d2fd8c72444b · 2023-04-21T19:39:22.000+02:00
The class name of an anonymous class can be long, so I decided to make
it shorter. A simple "class" is enough to describe the class name since
it is a reserved word, and that's how we define an anonymous class.

If the anonymous class extends another class, it makes sense to keep the
extended class name while ensuring the user understands it is anonymous.
In those cases, I kept the same behavior as PHP, with "@anonymous" next
to the extended class name.

Signed-off-by: Henrique Moody &lt;henriquemoody@gmail.com&gt;
diff --git a/src/Helpers/ObjectHelper.php b/src/Helpers/ObjectHelper.php
@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of Respect/Stringifier.
+ * Copyright (c) Henrique Moody <henriquemoody@gmail.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Stringifier\Helpers;
+
+use function array_filter;
+use function count;
+use function implode;
+use function sprintf;
+use function strstr;
+
+trait ObjectHelper
+{
+    private function format(object $object, ?string ...$pieces): string
+    {
+        $filteredPieces = array_filter($pieces);
+        if (count($filteredPieces) === 0) {
+            return $this->getName($object) . ' {}';
+        }
+
+        return sprintf('%s { %s }', $this->getName($object), implode(' ', $filteredPieces));
+    }
+
+    private function getName(object $object): string
+    {
+        $name = strstr($object::class, "\000", true);
+        if ($name === 'class@anonymous') {
+            return 'class';
+        }
+
+        if ($name !== false) {
+            return $name;
+        }
+
+        return $object::class;
+    }
+}
diff --git a/src/Stringifiers/DateTimeStringifier.php b/src/Stringifiers/DateTimeStringifier.php
@@ -11,13 +11,14 @@
 namespace Respect\Stringifier\Stringifiers;
 
 use DateTimeInterface;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 
-use function sprintf;
-
 final class DateTimeStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     public function __construct(
         private readonly Quoter $quoter,
         private readonly string $format
@@ -30,6 +31,6 @@ public function stringify(mixed $raw, int $depth): ?string
             return null;
         }
 
-        return $this->quoter->quote(sprintf('%s { %s }', $raw::class, $raw->format($this->format)), $depth);
+        return $this->quoter->quote($this->format($raw, $raw->format($this->format)), $depth);
     }
 }
diff --git a/src/Stringifiers/IteratorObjectStringifier.php b/src/Stringifiers/IteratorObjectStringifier.php
@@ -11,13 +11,14 @@
 namespace Respect\Stringifier\Stringifiers;
 
 use Iterator;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 
-use function sprintf;
-
 final class IteratorObjectStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     public function __construct(
         private readonly Stringifier $stringifier,
         private readonly Quoter $quoter
@@ -31,11 +32,7 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         return $this->quoter->quote(
-            sprintf(
-                '%s { current() => %s }',
-                $raw::class,
-                $this->stringifier->stringify($raw->current(), $depth + 1)
-            ),
+            $this->format($raw, 'current() =>', $this->stringifier->stringify($raw->current(), $depth + 1)),
             $depth
         );
     }
diff --git a/src/Stringifiers/JsonSerializableObjectStringifier.php b/src/Stringifiers/JsonSerializableObjectStringifier.php
@@ -11,13 +11,14 @@
 namespace Respect\Stringifier\Stringifiers;
 
 use JsonSerializable;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 
-use function sprintf;
-
 final class JsonSerializableObjectStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     public function __construct(
         private readonly Stringifier $stringifier,
         private readonly Quoter $quoter
@@ -31,11 +32,7 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         return $this->quoter->quote(
-            sprintf(
-                '%s { jsonSerialize() => %s }',
-                $raw::class,
-                $this->stringifier->stringify($raw->jsonSerialize(), $depth + 1)
-            ),
+            $this->format($raw, 'jsonSerialize() =>', $this->stringifier->stringify($raw->jsonSerialize(), $depth + 1)),
             $depth
         );
     }
diff --git a/src/Stringifiers/ObjectStringifier.php b/src/Stringifiers/ObjectStringifier.php
@@ -12,17 +12,19 @@
 
 use ReflectionObject;
 use ReflectionProperty;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 
 use function count;
-use function implode;
 use function is_object;
 use function sprintf;
 use function trim;
 
 final class ObjectStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     private const LIMIT_EXCEEDED_PLACEHOLDER = '...';
 
     public function __construct(
@@ -40,15 +42,13 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         if ($depth >= $this->maximumDepth) {
-            return $this->quoter->quote(sprintf('%s { %s }', $raw::class, self::LIMIT_EXCEEDED_PLACEHOLDER), $depth);
-        }
-
-        $properties = $this->getProperties(new ReflectionObject($raw), $raw, $depth + 1);
-        if (count($properties) === 0) {
-            return $this->quoter->quote(sprintf('%s {}', $raw::class), $depth);
+            return $this->quoter->quote($this->format($raw, self::LIMIT_EXCEEDED_PLACEHOLDER), $depth);
         }
 
-        return $this->quoter->quote(sprintf('%s { %s }', $raw::class, implode(' ', $properties)), $depth);
+        return $this->quoter->quote(
+            $this->format($raw, ...$this->getProperties(new ReflectionObject($raw), $raw, $depth + 1)),
+            $depth
+        );
     }
 
     /**
diff --git a/src/Stringifiers/StringableObjectStringifier.php b/src/Stringifiers/StringableObjectStringifier.php
@@ -10,14 +10,15 @@
 
 namespace Respect\Stringifier\Stringifiers;
 
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 use Stringable;
 
-use function sprintf;
-
 final class StringableObjectStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     public function __construct(
         private readonly Stringifier $stringifier,
         private readonly Quoter $quoter
@@ -31,11 +32,7 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         return $this->quoter->quote(
-            sprintf(
-                '%s { __toString() => %s }',
-                $raw::class,
-                $this->stringifier->stringify($raw->__toString(), $depth + 1)
-            ),
+            $this->format($raw, '__toString() =>', $this->stringifier->stringify($raw->__toString(), $depth + 1)),
             $depth
         );
     }
diff --git a/src/Stringifiers/ThrowableObjectStringifier.php b/src/Stringifiers/ThrowableObjectStringifier.php
@@ -10,16 +10,18 @@
 
 namespace Respect\Stringifier\Stringifiers;
 
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 use Throwable;
 
 use function getcwd;
-use function sprintf;
 use function str_replace;
 
 final class ThrowableObjectStringifier implements Stringifier
 {
+    use ObjectHelper;
+
     public function __construct(
         private readonly Stringifier $stringifier,
         private readonly Quoter $quoter
@@ -33,18 +35,15 @@ public function stringify(mixed $raw, int $depth): ?string
         }
 
         if ($raw->getMessage() === '') {
-            return $this->quoter->quote(
-                sprintf('%s { in %s }', $raw::class, $this->getSource($raw)),
-                $depth
-            );
+            return $this->quoter->quote($this->format($raw, 'in', $this->getSource($raw)), $depth);
         }
 
         return $this->quoter->quote(
-            sprintf(
-                '%s { %s in %s }',
-                $raw::class,
+            $this->format(
+                $raw,
                 $this->stringifier->stringify($raw->getMessage(), $depth + 1),
-                $this->getSource($raw),
+                'in',
+                $this->getSource($raw)
             ),
             $depth
         );
diff --git a/tests/integration/stringify-object.phpt b/tests/integration/stringify-object.phpt
@@ -9,9 +9,12 @@ outputMultiple(
     new stdClass(),
     new WithProperties(),
     new WithUninitializedProperties(),
+    new class {
+    },
 );
 ?>
 --EXPECT--
 `stdClass {}`
 `WithProperties { +$publicProperty=true #$protectedProperty=42 -$privateProperty="something" }`
 `WithUninitializedProperties { +$uninitializedProperty=*uninitialized* }`
+`class {}`
diff --git a/tests/unit/Stringifiers/DateTimeStringifierTest.php b/tests/unit/Stringifiers/DateTimeStringifierTest.php
@@ -17,9 +17,11 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Stringifiers\DateTimeStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 
+#[CoversClass(ObjectHelper::class)]
 #[CoversClass(DateTimeStringifier::class)]
 final class DateTimeStringifierTest extends TestCase
 {
diff --git a/tests/unit/Stringifiers/IteratorObjectStringifierTest.php b/tests/unit/Stringifiers/IteratorObjectStringifierTest.php
@@ -14,12 +14,14 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Stringifiers\IteratorObjectStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 use Respect\Stringifier\Test\Double\FakeStringifier;
 
 use function sprintf;
 
+#[CoversClass(ObjectHelper::class)]
 #[CoversClass(IteratorObjectStringifier::class)]
 final class IteratorObjectStringifierTest extends TestCase
 {
diff --git a/tests/unit/Stringifiers/JsonSerializableObjectStringifierTest.php b/tests/unit/Stringifiers/JsonSerializableObjectStringifierTest.php
@@ -14,13 +14,15 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Stringifiers\JsonSerializableObjectStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 use Respect\Stringifier\Test\Double\FakeStringifier;
 use stdClass;
 
 use function sprintf;
 
+#[CoversClass(ObjectHelper::class)]
 #[CoversClass(JsonSerializableObjectStringifier::class)]
 final class JsonSerializableObjectStringifierTest extends TestCase
 {
diff --git a/tests/unit/Stringifiers/ObjectStringifierTest.php b/tests/unit/Stringifiers/ObjectStringifierTest.php
@@ -17,6 +17,7 @@
 use Respect\Stringifier\Stringifiers\ObjectStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 use Respect\Stringifier\Test\Double\FakeStringifier;
+use SplStack;
 use stdClass;
 use WithProperties;
 use WithUninitializedProperties;
@@ -220,4 +221,49 @@ public function itShouldStringifyRawValueWithPlaceholderWhenItReachesLimitOfItem
 
         self::assertSame($expected, $actual);
     }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnAnonymousClass(): void
+    {
+        $raw = new class {
+            public int $foo = 1;
+        };
+
+        $stringifier = new FakeStringifier();
+        $quoter = new FakeQuoter();
+
+        $sut = new ObjectStringifier($stringifier, $quoter, self::MAXIMUM_DEPTH, self::MAXIMUM_NUMBER_OF_PROPERTIES);
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote(
+            sprintf(
+                'class { +$foo=%s }',
+                $stringifier->stringify($raw->foo, self::DEPTH + 1)
+            ),
+            self::DEPTH
+        );
+
+        self::assertSame($expected, $actual);
+    }
+
+    #[Test]
+    public function itShouldStringifyRawValueWhenItIsAnAnonymousClassExtendingAnotherClass(): void
+    {
+        $raw = new class extends SplStack {
+        };
+
+        $quoter = new FakeQuoter();
+
+        $sut = new ObjectStringifier(
+            new FakeStringifier(),
+            $quoter,
+            self::MAXIMUM_DEPTH,
+            self::MAXIMUM_NUMBER_OF_PROPERTIES
+        );
+
+        $actual = $sut->stringify($raw, self::DEPTH);
+        $expected = $quoter->quote('SplStack@anonymous {}', self::DEPTH);
+
+        self::assertSame($expected, $actual);
+    }
 }
diff --git a/tests/unit/Stringifiers/StringableObjectStringifierTest.php b/tests/unit/Stringifiers/StringableObjectStringifierTest.php
@@ -14,13 +14,15 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Stringifiers\StringableObjectStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 use Respect\Stringifier\Test\Double\FakeStringifier;
 use stdClass;
 
 use function sprintf;
 
+#[CoversClass(ObjectHelper::class)]
 #[CoversClass(StringableObjectStringifier::class)]
 final class StringableObjectStringifierTest extends TestCase
 {
diff --git a/tests/unit/Stringifiers/ThrowableObjectStringifierTest.php b/tests/unit/Stringifiers/ThrowableObjectStringifierTest.php
@@ -19,6 +19,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Helpers\ObjectHelper;
 use Respect\Stringifier\Stringifiers\ThrowableObjectStringifier;
 use Respect\Stringifier\Test\Double\FakeQuoter;
 use Respect\Stringifier\Test\Double\FakeStringifier;
@@ -29,6 +30,7 @@
 
 use function sprintf;
 
+#[CoversClass(ObjectHelper::class)]
 #[CoversClass(ThrowableObjectStringifier::class)]
 final class ThrowableObjectStringifierTest extends TestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,14 @@`
`11`	`11`	`namespace Respect\Stringifier\Stringifiers;`
`12`	`12`
`13`	`13`	`use DateTimeInterface;`
	`14`	`+use Respect\Stringifier\Helpers\ObjectHelper;`
`14`	`15`	`use Respect\Stringifier\Quoter;`
`15`	`16`	`use Respect\Stringifier\Stringifier;`
`16`	`17`
`17`		`-use function sprintf;`
`18`		`-`
`19`	`18`	`final class DateTimeStringifier implements Stringifier`
`20`	`19`	`{`
	`20`	`+ use ObjectHelper;`
	`21`	`+`
`21`	`22`	`public function __construct(`
`22`	`23`	`private readonly Quoter $quoter,`
`23`	`24`	`private readonly string $format`
`@@ -30,6 +31,6 @@ public function stringify(mixed $raw, int $depth): ?string`
`30`	`31`	`return null;`
`31`	`32`	`}`
`32`	`33`
`33`		`- return $this->quoter->quote(sprintf('%s { %s }', $raw::class, $raw->format($this->format)), $depth);`
	`34`	`+ return $this->quoter->quote($this->format($raw, $raw->format($this->format)), $depth);`
`34`	`35`	`}`
`35`	`36`	`}`