[master] type all class properties and function parameters

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Breaking Changes
 
 - PHP 8.1 is now required
+- All class properties and function parameters are now typed
 
 ### Fixed
 

composer.json

@@ -33,23 +33,24 @@
         "rector/rector": "^1.0",
         "roave/security-advisories": "dev-latest",
         "phpunit/phpunit": "^11.0",
-        "squizlabs/php_codesniffer": "^3.9"
+        "squizlabs/php_codesniffer": "^3.9",
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-deprecation-rules": "^1.1"
     },
     "extra": {
         "branch-alias": {
             "dev-master": "1.0.x-dev"
         }
     },
-    "archive": {
-        "exclude": ["data", "tests", "rector.config.php"]
-    },
     "scripts": {
         "check" : [
             "@cs-check",
             "@test"
         ],
         "cs-check" : "phpcs --parallel=50",
         "cs-fix" : "phpcbf",
+        "phpstan": "phpstan analyse",
         "rector": [
             "rector --config=rector.config.php",
             "@cs-fix"

phpstan-baseline.neon

@@ -0,0 +1,11 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Unsafe usage of new static\\(\\)\\.$#"
+			count: 1
+			path: src/Client/ClientBuilder.php
+
+		-
+			message: "#^Unsafe usage of new static\\(\\)\\.$#"
+			count: 1
+			path: src/Server/ServerBuilder.php

phpstan.neon.dist

@@ -0,0 +1,16 @@
+includes:
+  - phpstan-baseline.neon
+  - vendor/phpstan/phpstan-phpunit/extension.neon
+  - vendor/phpstan/phpstan-phpunit/rules.neon
+  - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+
+parameters:
+  tmpDir: data/phpstan
+  cache:
+      nodesByStringCountMax: 0
+  level: 5
+  fileExtensions:
+  	- php
+  paths:
+    - src
+    - tests

rector.config.php

@@ -7,6 +7,9 @@
 use Rector\Set\ValueObject\DowngradeLevelSetList;
 use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeDeclarationRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector;
+use Rector\TypeDeclaration\Rector\Property\AddPropertyTypeDeclarationRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->paths(
@@ -23,6 +26,9 @@
             LevelSetList::UP_TO_PHP_81,
             DowngradeLevelSetList::DOWN_TO_PHP_81,
             SetList::CODE_QUALITY,
+            SetList::TYPE_DECLARATION,
         ]
     );
+
+    $rectorConfig->importNames();
 };

src/Client/Client.php

@@ -2,6 +2,7 @@
 
 namespace Dflydev\Hawk\Client;
 
+use InvalidArgumentException;
 use Dflydev\Hawk\Credentials\CredentialsInterface;
 use Dflydev\Hawk\Crypto\Artifacts;
 use Dflydev\Hawk\Crypto\Crypto;
@@ -25,7 +26,7 @@ public function __construct(
     ) {
     }
 
