Merge pull request #32 from facile-it/add-rector

Add Rector

Author: Jean85

.github/workflows/continuous-integration.yml

@@ -44,7 +44,7 @@ jobs:
           sarif_file: psalm.sarif
 
   codestyle:
-    name: "Code Style"
+    name: "Rector + Code Style"
     runs-on: ubuntu-latest
 
     strategy:
@@ -71,7 +71,7 @@ jobs:
       - uses: ramsey/composer-install@v4
 
       - name: "Run PHPCS check"
-        run: "composer cs-check"
+        run: "composer rector-check && composer cs-check"
 
   phpunit:
     name: "PHPUnit"

composer.json

@@ -64,17 +64,21 @@
         "friendsofphp/php-cs-fixer": "^3.92.3",
         "phpspec/prophecy-phpunit": "^2.0.1",
         "phpunit/phpunit": "^10.5.60 || ^11.5.46 || ^12.0.0",
+        "rector/rector": "2.3.9",
         "spomky-labs/aes-key-wrap": "^7.0",
         "vimeo/psalm": "^6.14.3"
     },
     "scripts": {
+        "rector-check": "rector --dry-run",
+        "rector-fix": "rector",
         "cs-check": "php-cs-fixer fix --dry-run --diff --allow-risky=yes",
         "cs-fix": "php-cs-fixer fix --diff --allow-risky=yes",
         "psalm": "psalm",
         "test": "phpunit",
         "test-coverage": "phpunit --coverage-text",
         "check": [
-            "@cs-check",
+            "@rector-check",
+            "@cs-fix",
             "@psalm",
             "@test"
         ]

rector.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    // uncomment to reach your current PHP version
+    ->withPhpSets()
+    ->withComposerBased(
+        phpunit: true,
+    )
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        typeDeclarations: true
+    )
+;

src/AbstractTokenVerifier.php

