feat(human): human readable

Adding in human readable time zones
gaming-engine · Dec 3, 2023 · 644ccd6 · 644ccd6
1 parent 04dfc2e
commit 644ccd6
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 4 deletions.
diff --git a/src/Timezone.php b/src/Timezone.php
@@ -27,17 +27,35 @@ public function __construct(string $timezone)
         }
     }
 
-    public function offset()
+    public function offset(): int
     {
         return $this->timezone->getOffset(
             new DateTime('now', new DateTimeZone('UTC'))
         );
     }
 
+    public function offsetForHumans(): string
+    {
+        $offsetSeconds = $this->offset();
+
+        $offsetHours = floor($offsetSeconds / 3600);
+        $offsetMinutes = floor(($offsetSeconds % 3600) / 60);
+
+        $offsetSign = ($offsetSeconds < 0) ? '-' : '+';
+
+        return sprintf(
+            "(GMT %s%02d:%02d) %s",
+            $offsetSign,
+            abs($offsetHours),
+            abs($offsetMinutes),
+            $this->timezone->getName()
+        );
+    }
+
     /**
      * @throws InvalidPropertyException
      */
-    public function __get($name)
+    public function __get($name): mixed
     {
         if (method_exists($this, $name)) {
             return $this->$name();

diff --git a/tests/TimezoneTest.php b/tests/TimezoneTest.php
@@ -29,13 +29,14 @@ public function timezone_throws_an_exception_if_an_invalid_timezone_is_provided(
     public function timezone_provides_the_correct_offset_from_utc()
     {
         // Arrange
+        $today = new \DateTime();
 
         // Act
         $subject = new Timezone('America/Toronto');
 
         // Assert
         $this->assertEquals(
-            -4 * 60 * 60,
+            ( $today->format('I') === 1 ? -4 : -5) * 60 * 60,
             $subject->offset()
         );
     }
@@ -46,13 +47,14 @@ public function timezone_provides_the_correct_offset_from_utc()
     public function timezone_provides_the_correct_offset_from_utc_through_a_getter()
     {
         // Arrange
+        $today = new \DateTime();
 
         // Act
         $subject = new Timezone('America/Toronto');
 
         // Assert
         $this->assertEquals(
-            -4 * 60 * 60,
+            ( $today->format('I') === 1 ? -4 : -5) * 60 * 60,
             $subject->offset
         );
     }
@@ -90,4 +92,22 @@ public function timezone_returns_the_name_if_asked()
             $result
         );
     }
+
+    /**
+     * @test
+     */
+    public function timezone_returns_the_proper_offset_for_humans_text()
+    {
+        // Arrange
+        $subject = new Timezone('America/Halifax');
+
+        // Act
+        $result = $subject->offsetForHumans();
+
+        // Assert
+        $this->assertEquals(
+            '(GMT -04:00) America/Halifax',
+            $result
+        );
+    }
 }