Drop Symfony 5.x, Allow Symfony 8.0 (#59)

yann-eugone · web-flow · commit f679bd1532dc · 2025-12-03T10:57:05.000+01:00
* Drop Symfony 5.x, Allow Symfony 8.0

* Fixed PhpStan issues
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,13 +14,15 @@ jobs:
       matrix:
         include:
           - php-version: '8.1'
-            symfony-version: '5.4.*'
+            symfony-version: '6.4.*'
+          - php-version: '8.4'
+            symfony-version: '6.4.*'
           - php-version: '8.2'
-            symfony-version: '5.4.*'
-          - php-version: '8.1'
-            symfony-version: '6.3.*'
-          - php-version: '8.2'
-            symfony-version: '6.3.*'
+            symfony-version: '7.4.*'
+          - php-version: '8.4'
+            symfony-version: '7.4.*'
+          - php-version: '8.4'
+            symfony-version: '8.0.*'
     steps:
       - name: "Checkout"
         uses: actions/checkout@v2
@@ -41,8 +43,8 @@ jobs:
       - name: "Setup env & install dependencies"
         uses: ./.github/actions/install
         with:
-          php-version: '8.1'
-          symfony-version: '6.1.*'
+          php-version: '8.4'
+          symfony-version: '8.0.*'
       - name: "Run static analyzis with phpstan/phpstan"
         run: vendor/bin/phpstan analyze
 
@@ -55,8 +57,8 @@ jobs:
       - name: "Setup env & install dependencies"
         uses: ./.github/actions/install
         with:
-          php-version: '8.1'
-          symfony-version: '6.1.*'
+          php-version: '8.4'
+          symfony-version: '8.0.*'
       - name: "Run checkstyle with symplify/easy-coding-standard"
         run: vendor/bin/ecs
 
@@ -69,8 +71,8 @@ jobs:
       - name: "Setup env & install dependencies"
         uses: ./.github/actions/install
         with:
-          php-version: '8.1'
-          symfony-version: '6.1.*'
+          php-version: '8.4'
+          symfony-version: '8.0.*'
           coverage-mode: 'xdebug'
       - name: "Run tests with phpunit/phpunit"
         env:
diff --git a/composer.json b/composer.json
@@ -11,15 +11,15 @@
     "require": {
         "php": "^8.1",
         "ext-openssl": "*",
-        "symfony/framework-bundle": "^5.4|^6.0",
-        "doctrine/orm": "^2.7",
-        "doctrine/doctrine-bundle": "^2.0",
+        "symfony/framework-bundle": "^6.4|^7.4|^8.0",
+        "doctrine/common": "^3.0",
+        "doctrine/orm": "^3.0",
+        "doctrine/doctrine-bundle": "^2.0|^3.0",
         "yokai/dependency-injection": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "phpspec/prophecy-phpunit": "^2.0",
-        "symfony/yaml": "^5.4|^6.0",
+        "symfony/yaml": "^6.4|^7.4|^8.0",
         "phpstan/phpstan": "^1.7",
         "symplify/easy-coding-standard": "^11.3"
     },
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,30 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeDefinition\\:\\:addDefaultsIfNotSet\\(\\)\\.$#"
-			count: 2
-			path: src/DependencyInjection/Configuration.php
-
-		-
-			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeDefinition\\:\\:children\\(\\)\\.$#"
-			count: 2
-			path: src/DependencyInjection/Configuration.php
-
-		-
-			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeDefinition\\:\\:useAttributeAsKey\\(\\)\\.$#"
-			count: 1
-			path: src/DependencyInjection/Configuration.php
-
-		-
-			message: "#^Method Yokai\\\\SecurityTokenBundle\\\\Entity\\\\Token\\:\\:getLastUsage\\(\\) should return Yokai\\\\SecurityTokenBundle\\\\Entity\\\\TokenUsage\\|null but returns mixed\\.$#"
-			count: 1
-			path: src/Entity/Token.php
-
-		-
-			message: "#^Method Yokai\\\\SecurityTokenBundle\\\\Entity\\\\Token\\:\\:getUsages\\(\\) should return array\\<Yokai\\\\SecurityTokenBundle\\\\Entity\\\\TokenUsage\\> but returns array\\.$#"
-			count: 1
-			path: src/Entity/Token.php
-
 		-
 			message: "#^Property Yokai\\\\SecurityTokenBundle\\\\Entity\\\\Token\\:\\:\\$id is never written, only read\\.$#"
 			count: 1
@@ -35,13 +10,3 @@ parameters:
 			count: 1
 			path: src/Entity/TokenUsage.php
 
-		-
-			message: "#^Cannot cast mixed to string\\.$#"
-			count: 1
-			path: src/Manager/ChainUserManager.php
-
-		-
-			message: "#^Cannot cast mixed to string\\.$#"
-			count: 1
-			path: src/Manager/DoctrineUserManager.php
-
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,7 +2,8 @@ includes:
     - phpstan-baseline.neon
 parameters:
   level: max
-  checkMissingIterableValueType: false
-  checkGenericClassInNonGenericObjectType: false
+  ignoreErrors:
+    - identifier: missingType.generics
+    - identifier: missingType.iterableValue
   paths:
     - src/
diff --git a/src/Archive/ArchivistInterface.php b/src/Archive/ArchivistInterface.php
@@ -18,5 +18,5 @@ interface ArchivistInterface
      *
      * @return integer
      */
-    public function archive(string $purpose = null): int;
+    public function archive(string|null $purpose = null): int;
 }
