Merge pull request #141 from Sysix/psalm

add psalm

Author: Sysix

.gitattributes

@@ -4,4 +4,7 @@
 /.gitignore export-ignore
 /phpunit.xml export-ignore
 /phpstan.neon export-ignore
-/.php-cs-fixer.dist.php export-ignore
+/.php-cs-fixer.dist.php export-ignore
+/psalm.xml export-ignore
+/docker-compose.yml export-ignore
+/Dockerfile export-ignore

.github/workflows/psalm.yml

@@ -0,0 +1,13 @@
+name: Run Psalm
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: docker://ghcr.io/psalm/psalm-github-actions
+        with:
+          composer_require_dev: true

Dockerfile

@@ -0,0 +1,28 @@
+FROM php:8.2-fpm
+
+
+# install non php modules
+RUN apt-get update \
+    && apt-get install --no-install-recommends -y \
+        libssl-dev \
+        libzip-dev \
+        libxml2-dev \
+        libonig-dev \
+        libc-client-dev \
+        libkrb5-dev \
+        zlib1g-dev \
+        zip \
+        unzip \
+        git \
+    && rm -rf /var/lib/apt/lists/*
+
+# Configure imap
+RUN docker-php-ext-install \
+    zip \
+    mbstring \
+    xml \
+    curl
+
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+
+WORKDIR /var/www/html

composer.json

@@ -6,7 +6,8 @@
     "test": "phpunit",
     "lint": "phpstan analyse --ansi --error-format raw",
     "codestyle:check": "php-cs-fixer check",
-    "codestyle:fix": "php-cs-fixer fix"
+    "codestyle:fix": "php-cs-fixer fix",
+    "psalm": "psalm"
   },
   "keywords": [
     "lex-office",
@@ -25,7 +26,9 @@
     "phpstan/phpstan": "^1.10",
     "phpunit/phpunit": "^10.4",
     "guzzlehttp/guzzle": "^7.8",
-    "friendsofphp/php-cs-fixer": "^3.41"
+    "friendsofphp/php-cs-fixer": "^3.41",
+    "vimeo/psalm": "^5.18",
+    "psalm/plugin-phpunit": "^0.18.4"
   },
   "suggest": {
     "guzzlehttp/guzzle": "^7.0",

docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3.7'
+services:
+  php-fpm:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - './:/var/www/html'

psalm.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="8"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="src" />
+        <directory name="tests" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+    <issueHandlers>
+        <PropertyNotSetInConstructor errorLevel="suppress" />
+        <DeprecatedMethod errorLevel="suppress" />
+        <RedundantPropertyInitializationCheck errorLevel="suppress" />
+    </issueHandlers>
+    <plugins>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin" />
+    </plugins>
+</psalm>

src/Api.php

@@ -47,11 +47,9 @@ public function __construct(
 
     public function newRequest(string $method, string $resource, array $headers = []): self
     {
-        $this->setRequest(
+        return $this->setRequest(
             new Request($method, $this->createApiUri($resource), $headers)
         );
-
-        return $this;
     }
 
     public function setRequest(RequestInterface $request): self

src/Clients/File.php

@@ -18,9 +18,9 @@ public function get(string $id, string $acceptHeader = '*/*'): ResponseInterface
     {
         $this->api->newRequest('GET', $this->resource . '/' . rawurlencode($id));
 
-        $this->api->setRequest($this->api->getRequest()->withHeader('Accept', $acceptHeader));
-
-        return $this->api->getResponse();
+        return $this->api
+            ->setRequest($this->api->getRequest()->withHeader('Accept', $acceptHeader))
+            ->getResponse();
     }
 
     /**
@@ -44,8 +44,8 @@ public function upload(string $filepath, string $type): ResponseInterface
             'Content-Type' => 'multipart/form-data; boundary=' . $body->getBoundary()
         ]);
 
-        $api->setRequest($api->getRequest()->withBody($body));
-
-        return $api->getResponse();
+        return $api
+            ->setRequest($api->getRequest()->withBody($body))
+            ->getResponse();
     }
 }

src/Clients/Voucher.php

@@ -37,9 +37,9 @@ public function upload(string $id, string $filepath): ResponseInterface
             'Content-Type' => 'multipart/form-data; boundary=' . $body->getBoundary()
         ]);
 
-        $api->setRequest($api->getRequest()->withBody($body));
-
-        return $api->getResponse();
+        return $api
+            ->setRequest($api->getRequest()->withBody($body))
+            ->getResponse();
     }
 
     /**

src/Utils.php

@@ -24,25 +24,23 @@ public static function getJsonFromResponse(ResponseInterface $response): mixed
     }
 
     /**
-     * @param array{size?: int, metadata?: mixed[], mode?: bool, seekable?: bool} $options
+     * @param array{size?: int, metadata?: mixed[]} $options
      */
     public static function streamFor(string $resource = '', array $options = []): Stream
     {
-        if (is_scalar($resource)) {
-            $stream = fopen('php://temp', 'r+');
-            if ($resource !== '' && $stream) {
-                fwrite($stream, $resource);
-                fseek($stream, 0);
-
-                return new Stream($stream, $options);
-            }
+        $stream = fopen('php://temp', 'r+');
+        if ($resource !== '' && $stream) {
+            fwrite($stream, $resource);
+            fseek($stream, 0);
+
+            return new Stream($stream, $options);
         }
 
         throw new InvalidArgumentException('Invalid resource type: ' . gettype($resource));
     }
 
     /**
-     * @param int<1, max> $depth
+     * @param int<1, 2147483647> $depth
      */
     public static function jsonEncode(mixed $value, int $options = 0, int $depth = 512): string
     {
@@ -55,7 +53,7 @@ public static function jsonEncode(mixed $value, int $options = 0, int $depth = 5
     }
 
     /**
-     * @param int<1, max> $depth
+     * @param int<1, 2147483647> $depth
      */
     public static function jsonDecode(string $json, bool $assoc = false, int $depth = 512, int $options = 0): mixed
     {
@@ -69,7 +67,7 @@ public static function jsonDecode(string $json, bool $assoc = false, int $depth
 
     public static function createStream(mixed $content): StreamInterface
     {
-        return Utils::streamFor(Utils::jsonEncode($content));
+        return self::streamFor(self::jsonEncode($content));
     }
 
     /**