Merge pull request #203 from phil-davis/phpstan-phpunit

Add phpstan phpunit strict-rules
sabre-io · Jun 27, 2023 · 5220b2b · 5220b2b
2 parents fcc83fa + dbc86e4
commit 5220b2b
Show file tree

Hide file tree

Showing 14 changed files with 74 additions and 46 deletions.
diff --git a/composer.json b/composer.json
@@ -15,6 +15,9 @@
     "require-dev" : {
         "friendsofphp/php-cs-fixer": "^3.14",
         "phpstan/phpstan": "^1.9",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-strict-rules": "^1.4",
+        "phpstan/extension-installer": "^1.2",
         "phpunit/phpunit" : "^9.6"
     },
     "suggest" : {
@@ -60,5 +63,10 @@
             "composer cs-fixer",
             "composer phpunit"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     }
 }
diff --git a/lib/Auth/AWS.php b/lib/Auth/AWS.php
@@ -84,7 +84,7 @@ public function validate(string $secretKey): bool
     {
         $contentMD5 = $this->request->getHeader('Content-MD5');
 
-        if ($contentMD5) {
+        if (null !== $contentMD5) {
             // We need to validate the integrity of the request
             $body = $this->request->getBody();
             $this->request->setBody($body);
@@ -97,7 +97,9 @@ public function validate(string $secretKey): bool
             }
         }
 
-        if (!$requestDate = $this->request->getHeader('x-amz-date')) {
+        $requestDate = $this->request->getHeader('x-amz-date');
+
+        if (null === $requestDate) {
             $requestDate = $this->request->getHeader('Date');
         }
 

diff --git a/lib/Auth/Basic.php b/lib/Auth/Basic.php
@@ -31,15 +31,21 @@ public function getCredentials(): ?array
     {
         $auth = $this->request->getHeader('Authorization');
 
-        if (!$auth) {
+        if (null === $auth) {
             return null;
         }
 
         if ('basic ' !== strtolower(substr($auth, 0, 6))) {
             return null;
         }
 
-        $credentials = explode(':', base64_decode(substr($auth, 6)), 2);
+        $decodedAuth = base64_decode(substr($auth, 6), true);
+
+        if (false === $decodedAuth) {
+            return null;
+        }
+
+        $credentials = explode(':', $decodedAuth, 2);
 
         if (2 !== count($credentials)) {
             return null;

diff --git a/lib/Auth/Bearer.php b/lib/Auth/Bearer.php
@@ -28,7 +28,7 @@ public function getToken(): ?string
     {
         $auth = $this->request->getHeader('Authorization');
 
-        if (!$auth) {
+        if (null === $auth) {
             return null;
         }
 

diff --git a/lib/Auth/Digest.php b/lib/Auth/Digest.php
@@ -130,14 +130,14 @@ protected function validate(): bool
 
         if ('auth-int' === $this->digestParts['qop']) {
             // Making sure we support this qop value
-            if (!($this->qop & self::QOP_AUTHINT)) {
+            if (0 === ($this->qop & self::QOP_AUTHINT)) {
                 return false;
             }
             // We need to add an MD5 of the entire request body to the A2 part of the hash
             $body = $this->request->getBody();
             $this->request->setBody($body);
             $A2 .= ':'.md5($body);
-        } elseif (!($this->qop & self::QOP_AUTH)) {
+        } elseif (0 === ($this->qop & self::QOP_AUTH)) {
             return false;
         }
 
@@ -200,10 +200,10 @@ protected function parseDigest(string $digest)
         preg_match_all('@(\w+)=(?:(?:")([^"]+)"|([^\s,$]+))@', $digest, $matches, PREG_SET_ORDER);
 
         foreach ($matches as $m) {
-            $data[$m[1]] = $m[2] ?: $m[3];
+            $data[$m[1]] = ('' !== $m[2]) ? $m[2] : $m[3];
             unset($needed_parts[$m[1]]);
         }
 
-        return $needed_parts ? false : $data;
+        return (count($needed_parts) > 0) ? false : $data;
     }
 }
diff --git a/lib/Client.php b/lib/Client.php
@@ -122,7 +122,7 @@ public function send(RequestInterface $request): ResponseInterface
                 // open_basedir.
                 //
                 // https://github.com/fruux/sabre-http/issues/12
-                if ($redirects < $this->maxRedirects && in_array($code, [301, 302, 307, 308])) {
+                if ($redirects < $this->maxRedirects && in_array($code, [301, 302, 307, 308], true)) {
                     $oldLocation = $request->getUrl();
 
                     // Creating a new instance of the request object.
@@ -194,7 +194,7 @@ public function sendAsync(RequestInterface $request, callable $success = null, c
     public function poll(): bool
     {
         // nothing to do?
-        if (!$this->curlMultiMap) {
+        if (0 === count($this->curlMultiMap)) {
             return false;
         }
 
@@ -216,6 +216,7 @@ public function poll(): bool
 
             if ($status && CURLMSG_DONE === $status['msg']) {
                 $resourceId = (int) $status['handle'];
+
                 list(
                     $request,
                     $successCallback,
@@ -239,7 +240,7 @@ public function poll(): bool
 
                     $curlResult['request'] = $request;
 
-                    if ($errorCallback) {
+                    if (is_callable($errorCallback)) {
                         $errorCallback($curlResult);
                     }
                 } elseif (self::STATUS_HTTPERROR === $curlResult['status']) {
@@ -254,13 +255,13 @@ public function poll(): bool
 
                     $curlResult['request'] = $request;
 
-                    if ($errorCallback) {
+                    if (is_callable($errorCallback)) {
                         $errorCallback($curlResult);
                     }
                 } else {
                     $this->emit('afterRequest', [$request, $curlResult['response']]);
 
-                    if ($successCallback) {
+                    if (is_callable($successCallback)) {
                         $successCallback($curlResult['response']);
                     }
                 }
@@ -314,7 +315,7 @@ protected function doRequest(RequestInterface $request): ResponseInterface
     {
         $settings = $this->createCurlSettingsArray($request);
 
-        if (!$this->curlHandle) {
+        if (null === $this->curlHandle) {
             $this->curlHandle = curl_init();
         } else {
             curl_reset($this->curlHandle);
@@ -353,7 +354,7 @@ protected function doRequest(RequestInterface $request): ResponseInterface
      * Has a list of curl handles, as well as their associated success and
      * error callbacks.
      *
-     * @var array<int, mixed>
+     * @var array<int, array{0: RequestInterface, 1: callable, 2: callable, 3: int}>
      */
     private array $curlMultiMap = [];
 
@@ -475,7 +476,7 @@ protected function parseCurlResponse(array $headerLines, string $body, $curlHand
             $curlErrMsg
         ) = $this->curlStuff($curlHandle);
 
-        if ($curlErrNo) {
+        if (0 !== $curlErrNo) {
             return [
                 'status' => self::STATUS_CURLERROR,
                 'curl_errno' => $curlErrNo,
@@ -532,7 +533,7 @@ protected function parseCurlResult(string $response, $curlHandle): array
             $curlErrMsg
         ) = $this->curlStuff($curlHandle);
 
-        if ($curlErrNo) {
+        if (0 !== $curlErrNo) {
             return [
                 'status' => self::STATUS_CURLERROR,
                 'curl_errno' => $curlErrNo,
@@ -541,10 +542,13 @@ protected function parseCurlResult(string $response, $curlHandle): array
         }
 
         $headerBlob = substr($response, 0, $curlInfo['header_size']);
-        // In the case of 204 No Content, strlen($response) == $curlInfo['header_size].
+        // In the case of 204 No Content, strlen($response) == $curlInfo['header_size'].
         // This will cause substr($response, $curlInfo['header_size']) return FALSE instead of NULL
         // An exception will be thrown when calling getBodyAsString then
-        $responseBody = substr($response, $curlInfo['header_size']) ?: '';
+        $responseBody = substr($response, $curlInfo['header_size']);
+        if (false === $responseBody) {
+            $responseBody = '';
+        }
 
         unset($response);
 
@@ -570,7 +574,7 @@ protected function parseCurlResult(string $response, $curlHandle): array
      */
     protected function sendAsyncInternal(RequestInterface $request, callable $success, callable $error, int $retryCount = 0): void
     {
-        if (!$this->curlMultiHandle) {
+        if (null === $this->curlMultiHandle) {
             $this->curlMultiHandle = curl_multi_init();
         }
         $curl = curl_init();

diff --git a/lib/Request.php b/lib/Request.php
@@ -108,7 +108,7 @@ public function setAbsoluteUrl(string $url): void
      */
     public function getAbsoluteUrl(): string
     {
-        if (!$this->absoluteUrl) {
+        if ((null === $this->absoluteUrl) || ('' === $this->absoluteUrl)) {
             // Guessing we're a http endpoint.
             $this->absoluteUrl = 'http://'.
                 ($this->getHeader('Host') ?? 'localhost').

diff --git a/lib/Response.php b/lib/Response.php
@@ -97,7 +97,7 @@ class Response extends Message implements ResponseInterface
     /**
      * Creates the response object.
      *
-     * @param string|int                    $status
+     * @param string|int|null               $status
      * @param array<string, mixed>|null     $headers
      * @param resource|string|callable|null $body
      */

diff --git a/lib/Sapi.php b/lib/Sapi.php
@@ -201,7 +201,7 @@ public static function createFromServerArray(array $serverArray): Request
                     break;
 
                 case 'HTTPS':
-                    if (!empty($value) && 'off' !== $value) {
+                    if ('' !== $value && 'off' !== $value) {
                         $protocol = 'https';
                     }
                     break;

diff --git a/lib/functions.php b/lib/functions.php
@@ -103,7 +103,7 @@ function toDate(\DateTime $dateTime): string
  */
 function negotiateContentType(?string $acceptHeaderValue, array $availableOptions): ?string
 {
-    if (!$acceptHeaderValue) {
+    if ((null === $acceptHeaderValue) || ('' === $acceptHeaderValue)) {
         // Grabbing the first in the list.
         return reset($availableOptions);
     }
@@ -261,7 +261,7 @@ function parsePrefer($input): array
                 } else {
                     $value = true;
                 }
-                $output[strtolower($matches['name'])] = empty($value) ? true : $value;
+                $output[strtolower($matches['name'])] = ('' === $value) ? true : $value;
                 break;
         }
     }
@@ -291,7 +291,7 @@ function parsePrefer($input): array
 function getHeaderValues($values, $values2 = null): array
 {
     $values = (array) $values;
-    if ($values2) {
+    if (null !== $values2) {
         $values = array_merge($values, (array) $values2);
     }
 

diff --git a/phpstan.neon b/phpstan.neon
@@ -12,9 +12,17 @@ parameters:
     path: lib/Client.php
   -
     message: "#^Left side of || is always false.$#"
-    count: 2
+    count: 6
     path: lib/Client.php
+  -
+    message: "#^Casting to string something that's already string.$#"
+    count: 1
+    path: lib/Sapi.php
   -
     message: "#^Strict comparison using === between null and array<string, mixed> will always evaluate to false.$#"
     count: 1
     path: lib/functions.php
+  -
+    message: "#^.* will always evaluate to true\\.$#"
+    count: 4
+    path: tests/*
diff --git a/tests/HTTP/Auth/AWSTest.php b/tests/HTTP/Auth/AWSTest.php
@@ -90,7 +90,7 @@ public function testFutureDate(): void
         $contentMD5 = base64_encode(md5($content, true));
 
         $date = new \DateTime('@'.(time() + (60 * 20)));
-        $date->setTimeZone(new \DateTimeZone('GMT'));
+        $date->setTimezone(new \DateTimeZone('GMT'));
         $date = $date->format('D, d M Y H:i:s \\G\\M\\T');
 
         $this->request->setMethod('POST');
@@ -117,7 +117,7 @@ public function testPastDate(): void
         $contentMD5 = base64_encode(md5($content, true));
 
         $date = new \DateTime('@'.(time() - (60 * 20)));
-        $date->setTimeZone(new \DateTimeZone('GMT'));
+        $date->setTimezone(new \DateTimeZone('GMT'));
         $date = $date->format('D, d M Y H:i:s \\G\\M\\T');
 
         $this->request->setMethod('POST');
@@ -145,7 +145,7 @@ public function testIncorrectSignature(): void
         $contentMD5 = base64_encode(md5($content, true));
 
         $date = new \DateTime('now');
-        $date->setTimeZone(new \DateTimeZone('GMT'));
+        $date->setTimezone(new \DateTimeZone('GMT'));
         $date = $date->format('D, d M Y H:i:s \\G\\M\\T');
 
         $this->request->setUrl('/');
@@ -172,7 +172,7 @@ public function testValidRequest(): void
         $contentMD5 = base64_encode(md5($content, true));
 
         $date = new \DateTime('now');
-        $date->setTimeZone(new \DateTimeZone('GMT'));
+        $date->setTimezone(new \DateTimeZone('GMT'));
         $date = $date->format('D, d M Y H:i:s \\G\\M\\T');
 
         $sig = base64_encode($this->hmacsha1($secretKey,