feat: Allow default time zone to be changed

Author: pl-github

phpstan.neon.dist

@@ -7,6 +7,8 @@ parameters:
 #    excludePaths:
     ignoreErrors:
         - '#has a nullable return type declaration#'
+        - '#has parameter .+ with a nullable type declaration#'
+        - '#has parameter .+ with null as default value#'
     ergebnis:
         noExtends:
           classesAllowedToBeExtended:

rector.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Naming\Rector\Class_\RenamePropertyToMatchTypeRector;
 use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
 
@@ -25,4 +26,10 @@
         SetList::EARLY_RETURN,
         SetList::INSTANCEOF,
     ]);
+
+    $rectorConfig->skip([
+        RenamePropertyToMatchTypeRector::class => [
+            __DIR__ . '/tests',
+        ],
+    ]);
 };

src/Convert/Convert.php

@@ -145,9 +145,13 @@ public static function asDateTimeString(mixed $value): string|null
         return $value->format('c');
     }
 
-    private static function timeZone(): DateTimeZone
+    public static function timeZone(DateTimeZone|string|null $timeZone = null): DateTimeZone
     {
-        if (!self::$dateTimeZone instanceof DateTimeZone) {
+        if (is_string($timeZone)) {
+            self::$dateTimeZone = new DateTimeZone($timeZone);
+        } elseif ($timeZone instanceof DateTimeZone) {
+            self::$dateTimeZone = $timeZone;
+        } elseif (!self::$dateTimeZone instanceof DateTimeZone) {
             self::$dateTimeZone = new DateTimeZone(ini_get('date.timezone'));
         }
 

tests/Convert/AsDateTimeImmutableTest.php

@@ -5,6 +5,7 @@
 namespace Plook\Tests\TypeGuard\Convert;
 
 use DateTimeImmutable;
+use DateTimeZone;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversFunction;
 use PHPUnit\Framework\TestCase;
@@ -22,6 +23,18 @@
 #[CoversFunction('\Plook\TypeGuard\Convert\asString')]
 final class AsDateTimeImmutableTest extends TestCase
 {
+    private readonly DateTimeZone $originalTimeZone;
+
+    protected function setUp(): void
+    {
+        $this->originalTimeZone = Convert::timeZone();
+    }
+
+    protected function tearDown(): void
+    {
+        Convert::timeZone($this->originalTimeZone);
+    }
+
     public function testConvertsStrings(): void
     {
         $result = asDateTimeImmutable('2010-09-08T07:06:05+02:00');
@@ -40,20 +53,40 @@ public function testConvertsStringables(): void
 
     public function testConvertsDateTimeImmutableWithSameTimeZone(): void
     {
-        $dateTimeZone = asDateTimeImmutable(new DateTimeImmutable())->getTimezone();
-
-        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05+00:00', $dateTimeZone));
+        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05', Convert::timeZone()));
 
         self::assertInstanceOf(DateTimeImmutable::class, $result);
         self::assertSame('2010-09-08T07:06:05+00:00', $result->format('c'));
     }
 
     public function testConvertsDateTimeImmutableWithDifferentTimeZone(): void
     {
-        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05+02:00'));
+        $dateTimeZone = new DateTimeZone('Australia/Adelaide');
+
+        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05', $dateTimeZone));
+
+        self::assertInstanceOf(DateTimeImmutable::class, $result);
+        self::assertSame('2010-09-07T21:36:05+00:00', $result->format('c'));
+    }
+
+    public function testConvertsDateTimeImmutableDefaultTimeZoneCanBeChangedByDateTimeZone(): void
+    {
+        Convert::timeZone(new DateTimeZone('Australia/Adelaide'));
+
+        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05+00:00'));
+
+        self::assertInstanceOf(DateTimeImmutable::class, $result);
+        self::assertSame('2010-09-08T16:36:05+09:30', $result->format('c'));
+    }
+
+    public function testConvertsDateTimeImmutableDefaultTimeZoneCanBeChangedByTimeZoneName(): void
+    {
+        Convert::timeZone('Australia/Adelaide');
+
+        $result = asDateTimeImmutable(new DateTimeImmutable('2010-09-08T07:06:05+00:00'));
 
         self::assertInstanceOf(DateTimeImmutable::class, $result);
-        self::assertSame('2010-09-08T05:06:05+00:00', $result->format('c'));
+        self::assertSame('2010-09-08T16:36:05+09:30', $result->format('c'));
     }
 
     public function testDoesNotTouchNull(): void