Merge pull request #44 from CyberfusionNL/feature/php-8

Update the code with Rector to PHP >= 8.0

Author: dvdheiden

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.github/workflows/ci.yml

@@ -1,40 +1,44 @@
 name: Cluster API
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 jobs:
-    cluster-api-tests:
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                php-versions: ['8.0', '8.1', '8.2']
-
-        name: PHP ${{ matrix.php-versions }}
-
-        steps:
-            -   name: Checkout
-                uses: actions/checkout@v3
-                with:
-                    repository: ${{ github.event.pull_request.head.repo.full_name }}
-                    ref: ${{ github.event.pull_request.head.ref }}
-
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php-versions }}
-                  extensions: mbstring, intl
-
-            - name: Install Dependencies
-              run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress
-
-            - name: Execute tests (Unit and Feature tests) via PHPUnit
-              run: |
-                  vendor/bin/phpunit
-
-            - name: Execute static analysis
-              run: |
-                  vendor/bin/phpstan
-
-            - name: Execute code style check
-              run: |
-                  vendor/bin/ecs check
+  cluster-api-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: [ '8.0', '8.1', '8.2' ]
+
+    name: PHP ${{ matrix.php-versions }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl
+
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress
+
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        run: |
+          vendor/bin/phpunit
+
+      - name: Execute static analysis
+        run: |
+          vendor/bin/phpstan
+
+      - name: Execute rector
+        run: |
+          composer rector:check
+
+      - name: Execute code style check
+        run: |
+          vendor/bin/ecs check

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 this package and not the cluster API. See the changelog of the [cluster API](https://cluster-api.cyberfusion.nl/redoc#section/Changelog) 
 for detailed information.
 
+## [1.91.0]
+
+### Changed
+
+- Updated the code with Rector to PHP >= 8.0.
+
 ## [1.90.0]
 
 ### Changed

composer.json

@@ -20,6 +20,7 @@
     "require-dev": {
         "phpstan/phpstan": "^1.2",
         "phpunit/phpunit": "^9.0",
+        "rector/rector": "^0.14.6",
         "symplify/easy-coding-standard": "^11.1"
     },
     "autoload": {
@@ -37,7 +38,9 @@
         "test-coverage": "vendor/bin/phpunit",
         "analyse": "vendor/bin/phpstan analyse",
         "ecs:check": "@php vendor/bin/ecs check",
-        "ecs:fix": "@ecs:check --fix"
+        "ecs:fix": "@ecs:check --fix",
+        "rector:check": "@rector:fix --dry-run",
+        "rector:fix": "@php vendor/bin/rector process"
     },
     "config": {
         "sort-packages": true

rector.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
+use Rector\Config\RectorConfig;
+use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
+use Rector\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector;
+use Rector\Set\ValueObject\SetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([
+        SetList::PHP_80,
+        SetList::CODE_QUALITY,
+        SetList::DEAD_CODE,
+    ]);
+
+    $rectorConfig->paths([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ]);
+
+    $rectorConfig->skip([
+        AddLiteralSeparatorToNumberRector::class,
+        CountArrayToEmptyArrayComparisonRector::class,
+        JsonThrowOnErrorRector::class,
+    ]);
+
+    $rectorConfig->importNames();
+    $rectorConfig->importShortClasses();
+};

src/Client.php

@@ -17,23 +17,16 @@ class Client implements ClientContract
 {
     private const CONNECT_TIMEOUT = 60;
     private const TIMEOUT = 180;
-    private const VERSION = '1.90.0';
+    private const VERSION = '1.91.0';
     private const USER_AGENT = 'cyberfusion-cluster-api-client/' . self::VERSION;
-
-    private Configuration $configuration;
     private GuzzleClient $httpClient;
 
     /**
-     * Client constructor.
-     * @param Configuration $configuration
-     * @param bool $manuallyAuthenticate
      * @throws ClientException
      * @throws ClusterApiException
      */
-    public function __construct(Configuration $configuration, bool $manuallyAuthenticate = false)
+    public function __construct(private Configuration $configuration, bool $manuallyAuthenticate = false)
     {
-        $this->configuration = $configuration;
-
         // Initialize the HTTP client
         $this->initHttpClient();
 
@@ -70,16 +63,14 @@ private function initHttpClient(): void
 
     /**
      * Determines if the API is up.
-     *
-     * @return bool
      */
     private function isUp(): bool
     {
         // Retrieve the health status
         $healthEndpoint = new Health($this);
         try {
             $response = $healthEndpoint->get();
-        } catch (RequestException $exception) {
+        } catch (RequestException) {
             return false;
         }
 
@@ -127,7 +118,6 @@ private function authenticate(): void
     /**
      * Determine if the current access token is valid.
      *
-     * @return bool
      * @throws RequestException
      */
     private function validateAccessToken(): bool
@@ -147,7 +137,6 @@ private function validateAccessToken(): bool
     /**
      * Retrieve the access token with the credentials. Returns null when no access token could be retrieved.
      *
-     * @return string|null
      * @throws RequestException
      */
     private function retrieveAccessToken(): ?string
@@ -172,8 +161,6 @@ private function retrieveAccessToken(): ?string
 
     /**
      * Store the access token in the configuration.
-     *
-     * @param string $accessToken
      */
     private function storeAccessToken(string $accessToken): void
     {
@@ -204,9 +191,6 @@ public function request(Request $request): Response
 
     /**
      * Determine the request options based on the request and configuration.
-     *
-     * @param Request $request
-     * @return array
      */
     private function getRequestOptions(Request $request): array
     {
@@ -227,9 +211,6 @@ private function getRequestOptions(Request $request): array
 
     /**
      * Parse the body to error models when applicable.
-     *
-     * @param ResponseInterface $response
-     * @return array
      */
     private function parseBody(ResponseInterface $response): array
     {