DateTimeInterface should not be treated as strings

They are objects, therefore they need to be represented as is.

Author: henriquemoody

src/Stringifiers/ClusterStringifier.php

@@ -53,7 +53,7 @@ public static function createDefault(): self
         $stringifier = new self();
         $stringifier->setStringifiers([
             new TraversableStringifier($stringifier, $quoter),
-            new DateTimeStringifier($stringifier, 'c'),
+            new DateTimeStringifier($stringifier, $quoter, 'c'),
             new ThrowableStringifier($stringifier, $quoter),
             new StringableObjectStringifier($stringifier),
             new JsonSerializableStringifier($stringifier, $quoter),

src/Stringifiers/DateTimeStringifier.php

@@ -14,6 +14,9 @@
 namespace Respect\Stringifier\Stringifiers;
 
 use DateTimeInterface;
+use function get_class;
+use function sprintf;
+use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 
 /**
@@ -28,6 +31,11 @@ final class DateTimeStringifier implements Stringifier
      */
     private $stringifier;
 
+    /**
+     * @var Quoter
+     */
+    private $quoter;
+
     /**
      * @var string
      */
@@ -37,11 +45,13 @@ final class DateTimeStringifier implements Stringifier
      * Initializes the stringifier.
      *
      * @param Stringifier $stringifier
+     * @param Quoter $quoter
      * @param string $format
      */
-    public function __construct(Stringifier $stringifier, string $format)
+    public function __construct(Stringifier $stringifier, Quoter $quoter, string $format)
     {
         $this->stringifier = $stringifier;
+        $this->quoter = $quoter;
         $this->format = $format;
     }
 
@@ -54,6 +64,13 @@ public function stringify($raw, int $depth): ?string
             return null;
         }
 
-        return $this->stringifier->stringify($raw->format($this->format), $depth);
+        return $this->quoter->quote(
+            sprintf(
+                '[date-time] (%s: %s)',
+                get_class($raw),
+                $this->stringifier->stringify($raw->format($this->format), $depth + 1)
+            ),
+            $depth
+        );
     }
 }

tests/integration/stringify-object-dateTime.phpt

@@ -5,8 +5,16 @@ require 'vendor/autoload.php';
 use function Respect\Stringifier\stringify;
 
 $dateTime = DateTime::createFromFormat('Y-m-d\TH:i:sP', '2017-12-31T23:59:59+00:00');
+$dateTimeImmutable = DateTimeImmutable::createFromMutable($dateTime);
 
-echo stringify($dateTime);
+echo implode(
+    PHP_EOL,
+    [
+        stringify($dateTime),
+        stringify($dateTimeImmutable),
+    ]
+);
 ?>
 --EXPECT--
-"2017-12-31T23:59:59+00:00"
+`[date-time] (DateTime: "2017-12-31T23:59:59+00:00")`
+`[date-time] (DateTimeImmutable: "2017-12-31T23:59:59+00:00")`

tests/unit/Stringifiers/DateTimeStringifierTest.php

@@ -17,6 +17,7 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use PHPUnit\Framework\TestCase;
+use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 use Respect\Stringifier\Stringifiers\DateTimeStringifier;
 
@@ -37,7 +38,12 @@ public function shouldNotConvertWhenNotInstanceOfDateTimeInterface(): void
             ->expects($this->never())
             ->method('stringify');
 
-        $dateTimeStringifier = new DateTimeStringifier($stringifierMock, 'c');
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->never())
+            ->method('quote');
+
+        $dateTimeStringifier = new DateTimeStringifier($stringifierMock, $quoterMock, 'c');
 
         self::assertNull($dateTimeStringifier->stringify('NotDateTimeInterface', 0));
     }
@@ -49,25 +55,34 @@ public function shouldNotConvertWhenNotInstanceOfDateTimeInterface(): void
      *
      * @param DateTimeInterface $raw
      * @param string $format
-     * @param string $expectedValue
+     * @param string $expected
      */
     public function shouldConvertDateTimeInterfaceToString(
         DateTimeInterface $raw,
         string $format,
-        string $expectedValue
+        string $expected
     ): void {
         $depth = 0;
 
+        $formattedDateTime = $raw->format($format);
+
         $stringifierMock = $this->createMock(Stringifier::class);
         $stringifierMock
             ->expects($this->once())
             ->method('stringify')
-            ->with($expectedValue, $depth)
-            ->willReturn($expectedValue);
+            ->with($formattedDateTime, $depth + 1)
+            ->willReturn($formattedDateTime);
+
+        $quoterMock = $this->createMock(Quoter::class);
+        $quoterMock
+            ->expects($this->once())
+            ->method('quote')
+            ->with($expected)
+            ->willReturn($expected);
 
-        $dateTimeStringifier = new DateTimeStringifier($stringifierMock, $format);
+        $dateTimeStringifier = new DateTimeStringifier($stringifierMock, $quoterMock, $format);
 
-        self::assertSame($expectedValue, $dateTimeStringifier->stringify($raw, $depth));
+        self::assertSame($expected, $dateTimeStringifier->stringify($raw, $depth));
     }
 
     public function validValuesProvider(): array
@@ -76,9 +91,9 @@ public function validValuesProvider(): array
         $dateTimeImmutable = DateTimeImmutable::createFromMutable($dateTime);
 
         return [
-            [$dateTime, 'd/m/Y', '31/12/2017'],
-            [$dateTime, 'c', '2017-12-31T23:59:59+00:00'],
-            [$dateTimeImmutable, 'Y-m-d H:i:s', '2017-12-31 23:59:59'],
+            [$dateTime, 'd/m/Y', '[date-time] (DateTime: 31/12/2017)'],
+            [$dateTime, 'c', '[date-time] (DateTime: 2017-12-31T23:59:59+00:00)'],
+            [$dateTimeImmutable, 'Y-m-d H:i:s', '[date-time] (DateTimeImmutable: 2017-12-31 23:59:59)'],
         ];
     }
 }