Merge pull request #5 from loevgaard/cs

Add coding standard, types, and Psalm

Author: BenjaminFavre

.github/workflows/build.yaml

@@ -57,6 +57,7 @@ jobs:
                     - "8.1"
 
                 dependencies:
+                    - "lowest"
                     - "highest"
 
         steps:
@@ -94,6 +95,7 @@ jobs:
                     - "8.1"
 
                 dependencies:
+                    - "lowest"
                     - "highest"
 
         steps:
@@ -113,4 +115,4 @@ jobs:
                     dependency-versions: "${{ matrix.dependencies }}"
 
             -   name: "Static analysis"
-                run: "composer phpstan"
+                run: "composer analyse"

composer.json

@@ -23,10 +23,11 @@
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.28",
-        "phpstan/phpstan": "^0.12.64",
         "phpunit/phpunit": "^9.4.3",
+        "sylius-labs/coding-standard": "^4.2",
         "symfony/cache": "^6.0",
-        "symfony/http-client": "^6.0"
+        "symfony/http-client": "^6.0",
+        "vimeo/psalm": "^4.26"
     },
     "provide": {
         "symfony/http-client-implementation": "^2.3.1"
@@ -38,10 +39,13 @@
     },
     "config": {
         "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": false,
             "ergebnis/composer-normalize": true
         }
     },
     "scripts": {
-        "phpstan": "vendor/bin/phpstan analyse --level max src tests"
+        "analyse": "psalm",
+        "check-style": "ecs check",
+        "fix-style": "ecs check --fix"
     }
 }

ecs.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $config): void {
+    $config->import('vendor/sylius-labs/coding-standard/ecs.php');
+    $config->paths([
+        'src',
+    ]);
+};

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    errorLevel="1"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    phpVersion="8.1"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Exception/OAuthException.php

@@ -1,14 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\Exception;
 
 use RuntimeException;
 
 /**
  * Represents errors during OAuth protocol.
- *
- * @author Benjamin Favre <[email protected]>
  */
 class OAuthException extends RuntimeException implements OAuthExceptionInterface
 {
-}
+}

src/Exception/OAuthExceptionInterface.php

@@ -1,14 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\Exception;
 
 use Symfony\Contracts\HttpClient\Exception\ExceptionInterface;
 
 /**
  * Represents errors during OAuth protocol.
- * 
- * @author Benjamin Favre <[email protected]>
  */
 interface OAuthExceptionInterface extends ExceptionInterface
 {
-}
+}

src/GrantType/AuthorizationCodeGrantType.php

@@ -1,29 +1,28 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\GrantType;
 
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * Implementation of the OAuth authorization grant type.
- *
- * @author Benjamin Favre <[email protected]>
  */
 class AuthorizationCodeGrantType implements RefreshableGrantTypeInterface
 {
     use TokensExtractor;
 
-    /** @var HttpClientInterface */
-    private $client;
-    /** @var string */
-    private $tokenUrl;
-    /** @var string */
-    private $code;
-    /** @var string */
-    private $clientId;
-    /** @var string */
-    private $clientSecret;
+    private HttpClientInterface $client;
+
+    private string $tokenUrl;
+
+    private string $code;
+
+    private string $clientId;
+
+    private string $clientSecret;
 
     /**
      * @param HttpClientInterface $client A HTTP client to be used to communicate with the OAuth server.
@@ -37,7 +36,7 @@ public function __construct(
         string $tokenUrl,
         string $code,
         string $clientId,
-        string $clientSecret
+        string $clientSecret,
     ) {
         $this->client = $client;
         $this->tokenUrl = $tokenUrl;
@@ -47,9 +46,8 @@ public function __construct(
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
-     * @return Tokens
      * @throws TransportExceptionInterface
      */
     public function getTokens(): Tokens
@@ -60,7 +58,7 @@ public function getTokens(): Tokens
                 'client_id' => $this->clientId,
                 'client_secret' => $this->clientSecret,
                 'code' => $this->code,
-            ])
+            ]),
         ]);
 
         return $this->extractTokens($response);
@@ -70,4 +68,4 @@ public function getRefreshTokenGrant(string $refreshToken): GrantTypeInterface
     {
         return new RefreshTokenGrantType($this->client, $this->tokenUrl, $refreshToken, $this->clientId, $this->clientSecret);
     }
