Merge pull request #1 from Gared/add_phpstan

Add phpstan to project

Author: Gared

.github/workflows/php.yml

@@ -37,7 +37,5 @@ jobs:
         php_version: 7.4
         version: 9
 
-    - name: PHPStan
-      uses: docker://oskarstark/phpstan-ga
-      with:
-        args: analyse lib/ --level=5
+    - name: Run PHPStan
+      run: vendor/bin/phpstan

composer.json

@@ -30,6 +30,9 @@
     "phpdocumentor/reflection-docblock": "^5.2"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.5"
+    "phpunit/phpunit": "^9.5",
+    "phpstan/phpstan": "^1.0",
+    "phpstan/phpstan-phpunit": "^1.0",
+    "phpstan/phpstan-strict-rules": "^1.0"
   }
 }

lib/HTTP/Client.php

@@ -4,6 +4,7 @@
 namespace ShellyClient\HTTP;
 
 use GuzzleHttp\ClientInterface;
+use GuzzleHttp\RequestOptions;
 use ShellyClient\Model\Request\SettingsActionsRequest;
 use ShellyClient\Model\Request\SettingsLightRequest;
 use ShellyClient\Model\Response\SettingsActionsResponse;
@@ -29,11 +30,7 @@
 class Client
 {
     private ClientInterface $httpClient;
-
-    private SerializerInterface $serializer;
-
     private string $baseUrl;
-
     private ?string $deviceName;
 
     /**
@@ -45,7 +42,7 @@ public function __construct(string $baseUrl, string $deviceName = null, ClientIn
     {
         $this->baseUrl = $baseUrl;
         $this->deviceName = $deviceName;
-        $this->serializer = $this->getSerializer();
+
         if ($client === null) {
             $this->httpClient = $this->createDefaultHttpClient();
         } else {
@@ -104,8 +101,8 @@ protected function createDefaultHttpClient(): ClientInterface
     {
         return new \GuzzleHttp\Client([
             'base_uri' => $this->baseUrl,
-            'timeout' => 5,
-            'connect_timeout' => 5,
+            RequestOptions::TIMEOUT => 5,
+            RequestOptions::CONNECT_TIMEOUT => 5,
         ]);
     }
 

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+
+parameters:
+	level: 5
+	paths:
+		- lib
+		- tests
+	phpVersion: 80000

tests/Model/Request/AbstractRequestTest.php

@@ -3,15 +3,17 @@
 
 namespace ShellyClientTest\Model\Request;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use ShellyClient\HTTP\Client;
 use ShellyClient\HTTP\RequestService;
 use ShellyClientTest\Mock\HTTP\ClientMock;
 
 abstract class AbstractRequestTest extends TestCase
 {
-    protected static Client $client;
-
+    protected static ClientMock $client;
+    /**
+     * @var RequestService&MockObject
+     */
     protected RequestService $requestService;
 
     public static function setUpBeforeClass(): void
@@ -23,7 +25,7 @@ protected function setUp(): void
     {
         $this->requestService = $this
             ->getMockBuilder(RequestService::class)
-            ->setMethods(['getResponse', 'getRequest'])
+            ->onlyMethods(['getResponse', 'getRequest'])
             ->setConstructorArgs([self::$client->getHttpClient(), self::$client->getSerializer()])
             ->getMock();
     }

tests/Model/Request/SettingsRequestTest.php

@@ -4,32 +4,11 @@
 namespace ShellyClientTest\Model\Request;
 
 use GuzzleHttp\Psr7\Response;
-use PHPUnit\Framework\TestCase;
-use ShellyClient\HTTP\Client;
-use ShellyClient\HTTP\RequestService;
 use ShellyClient\Model\Request\SettingsRequest;
-use ShellyClientTest\Mock\HTTP\ClientMock;
+use ShellyClient\Model\Response\SettingsResponse;
 
-class SettingsRequestTest extends TestCase
+class SettingsRequestTest extends AbstractRequestTest
 {
-    private static Client $client;
-
-    private RequestService $requestService;
-
-    public static function setUpBeforeClass(): void
-    {
-        self::$client = new ClientMock('');
-    }
-
-    protected function setUp(): void
-    {
-        $this->requestService = $this
-            ->getMockBuilder(RequestService::class)
-            ->setMethods(['getResponse', 'getRequest'])
-            ->setConstructorArgs([self::$client->getHttpClient(), self::$client->getSerializer()])
-            ->getMock();
-    }
-
     public function simpleDataProvider(): array
     {
         return [
@@ -54,12 +33,13 @@ public function testSimple(string $testFile, string $expectedType): void
         $this->requestService->method('getResponse')->willReturn($response);
         $this->requestService->method('getRequest')->willReturn(new SettingsRequest());
 
+        /** @var SettingsResponse $settings */
         $settings = $this->requestService->getResponseSerialized();
 
         self::assertSame('PC', $settings->getName());
         self::assertSame($expectedType, $settings->getDevice()->getType());
 
-        self::assertIsArray($settings->getRelays());
+        self::assertNotEmpty($settings->getRelays());
         self::assertCount($settings->getDevice()->getNumOutputs(), $settings->getRelays());
     }