Release 3.1.0

github-actions(deps): bump dependabot/fetch-metadata from 3.0.0 to 3.1.0

.gitattributes

@@ -6,4 +6,3 @@
 /.gitignore                     export-ignore
 /phpstan.neon.dist              export-ignore
 /phpunit.xml.dist               export-ignore
-/psalm.xml.dist                 export-ignore

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      include: "scope"
+      prefix: "github-actions"
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"

.github/settings.yml

@@ -0,0 +1,2 @@
+# https://probot.github.io/apps/settings/
+_extends: beste/.github

.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,23 @@
+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}}"

.github/workflows/tests.yml

@@ -4,26 +4,31 @@ on:
   pull_request:
   push:
     branches:
-      - 'main'
+      - '1.x'
+      - '2.x'
+      - '3.x'
 
 jobs:
   tests:
     name: PHP ${{ matrix.php }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:
         php:
-          - "7.4"
           - "8.0"
           - "8.1"
-        dependencies:
+          - "8.2"
-          - "lowest"
+          - "8.3"
-          - "highest"
+          - "8.4"
+          - "8.5"
+        include:
+          - php: "8.6"
+            composer-options: "--ignore-platform-req=php+"
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -33,9 +38,8 @@ jobs:
         env:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: "ramsey/composer-install@v1"
+      - uses: "ramsey/composer-install@v4"
         with:
-          dependency-versions: "${{ matrix.dependencies }}"
           composer-options: "${{ matrix.composer-options }}"
 
       - name: Setup problem matchers for PHP
@@ -44,9 +48,6 @@ jobs:
       - name: Run PHPStan
         run: vendor/bin/phpstan analyse --error-format=github
 
-      - name: Run Psalm
-        run: vendor/bin/psalm --output-format=github
-
       - name: Setup Problem Matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 

.gitignore

@@ -4,4 +4,3 @@
 /composer.lock
 /phpstan.neon
 /phpunit.xml
-/psalm.xml

CHANGELOG.md

@@ -1,8 +1,32 @@
 # CHANGELOG
 
-## [Unreleased]
+## Unreleased
+
+## 3.1.0 - 2026-08-22
+
+Deprecates `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`.
+
+## 2.3.1 - 2022-11-25
+This release reverts the change to implement `psr/clock` directly, to not break dependents who rely on `stella-maris/clock`
+
+## 2.3.0 - 2022-11-25
+This release re-introduces support for PHP ^8.0 and implements the freshly released `psr/clock` (PSR-20) directly.
+
+## 2.2.0 - 2022-11-04
+This release drops support for PHP <8.1.
+
+## 2.1.0 - 2022-04-22
+Adds the `WrappingClock` which allows using an object with a `now()` method returning a `DateTimeImmutable` object
+as a "real" clock.
+
+## 2.0.0 - 2022-04-20
+This release introduces a compatibility layer with the PSR-20 draft, allowing us to already
+get some interoperability by depending on a shared interface.
 
 ## 1.0.0 - 2021-12-10
 Initial Release
-
-[Unreleased]: https://github.com/beste/clock/compare/1.0.0...main

README.md

@@ -4,7 +4,7 @@
 [![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/beste/clock)](https://packagist.org/packages/beste/clock)
 [![Tests](https://github.com/beste/clock/actions/workflows/tests.yml/badge.svg)](https://github.com/beste/clock/actions/workflows/tests.yml)
 
-A collection of Clock implementations.
+A collection of [PSR-20](https://www.php-fig.org/psr/psr-20/) Clock implementations.
 
 ## Table of Contents
 
@@ -15,6 +15,7 @@ A collection of Clock implementations.
     - [`UTCClock`](#utcclock) - The clock that you should™ use
     - [`FrozenClock`](#frozenclock) - A clock that stopped moving (perfect for tests)
     - [`MinuteClock`](#minuteclock) - Who cares about seconds or even less?
+    - [`WrappingClock`](#wrappingclock) - Allows wrapping a non-clock with a `now()` method in a clock
 - [Running Tests](#running-tests)
     
 ## Installation
@@ -136,7 +137,42 @@ printf("For %s, the minute clock still returns %s\n",
     $frozenClock->now()->format('H:i:s'),
     $clock->now()->format('H:i:s')
 );
+```
 
+### `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.
+
+```php
+# examples/wrapping_clock.php
+
+use Beste\Clock\WrappingClock;
+
+// Create a frozen $now so that we can test the wrapping clock.
+$now = new DateTimeImmutable('2012-04-24 12:00:00');
+
+// Create an object that is NOT a clock, but has a now() method returning the frozen $now.
+$clock = new class($now) {
+    private \DateTimeImmutable $now;
+
+    public function __construct(\DateTimeImmutable $now)
+    {
+        $this->now = $now;
+    }
+
+    public function now(): \DateTimeImmutable
+    {
+        return $this->now;
+    }
+};
+
+// We can now wrap the object in a clock.
+$wrappedClock = WrappingClock::wrapping($clock);
+
+assert($now->format(DATE_ATOM) === $wrappedClock->now()->format(DATE_ATOM));
 ```
 
 ## Running tests

SECURITY.md

@@ -0,0 +1,5 @@
+## Security contact information
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.

composer.json

@@ -11,23 +11,21 @@
         }
     ],
     "require": {
-        "php": "~7.4.0 || ~8.0.0 || ~8.1.0"
+        "php": "^8.0",
+        "psr/clock": "^1.0"
     },
     "require-dev": {
-        "phpstan/extension-installer": "^1.1",
+        "phpstan/extension-installer": "^1.4.1",
-        "phpstan/phpstan": "^1.0",
+        "phpstan/phpstan": "^2.1",
-        "phpstan/phpstan-phpunit": "^1.0",
+        "phpstan/phpstan-phpunit": "^2.0",
-        "phpstan/phpstan-strict-rules": "^1.0",
+        "phpstan/phpstan-strict-rules": "^2.0",
-        "phpunit/phpunit": "^9.5.10",
+        "phpunit/phpunit": "^9.6.20"
-        "psalm/plugin-phpunit": "^0.16.0",
-        "vimeo/psalm": "^4.15"
     },
     "autoload": {
         "psr-4": {
             "Beste\\Clock\\": "src/Clock"
         },
         "files": [
-            "src/psr-polyfill.php",
             "src/Clock.php"
         ]
     },
@@ -40,16 +38,17 @@
         "psr/clock-implementation": "1.0"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     },
     "scripts": {
         "test": [
             "@phpstan",
-            "@psalm",
             "@phpunit"
         ],
         "phpunit": "vendor/bin/phpunit",
-        "phpstan": "vendor/bin/phpstan analyse",
+        "phpstan": "vendor/bin/phpstan analyse"
-        "psalm": "vendor/bin/psalm"
     }
 }

examples/wrapping_clock.php

@@ -0,0 +1,28 @@
+<?php
+
+require __DIR__.'/../vendor/autoload.php';
+
+use Beste\Clock\WrappingClock;
+
+// Create a frozen $now so that we can test the wrapping clock.
+$now = new DateTimeImmutable('2012-04-24 12:00:00');
+
+// Create an object that is NOT a clock, but has a now() method returning the frozen $now.
+$clock = new class($now) {
+    private \DateTimeImmutable $now;
+
+    public function __construct(\DateTimeImmutable $now)
+    {
+        $this->now = $now;
+    }
+
+    public function now(): \DateTimeImmutable
+    {
+        return $this->now;
+    }
+};
+
+// We can now wrap the object in a clock.
+$wrappedClock = WrappingClock::wrapping($clock);
+
+assert($now->format(DATE_ATOM) === $wrappedClock->now()->format(DATE_ATOM));

phpstan.neon.dist

@@ -7,5 +7,3 @@ parameters:
 
 	tmpDir: .build/phpstan/
 
-	bootstrapFiles:
-		- ./src/psr-polyfill.php

psalm.xml.dist

@@ -1,21 +0,0 @@
-<?xml version="1.0"?>
-<psalm
-    xmlns="https://getpsalm.org/schema/config"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
-    cacheDirectory=".build/psalm"
-    errorLevel="1"
-    resolveFromConfigFile="true"
->
-    <projectFiles>
-        <directory name="src" />
-        <directory name="tests" />
-        <ignoreFiles>
-            <directory name="vendor" />
-        </ignoreFiles>
-    </projectFiles>
-
-    <plugins>
-        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
-    </plugins>
-</psalm>

src/Clock.php

@@ -6,6 +6,9 @@ namespace Beste;
 
 use Psr\Clock\ClockInterface;
 
+/**
+ * @deprecated since 3.1.0, use {@see ClockInterface} instead.
+ */
 interface Clock extends ClockInterface
 {
 

src/Clock/WrappingClock.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Beste\Clock;
+
+use Beste\Clock;
+use DateTimeImmutable;
+use InvalidArgumentException;
+use Psr\Clock\ClockInterface;
+
+final class WrappingClock implements Clock
+{
+    private ClockInterface $wrappedClock;
+
+    private function __construct(ClockInterface $wrappedClock)
+    {
+        $this->wrappedClock = $wrappedClock;
+    }
+
+    public static function wrapping(object $clock): self
+    {
+        if ($clock instanceof ClockInterface) {
+            return new self($clock);
+        }
+
+        if (!method_exists($clock, 'now')) {
+            throw new InvalidArgumentException('$clock must implement StellaMaris\Clock\ClockInterface or have a now() method');
+        }
+
+        if (!($clock->now() instanceof DateTimeImmutable)) {
+            throw new InvalidArgumentException('$clock->now() must return a DateTimeImmutable');
+        }
+
+        $wrappedClock = new class($clock) implements ClockInterface {
+            private object $clock;
+
+            public function __construct(object $clock)
+            {
+                $this->clock = $clock;
+            }
+
+            public function now(): DateTimeImmutable
+            {
+                assert(method_exists($this->clock, 'now'));
+
+                $now = $this->clock->now();
+
+                assert($now instanceof DateTimeImmutable);
+
+                return $now;
+            }
+        };
+
+        return new self($wrappedClock);
+    }
+
+    public function now(): DateTimeImmutable
+    {
+        return $this->wrappedClock->now();
+    }
+}

src/psr-polyfill.php

@@ -1,17 +0,0 @@
-<?php
-
-namespace Psr\Clock;
-
-if (class_exists('\Psr\Clock\ClockInterface')) {
-    return;
-}
-
-use DateTimeImmutable;
-
-interface ClockInterface
-{
-    /**
-     * Returns the current time as a DateTimeImmutable Object
-     */
-    public function now(): DateTimeImmutable;
-}

tests/Clock/FrozenClockTest.php

@@ -32,10 +32,10 @@ final class FrozenClockTest extends TestCase
     /**
      * @test
      *
-     * @uses \Beste\Clock\FrozenClock::__construct
+     * @uses ::__construct
-     * @uses \Beste\Clock\FrozenClock::fromUTC()
+     * @uses ::fromUTC
      *
-     * @covers ::now()
+     * @covers ::now
      */
     public function itReturnsAnEqualNowButNotTheSame(): void
     {
@@ -51,8 +51,8 @@ final class FrozenClockTest extends TestCase
     /**
      * @test
      *
-     * @uses \Beste\Clock\FrozenClock::__construct
+     * @uses ::__construct
-     * @uses \Beste\Clock\FrozenClock::now
+     * @uses ::now
      *
      * @covers ::withNowFrom
      */
@@ -74,8 +74,8 @@ final class FrozenClockTest extends TestCase
     /**
      * @test
      *
-     * @uses \Beste\Clock\FrozenClock::__construct
+     * @uses ::__construct
-     * @uses \Beste\Clock\FrozenClock::now
+     * @uses ::now
      *
      * @covers ::fromUTC
      */
@@ -90,9 +90,9 @@ final class FrozenClockTest extends TestCase
     /**
      * @test
      *
-     * @uses \Beste\Clock\FrozenClock::__construct
+     * @uses ::__construct
-     * @uses \Beste\Clock\FrozenClock::at
+     * @uses ::at
-     * @uses \Beste\Clock\FrozenClock::now
+     * @uses ::now
      *
      * @covers ::setTo
      */

tests/Clock/WrappingClockTest.php

@@ -0,0 +1,88 @@
+<?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);
+    }
+}