Merge pull request #2235 from Cyberking99/feature/forward-datetime-calls

Forward DateString method calls to DateTime instances

Author: emmadesilva

RELEASE_NOTES.md

@@ -65,6 +65,7 @@ This serves two purposes:
 - The `publish:views` command is now interactive on Unix-like systems in [#2062](https://github.com/hydephp/develop/pull/2062)
 - You can now add custom posts to the blog post feed component when including it directly in [#1893](https://github.com/hydephp/develop/pull/1893)
 - You can now specify sidebar item priorities by adding a numeric prefix to documentation page source file names in [#1709](https://github.com/hydephp/develop/pull/1709)
+- You can now forward method calls to the underlying `DateTime` instance in `DateString` instances in [#2235](https://github.com/hydephp/develop/pull/2235)
 
 ### Changed
 

packages/framework/src/Framework/Features/XmlGenerators/RssFeedGenerator.php

@@ -65,7 +65,7 @@ protected function addDynamicItemData(SimpleXMLElement $item, MarkdownPost $post
         }
 
         if (isset($post->date)) {
-            $this->addChild($item, 'pubDate', $post->date->dateTimeObject->format(DATE_RSS));
+            $this->addChild($item, 'pubDate', $post->date->format(DATE_RSS));
         }
 
         if (isset($post->author)) {

packages/framework/src/Pages/MarkdownPost.php

@@ -37,7 +37,7 @@ class MarkdownPost extends BaseMarkdownPage implements BlogPostSchema
     public static function getLatestPosts(): PageCollection
     {
         return static::all()->sortByDesc(function (self $post): int {
-            return $post->date?->dateTimeObject->getTimestamp() ?? 0;
+            return $post->date?->getTimestamp() ?? 0;
         });
     }
 

packages/framework/src/Support/Models/DateString.php

@@ -6,6 +6,7 @@
 
 use DateTime;
 use Stringable;
+use BadMethodCallException;
 
 /**
  * Parse a date string and create normalized formats.
@@ -46,4 +47,13 @@ public function __toString(): string
     {
         return $this->short;
     }
+
+    public function __call(string $method, array $arguments): mixed
+    {
+        if (method_exists($this->dateTimeObject, $method)) {
+            return $this->dateTimeObject->$method(...$arguments);
+        }
+
+        throw new BadMethodCallException("Method {$method} does not exist on the DateTime object.");
+    }
 }

packages/framework/tests/Unit/DateStringTest.php

@@ -48,4 +48,36 @@ public function testItCanFormatDateStringIntoShortHumanReadableStringUsingMagicM
         $dateString = new DateString('2022-01-01 UTC');
         $this->assertSame('Jan 1st, 2022', (string) $dateString);
     }
+
+    public function testItCanForwardGetTimestampMethodToDateTimeObject()
+    {
+        $dateString = new DateString('2020-01-01 00:00:00 UTC');
+        $expected = (new DateTime('2020-01-01 00:00:00 UTC'))->getTimestamp();
+        $this->assertSame($expected, $dateString->getTimestamp());
+    }
+
+    public function testItCanForwardModifyMethodToDateTimeObject()
+    {
+        $dateString = new DateString('2020-01-01 UTC');
+        $modified = $dateString->modify('+1 day');
+        $this->assertInstanceOf(DateTime::class, $modified);
+        $this->assertSame('2020-01-02', $modified->format('Y-m-d'));
+    }
+
+    public function testItCanForwardSetTimeMethodToDateTimeObject()
+    {
+        $dateString = new DateString('2020-01-01 UTC');
+        $modified = $dateString->setTime(15, 30);
+        $this->assertInstanceOf(DateTime::class, $modified);
+        $this->assertSame('15:30:00', $modified->format('H:i:s'));
+    }
+
+    public function testCallingUndefinedMethodThrowsException()
+    {
+        $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessage('Method nonExistentMethod does not exist on the DateTime object.');
+
+        $dateString = new DateString('2020-01-01 UTC');
+        $dateString->nonExistentMethod();
+    }
 }