Author SHA1 Message Date
Jérôme Gamez 0754922206 Release 4.0.0 2026-08-23 23:06:53 +02:00
Jérôme Gamez df585ab815 Update changelog 2026-08-23 20:09:20 +02:00
Jérôme Gamez c094cf87e3 Don't assume the local time zone is not Europe/Berlin 2026-08-23 20:03:38 +02:00
Jérôme Gamez c2243a5934 Harden WrappingClock validation
Wrapping an object should not call it just to validate the return value.
Instead, we check the method signature when the object is wrapped, and
the return value at runtime. We were implicitly checking it already
with the `assert()` calls.
2026-08-23 20:03:38 +02:00
Jérôme Gamez e8f20c112e Don't auto-merge dependabot PRs 2026-08-23 19:35:54 +02:00
Jérôme Gamez 7db7032723 Type time zone input 2026-08-23 19:33:15 +02:00
Jérôme Gamez 8f5274748c Update README 2026-08-23 19:30:12 +02:00
Jérôme Gamez e73aacc19c Update to PHPUnit 12 2026-08-22 23:51:52 +02:00
Jérôme Gamez c062aff727 Drop support for PHP versions before 8.3 2026-08-22 23:51:52 +02:00
Jérôme Gamez b4408036c1 Move source and test files up one level 2026-08-22 23:24:55 +02:00
Jérôme Gamez 0a55b7a019 Remove deprecated Clock interface 2026-08-22 23:24:55 +02:00
Jérôme Gamez 9818902960 Release 3.1.0 2026-08-22 23:09:57 +02:00
Jérôme Gamez 622d86328b Deprecate Clock interface 2026-08-22 00:11:17 +02:00
Jérôme Gamez bebff7fd27 Test against PHP 8.6 2026-08-21 00:00:48 +02:00
20 changed files with 247 additions and 269 deletions
@@ -1,23 +0,0 @@
name: "Dependabot auto-merge"
on: [pull_request_target] # yamllint disable-line rule:truthy
permissions:
contents: "write"
jobs:
dependabot:
runs-on: "ubuntu-latest"
if: "${{ github.actor == 'dependabot[bot]' }}"
steps:
- name: "Dependabot metadata"
id: "metadata"
uses: "dependabot/[email protected]"
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"
- name: "Enable auto-merge for Dependabot PRs"
if: "${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }}"
run: "gh pr merge --auto --merge \"$PR_URL\""
env:
PR_URL: "${{github.event.pull_request.html_url}}"
GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
+7 -9
View File
@@ -4,9 +4,7 @@ on:
pull_request:
push:
branches:
- '1.x'
- '2.x'
- '3.x'
- '4.x'
jobs:
tests:
@@ -16,18 +14,16 @@ jobs:
strategy:
matrix:
php:
- "8.0"
- "8.1"
- "8.2"
- "8.3"
- "8.4"
- "8.5"
include:
- php: "8.5"
composer-options: "--ignore-platform-reqs"
- php: "8.6"
composer-options: "--ignore-platform-req=php+"
steps:
- name: Checkout code
uses: actions/checkout@v7
uses: actions/checkout@v6
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
@@ -38,6 +34,8 @@ jobs:
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: "ramsey/composer-install@v4"
with:
composer-options: "${{ matrix.composer-options }}"
- name: Setup problem matchers for PHP
run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+17
View File
@@ -1,5 +1,22 @@
# CHANGELOG
## Unreleased
## 4.0.0 - 2026-08-23
* Dropped support for PHP <8.3.
* Removed the deprecated `Beste\Clock` interface. Clock implementations now implement
`Psr\Clock\ClockInterface` directly.
* `WrappingClock` will throw an `InvalidArgumentException` if the given object doesn't behave like
a PSR-20 clock and will throw an `UnexpectedValueException` if a later call does not return
`DateTimeImmutable`.
## 3.1.0 - 2026-08-22
Deprecated `Beste\Clock` in favor of `Psr\Clock\ClockInterface`. The implementations continue to implement
the deprecated interface for backwards compatibility. Please type against `Psr\Clock\ClockInterface`.
`Beste\Clock` will be removed in 4.0.
## 3.0.0 - 2022-11-26
This release replaces `stella-maris/clock` with `psr/clock`.
+4 -6
View File
@@ -114,8 +114,8 @@ printf("\nAfter turning back the clock 5 minutes, it's %s", $frozenClock->now()-
### `MinuteClock`
In some cases, microseconds, milliseconds, or even seconds are too precise for some use cases - sometimes it's just
enough if something happened in the same minute. Using the minute
In some cases, microseconds, milliseconds, or even seconds are too precise. Sometimes it is enough to know that
something happened within the same minute. `MinuteClock` removes seconds and fractions of a second from another clock.
```php
# examples/minute_clock.php
@@ -141,10 +141,8 @@ printf("For %s, the minute clock still returns %s\n",
### `WrappingClock`
If you already have an object with a `now()` method returning a `DateTimeImmutable` object, you can wrap it
in a `WrappingClock` to make it a "real" Clock.
as a "real" clock.
If you already have an object with a `now()` method returning a `DateTimeImmutable`, you can wrap it in a
`WrappingClock` to make it a PSR-20 clock.
```php
# examples/wrapping_clock.php
+5 -8
View File
@@ -11,7 +11,7 @@
}
],
"require": {
"php": "^8.0",
"php": "^8.3",
"psr/clock": "^1.0"
},
"require-dev": {
@@ -19,19 +19,16 @@
"phpstan/phpstan": "^2.1",
"phpstan/phpstan-phpunit": "^2.0",
"phpstan/phpstan-strict-rules": "^2.0",
"phpunit/phpunit": "^9.6.20"
"phpunit/phpunit": "^12.5"
},
"autoload": {
"psr-4": {
"Beste\\Clock\\": "src/Clock"
},
"files": [
"src/Clock.php"
]
"Beste\\Clock\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Beste\\Clock\\Tests\\": "tests/Clock"
"Beste\\Clock\\Tests\\": "tests"
}
},
"provide": {
+7 -7
View File
@@ -1,9 +1,9 @@
<?xml version="1.0"?>
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.5/phpunit.xsd"
bootstrap="vendor/autoload.php"
cacheResultFile=".build/phpunit/phpunit.cache"
beStrictAboutCoversAnnotation="true"
cacheDirectory=".build/phpunit/cache"
beStrictAboutCoverageMetadata="true"
colors="true"
>
<testsuites>
@@ -12,10 +12,10 @@
</testsuite>
</testsuites>
<coverage>
<source>
<include>
<directory>src/Clock</directory>
<directory>src</directory>
</include>
</coverage>
</source>
</phpunit>
-12
View File
@@ -1,12 +0,0 @@
<?php
declare(strict_types=1);
namespace Beste;
use Psr\Clock\ClockInterface;
interface Clock extends ClockInterface
{
}
@@ -4,12 +4,11 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use DateTimeImmutable;
use DateTimeZone;
use Psr\Clock\ClockInterface;
final class FrozenClock implements Clock
final class FrozenClock implements ClockInterface
{
private DateTimeImmutable $frozenAt;
@@ -4,13 +4,13 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use DateTimeImmutable;
use DateTimeZone;
use InvalidArgumentException;
use Psr\Clock\ClockInterface;
use Throwable;
final class LocalizedClock implements Clock
final class LocalizedClock implements ClockInterface
{
private DateTimeZone $timeZone;
@@ -19,10 +19,7 @@ final class LocalizedClock implements Clock
$this->timeZone = $timeZone;
}
/**
* @param DateTimeZone|string $timeZone
*/
public static function in($timeZone): self
public static function in(DateTimeZone|string $timeZone): self
{
if (is_string($timeZone)) {
try {
@@ -4,11 +4,10 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use DateTimeImmutable;
use Psr\Clock\ClockInterface;
final class MinuteClock implements Clock
final class MinuteClock implements ClockInterface
{
private ClockInterface $clock;
@@ -4,10 +4,10 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use DateTimeImmutable;
use Psr\Clock\ClockInterface;
final class SystemClock implements Clock
final class SystemClock implements ClockInterface
{
private function __construct()
{
+2 -2
View File
@@ -4,11 +4,11 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use DateTimeImmutable;
use DateTimeZone;
use Psr\Clock\ClockInterface;
final class UTCClock implements Clock
final class UTCClock implements ClockInterface
{
private DateTimeZone $timeZone;
@@ -4,12 +4,14 @@ declare(strict_types=1);
namespace Beste\Clock;
use Beste\Clock;
use Closure;
use DateTimeImmutable;
use InvalidArgumentException;
use Psr\Clock\ClockInterface;
use ReflectionMethod;
use UnexpectedValueException;
final class WrappingClock implements Clock
final class WrappingClock implements ClockInterface
{
private ClockInterface $wrappedClock;
@@ -18,6 +20,9 @@ final class WrappingClock implements Clock
$this->wrappedClock = $wrappedClock;
}
/**
* @throws InvalidArgumentException when the given object doesn't behave like a clock.
*/
public static function wrapping(object $clock): self
{
if ($clock instanceof ClockInterface) {
@@ -25,28 +30,30 @@ final class WrappingClock implements Clock
}
if (!method_exists($clock, 'now')) {
throw new InvalidArgumentException('$clock must implement StellaMaris\Clock\ClockInterface or have a now() method');
throw new InvalidArgumentException('$clock must implement Psr\Clock\ClockInterface or have a now() method');
}
if (!($clock->now() instanceof DateTimeImmutable)) {
throw new InvalidArgumentException('$clock->now() must return a DateTimeImmutable');
$method = new ReflectionMethod($clock, 'now');
if (!$method->isPublic() || $method->getNumberOfRequiredParameters() > 0) {
throw new InvalidArgumentException('$clock->now() must be public and accept no required parameters');
}
$wrappedClock = new class($clock) implements ClockInterface {
private object $clock;
$wrappedClock = new class($method->getClosure($clock)) implements ClockInterface {
private Closure $now;
public function __construct(object $clock)
public function __construct(Closure $now)
{
$this->clock = $clock;
$this->now = $now;
}
public function now(): DateTimeImmutable
{
assert(method_exists($this->clock, 'now'));
$now = ($this->now)();
$now = $this->clock->now();
assert($now instanceof DateTimeImmutable);
if (!$now instanceof DateTimeImmutable) {
throw new UnexpectedValueException('$clock->now() must return a DateTimeImmutable');
}
return $now;
}
-88
View File
@@ -1,88 +0,0 @@
<?php
declare(strict_types=1);
namespace Beste\Clock\Tests;
use Beste\Clock\FrozenClock;
use Beste\Clock\WrappingClock;
use DateTimeImmutable;
use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
/**
* @internal
* @coversDefaultClass \Beste\Clock\WrappingClock
*/
final class WrappingClockTest extends TestCase
{
/**
* @test
*
* @covers ::__construct
* @covers ::wrapping
* @covers ::now
*/
public function itWrapsAClockInterface(): void
{
$clock = FrozenClock::fromUTC();
$wrappedClock = WrappingClock::wrapping($clock);
self::assertSame(
$clock->now()->format(DATE_ATOM),
$wrappedClock->now()->format(DATE_ATOM)
);
}
/**
* @test
*
* @covers ::wrapping
*/
public function itWrapsAnObjectWithANowMethod(): void
{
$now = FrozenClock::fromUTC()->now();
$clock = new class($now) {
private DateTimeImmutable $now;
public function __construct(DateTimeImmutable $now)
{
$this->now = $now;
}
public function now(): DateTimeImmutable
{
return $this->now;
}
};
$wrappedClock = WrappingClock::wrapping($clock);
self::assertSame(
$now->format(DATE_ATOM),
$wrappedClock->now()->format(DATE_ATOM)
);
}
/**
* @test
*
* @covers ::wrapping
*/
public function itRejectsObjectsWithANowMethodReturningANonDateTimeImmutable(): void
{
$clock = new class() {
public function now(): string
{
return 'foo';
}
};
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('$clock->now() must return a DateTimeImmutable');
WrappingClock::wrapping($clock);
}
}
@@ -6,21 +6,18 @@ namespace Beste\Clock\Tests;
use Beste\Clock\FrozenClock;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
use Psr\Clock\ClockInterface;
/**
* @internal
* @coversDefaultClass \Beste\Clock\FrozenClock
*/
#[CoversClass(FrozenClock::class)]
final class FrozenClockTest extends TestCase
{
/**
* @test
* @covers ::__construct
* @covers ::at
* @covers ::now
*/
#[Test]
public function itFreezesTime(): void
{
$now = new DateTimeImmutable('2021-03-21 22:16:00');
@@ -29,14 +26,7 @@ final class FrozenClockTest extends TestCase
self::assertEquals($now, $clock->now());
}
/**
* @test
*
* @uses ::__construct
* @uses ::fromUTC
*
* @covers ::now
*/
#[Test]
public function itReturnsAnEqualNowButNotTheSame(): void
{
$clock = FrozenClock::fromUTC();
@@ -48,14 +38,7 @@ final class FrozenClockTest extends TestCase
self::assertNotSame($first, $second);
}
/**
* @test
*
* @uses ::__construct
* @uses ::now
*
* @covers ::withNowFrom
*/
#[Test]
public function itFreezesTimeFromAnotherClock(): void
{
$now = new DateTimeImmutable('now');
@@ -71,14 +54,7 @@ final class FrozenClockTest extends TestCase
self::assertEquals($now, $frozenClock->now());
}
/**
* @test
*
* @uses ::__construct
* @uses ::now
*
* @covers ::fromUTC
*/
#[Test]
public function itFreezesTheCurrentUTCTime(): void
{
$clock = FrozenClock::fromUTC();
@@ -87,15 +63,7 @@ final class FrozenClockTest extends TestCase
self::assertEquals($clock->now(), $clock->now());
}
/**
* @test
*
* @uses ::__construct
* @uses ::at
* @uses ::now
*
* @covers ::setTo
*/
#[Test]
public function itCanBeSet(): void
{
$now = new DateTimeImmutable('2021-03-21 18:18:18');
@@ -7,18 +7,17 @@ namespace Beste\Clock\Tests;
use Beste\Clock\LocalizedClock;
use DateTimeZone;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
/**
* @internal
* @coversDefaultClass \Beste\Clock\LocalizedClock
*/
#[CoversClass(LocalizedClock::class)]
final class LocalizedClockTest extends TestCase
{
/**
* @test
* @covers ::in
*/
#[Test]
public function itRejectsAnInvalidTimeZone(): void
{
$this->expectException(InvalidArgumentException::class);
@@ -26,12 +25,7 @@ final class LocalizedClockTest extends TestCase
LocalizedClock::in('invalid');
}
/**
* @test
* @covers ::__construct
* @covers ::in
* @covers ::now
*/
#[Test]
public function itUsesTheGivenTimeZone(): void
{
$timeZone = new DateTimeZone('Asia/Bangkok');
@@ -41,12 +35,7 @@ final class LocalizedClockTest extends TestCase
self::assertSame($timeZone->getName(), $now->getTimezone()->getName());
}
/**
* @test
* @covers ::__construct
* @covers ::in
* @covers ::now
*/
#[Test]
public function itAcceptsTheTimeZoneAsAString(): void
{
$timeZone = 'Pacific/Guam';
@@ -6,30 +6,23 @@ namespace Beste\Clock\Tests;
use Beste\Clock\MinuteClock;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
use Psr\Clock\ClockInterface;
/**
* @internal
* @coversDefaultClass \Beste\Clock\MinuteClock
*/
#[CoversClass(MinuteClock::class)]
final class MinuteClockTest extends TestCase
{
/**
* @test
*
* @covers ::__construct
* @covers ::wrapping
* @covers ::now
* @covers ::floor
*
* @uses \Beste\Clock\FrozenClock
*
* @dataProvider dateTimeStringProvider
*/
#[Test]
#[DataProvider('dateTimeStringProvider')]
public function itDiscardsEverythingSmallerThanMinutes(string $format, string $input, string $expected): void
{
$mockClock = $this->createMock(ClockInterface::class);
$mockClock = self::createStub(ClockInterface::class);
$mockClock->method('now')->willReturn(new DateTimeImmutable($input));
// Just to be sure that the test input is valid ^^
@@ -43,7 +36,7 @@ final class MinuteClockTest extends TestCase
/**
* @return array<string, string[]>
*/
public function dateTimeStringProvider(): array
public static function dateTimeStringProvider(): array
{
return [
'microseconds' => [
@@ -5,12 +5,14 @@ declare(strict_types=1);
namespace Beste\Clock\Tests;
use Beste\Clock\SystemClock;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
/**
* @internal
* @coversDefaultClass \Beste\Clock\SystemClock
*/
#[CoversClass(SystemClock::class)]
final class SystemClockTest extends TestCase
{
private string $defaultTimeZone;
@@ -25,16 +27,10 @@ final class SystemClockTest extends TestCase
date_default_timezone_set($this->defaultTimeZone);
}
/**
* @test
*
* @covers ::__construct
* @covers ::create
* @covers ::now
*/
#[Test]
public function itUsesTheSystemTimeZone(): void
{
$timeZone = 'Europe/Berlin';
$timeZone = $this->defaultTimeZone === 'Europe/Berlin' ? 'UTC' : 'Europe/Berlin';
self::assertNotSame($timeZone, $this->defaultTimeZone);
date_default_timezone_set($timeZone);
@@ -5,12 +5,14 @@ declare(strict_types=1);
namespace Beste\Clock\Tests;
use Beste\Clock\UTCClock;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
/**
* @internal
* @coversDefaultClass \Beste\Clock\UTCClock
*/
#[CoversClass(UTCClock::class)]
final class UTCClockTest extends TestCase
{
private string $defaultTimeZone;
@@ -25,13 +27,7 @@ final class UTCClockTest extends TestCase
date_default_timezone_set($this->defaultTimeZone);
}
/**
* @test
*
* @covers ::__construct
* @covers ::create
* @covers ::now
*/
#[Test]
public function itUsesUTCRegardlessOfTheSystemTimeZone(): void
{
date_default_timezone_set('Europe/Berlin');
+147
View File
@@ -0,0 +1,147 @@
<?php
declare(strict_types=1);
namespace Beste\Clock\Tests;
use Beste\Clock\FrozenClock;
use Beste\Clock\WrappingClock;
use DateTimeImmutable;
use DateTimeZone;
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\Attributes\UsesClass;
use PHPUnit\Framework\TestCase;
use UnexpectedValueException;
/**
* @internal
*/
#[CoversClass(WrappingClock::class)]
#[UsesClass(FrozenClock::class)]
final class WrappingClockTest extends TestCase
{
#[Test]
public function itWrapsAClockInterface(): void
{
$clock = FrozenClock::fromUTC();
$wrappedClock = WrappingClock::wrapping($clock);
self::assertSame(
$clock->now()->format(DATE_ATOM),
$wrappedClock->now()->format(DATE_ATOM)
);
}
#[Test]
public function itWrapsAnObjectWithANowMethod(): void
{
$now = FrozenClock::fromUTC()->now();
$clock = new class($now) {
private DateTimeImmutable $now;
public function __construct(DateTimeImmutable $now)
{
$this->now = $now;
}
public function now(): DateTimeImmutable
{
return $this->now;
}
};
$wrappedClock = WrappingClock::wrapping($clock);
self::assertSame(
$now->format(DATE_ATOM),
$wrappedClock->now()->format(DATE_ATOM)
);
}
#[Test]
public function itDoesNotCallNowWhileWrapping(): void
{
$clock = new class() {
public int $calls = 0;
public function now(): DateTimeImmutable
{
++$this->calls;
return new DateTimeImmutable();
}
};
$wrappedClock = WrappingClock::wrapping($clock);
self::assertSame(0, $clock->calls);
$wrappedClock->now();
self::assertSame(1, $clock->calls);
}
#[Test]
public function itRejectsObjectsWithANowMethodReturningANonDateTimeImmutable(): void
{
$clock = new class() {
public function now(): string
{
return 'foo';
}
};
$this->expectException(UnexpectedValueException::class);
$this->expectExceptionMessage('$clock->now() must return a DateTimeImmutable');
WrappingClock::wrapping($clock)->now();
}
#[Test]
public function itRejectsObjectsWithoutANowMethod(): void
{
$clock = new class() {
};
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('$clock must implement Psr\Clock\ClockInterface or have a now() method');
WrappingClock::wrapping($clock);
}
#[Test]
public function itRejectsObjectsWithANonPublicNowMethod(): void
{
$clock = new class() {
protected function now(): DateTimeImmutable
{
return new DateTimeImmutable();
}
};
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('$clock->now() must be public and accept no required parameters');
WrappingClock::wrapping($clock);
}
#[Test]
public function itRejectsObjectsWithANowMethodRequiringArguments(): void
{
$clock = new class() {
public function now(string $timeZone): DateTimeImmutable
{
return new DateTimeImmutable('now', new DateTimeZone($timeZone));
}
};
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('$clock->now() must be public and accept no required parameters');
WrappingClock::wrapping($clock);
}
}