-}
+}

src/GrantType/ClientCredentialsGrantType.php

@@ -1,27 +1,26 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\GrantType;
 
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * Implementation of the OAuth client credentials grant type.
- *
- * @author Benjamin Favre <[email protected]>
  */
 class ClientCredentialsGrantType implements GrantTypeInterface
 {
     use TokensExtractor;
 
-    /** @var HttpClientInterface */
-    private $client;
-    /** @var string */
-    private $tokenUrl;
-    /** @var string */
-    private $clientId;
-    /** @var string */
-    private $clientSecret;
+    private HttpClientInterface $client;
+
+    private string $tokenUrl;
+
+    private string $clientId;
+
+    private string $clientSecret;
 
     /**
      * @param HttpClientInterface $client A HTTP client to be used to communicate with the OAuth server.
@@ -33,7 +32,7 @@ public function __construct(
         HttpClientInterface $client,
         string $tokenUrl,
         string $clientId,
-        string $clientSecret
+        string $clientSecret,
     ) {
         $this->client = $client;
         $this->tokenUrl = $tokenUrl;
@@ -42,9 +41,8 @@ public function __construct(
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
-     * @return Tokens
      * @throws TransportExceptionInterface
      */
     public function getTokens(): Tokens
@@ -56,4 +54,4 @@ public function getTokens(): Tokens
 
         return $this->extractTokens($response);
     }
-}
+}

src/GrantType/GrantTypeInterface.php

@@ -1,21 +1,22 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\GrantType;
 
 use BenjaminFavre\OAuthHttpClient\Exception\OAuthException;
 
 /**
  * Implementation of one OAuth grant type.
- *
- * @author Benjamin Favre <[email protected]>
  */
 interface GrantTypeInterface
 {
     /**
      * Retrieves tokens from an OAuth server.
      *
      * @return Tokens The tokens retrieved from the OAuth server.
+     *
      * @throws OAuthException When the tokens could not be retrieved.
      */
     public function getTokens(): Tokens;
-}
+}

src/GrantType/PasswordGrantType.php

@@ -1,47 +1,46 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenjaminFavre\OAuthHttpClient\GrantType;
 
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * Implementation of the OAuth password grant type.
- *
- * @author Benjamin Favre <[email protected]>
  */
 class PasswordGrantType implements GrantTypeInterface
 {
     use TokensExtractor;
 
-    /** @var HttpClientInterface */
-    private $client;
-    /** @var string */
-    private $tokenUrl;
-    /** @var string */
-    private $username;
-    /** @var string */
-    private $password;
-    /** @var ?string */
-    private $clientId;
-    /** @var ?string */
-    private $clientSecret;
+    private HttpClientInterface $client;
+
+    private string $tokenUrl;
+
+    private string $username;
+
+    private string $password;
+
+    private ?string $clientId;
+
+    private ?string $clientSecret;
 
     /**
      * @param HttpClientInterface $client A HTTP client to be used to communicate with the OAuth server.
      * @param string $tokenUrl The full URL of the token endpoint of the OAuth server.
      * @param string $username The OAuth user username.
      * @param string $password The OAuth user password.
-     * @param ?string $clientId The OAuth client ID.
-     * @param ?string $clientSecret The OAuth client secret.
+     * @param string|null $clientId The OAuth client ID.
+     * @param string|null $clientSecret The OAuth client secret.
      */
     public function __construct(
         HttpClientInterface $client,
         string $tokenUrl,
         string $username,
         string $password,
-        ?string $clientId = null,
-        ?string $clientSecret = null
+        string $clientId = null,
+        string $clientSecret = null,
     ) {
         $this->client = $client;
         $this->tokenUrl = $tokenUrl;
@@ -52,9 +51,8 @@ public function __construct(
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      *
-     * @return Tokens
      * @throws TransportExceptionInterface
      */
     public function getTokens(): Tokens
@@ -64,7 +62,7 @@ public function getTokens(): Tokens
             'username' => $this->username,
             'password' => $this->password,
         ];
-        
+
         if ($this->clientId !== null && $this->clientSecret !== null) {
             $parameters = array_merge($parameters, [
                 'client_id' => $this->clientId,
@@ -78,4 +76,4 @@ public function getTokens(): Tokens
 
         return $this->extractTokens($response);
     }
-}
+}