Add upgrade instructions - replaces changelog

Author: sstok

CHANGELOG.md

@@ -0,0 +1,17 @@
+UPGRADE
+=======
+
+## Upgrade from 0.1.2
+
+* Support for PHP 8.1 and lower was dropped;
+
+* Now always uses Aragon2id instead of Aragon2i;
+
+* The `Argon2SplitTokenFactory` now expects a `DateInterval` or string with a date-interval
+  as second argument to constructor. Previously this required a `DateTimeImmutable`;
+
+* The `SplitTokenFactory::generate()` now allows a `DateTimeImmutable` or `DateInterval`
+  which is calculated relative to "now" or the `now()` as provided by the `ClockInterface`.
+
+  Use `setClock()` on the factory to set an active Clock instance, this is also the recommended
+  way for using the `FakeSplitTokenFactory()`.

UPGRADE.md

@@ -11,6 +11,7 @@
 namespace Rollerworks\Component\SplitToken;
 
 use Psr\Clock\ClockInterface;
+use Symfony\Contracts\Service\Attribute\Required;
 
 abstract class AbstractSplitTokenFactory implements SplitTokenFactory
 {

src/AbstractSplitTokenFactory.php

@@ -34,9 +34,7 @@ protected function verifyHash(string $hash, string $verifier): bool
         return password_verify($verifier, $hash);
     }
 
-    /**
-     * @codeCoverageIgnore
-     */
+    /** @codeCoverageIgnore */
     protected function hashVerifier(string $verifier): string
     {
         $passwordHash = password_hash($verifier, \PASSWORD_ARGON2ID, $this->config);

src/Argon2SplitToken.php

@@ -30,7 +30,7 @@ public static function randomInstance(): self
         return new self(random_bytes(FakeSplitToken::TOKEN_DATA_LENGTH));
     }
 
-    public function __construct(string $randomValue = null, \DateInterval | string | null $defaultLifeTime = null)
+    public function __construct(string $randomValue = null, \DateInterval | string $defaultLifeTime = null)
     {
         parent::__construct($defaultLifeTime);
 
@@ -39,9 +39,8 @@ public function __construct(string $randomValue = null, \DateInterval | string |
 
     public function generate(\DateTimeImmutable | \DateInterval $expiresAt = null): SplitToken
     {
-        $splitToken = FakeSplitToken::create(new HiddenString($this->randomValue, false, true));
-
-        return $splitToken->expireAt($this->getExpirationTimestamp($expiresAt));
+        return FakeSplitToken::create(new HiddenString($this->randomValue, false, true))
+            ->expireAt($this->getExpirationTimestamp($expiresAt));
     }
 
     public function fromString(string $token): SplitToken

src/FakeSplitTokenFactory.php

@@ -11,9 +11,14 @@
 namespace Rollerworks\Component\SplitToken;
 
 use ParagonIE\HiddenString\HiddenString;
+use Psr\Clock\ClockInterface;
+use Symfony\Contracts\Service\Attribute\Required;
 
 interface SplitTokenFactory
 {
+    #[Required]
+    public function setClock(ClockInterface $clock): void;
+
     /**
      * Generates a new SplitToken object.
      *

src/SplitTokenFactory.php

@@ -8,7 +8,6 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 use Rollerworks\Component\SplitToken\FakeSplitTokenFactory;