Added possibility to format time, removed redundant default timezone (#25)

Author: norberttech

composer.json

@@ -7,7 +7,7 @@
     "minimum-stability": "dev",
     "require": {
         "php": ">=7.4.2",
-        "aeon-php/calendar": ">=0.7.0",
+        "aeon-php/calendar": ">=0.9.0",
         "twig/twig": "^1.42|^2.10|^3"
     },
     "require-dev": {

composer.lock

@@ -10,6 +10,7 @@
 use Aeon\Calendar\Gregorian\Day;
 use Aeon\Calendar\Gregorian\Interval;
 use Aeon\Calendar\Gregorian\Month;
+use Aeon\Calendar\Gregorian\Time;
 use Aeon\Calendar\Gregorian\TimeZone;
 use Aeon\Calendar\Gregorian\Year;
 use Aeon\Calendar\TimeUnit;
@@ -25,27 +26,22 @@ final class CalendarExtension extends AbstractExtension
 
     private string $defaultDayFormat;
 
-    private ?string $defaultTimeZone;
+    private string $defaultTimeFormat;
 
-    public function __construct(Calendar $calendar, string $defaultDateTimeFormat = 'Y-m-d H:i:s', string $defaultDayFormat = 'Y-m-d', string $defaultTimeZone = null)
+    public function __construct(Calendar $calendar, string $defaultDateTimeFormat = 'Y-m-d H:i:s', string $defaultDayFormat = 'Y-m-d', string $defaultTimeFormat = 'H:i:s')
     {
-        if (\is_string($defaultTimeZone)) {
-            if (!TimeZone::isValid($defaultTimeZone)) {
-                throw new InvalidArgumentException($defaultTimeZone . ' is not valid timezone.');
-            }
-        }
-
         $this->calendar = $calendar;
         $this->defaultDateTimeFormat = $defaultDateTimeFormat;
         $this->defaultDayFormat = $defaultDayFormat;
-        $this->defaultTimeZone = $defaultTimeZone;
+        $this->defaultTimeFormat = $defaultTimeFormat;
     }
 
     public function getFilters() : array
     {
         return [
-            new TwigFilter('aeon_date_format', [$this, 'aeon_date_format']),
+            new TwigFilter('aeon_datetime_format', [$this, 'aeon_datetime_format']),
             new TwigFilter('aeon_day_format', [$this, 'aeon_day_format']),
+            new TwigFilter('aeon_time_format', [$this, 'aeon_time_format']),
             new TwigFilter('aeon_in_seconds', [$this, 'aeon_in_seconds']),
             new TwigFilter('aeon_in_seconds_precise', [$this, 'aeon_in_seconds_precise']),
             new TwigFilter('aeon_interval', [$this, 'aeon_interval']),
@@ -64,6 +60,7 @@ public function getFunctions() : array
     {
         return [
             new TwigFunction('aeon_now', [$this, 'aeon_now']),
+            new TwigFunction('aeon_current_time', [$this, 'aeon_current_time']),
             new TwigFunction('aeon_current_day', [$this, 'aeon_current_day']),
             new TwigFunction('aeon_current_month', [$this, 'aeon_current_month']),
             new TwigFunction('aeon_current_year', [$this, 'aeon_current_year']),
@@ -74,23 +71,32 @@ public function getFunctions() : array
         ];
     }
 
-    public function aeon_date_format(DateTime $dateTime, string $format = null, string $timezone = null) : string
+    public function aeon_datetime_format(DateTime $dateTime, string $format = null, string $timezone = null) : string
     {
-        $tz = \is_string($timezone)
-            ? $timezone
-            : (\is_string($this->defaultTimeZone) ? $this->defaultTimeZone : null);
+        $tz = (\is_string($timezone) && TimeZone::isValid($timezone))
+            ? new TimeZone($timezone)
+            : null;
 
         $fmt = \is_string($format)
             ? $format
             : $this->defaultDateTimeFormat;
 
-        if (\is_string($tz)) {
-            return $dateTime->toTimeZone(new TimeZone($tz))->format($fmt);
+        if ($tz instanceof TimeZone) {
+            return $dateTime->toTimeZone($tz)->format($fmt);
         }
 
         return $dateTime->format($fmt);
     }
 
+    public function aeon_time_format(Time $time, string $format = null) : string
+    {
+        $fmt = \is_string($format)
+            ? $format
+            : $this->defaultTimeFormat;
+
+        return $time->format($fmt);
+    }
+
     public function aeon_day_format(Day $day, string $format = null) : string
     {
         $fmt = \is_string($format)
@@ -158,6 +164,11 @@ public function aeon_now(string $timezone = null) : DateTime
         return $this->calendar->now();
     }
 
+    public function aeon_current_time() : Time
+    {
+        return $this->calendar->now()->time();
+    }
+
     public function aeon_current_day() : Day
     {
         return $this->calendar->currentDay();

src/Aeon/Twig/CalendarExtension.php

@@ -25,7 +25,7 @@ public function test_extension() : void
         $this->assertInstanceOf(ExtensionInterface::class, new CalendarExtension($this->calendarStub));
     }
 
-    public function test_filter_aeon_date() : void
+    public function test_filter_aeon_datetime() : void
     {
         $twig = new Environment(
             new FilesystemLoader(
@@ -34,11 +34,45 @@ public function test_filter_aeon_date() : void
                 ]
             )
         );
-        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d', 'Europe/Warsaw'));
+        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d', 'H:i:s'));
 
         $this->assertStringEqualsFile(
-            __DIR__ . '/Fixtures/filters/aeon_date_format.txt',
-            $twig->render('aeon_date_format.twig.txt')
+            __DIR__ . '/Fixtures/filters/aeon_datetime_format.txt',
+            $twig->render('aeon_datetime_format.twig.txt')
+        );
+    }
+
+    public function test_filter_aeon_day() : void
+    {
+        $twig = new Environment(
+            new FilesystemLoader(
+                [
+                    __DIR__ . '/Fixtures/filters',
+                ]
+            )
+        );
+        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d', 'H:i:s'));
+
+        $this->assertStringEqualsFile(
+            __DIR__ . '/Fixtures/filters/aeon_day_format.txt',
+            $twig->render('aeon_day_format.twig.txt')
+        );
+    }
+
+    public function test_filter_aeon_time() : void
+    {
+        $twig = new Environment(
+            new FilesystemLoader(
+                [
+                    __DIR__ . '/Fixtures/filters',
+                ]
+            )
+        );
+        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d', 'H:i:s'));
+
+        $this->assertStringEqualsFile(
+            __DIR__ . '/Fixtures/filters/aeon_time_format.txt',
+            $twig->render('aeon_time_format.twig.txt')
         );
     }
 
@@ -85,7 +119,7 @@ public function test_function_aeon_now() : void
                 ]
             )
         );
-        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d', 'Europe/Warsaw'));
+        $twig->addExtension(new CalendarExtension($this->calendarStub, 'Y-m-d H:i:sO', 'Y-m-d'));
 
         $this->assertStringEqualsFile(
             __DIR__ . '/Fixtures/functions/aeon_now.txt',

tests/Aeon/Twig/Tests/Integration/CalendarExtensionTest.php

@@ -0,0 +1,5 @@
+{{ aeon_now() | aeon_datetime_format('Y-m-d') }}
+{{ aeon_now() | aeon_datetime_format }}
+{{ aeon_now() | aeon_datetime_format('Y-m-d H:i:s') }}
+{{ aeon_now() | aeon_datetime_format('Y-m-d H:i:s', 'UTC') }}
+{{ aeon_now() | aeon_datetime_format('Y-m-d H:i:s', 'Europe/Warsaw') }}

tests/Aeon/Twig/Tests/Integration/Fixtures/filters/aeon_date_format.twig.txt

@@ -0,0 +1,5 @@
+2020-01-01
+2020-01-01 00:00:00+0000
+2020-01-01 00:00:00
+2020-01-01 00:00:00
+2020-01-01 01:00:00

tests/Aeon/Twig/Tests/Integration/Fixtures/filters/aeon_date_format.txt

@@ -0,0 +1,2 @@
+{{ aeon_current_day() | aeon_day_format('Y m d') }}
+{{ aeon_current_day() | aeon_day_format }}

tests/Aeon/Twig/Tests/Integration/Fixtures/filters/aeon_datetime_format.twig.txt

@@ -0,0 +1,2 @@
+2020 01 01
+2020-01-01