Merge pull request #6753 from kenjis/refactor-date-now

refactor: make now() testable

Author: kenjis

system/Helpers/date_helper.php

@@ -9,6 +9,8 @@
  * the LICENSE file that was distributed with this source code.
  */
 
+use CodeIgniter\I18n\Time;
+
 // CodeIgniter Date Helpers
 
 if (! function_exists('now')) {
@@ -18,20 +20,29 @@
      * Returns time() based on the timezone parameter or on the
      * app_timezone() setting
      *
-     * @param string $timezone
-     *
      * @throws Exception
      */
     function now(?string $timezone = null): int
     {
         $timezone = empty($timezone) ? app_timezone() : $timezone;
 
         if ($timezone === 'local' || $timezone === date_default_timezone_get()) {
-            return time();
+            $time = Time::now();
+
+            return $time->getTimestamp();
         }
 
-        $datetime = new DateTime('now', new DateTimeZone($timezone));
-        sscanf($datetime->format('j-n-Y G:i:s'), '%d-%d-%d %d:%d:%d', $day, $month, $year, $hour, $minute, $second);
+        $time = Time::now($timezone);
+        sscanf(
+            $time->format('j-n-Y G:i:s'),
+            '%d-%d-%d %d:%d:%d',
+            $day,
+            $month,
+            $year,
+            $hour,
+            $minute,
+            $second
+        );
 
         return mktime($hour, $minute, $second, $month, $day, $year);
     }

tests/system/Helpers/DateHelperTest.php

@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\Helpers;
 
+use CodeIgniter\I18n\Time;
 use CodeIgniter\Test\CIUnitTestCase;
 use DateTimeZone;
 
@@ -29,13 +30,24 @@ protected function setUp(): void
 
     public function testNowDefault()
     {
-        $this->assertCloseEnough(now(), time());  // close enough
+        Time::setTestNow('June 20, 2022', 'America/Chicago');
+
+        $this->assertSame(now(), 1_655_701_200);
+
+        Time::setTestNow();
     }
 
     public function testNowSpecific()
     {
+        Time::setTestNow('June 20, 2022', 'America/Chicago');
+
         // Chicago should be two hours ahead of Vancouver
-        $this->assertCloseEnough(7200, now('America/Chicago') - now('America/Vancouver'));
+        $this->assertSame(
+            7200,
+            now('America/Chicago') - now('America/Vancouver')
+        );
+
+        Time::setTestNow();
     }
 
     public function testTimezoneSelectDefault()
@@ -68,7 +80,10 @@ public function testTimezoneSelectSpecific()
 
         $expected .= ("</select>\n");
 
-        $this->assertSame($expected, timezone_select('custom-select', 'Asia/Jakarta', $spesificRegion));
+        $this->assertSame(
+            $expected,
+            timezone_select('custom-select', 'Asia/Jakarta', $spesificRegion)
+        );
     }
 
     public function testTimezoneSelectSingle()
@@ -86,6 +101,9 @@ public function testTimezoneSelectSingle()
 
         $expected .= ("</select>\n");
 
-        $this->assertSame($expected, timezone_select('custom-select', 'Asia/Jakarta', $spesificRegion, $country));
+        $this->assertSame(
+            $expected,
+            timezone_select('custom-select', 'Asia/Jakarta', $spesificRegion, $country)
+        );
     }
 }