Add support for php8.4 and other improvements (#32)

filisko · web-flow · commit 14915c092d6b · 2025-03-22T11:49:57.000+01:00
* php8.4 support among other improvements

* cleanup

* update github workflow

* update workflow
diff --git a/.gitattributes b/.gitattributes
@@ -1,10 +1,10 @@
 * text=auto eol=lf
 
-/tests            export-ignore
-.editorconfig     export-ignore
-.gitattributes    export-ignore
-.gitignore        export-ignore
-.php_cs           export-ignore
-.travis.yml       export-ignore
-phpcs.xml.dist    export-ignore
-phpunit.xml.dist  export-ignore
+/tests               export-ignore
+.editorconfig        export-ignore
+.gitattributes       export-ignore
+.gitignore           export-ignore
+.php-cs-fixer.php    export-ignore
+phpcs.xml.dist       export-ignore
+phpunit.xml.dist     export-ignore
+.phpstan.neon        export-ignore
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -1,10 +1,10 @@
 name: "testing"
 
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+    push:
+        branches: [ master ]
+    pull_request:
+        branches: [ master ]
 
 jobs:
     qa:
@@ -20,16 +20,16 @@ jobs:
 
             - name: Cache Composer packages
               id: composer-cache
-              uses: actions/cache@v3
+              uses: actions/cache@v4
               with:
-                path: vendor
-                key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-                restore-keys: |
-                  ${{ runner.os }}-php-
+                  path: vendor
+                  key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-php-
 
             - name: Install dependencies
               if: steps.composer-cache.outputs.cache-hit != 'true'
-              run: composer install --prefer-dist --no-progress --no-suggest
+              run: composer install --prefer-dist --no-progress
 
             - name: Coding Standard
               run: composer run-script cs
@@ -40,11 +40,11 @@ jobs:
 
         strategy:
             matrix:
-              php:
-                - 8.1
-                - 8.2
-                - 8.3
-                - 8.4
+                php:
+                    - 8.1
+                    - 8.2
+                    - 8.3
+                    - 8.4
 
         steps:
             - name: Checkout
@@ -63,10 +63,7 @@ jobs:
                   restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-composer-
 
             - name: Install dependencies
-              run: composer install --prefer-dist --no-progress --no-suggest
+              run: composer install --prefer-dist --no-progress
 
             - name: Tests
               run: composer test
-
-            - name: Tests coverage
-              run: composer coverage
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,5 @@ vendor
 composer.lock
 coverage
 *.cache
+.idea
+kit
diff --git a/.phpstan-baseline.neon b/.phpstan-baseline.neon
@@ -0,0 +1,33 @@
+parameters:
+	ignoreErrors:
+		-
+		    identifier: "new.static"
+		-
+			message: "#^Negated boolean expression is always false\\.$#"
+			count: 1
+			path: src/Factory.php
+
+		-
+			message: "#^Method Middlewares\\\\Utils\\\\FactoryDiscovery\\:\\:getFactory\\(\\) has no return type specified\\.$#"
+			count: 1
+			path: src/FactoryDiscovery.php
+
+		-
+			message: "#^Parameter \\#1 \\$class of function class_exists expects string, array\\<string, class\\-string\\>\\|string given\\.$#"
+			count: 1
+			path: src/FactoryDiscovery.php
+
+		-
+			message: "#^Property Middlewares\\\\Utils\\\\FactoryDiscovery\\:\\:\\$factory has no type specified\\.$#"
+			count: 1
+			path: src/FactoryDiscovery.php
+
+		-
+			message: "#^Unsafe usage of new static\\(\\)\\.$#"
+			count: 1
+			path: src/HttpErrorException.php
+
+		-
+			message: "#^Method Middlewares\\\\Utils\\\\RequestHandlerContainer\\:\\:resolve\\(\\) has no return type specified\\.$#"
+			count: 1
+			path: src/RequestHandlerContainer.php
diff --git a/.phpstan.neon b/.phpstan.neon
@@ -0,0 +1,11 @@
+parameters:
+    treatPhpDocTypesAsCertain: false
+    reportUnmatchedIgnoredErrors: false
+    inferPrivatePropertyTypeFromConstructor: true
+    level: 8
+    paths:
+        - src
+        - tests
+
+includes:
+    - .phpstan-baseline.neon
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019
+Copyright (c) 2019-2025
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/composer.json b/composer.json
@@ -18,17 +18,17 @@
     "require": {
         "php": ">=8.1",
         "psr/http-message": "^1.0 || ^2.0",
-        "psr/http-server-middleware": "^1.0",
+        "psr/http-server-middleware": "^1",
         "psr/container": "^1.0 || ^2.0",
         "psr/http-factory": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.5",
-        "phpstan/phpstan": "^1.10",
-        "laminas/laminas-diactoros": "^3.3",
-        "friendsofphp/php-cs-fixer": "^3.41",
-        "oscarotero/php-cs-fixer-config": "^2.0",
-        "squizlabs/php_codesniffer": "^3.8",
+        "phpunit/phpunit": "^10",
+        "phpstan/phpstan": "^2",
+        "laminas/laminas-diactoros": "^3",
+        "friendsofphp/php-cs-fixer": "^3",
+        "oscarotero/php-cs-fixer-config": "^2",
+        "squizlabs/php_codesniffer": "^3",
         "slim/psr7": "^1.6",
         "guzzlehttp/psr7": "^2.6",
         "sunrise/http-message": "^3.0",
@@ -52,4 +52,4 @@
         "coverage": "phpunit --coverage-text",
         "coverage-html": "phpunit --coverage-html=coverage"
     }
-}
+}
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<ruleset name="Middlewares coding standard">
+    <description>Middlewares coding standard</description>
+
+    <!-- display progress -->
+    <arg value="p"/>
+    <arg name="report" value="full"/>
+    <arg name="colors"/>
+
+    <!-- coding standard -->
+    <rule ref="PSR2"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+    <file>tests</file>
+</ruleset>
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" beStrictAboutOutputDuringTests="true" colors="true" failOnWarning="true" cacheDirectory=".phpunit.cache">
+  <coverage/>
+  <testsuites>
+    <testsuite name="Skeleton test suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+    <exclude>
+      <directory>./tests</directory>
+      <directory>./vendor</directory>
+    </exclude>
+  </source>
+</phpunit>
diff --git a/src/CallableHandler.php b/src/CallableHandler.php
@@ -58,6 +58,8 @@ public function __invoke(): ResponseInterface
 
     /**
      * Execute the callable.
+     *
+     * @param array<int,ServerRequestInterface|RequestHandlerInterface> $arguments
      */
     private function execute(array $arguments = []): ResponseInterface
     {
diff --git a/src/Dispatcher.php b/src/Dispatcher.php
@@ -12,11 +12,12 @@
 
 class Dispatcher implements RequestHandlerInterface
 {
-    /** @var array */
     private $stack;
 
     /**
      * Static helper to create and dispatch a request.
+     *
+     * @param CallableHandler[]|MiddlewareInterface[]|callable[] $stack
      */
     public static function run(array $stack, ?ServerRequestInterface $request = null): ResponseInterface
     {
@@ -27,6 +28,9 @@ public static function run(array $stack, ?ServerRequestInterface $request = null
         return (new static($stack))->dispatch($request);
     }
 
+    /**
+     * @param CallableHandler[]|MiddlewareInterface[]|callable[] $stack
+     */
     public function __construct(array $stack)
     {
         $this->stack = $stack;
diff --git a/src/Factory.php b/src/Factory.php
@@ -67,7 +67,8 @@ public static function getServerRequestFactory(): ServerRequestFactoryInterface
     }
 
     /**
-     * @param UriInterface|string $uri
+     * @param UriInterface|string   $uri
+     * @param array<string, string> $serverParams
      */
     public static function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface
     {
diff --git a/src/FactoryDiscovery.php b/src/FactoryDiscovery.php
@@ -52,7 +52,7 @@ class FactoryDiscovery implements FactoryInterface
         'uri' => '\Sunrise\Http\Message\UriFactory',
     ];
 
-    /** @var array<array<string, class-string>|string> */
+    /** @var array<mixed> */
     private $strategies = [
         self::DIACTOROS,
         self::GUZZLE,
@@ -63,11 +63,11 @@ class FactoryDiscovery implements FactoryInterface
 
     private $factory;
 
-    /** @var array */
+    /** @var array<string, mixed> */
     private $factories = [];
 
     /**
-     * @param array $strategies
+     * @param array<mixed> $strategies
      */
     public function __construct(...$strategies)
     {
@@ -78,6 +78,8 @@ public function __construct(...$strategies)
 
     /**
      * Get the strategies
+     *
+     * @return array<mixed>
      */
     public function getStrategies(): array
     {
@@ -160,14 +162,14 @@ private function getFactory(string $type)
         foreach ($this->strategies as $className) {
             if (is_array($className) && isset($className[$type])) {
                 $className = $className[$type];
-
                 if (class_exists($className)) {
                     return $this->factories[$type] = new $className();
                 }
 
                 continue;
             }
 
+            /* @phpstan-ignore-next-line */
             if (!class_exists($className)) {
                 continue;
             }
diff --git a/src/HttpErrorException.php b/src/HttpErrorException.php
@@ -58,13 +58,14 @@ class HttpErrorException extends Exception
         599 => 'Network Connect Timeout Error',
     ];
 
-    /** @var array */
+    /** @var array<string, mixed> */
     private $context = [];
 
     /**
      * Create and returns a new instance
      *
-     * @param int $code A valid http error code
+     * @param int                 $code    A valid http error code
+     * @param array<string,mixed> $context
      */
     public static function create(int $code = 500, array $context = [], ?Throwable $previous = null): self
     {
@@ -78,6 +79,9 @@ public static function create(int $code = 500, array $context = [], ?Throwable $
         return $exception;
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     public function getContext(): array
     {
         return $this->context;
diff --git a/src/RequestHandlerContainer.php b/src/RequestHandlerContainer.php
@@ -16,9 +16,12 @@
  */
 class RequestHandlerContainer implements ContainerInterface
 {
-    /** @var array */
+    /** @var mixed[] */
     protected $constructorArguments;
 
+    /**
+     * @param mixed[] $constructorArguments
+     */
     public function __construct(array $constructorArguments = [])
     {
         $this->constructorArguments = $constructorArguments;
@@ -36,7 +39,7 @@ public function has($id): bool
     }
 
     /**
-     * @param  string                  $id
+     * @param  class-string|string     $id
      * @return RequestHandlerInterface
      */
     public function get($id)
@@ -58,6 +61,10 @@ public function get($id)
         }
     }
 
+    /**
+     * @param  class-string|string $handler
+     * @return mixed
+     */
     protected function resolve(string $handler)
     {
         $handler = $this->split($handler);
diff --git a/tests/CallableHandlerTest.php b/tests/CallableHandlerTest.php
@@ -3,6 +3,7 @@
 
 namespace Middlewares\Tests;
 
+use Exception;
 use Middlewares\Utils\CallableHandler;
 use Middlewares\Utils\Factory;
 use PHPUnit\Framework\TestCase;
@@ -53,15 +54,15 @@ public function testOb(): void
             echo 'Hello';
             ob_start();
             echo 'Hello';
-            throw new \Exception('Error Processing Request');
+            throw new Exception('Error Processing Request');
         });
 
         ob_start();
         $level = ob_get_level();
 
         try {
             $callable();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
         }
 
         self::assertSame($level, ob_get_level());
diff --git a/tests/DispatcherTest.php b/tests/DispatcherTest.php
@@ -54,6 +54,7 @@ public function testMiddlewareException(): void
     {
         $this->expectException('UnexpectedValueException');
 
+        /** @phpstan-ignore-next-line */
         $response = Dispatcher::run(['']);
     }
 }
diff --git a/tests/HttpErrorExceptionTest.php b/tests/HttpErrorExceptionTest.php

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,8 @@ public function __invoke(): ResponseInterface`
`58`	`58`
`59`	`59`	`/**`
`60`	`60`	`* Execute the callable.`
	`61`	`+ *`
	`62`	`+ * @param array<int,ServerRequestInterface\|RequestHandlerInterface> $arguments`
`61`	`63`	`*/`
`62`	`64`	`private function execute(array $arguments = []): ResponseInterface`
`63`	`65`	`{`