Merge pull request #51 from lcobucci/add-named-constructors-to-system…

…-clock

Add named constructors to system clock

README.md

@@ -43,13 +43,18 @@ function filterData(Clock $clock, array $objects): array
 }
 
 // Object that will return the current time based on the given timezone
-$clock = new SystemClock(new DateTimeZone('UTC'));
+// $clock = SystemClock::fromSystemTimezone();
+// $clock = SystemClock::fromUTC();
+$clock = new SystemClock(new DateTimeZone('America/Sao_Paulo'));
 
 // Test object that always returns a fixed time object
 $clock = new FrozenClock(
     new DateTimeImmutable('2017-05-07 18:49:30')
 );
 
+// Or creating a frozen clock from the current time on UTC
+// $clock = FrozenClock::fromUTC();
+
 $objects = [
     (object) ['expiresAt' => new DateTimeImmutable('2017-12-31 23:59:59')],
     (object) ['expiresAt' => new DateTimeImmutable('2017-06-30 23:59:59')],

src/FrozenClock.php

@@ -15,7 +15,7 @@ public function __construct(DateTimeImmutable $now)
         $this->now = $now;
     }
 
-    public static function fromUTC(): FrozenClock
+    public static function fromUTC(): self
     {
         return new self(new DateTimeImmutable('now', new DateTimeZone('UTC')));
     }

src/SystemClock.php

@@ -17,6 +17,16 @@ public function __construct(?DateTimeZone $timezone = null)
         $this->timezone = $timezone ?? new DateTimeZone(date_default_timezone_get());
     }
 
+    public static function fromUTC(): self
+    {
+        return new self(new DateTimeZone('UTC'));
+    }
+
+    public static function fromSystemTimezone(): self
+    {
+        return new self(new DateTimeZone(date_default_timezone_get()));
+    }
+
     public function now(): DateTimeImmutable
     {
         return new DateTimeImmutable('now', $this->timezone);

test/FrozenClockTest.php

@@ -47,20 +47,15 @@ public function nowSetChangesTheObject(): void
      * @test
      *
      * @covers \Lcobucci\Clock\FrozenClock::fromUTC
+     * @covers \Lcobucci\Clock\FrozenClock::__construct
      *
-     * @uses \Lcobucci\Clock\FrozenClock::__construct
      * @uses \Lcobucci\Clock\FrozenClock::now
      */
     public function fromUTCCreatesClockFrozenAtCurrentSystemTimeInUTC(): void
     {
-        $lower = new DateTimeImmutable();
         $clock = FrozenClock::fromUTC();
-        $upper = new DateTimeImmutable();
-
-        $now = $clock->now();
+        $now   = $clock->now();
 
-        self::assertGreaterThanOrEqual($lower->getTimestamp(), $now->getTimestamp());
-        self::assertLessThanOrEqual($upper->getTimestamp(), $now->getTimestamp());
-        self::assertEquals('UTC', $now->getTimezone()->getName());
+        self::assertSame('UTC', $now->getTimezone()->getName());
     }
 }

test/SystemClockTest.php

@@ -40,4 +40,36 @@ public function nowShouldRespectTheProvidedTimezone(): void
         self::assertGreaterThanOrEqual($lower, $now);
         self::assertLessThanOrEqual($upper, $now);
     }
+
+    /**
+     * @test
+     *
+     * @covers \Lcobucci\Clock\SystemClock::fromUTC
+     * @covers \Lcobucci\Clock\SystemClock::__construct
+     *
+     * @uses \Lcobucci\Clock\SystemClock::now
+     */
+    public function fromUTCCreatesAnInstanceUsingUTCAsTimezone(): void
+    {
+        $clock = SystemClock::fromUTC();
+        $now   = $clock->now();
+
+        self::assertSame('UTC', $now->getTimezone()->getName());
+    }
+
+    /**
+     * @test
+     *
+     * @covers \Lcobucci\Clock\SystemClock::fromSystemTimezone
+     * @covers \Lcobucci\Clock\SystemClock::__construct
+     *
+     * @uses \Lcobucci\Clock\SystemClock::now
+     */
+    public function fromSystemTimezoneCreatesAnInstanceUsingTheDefaultTimezoneInSystem(): void
+    {
+        $clock = SystemClock::fromSystemTimezone();
+        $now   = $clock->now();
+
+        self::assertSame(date_default_timezone_get(), $now->getTimezone()->getName());
+    }
 }