merge PR #7: GitHub workflow for PHPStan

Author: rosasurfer

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+
+updates:
+  - package-ecosystem: composer
+    directory: /
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 0

.github/workflows/phpstan.yml

@@ -0,0 +1,65 @@
+#
+# Run a PHPStan check using the configuration in "/etc/phpstan/".
+# If the most recent commit message contains "[skip phpstan]" this workflow is skipped.
+#
+name: PHPStan
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0                      # fetch all branches and history (to access the source branch of PRs)
+
+      # ------------------------------------------------------------------------------------------------------------------------------------
+      - name: Validate "composer.json"
+        run: |
+          composer validate --strict
+
+      # ------------------------------------------------------------------------------------------------------------------------------------
+      - name: Check commit message for "[skip phpstan]"
+        run: |
+          SKIP_PHPSTAN=false
+          REF_NAME=
+          if   [[ "$GITHUB_EVENT_NAME" == "push"         ]]; then REF_NAME="$GITHUB_REF_NAME"
+          elif [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then REF_NAME="$GITHUB_HEAD_REF"
+          else
+            echo "unsupported event: $GITHUB_EVENT_NAME"
+            exit 1
+          fi
+          COMMIT_MSG=$(git log -1 --format="%B" "origin/$REF_NAME")
+          MAGIC_KEY=$(echo "$COMMIT_MSG" | (grep -io "\[skip phpstan\]" || true) | tail -1)
+
+          if [[ -n "$MAGIC_KEY" ]]; then
+            echo "Magic commit message found: $MAGIC_KEY"
+            SKIP_PHPSTAN=true
+          fi
+          echo "SKIP_PHPSTAN: $SKIP_PHPSTAN"
+          echo "SKIP_PHPSTAN=$SKIP_PHPSTAN" >> "$GITHUB_ENV"
+
+      # ------------------------------------------------------------------------------------------------------------------------------------
+      - name: Run PHPStan
+        if:   env.SKIP_PHPSTAN != 'true'
+        run: |
+          echo "Installing Composer dependencies..."
+          composer install --no-progress
+
+          echo "Generating PHPStan report..."
+          bin/phpstan --no-progress -vvv
+
+      # ------------------------------------------------------------------------------------------------------------------------------------

composer.json

@@ -2,7 +2,7 @@
     "name":        "rosasurfer/ministruts",
     "description": "MVC micro framework inspired by Java Struts",
     "type":        "library",
-    "license":     "WTFPL",
+    "license":     "Unlicense",
     "authors": [{
         "name":  "Peter Walther",
         "email": "[email protected]"

etc/phpstan/extension/CoreFunctionReturnType.php

@@ -37,7 +37,7 @@ public function __construct() {
         $this->supportedFunctions = [
             // function            type to remove       original return type
             // -------------------------------------------------------------------------
-            'curl_init'            => $bool,            // resource|CurlHandle|false (2)    @see  https://www.php.net/manual/en/function.curl-init.php
+            'curl_init'            => $bool,            // resource|CurlHandle|false        @see  https://www.php.net/manual/en/function.curl-init.php
             'file'                 => $bool,            // array|false
             'file_get_contents'    => $bool,            // string|false                     @see  https://www.php.net/manual/en/function.file-get-contents.php
             'filemtime'            => $bool,            // int|false                        @see  https://www.php.net/manual/en/function.filemtime.php
@@ -57,7 +57,7 @@ public function __construct() {
             'stream_get_contents'  => $bool,            // string|false                     @see  https://www.php.net/manual/en/function.stream-get-contents.php
 
             // (1) either PHPStan or the PHP documentation is wrong
-            // (2) with PHPStan v1.11.10 the extension is not called
+            // (2) the extension is not called by PHPStan
         ];
     }
 
@@ -104,8 +104,9 @@ protected function getOriginalTypeFromFunctionCall(FunctionReflection $function,
     public function getTypeFromFunctionCall(FunctionReflection $function, FuncCall $functionCall, Scope $scope): Type {
         $name = $function->getName();
 
-        if (in_array($name, ['curl_init', 'preg_replace'])) {
-            throw new ExtensionException("function $name was passed to ".simpleClassName(__CLASS__).' extension');
+        if (in_array($name, ['preg_replace'])) {
+            // throw an exception to get notified when PHPStan bugs get fixed
+            throw new ExtensionException("pewa: PHPStan bugfix -> core function $name is now passed to the ".simpleClassName(__CLASS__).' extension');
         }
 
         $origType = $this->getOriginalTypeFromFunctionCall($function, $functionCall, $scope);