simple-normalizable_to-string (#18)

Author: era269

README.md

@@ -31,7 +31,8 @@ based messages (HTTP, AMQP, ...)
 
 ### Simple Normalization
 
-If all object properties are scalar `or` ScalarableInterface `or` NormalizableInterface then:
+If all object properties are scalar `or` ScalarableInterface `or` NormalizableInterface `or` Stringable (
+has `__toString`) then:
 **SimpleNormalizableTrait** will do everything automatically
 
 ```php
@@ -139,7 +140,7 @@ use Era269\Normalizable\Adapter\ThrowableToNormalizableAdapter;
 
 final class ExceptionNormalizer implements NormalizerInterface
 {    
-    public function normalize(object $object) : array
+    public function normalize($object) : array
     {
         /** @var Throwable $object */
         return (new ThrowableToNormalizableAdapter($object))->normalize();
@@ -165,8 +166,9 @@ final class DomainEvent implements NormalizableInterface, DenormalizableInterfac
 {
     use AbstractNormalizableTrait;
 
-    private string $name;
-    private DateTimeRfc3339Normalizable $createdAt;
+    private $name;
+
+    private $createdAt;
 
     public function __construct(string $name)
     {
@@ -181,7 +183,7 @@ final class DomainEvent implements NormalizableInterface, DenormalizableInterfac
             'createdAt' => $this->createdAt->normalize(),
         ];
     }
-    public static function denormalize(array $data) : static
+    public static function denormalize(array $data) : static //since php 8.0
     {
         $self = new self($data['name']);
         $self->createdAt = DateTimeRfc3339Normalizable::denormalize($data);

src/Traits/SimpleNormalizableTrait.php

@@ -63,6 +63,9 @@ private function extractScalar($value)
             case $value instanceof ScalarableInterface:
                 return $value->toScalar();
 
+            case $this->isStringable($value):
+                return (string) $value;
+
             default:
                 throw new LogicException(sprintf(
                     'Value "%s", but MUST be scalar or implement any of [%s, %s]',
@@ -72,4 +75,12 @@ private function extractScalar($value)
                 ));
         }
     }
+
+    /**
+     * @param object $value
+     */
+    private function isStringable($value): bool
+    {
+        return method_exists($value, '__toString');
+    }
 }

tests/Object/SimpleNormalizableTraitTest.php

@@ -11,6 +11,7 @@
 use Era269\Normalizable\Object\IntegerObject;
 use Era269\Normalizable\Object\StringObject;
 use Era269\Normalizable\Traits\SimpleNormalizableTrait;
+use Exception;
 use LogicException;
 use PHPUnit\Framework\TestCase;
 
@@ -19,14 +20,21 @@ class SimpleNormalizableTraitTest extends TestCase
     public function testNormalize(): void
     {
         $dateTime = new DateTimeRfc3339Normalizable();
-        $normalizable = $this->createAutoNormalizable($dateTime);
+        $stringable = new Exception('message', 269);
+        $normalizable = $this->createAutoNormalizable($dateTime, $stringable);
         self::assertEquals(
-            $this->getExpectedNormalized($normalizable, $dateTime, 1),
+            $this->getExpectedNormalized($normalizable, $dateTime, $stringable, 1),
             $normalizable->normalize()
         );
     }
 
-    private function createAutoNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc3339Normalizable): NormalizableInterface
+    /**
+     * @param object $stringable
+     */
+    private function createAutoNormalizable(
+        DateTimeRfc3339Normalizable $dateTimeRfc3339Normalizable,
+        $stringable
+    ): NormalizableInterface
     {
         return new class (
             1,
@@ -39,7 +47,8 @@ private function createAutoNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc
             [1, '1', false, null],
             new IntegerObject(5),
             new StringObject('10'),
-            $dateTimeRfc3339Normalizable
+            $dateTimeRfc3339Normalizable,
+            $stringable
         ) implements NormalizableInterface {
             use SimpleNormalizableTrait;
 
@@ -87,8 +96,13 @@ private function createAutoNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc
              * @var DateTimeInterface
              */
             private $dateTimeRfc3339Normalizable;
+            /**
+             * @var object
+             */
+            private $stringable;
 
             /**
+             * @param object $stringable
              * @param array<int, mixed> $privateArray
              */
             public function __construct(
@@ -102,7 +116,8 @@ public function __construct(
                 array $privateArray,
                 IntegerObject $integerObject,
                 StringObject $stringObject,
-                DateTimeInterface $dateTimeRfc3339Normalizable
+                DateTimeInterface $dateTimeRfc3339Normalizable,
+                $stringable
             )
             {
                 $this->publicInt = $publicInt;
@@ -116,16 +131,20 @@ public function __construct(
                 $this->integerObject = $integerObject;
                 $this->stringObject = $stringObject;
                 $this->dateTimeRfc3339Normalizable = $dateTimeRfc3339Normalizable;
+                $this->stringable = $stringable;
             }
         };
     }
 
     /**
+     * @param object $stringable
+     *
      * @return array<string, mixed>
      */
     private function getExpectedNormalized(
         NormalizableInterface $normalizable,
         DateTimeRfc3339Normalizable $dateTime,
+        $stringable,
         int $publicIntManuallyNormalized
     ): array
     {
@@ -142,20 +161,25 @@ private function getExpectedNormalized(
             'integerObject' => 5,
             'stringObject' => '10',
             'dateTimeRfc3339Normalizable' => $dateTime->normalize(),
+            'stringable' => (string) $stringable,
         ];
     }
 
     public function testAutoNormalize(): void
     {
         $dateTime = new DateTimeRfc3339Normalizable();
-        $normalizable = $this->createNormalizable($dateTime);
+        $stringable = new Exception('message', 269);
+        $normalizable = $this->createNormalizable($dateTime, $stringable);
         self::assertEquals(
-            $this->getExpectedNormalized($normalizable, $dateTime, 2),
+            $this->getExpectedNormalized($normalizable, $dateTime, $stringable, 2),
             $normalizable->normalize()
         );
     }
 
-    private function createNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc3339Normalizable): NormalizableInterface
+    /**
+     * @param object $stringable
+     */
+    private function createNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc3339Normalizable, $stringable): NormalizableInterface
     {
         return new class (
             1,
@@ -168,7 +192,8 @@ private function createNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc3339
             [1, '1', false, null],
             new IntegerObject(5),
             new StringObject('10'),
-            $dateTimeRfc3339Normalizable
+            $dateTimeRfc3339Normalizable,
+            $stringable
         ) implements NormalizableInterface {
             use SimpleNormalizableTrait;
 
@@ -216,6 +241,10 @@ private function createNormalizable(DateTimeRfc3339Normalizable $dateTimeRfc3339
              * @var DateTimeInterface
              */
             private $dateTimeRfc3339Normalizable;
+            /**
+             * @var object
+             */
+            private $stringable;
 
             /**
              * @param array<int, mixed> $privateArray
@@ -231,7 +260,8 @@ public function __construct(
                 array $privateArray,
                 IntegerObject $integerObject,
                 StringObject $stringObject,
-                DateTimeInterface $dateTimeRfc3339Normalizable
+                DateTimeInterface $dateTimeRfc3339Normalizable,
+                $stringable
             )
             {
                 $this->publicInt = $publicInt;
@@ -245,6 +275,7 @@ public function __construct(
                 $this->integerObject = $integerObject;
                 $this->stringObject = $stringObject;
                 $this->dateTimeRfc3339Normalizable = $dateTimeRfc3339Normalizable;
+                $this->stringable = $stringable;
             }
 
             /**