@@ -38,22 +38,6 @@
  */
 abstract class AbstractTokenVerifier implements TokenVerifierInterface
 {
-    protected string $issuer;
-
-    protected string $clientId;
-
-    protected ?string $clientSecret;
-
-    protected ?string $expectedAzp;
-
-    protected ?string $expectedAlg;
-
-    protected int $clockTolerance;
-
-    protected bool $authTimeRequired;
-
-    protected bool $aadIssValidation;
-
     protected JwksProviderInterface $jwksProvider;
 
     protected TokenDecrypterInterface $decrypter;
@@ -70,26 +54,18 @@ abstract class AbstractTokenVerifier implements TokenVerifierInterface
      * @psalm-internal \Facile\JoseVerifier
      */
     final public function __construct(
-        string $issuer,
-        string $clientId,
-        ?string $clientSecret = null,
-        bool $authTimeRequired = false,
-        int $clockTolerance = 0,
-        bool $aadIssValidation = false,
-        ?string $expectedAzp = null,
-        ?string $expectedAlg = null,
+        protected string $issuer,
+        protected string $clientId,
+        protected ?string $clientSecret = null,
+        protected bool $authTimeRequired = false,
+        protected int $clockTolerance = 0,
+        protected bool $aadIssValidation = false,
+        protected ?string $expectedAzp = null,
+        protected ?string $expectedAlg = null,
         ?JwksProviderInterface $jwksProvider = null,
         ?TokenDecrypterInterface $decrypter = null,
         ?ClockInterface $clock = null,
     ) {
-        $this->issuer = $issuer;
-        $this->clientId = $clientId;
-        $this->clientSecret = $clientSecret;
-        $this->authTimeRequired = $authTimeRequired;
-        $this->clockTolerance = $clockTolerance;
-        $this->aadIssValidation = $aadIssValidation;
-        $this->expectedAzp = $expectedAzp;
-        $this->expectedAlg = $expectedAlg;
         $this->jwksProvider = $jwksProvider ?? new MemoryJwksProvider();
         $this->decrypter = $decrypter ?? new NullTokenDecrypter();
         $this->clock = $clock ?? new InternalClock();
@@ -238,12 +214,12 @@ private function getJWKFromKid(string $kid): JWK
         $jwks = JWKSet::createFromKeyData($this->jwksProvider->getJwks());
         $jwk = $jwks->selectKey('sig', null, ['kid' => $kid]);
 
-        if (null === $jwk) {
+        if (! $jwk instanceof JWK) {
             $jwks = JWKSet::createFromKeyData($this->jwksProvider->reload()->getJwks());
             $jwk = $jwks->selectKey('sig', null, ['kid' => $kid]);
         }
 
-        if (null === $jwk) {
+        if (! $jwk instanceof JWK) {
             throw new InvalidTokenException('Unable to find the jwk with the provided kid: ' . $kid);
         }
 

src/Builder/AbstractTokenVerifierBuilder.php

@@ -28,20 +28,6 @@
  */
 abstract class AbstractTokenVerifierBuilder implements TokenVerifierBuilderInterface
 {
-    /**
-     * @var array<string, mixed>
-     *
-     * @psalm-var ClientMetadataType
-     */
-    protected array $clientMetadata;
-
-    /**
-     * @var array<string, mixed>
-     *
-     * @psalm-var IssuerMetadataType
-     */
-    protected array $issuerMetadata;
-
     protected int $clockTolerance = 0;
 
     protected bool $aadIssValidation = false;
@@ -55,14 +41,16 @@ abstract class AbstractTokenVerifierBuilder implements TokenVerifierBuilderInter
     protected ?JwksProviderBuilder $jwksProviderBuilder = null;
 
     /**
+     * @param array<string, mixed> $issuerMetadata
+     * @param array<string, mixed> $clientMetadata
+     *
      * @psalm-param IssuerMetadataType $issuerMetadata
      * @psalm-param ClientMetadataType $clientMetadata
      */
-    protected function __construct(array $issuerMetadata, array $clientMetadata)
-    {
-        $this->issuerMetadata = $issuerMetadata;
-        $this->clientMetadata = $clientMetadata;
-    }
+    protected function __construct(
+        protected array $issuerMetadata,
+        protected array $clientMetadata,
+    ) {}
 
     public function withClockTolerance(int $clockTolerance): static
     {
@@ -111,11 +99,7 @@ public function withClientJwksProvider(JwksProviderInterface $clientJwksProvider
 
     protected function getJwksProvider(): JwksProviderInterface
     {
-        if ($this->jwksProvider) {
-            return $this->jwksProvider;
-        }
-
-        return $this->jwksProvider = $this->buildJwksProvider();
+        return $this->jwksProvider ??= $this->buildJwksProvider();
     }
 
     /**
@@ -136,11 +120,7 @@ protected function buildJwksProvider(): JwksProviderInterface
 
     protected function getClientJwksProvider(): JwksProviderInterface
     {
-        if ($this->clientJwksProvider) {
-            return $this->clientJwksProvider;
-        }
-
-        return $this->clientJwksProvider = $this->buildClientJwksProvider();
+        return $this->clientJwksProvider ??= $this->buildClientJwksProvider();
     }
 
     protected function buildClientJwksProvider(): JwksProviderInterface

src/Decrypter/TokenDecrypter.php

@@ -79,7 +79,7 @@ public function __construct()
             if (class_exists($algorithmClass)) {
                 try {
                     $this->algorithms[] = new $algorithmClass();
-                } catch (Throwable $throwable) {
+                } catch (Throwable) {
                     // does nothing
                 }
             }
@@ -158,7 +158,7 @@ protected function getAlgorithmMap(): array
             KeyEncryption\A128GCMKW::class,
             KeyEncryption\A192GCMKW::class,
             KeyEncryption\A256GCMKW::class,
-            ...(class_exists('AESKW\Wrapper') ? [
+            ...(class_exists(\AESKW\Wrapper::class) ? [
                 KeyEncryption\A128KW::class,
                 KeyEncryption\A192KW::class,
                 KeyEncryption\A256KW::class,

src/Exception/InvalidTokenClaimException.php

@@ -11,19 +11,16 @@
  */
 class InvalidTokenClaimException extends RuntimeException implements InvalidTokenExceptionInterface
 {
-    private string $claim;
-
-    /** @var mixed */
-    private $value;
-
     /**
      * @param mixed $value
      */
-    public function __construct(string $message, string $claim, $value, ?Throwable $previous = null)
-    {
+    public function __construct(
+        string $message,
+        private readonly string $claim,
+        private $value,
+        ?Throwable $previous = null,
+    ) {
         parent::__construct($message, 0, $previous);
-        $this->claim = $claim;
-        $this->value = $value;
     }
 
     public function getClaim(): string

src/Internal/Checker/AbstractHashChecker.php

@@ -19,31 +19,20 @@
  */
 abstract class AbstractHashChecker implements ClaimChecker
 {
-    private string $valueToCheck;
-
-    private string $alg;
-
-    /**
-     * SHashChecker constructor.
-     */
-    public function __construct(string $valueToCheck, string $alg)
-    {
-        $this->valueToCheck = $valueToCheck;
-        $this->alg = $alg;
-    }
+    public function __construct(
+        private readonly string $valueToCheck,
+        private readonly string $alg,
+    ) {}
 
     private function getShaSize(string $alg): string
     {
         $size = substr($alg, -3);
 
-        switch ($size) {
-            case '512':
-                return 'sha512';
-            case '384':
-                return 'sha384';
-            default:
-                return 'sha256';
-        }
+        return match ($size) {
+            '512' => 'sha512',
+            '384' => 'sha384',
+            default => 'sha256',
+        };
     }
 
     /**

src/Internal/Checker/AuthTimeChecker.php

@@ -14,22 +14,15 @@
 /**
  * @internal
  */
-final class AuthTimeChecker implements ClaimChecker
+final readonly class AuthTimeChecker implements ClaimChecker
 {
     private const CLAIM_NAME = 'auth_time';
 
-    private int $maxAge;
-
-    private int $allowedTimeDrift;
-
-    private ClockInterface $clock;
-
-    public function __construct(int $maxAge, int $allowedTimeDrift = 0, ?ClockInterface $clock = null)
-    {
-        $this->maxAge = $maxAge;
-        $this->allowedTimeDrift = $allowedTimeDrift;
-        $this->clock = $clock ?? new InternalClock();
-    }
+    public function __construct(
+        private int $maxAge,
+        private int $allowedTimeDrift = 0,
+        private ClockInterface $clock = new InternalClock(),
+    ) {}
 
     /**
      * @throws InvalidClaimException

src/Internal/Checker/AzpChecker.php

@@ -12,16 +12,13 @@
 /**
  * @internal
  */
-final class AzpChecker implements ClaimChecker
+final readonly class AzpChecker implements ClaimChecker
 {
     private const CLAIM_NAME = 'azp';
 
-    private string $azp;
-
-    public function __construct(string $azp)
-    {
-        $this->azp = $azp;
-    }
+    public function __construct(
+        private string $azp,
+    ) {}
 
     /**
      * @param mixed $value