diff --git a/src/Archive/DeleteArchivist.php b/src/Archive/DeleteArchivist.php
@@ -27,7 +27,7 @@ public function __construct(EntityRepository $tokenRepository)
         $this->tokenRepository = $tokenRepository;
     }
 
-    public function archive(string $purpose = null): int
+    public function archive(string|null $purpose = null): int
     {
         $builder = $this->tokenRepository->createQueryBuilder('token')
             ->delete($this->tokenRepository->getClassName(), 'token');
diff --git a/src/Entity/Token.php b/src/Entity/Token.php
@@ -70,7 +70,7 @@ class Token
     private $keepUntil;
 
     /**
-     * @var Collection<TokenUsage>
+     * @var Collection<int, TokenUsage>
      */
     private $usages;
 
@@ -192,15 +192,15 @@ public function getUsages(): array
         return $this->usages->toArray();
     }
 
-    public function getLastUsage(): ?TokenUsage
+    public function getLastUsage(): TokenUsage|null
     {
-        return $this->usages->last();
+        return $this->usages->last() ?: null;
     }
 
     /**
      * @throws LogicException
      */
-    public function consume(array $information, DateTime $date = null): void
+    public function consume(array $information, DateTime|null $date = null): void
     {
         if ($this->isConsumed()) {
             throw new LogicException(
diff --git a/src/Entity/TokenUsage.php b/src/Entity/TokenUsage.php
@@ -31,7 +31,7 @@ class TokenUsage
     /**
      * @param array<string, mixed> $information
      */
-    public function __construct(Token $token, array $information, DateTime $createdAt = null)
+    public function __construct(Token $token, array $information, DateTime|null $createdAt = null)
     {
         $this->token = $token;
         $this->information = $information;
diff --git a/src/EventDispatcher.php b/src/EventDispatcher.php
@@ -53,7 +53,7 @@ public function tokenCreated(Token $token): TokenCreatedEvent
         return $event;
     }
 
-    public function consumeToken(Token $token, DateTime $at = null, array $information = []): ConsumeTokenEvent
+    public function consumeToken(Token $token, DateTime|null $at = null, array $information = []): ConsumeTokenEvent
     {
         $this->eventDispatcher->dispatch(
             $event = new ConsumeTokenEvent($token, $at, $information)
@@ -71,7 +71,6 @@ public function tokenConsumed(Token $token): TokenConsumedEvent
         return $event;
     }
 
-    
     public function tokenTotallyConsumed(Token $token): TokenTotallyConsumedEvent
     {
         $this->eventDispatcher->dispatch(
diff --git a/src/Manager/ChainUserManager.php b/src/Manager/ChainUserManager.php
@@ -108,10 +108,18 @@ private function getManagerForUser($user): UserManagerInterface
             $tries[] = get_class($manager);
         }
 
-        if (is_object($user) && !method_exists($user, '__toString')) {
-            $userAsString = sprintf('%s::%s', get_class($user), spl_object_hash($user));
+        if (is_object($user)) {
+            if (!method_exists($user, '__toString')) {
+                $userAsString = sprintf('%s::%s', get_class($user), spl_object_hash($user));
+            } else {
+                $userAsString = (string)$user;
+            }
         } else {
-            $userAsString = (string)$user;
+            if (is_scalar($user)) {
+                $userAsString = (string)$user;
+            } else {
+                $userAsString = get_debug_type($user);
+            }
         }
 
         throw new \InvalidArgumentException(
diff --git a/src/Manager/DoctrineUserManager.php b/src/Manager/DoctrineUserManager.php
@@ -54,10 +54,8 @@ public function get(string $class, string $id)
     public function getClass($user): string
     {
         /** @var object $user */
-        /** @var class-string $class */
-        $class = ClassUtils::getClass($user);
 
-        return $class;
+        return ClassUtils::getClass($user);
     }
 
     public function getId($user): string
@@ -71,7 +69,15 @@ public function getId($user): string
             throw new \InvalidArgumentException('Entities with composite ids are not supported');
         }
 
-        return (string) reset($identifiers);
+        $identifier = reset($identifiers);
+        if (is_scalar($identifier)
+            || $identifier === null
+            || (is_object($identifier) && method_exists($identifier, '__toString'))
+        ) {
+            return (string)$identifier;
+        }
+
+        throw new \InvalidArgumentException('Entities with non stringable ids are not supported');
     }
 
     /**
diff --git a/src/Manager/TokenManager.php b/src/Manager/TokenManager.php
@@ -101,7 +101,7 @@ public function create(string $purpose, $user, array $payload = []): Token
         return $token;
     }
 
-    public function consume(Token $token, DateTime $at = null): void
+    public function consume(Token $token, DateTime|null $at = null): void
     {
         $event = $this->eventDispatcher->consumeToken($token, $at, $this->informationGuesser->get());
 
diff --git a/src/Manager/TokenManagerInterface.php b/src/Manager/TokenManagerInterface.php
@@ -48,7 +48,7 @@ public function create(string $purpose, $user, array $payload = []): Token;
      * @param Token         $token The token to consume
      * @param DateTime|null $at    The date/time at which the token was consumed (defaults to now)
      */
-    public function consume(Token $token, DateTime $at = null): void;
+    public function consume(Token $token, DateTime|null $at = null): void;
 
     /**
      * Get the user associated to a token.
diff --git a/src/Repository/DoctrineORMTokenRepository.php b/src/Repository/DoctrineORMTokenRepository.php
@@ -44,7 +44,7 @@ public function get(string $value, string $purpose): Token
             [
                 'value' => $value,
                 'purpose' => $purpose,
-            ]
+            ],
         );
 
         if (!$token instanceof Token) {
@@ -67,7 +67,7 @@ public function findExisting(string $userClass, string $userId, string $purpose)
                 'userClass' => $userClass,
                 'userId' => $userId,
                 'purpose' => $purpose,
-            ]
+            ],
         );
         if (!$token instanceof Token) {
             return null;
@@ -81,14 +81,12 @@ public function findExisting(string $userClass, string $userId, string $purpose)
 
     public function create(Token $token): void
     {
-        $this->manager->persist($token);
-        $this->manager->flush($token);
+        $this->save($token);
     }
 
     public function update(Token $token): void
     {
-        $this->manager->persist($token);
-        $this->manager->flush($token);
+        $this->save($token);
     }
 
     public function exists(string $value, string $purpose): bool
@@ -107,4 +105,10 @@ public function exists(string $value, string $purpose): bool
 
         return intval($result) > 0;
     }
+
+    private function save(Token $token): void
+    {
+        $this->manager->persist($token);
+        $this->manager->flush();
+    }
 }
diff --git a/tests/Command/ArchiveTokenCommandTest.php b/tests/Command/ArchiveTokenCommandTest.php
@@ -4,8 +4,7 @@
 
 namespace Yokai\SecurityTokenBundle\Tests\Command;
 
-use Prophecy\PhpUnit\ProphecyTrait;
-use Prophecy\Prophecy\ObjectProphecy;
+use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\Console\Command\Command;
@@ -19,10 +18,8 @@
  */
 class ArchiveTokenCommandTest extends KernelTestCase
 {
-    use ProphecyTrait;
-
     /**
-     * @var ArchivistInterface|ObjectProphecy
+     * @var MockObject<ArchivistInterface>
      */
     private $archivist;
 
@@ -33,10 +30,10 @@ class ArchiveTokenCommandTest extends KernelTestCase
 
     protected function setUp(): void
     {
-        $this->archivist = $this->prophesize(ArchivistInterface::class);
+        $this->archivist = $this->createMock(ArchivistInterface::class);
 
         self::bootKernel();
-        self::$kernel->getContainer()->set('yokai_security_token.archivist', $this->archivist->reveal());
+        self::$kernel->getContainer()->set('yokai_security_token.archivist', $this->archivist);
 
         $this->application = new Application(self::$kernel);
     }
@@ -75,8 +72,9 @@ public function it_archive_every_token_when_run_without_options_with_confirmatio
     {
         $command = $this->command();
 
-        $this->archivist->archive(null)
-            ->shouldBeCalledTimes(1)
+        $this->archivist->expects(self::once())
+            ->method('archive')
+            ->with(null)
             ->willReturn(10);
 
         $output = $this->runCommand($command);
@@ -91,8 +89,9 @@ public function it_archive_partial_tokens_when_run_with_options(): void
     {
         $command = $this->command();
 
-        $this->archivist->archive('init_password')
-            ->shouldBeCalledTimes(1)
+        $this->archivist->expects(self::once())
+            ->method('archive')
+            ->with('init_password')
             ->willReturn(10);
 
         $output = $this->runCommand($command, ['purpose' => 'init_password']);
diff --git a/tests/DependencyInjection/DependencyInjectionTest.php b/tests/DependencyInjection/DependencyInjectionTest.php
diff --git a/tests/Factory/TokenFactoryTest.php b/tests/Factory/TokenFactoryTest.php
diff --git a/tests/Manager/ChainUserManagerTest.php b/tests/Manager/ChainUserManagerTest.php
diff --git a/tests/Manager/DoctrineUserManagerTest.php b/tests/Manager/DoctrineUserManagerTest.php
diff --git a/tests/Manager/TokenManagerTest.php b/tests/Manager/TokenManagerTest.php
diff --git a/tests/Repository/DoctrineORMTokenRepositoryTest.php b/tests/Repository/DoctrineORMTokenRepositoryTest.php
diff --git a/tests/app/config.yml b/tests/app/config.yml

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,5 @@ interface ArchivistInterface`
`18`	`18`	`*`
`19`	`19`	`* @return integer`
`20`	`20`	`*/`
`21`		`- public function archive(string $purpose = null): int;`
	`21`	`+ public function archive(string\|null $purpose = null): int;`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function __construct(EntityRepository $tokenRepository)`
`27`	`27`	`$this->tokenRepository = $tokenRepository;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function archive(string $purpose = null): int`
	`30`	`+ public function archive(string\|null $purpose = null): int`
`31`	`31`	`{`
`32`	`32`	`$builder = $this->tokenRepository->createQueryBuilder('token')`
`33`	`33`	`->delete($this->tokenRepository->getClassName(), 'token');`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ class Token`
`70`	`70`	`private $keepUntil;`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * @var Collection<TokenUsage>`
	`73`	`+ * @var Collection<int, TokenUsage>`
`74`	`74`	`*/`
`75`	`75`	`private $usages;`
`76`	`76`
`@@ -192,15 +192,15 @@ public function getUsages(): array`
`192`	`192`	`return $this->usages->toArray();`
`193`	`193`	`}`
`194`	`194`
`195`		`- public function getLastUsage(): ?TokenUsage`
	`195`	`+ public function getLastUsage(): TokenUsage\|null`
`196`	`196`	`{`
`197`		`- return $this->usages->last();`
	`197`	`+ return $this->usages->last() ?: null;`
`198`	`198`	`}`
`199`	`199`
`200`	`200`	`/**`
`201`	`201`	`* @throws LogicException`
`202`	`202`	`*/`
`203`		`- public function consume(array $information, DateTime $date = null): void`
	`203`	`+ public function consume(array $information, DateTime\|null $date = null): void`
`204`	`204`	`{`
`205`	`205`	`if ($this->isConsumed()) {`
`206`	`206`	`throw new LogicException(`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class TokenUsage`
`31`	`31`	`/**`
`32`	`32`	`* @param array<string, mixed> $information`
`33`	`33`	`*/`
`34`		`- public function __construct(Token $token, array $information, DateTime $createdAt = null)`
	`34`	`+ public function __construct(Token $token, array $information, DateTime\|null $createdAt = null)`
`35`	`35`	`{`
`36`	`36`	`$this->token = $token;`
`37`	`37`	`$this->information = $information;`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function tokenCreated(Token $token): TokenCreatedEvent`
`53`	`53`	`return $event;`
`54`	`54`	`}`
`55`	`55`
`56`		`- public function consumeToken(Token $token, DateTime $at = null, array $information = []): ConsumeTokenEvent`
	`56`	`+ public function consumeToken(Token $token, DateTime\|null $at = null, array $information = []): ConsumeTokenEvent`
`57`	`57`	`{`
`58`	`58`	`$this->eventDispatcher->dispatch(`
`59`	`59`	`$event = new ConsumeTokenEvent($token, $at, $information)`
`@@ -71,7 +71,6 @@ public function tokenConsumed(Token $token): TokenConsumedEvent`
`71`	`71`	`return $event;`
`72`	`72`	`}`
`73`	`73`
`74`		`-`
`75`	`74`	`public function tokenTotallyConsumed(Token $token): TokenTotallyConsumedEvent`
`76`	`75`	`{`
`77`	`76`	`$this->eventDispatcher->dispatch(`