Adopt Psalm (#19)

Fantom409 · web-flow · commit 45151da0a582 · 2020-10-21T17:05:06.000+03:00
* Adopt Psalm
* Psalm fixes
* Fix testSetResponseLoopFormatter
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -7,8 +7,6 @@ name: static analysis
 jobs:
   mutation:
     name: PHP ${{ matrix.php-version }}-${{ matrix.os }}
-    env:
-      extensions: ast
 
     runs-on: ${{ matrix.os }}
 
@@ -28,7 +26,6 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           php-version: "${{ matrix.php-version }}"
-          extensions: ${{ env.extensions }}
           tools: composer:v2, cs2pr
           coverage: none
 
@@ -46,5 +43,5 @@ jobs:
       - name: Install dependencies with composer
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader
 
-      - name: Static analysis with phan
-        run: vendor/bin/phan --no-progress-bar --output-mode checkstyle | cs2pr --graceful-warnings --colorize
+      - name: Static analysis with psalm
+        run: vendor/bin/psalm --shepherd --stats --output-format=checkstyle | cs2pr --graceful-warnings --colorize
diff --git a/.phan/config.php b/.phan/config.php
diff --git a/README.md b/README.md
@@ -36,8 +36,8 @@ The package tests are checked with [Infection](https://infection.github.io/) mut
 
 ### Static analysis
 
-The code is statically analyzed with [Phan](https://github.com/phan/phan/wiki). To run static analysis:
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
 
 ```php
-./vendor/bin/phan
+./vendor/bin/psalm
 ```
diff --git a/composer.json b/composer.json
@@ -28,9 +28,9 @@
     },
     "require-dev": {
         "infection/infection": "^0.16.3",
-        "phan/phan": "^3.0",
         "phpunit/phpunit": "^9.3",
-        "nyholm/psr7": "^1.0"
+        "nyholm/psr7": "^1.0",
+        "vimeo/psalm": "^4.0"
     },
     "autoload": {
         "psr-4": {
diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="3"
+    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"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/DataResponse.php b/src/DataResponse.php
@@ -36,8 +36,8 @@ public function getBody(): StreamInterface
             return $this->dataStream;
         }
 
-        if ($this->responseFormatter !== null) {
-            $this->response = $this->formatResponse();
+        if (($response = $this->formatResponse()) !== null) {
+            $this->response = $response;
             return $this->dataStream = $this->response->getBody();
         }
 
@@ -165,13 +165,17 @@ public function getData()
         return is_object($this->data) ? clone $this->data : $this->data;
     }
 
-    private function formatResponse(): ResponseInterface
+    private function formatResponse(): ?ResponseInterface
     {
-        $response = $this->responseFormatter->format($this);
-        if ($response instanceof self) {
-            throw new \RuntimeException('DataResponseFormatterInterface should not return instance of DateResponse.');
+        if ($this->responseFormatter !== null) {
+            $response = $this->responseFormatter->format($this);
+            if ($response instanceof self) {
+                throw new \RuntimeException('DataResponseFormatterInterface should not return instance of DataResponse.');
+            }
+
+            return $response;
+        } else {
+            return null;
         }
-
-        return $response;
     }
 }
diff --git a/src/Formatter/XmlDataResponseFormatter.php b/src/Formatter/XmlDataResponseFormatter.php
@@ -113,7 +113,7 @@ public function withUseObjectTags(bool $useObjectTags): self
     }
 
     /**
-     * @param DOMElement $element
+     * @param DOMElement|DOMDocument $element
      * @param mixed $data
      */
     private function buildXml($element, $data): void
diff --git a/tests/DataResponseTest.php b/tests/DataResponseTest.php
@@ -66,7 +66,7 @@ public function testSetEmptyResponseFormatter(): void
     public function testSetResponseLoopFormatter(): void
     {
         $this->expectException(\RuntimeException::class);
-        $this->expectExceptionMessage('DataResponseFormatterInterface should not return instance of DateResponse.');
+        $this->expectExceptionMessage('DataResponseFormatterInterface should not return instance of DataResponse.');
 
         $dataResponse = new DataResponse('test', Status::OK, '', new Psr17Factory());
         $dataResponse = $dataResponse->withResponseFormatter(new LoopDataResponseFormatter());

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,8 @@ public function getBody(): StreamInterface`
`36`	`36`	`return $this->dataStream;`
`37`	`37`	`}`
`38`	`38`
`39`		`- if ($this->responseFormatter !== null) {`
`40`		`- $this->response = $this->formatResponse();`
	`39`	`+ if (($response = $this->formatResponse()) !== null) {`
	`40`	`+ $this->response = $response;`
`41`	`41`	`return $this->dataStream = $this->response->getBody();`
`42`	`42`	`}`
`43`	`43`
`@@ -165,13 +165,17 @@ public function getData()`
`165`	`165`	`return is_object($this->data) ? clone $this->data : $this->data;`
`166`	`166`	`}`
`167`	`167`
`168`		`- private function formatResponse(): ResponseInterface`
	`168`	`+ private function formatResponse(): ?ResponseInterface`
`169`	`169`	`{`
`170`		`- $response = $this->responseFormatter->format($this);`
`171`		`- if ($response instanceof self) {`
`172`		`- throw new \RuntimeException('DataResponseFormatterInterface should not return instance of DateResponse.');`
	`170`	`+ if ($this->responseFormatter !== null) {`
	`171`	`+ $response = $this->responseFormatter->format($this);`
	`172`	`+ if ($response instanceof self) {`
	`173`	`+ throw new \RuntimeException('DataResponseFormatterInterface should not return instance of DataResponse.');`
	`174`	`+ }`
	`175`	`+`
	`176`	`+ return $response;`
	`177`	`+ } else {`
	`178`	`+ return null;`
`173`	`179`	`}`
`174`		`-`
`175`		`- return $response;`
`176`	`180`	`}`
`177`	`181`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public function withUseObjectTags(bool $useObjectTags): self`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`/**`
`116`		`- * @param DOMElement $element`
	`116`	`+ * @param DOMElement\|DOMDocument $element`
`117`	`117`	`* @param mixed $data`
`118`	`118`	`*/`
`119`	`119`	`private function buildXml($element, $data): void`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function testSetEmptyResponseFormatter(): void`
`66`	`66`	`public function testSetResponseLoopFormatter(): void`
`67`	`67`	`{`
`68`	`68`	`$this->expectException(\RuntimeException::class);`
`69`		`- $this->expectExceptionMessage('DataResponseFormatterInterface should not return instance of DateResponse.');`
	`69`	`+ $this->expectExceptionMessage('DataResponseFormatterInterface should not return instance of DataResponse.');`
`70`	`70`
`71`	`71`	`$dataResponse = new DataResponse('test', Status::OK, '', new Psr17Factory());`
`72`	`72`	`$dataResponse = $dataResponse->withResponseFormatter(new LoopDataResponseFormatter());`