-    public function createRequest(CredentialsInterface $credentials, $uri, $method, array $options = [])
+    public function createRequest(CredentialsInterface $credentials, $uri, $method, array $options = []): Request
     {
         $timestamp = $options['timestamp'] ?? $this->timeProvider->createTimestamp();
         if ($this->localtimeOffset) {
@@ -50,7 +51,7 @@ public function createRequest(CredentialsInterface $credentials, $uri, $method,
                 $contentType = $options['content_type'];
                 $hash = $this->crypto->calculatePayloadHash($payload, $credentials->algorithm(), $contentType);
             } else {
-                throw new \InvalidArgumentException(
+                throw new InvalidArgumentException(
                     "If one of 'payload' and 'content_type' are specified, both must be specified."
                 );
             }
@@ -107,12 +108,12 @@ public function authenticate(
         Request $request,
         $headerObjectOrString,
         array $options = []
-    ) {
+    ): bool {
         $header = HeaderFactory::createFromHeaderObjectOrString(
             'Server-Authorization',
             $headerObjectOrString,
             function (): never {
-                throw new \InvalidArgumentException(
+                throw new InvalidArgumentException(
                     'Header must either be a string or an instance of "Dflydev\Hawk\Header\Header"'
                 );
             }
@@ -123,7 +124,7 @@ function (): never {
                 $payload = $options['payload'];
                 $contentType = $options['content_type'];
             } else {
-                throw new \InvalidArgumentException(
+                throw new InvalidArgumentException(
                     'If one of "payload" and "content_type" are specified, both must be specified.'
                 );
             }
@@ -168,7 +169,7 @@ function (): never {
         return $artifacts->hash() === $hash;
     }
 
-    public function createBewit(CredentialsInterface $credentials, $uri, $ttlSec, array $options = [])
+    public function createBewit(CredentialsInterface $credentials, $uri, $ttlSec, array $options = []): string
     {
         $timestamp = $options['timestamp'] ?? $this->timeProvider->createTimestamp();
         if ($this->localtimeOffset) {

src/Client/ClientBuilder.php

@@ -10,40 +10,40 @@
 
 class ClientBuilder
 {
-    private $crypto;
-    private $timeProvider;
-    private $nonceProvider;
-    private $localtimeOffset = 0;
+    private ?Crypto $crypto = null;
+    private ?TimeProviderInterface $timeProvider = null;
+    private ?NonceProviderInterface $nonceProvider = null;
+    private int $localtimeOffset = 0;
 
-    public function setCrypto(Crypto $crypto)
+    public function setCrypto(Crypto $crypto): static
     {
         $this->crypto = $crypto;
 
         return $this;
     }
 
-    public function setTimeProvider(TimeProviderInterface $timeProvider)
+    public function setTimeProvider(TimeProviderInterface $timeProvider): static
     {
         $this->timeProvider = $timeProvider;
 
         return $this;
     }
 
-    public function setNonceProvider(NonceProviderInterface $nonceProvider)
+    public function setNonceProvider(NonceProviderInterface $nonceProvider): static
     {
         $this->nonceProvider = $nonceProvider;
 
         return $this;
     }
 
-    public function setLocaltimeOffset($localtimeOffset = null)
+    public function setLocaltimeOffset(int $localtimeOffset = null): static
     {
         $this->localtimeOffset = $localtimeOffset;
 
         return $this;
     }
 
-    public function build()
+    public function build(): Client
     {
         $crypto = $this->crypto ?: new Crypto();
         $timeProvider = $this->timeProvider ?: DefaultTimeProviderFactory::create();
@@ -57,7 +57,7 @@ public function build()
         );
     }
 
-    public static function create()
+    public static function create(): static
     {
         return new static();
     }

src/Client/ClientInterface.php

@@ -6,7 +6,7 @@
 
 interface ClientInterface
 {
-    public function createRequest(CredentialsInterface $credentials, $uri, $method, array $options = []);
+    public function createRequest(CredentialsInterface $credentials, string $uri, string $method, array $options = []);
     public function authenticate(
         CredentialsInterface $credentials,
         Request $request,

src/Client/Request.php

@@ -11,12 +11,12 @@ public function __construct(private readonly Header $header, private readonly Ar
     {
     }
 
-    public function header()
+    public function header(): Header
     {
         return $this->header;
     }
 
-    public function artifacts()
+    public function artifacts(): Artifacts
     {
         return $this->artifacts;
     }

src/Credentials/CallbackCredentialsProvider.php

@@ -8,7 +8,7 @@ public function __construct(private $callback)
     {
     }
 
-    public function loadCredentialsById($id)
+    public function loadCredentialsById(string $id): CredentialsInterface
     {
         return call_user_func($this->callback, $id);
     }

src/Credentials/Credentials.php

@@ -4,21 +4,21 @@
 
 class Credentials implements CredentialsInterface
 {
-    public function __construct(private $key, private $algorithm = 'sha256', private $id = null)
+    public function __construct(private string $key, private string $algorithm = 'sha256', private ?string $id = null)
     {
     }
 
-    public function id()
+    public function id(): ?string
     {
         return $this->id;
     }
 
-    public function key()
+    public function key(): string
     {
         return $this->key;
     }
 
-    public function algorithm()
+    public function algorithm(): string
     {
         return $this->algorithm;
     }

src/Credentials/CredentialsInterface.php

@@ -4,7 +4,7 @@
 
 interface CredentialsInterface
 {
-    public function key();
-    public function algorithm();
-    public function id();
+    public function key(): string;
+    public function algorithm(): string;
+    public function id(): ?string;
 }

src/Credentials/CredentialsProviderInterface.php

@@ -4,5 +4,5 @@
 
 interface CredentialsProviderInterface
 {
-    public function loadCredentialsById($id);
+    public function loadCredentialsById(string $id): CredentialsInterface;
 }