Merge pull request #1 from artemeon/feat/phpstan

feat: PHPStan Level 5

Author: marcreichel

Diff for: .github/workflows/phpstan.yml

@@ -0,0 +1,11 @@
+name: PHPStan
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  phpstan:
+    uses: artemeon/.shared/.github/workflows/phpstan.yml@main

Diff for: composer.json

@@ -3,6 +3,9 @@
   "description": "Connect to the Atlassian Confluence API",
   "license": "MIT",
   "type": "library",
+  "scripts": {
+    "phpstan": "php ./vendor/bin/phpstan analyse --memory-limit=4G"
+  },
   "require": {
     "php": ">=8.1",
     "guzzlehttp/guzzle": "~7.4",
@@ -11,7 +14,9 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.0",
-    "vimeo/psalm": "^3.16"
+    "phpstan/phpstan": "^1.10",
+    "phpstan/extension-installer": "^1.3",
+    "phpstan/phpstan-phpunit": "^1.3"
   },
   "autoload": {
     "psr-4": {
@@ -22,5 +27,10 @@
     "psr-4": {
       "Artemeon\\Confluence\\Tests\\": "tests/"
     }
+  },
+  "config": {
+    "allow-plugins": {
+      "phpstan/extension-installer": true
+    }
   }
-}
+}

Diff for: phpstan.neon

@@ -0,0 +1,8 @@
+includes:
+    - phar://phpstan.phar/conf/bleedingEdge.neon
+
+parameters:
+    level: 5
+    paths:
+        - src
+        - tests

Diff for: src/ConfluencePageContentDownloader.php

@@ -45,4 +45,4 @@ public function downloadPageContent(ConfluencePage $page): void
         }
     }
 
-}
+}

Diff for: src/Endpoint/Auth.php

@@ -19,4 +19,4 @@ public function getAuthenticationArray(): array
     {
         return ['auth' => [$this->username, $this->password]];
     }
-}
+}

Diff for: src/Endpoint/Content.php

@@ -66,4 +66,4 @@ public function findChildAttachments(string $pageId): array
             throw new Exception('Fehler beim Abrufen der Attachments. HTTP-Statuscode: ' . $response->getStatusCode());
         }
     }
-}
+}

Diff for: src/Endpoint/Download.php

@@ -58,4 +58,4 @@ public function downloadAttachment(ConfluenceAttachment $attachment): void
 
         file_put_contents($this->downloadFolder . '/' . $attachment->getTitle(), $attachmentContent);
     }
-}
+}

Diff for: src/Endpoint/Dto/ConfluenceAttachment.php

@@ -19,11 +19,11 @@ public function __construct(array $rawData)
 
     public function findDownloadPath(): ?string
     {
-        return (string)$this->rawData['_links']['download'] ?? null;
+        return $this->rawData['_links']['download'] ?? null;
     }
 
     public function getTitle(): string
     {
         return $this->title;
     }
-}
+}

Diff for: src/Endpoint/Dto/ConfluenceLabel.php

@@ -38,4 +38,4 @@ public function getLabel(): string
     {
         return $this->label;
     }
-}
+}

Diff for: src/Endpoint/Dto/ConfluencePage.php

@@ -22,10 +22,14 @@ public function __construct(array $rawData)
     {
         $this->rawData = $rawData;
 
-        $this->id = $rawData['id'];
-        $this->title = $rawData['title'];
-        $this->body = $rawData['body'];
-        $this->metadata = $rawData['metadata'];
+        $this->id = $rawData['id'] ?? null;
+        $this->type = $rawData['type'] ?? null;
+        $this->status = $rawData['status'] ?? null;
+        $this->title = $rawData['title'] ?? null;
+        $this->space = $rawData['space'] ?? null;
+        $this->version = $rawData['version'] ?? null;
+        $this->body = $rawData['body'] ?? null;
+        $this->metadata = $rawData['metadata'] ?? null;
     }
 
     public function getId(): ?string
@@ -91,4 +95,9 @@ public function getLabels(): array {
 
         return $labels;
     }
+
+    public function getRawData(): array
+    {
+        return $this->rawData;
+    }
 }

Diff for: src/MacroReplacer/ImageAndVideoMacroReplacer.php

@@ -41,4 +41,4 @@ function ($match) {
             $haystack
         );
     }
-}
+}

Diff for: src/MacroReplacer/MacroReplacerInterface.php

@@ -7,4 +7,4 @@
 interface MacroReplacerInterface
 {
     public function replace(string $haystack) : string;
-}
+}

Diff for: src/MacroReplacer/OtherMacroRemover.php

@@ -9,9 +9,8 @@
  */
 class OtherMacroRemover implements MacroReplacerInterface
 {
-
     public function replace(string $haystack): string
     {
         return preg_replace('/<ac:[^>]*>.*?<\/ac:[^>]*>/is', '', $haystack);
     }
-}
+}

Diff for: src/MacroReplacer/StructuredMacroReplacer.php

@@ -21,4 +21,4 @@ function ($match) {
             $haystack
         );
     }
-}
+}