Enable PHP 8.4 compat and update

.github/workflows/continuous-integration.yml

@@ -9,5 +9,5 @@ jobs:
   ci:
     uses: ray-di/.github/.github/workflows/continuous-integration.yml@v1
     with:
-      old_stable: '["8.1", "8.2"]'
-      current_stable: 8.3
+      old_stable: '["8.1", "8.2", "8.3"]'
+      current_stable: 8.4

composer.json

@@ -37,23 +37,28 @@
           "bamarni/composer-bin-plugin": "^1.4"
      },
      "scripts" :{
-          "post-install-cmd": ["@composer bin all install --ansi"],
-          "post-update-cmd": ["@composer bin all update --ansi"],
+          "bin": "echo 'no bin' installed.",
           "test": ["./vendor/bin/phpunit"],
           "tests": ["@cs", "@sa", "@test"],
           "coverage": ["php -dzend_extension=xdebug.so -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
           "pcov": ["php -dextension=pcov.so -d pcov.enabled=1 ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage  --coverage-clover=coverage.xml"],
-          "cs": ["./vendor/bin/phpcs"],
-          "cs-fix": ["./vendor/bin/phpcbf src tests"],
-          "clean": ["./vendor/bin/phpstan clear-result-cache", "./vendor/bin/psalm --clear-cache", "rm -rf tests/tmp/*.php"],
-          "sa": ["./vendor/bin/phpstan analyse -c phpstan.neon", "psalm --show-info=true"],
-          "metrics": ["./vendor/bin/phpmetrics --report-html=build/metrics --exclude=Exception --junit=build/junit.xml src"],
-          "phpmd": ["./vendor/bin/phpmd --exclude src/Annotation src text ./phpmd.xml"],
+          "cs": ["./vendor-bin/tools/vendor/bin/phpcs"],
+          "cs-fix": ["./vendor-bin/tools/vendor/bin/phpcbf src tests"],
+          "clean": ["./vendor-bin/tools/vendor/bin/phpstan clear-result-cache", "./vendor-bin/tools/vendor/bin/psalm --clear-cache", "rm -rf tests/tmp/*.php"],
+          "sa": ["./vendor-bin/tools/vendor/bin/phpstan analyse -c phpstan.neon", "psalm --show-info=true"],
+          "metrics": ["./vendor-bin/tools/vendor/bin/phpmetrics --report-html=build/metrics --exclude=Exception --junit=build/junit.xml src"],
+          "phpmd": ["./vendor-bin/tools/vendor/bin/phpmd --exclude src/Annotation src text ./phpmd.xml"],
           "build": ["@cs", "@sa", "@pcov", "@metrics"]
      },
      "config": {
           "allow-plugins": {
                "bamarni/composer-bin-plugin": true
           }
+     },
+     "extra": {
+          "bamarni-bin": {
+               "bin-links": true,
+               "forward-command": true
+          }
      }
 }

phpcs.xml

@@ -1,53 +1,44 @@
 <?xml version="1.0"?>
 <ruleset
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="bearcs"
-        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="vendor-bin/tools/vendor/squizlabs/php_codesniffer/phpcs.xsd">
 
     <arg name="basepath" value="."/>
     <arg name="extensions" value="php"/>
     <arg name="parallel" value="80"/>
     <arg name="cache" value=".phpcs-cache"/>
 
-    <!-- Compatibility with PHP 7.2.0 -->
-    <config name="php_version" value="70200"/>
+    <!-- PHP Compatibility -->
+    <config name="php_version" value="80300"/>
 
     <!-- Ignore warnings, show progress of the run and show sniff names -->
     <arg value="nps"/>
 
     <!-- Directories to be checked -->
     <file>src</file>
     <file>tests</file>
-    <exclude-pattern>*/tests/tmp/*</exclude-pattern>
-    <exclude-pattern>*/src/Annotation/*</exclude-pattern>
-    <exclude-pattern>*/tests/header.php</exclude-pattern>
+    <exclude-pattern>*/tmp/*</exclude-pattern>
+    <exclude-pattern>*/Fake/*</exclude-pattern>
 
     <!-- PSR12 Coding Standard -->
     <rule ref="PSR12"/>
 
-    <!-- Doctrine Coding Standard -->
+    <!-- Based on Doctrine Coding Standard -->
     <rule ref="Doctrine">
-        <!-- Inapplicable for this project -->
-        <!-- Base -->
+        <!-- Exclude Rules -->
         <exclude name="Generic.Formatting.MultipleStatementAlignment.NotSame"/>
         <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix"/>
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming.SuperfluousSuffix"/>
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming.SuperfluousSuffix"/>
         <exclude name="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.MissingVariable"/>
         <exclude name="SlevomatCodingStandard.Commenting.UselessInheritDocComment.UselessInheritDocComment"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint"/>
         <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint"/>
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint"/>
-        <!-- /Base -->
-        <!-- Option -->
         <exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed"/>
-        <!-- attribute -->
-        <exclude name="Squiz.WhiteSpace.FunctionSpacing.Before"/>
-        <!-- /Option -->
-        <!-- Exclude Fake files form Doctrine CS -->
-        <exclude-pattern>*/tests/Fake/*</exclude-pattern>
+        <exclude name="SlevomatCodingStandard.PHP.RequireExplicitAssertion.RequiredExplicitAssertion"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint" />
+        <exclude name="Squiz.NamingConventions.ValidVariableName.NotCamelCaps" />
     </rule>
-
     <!-- Additional Rules -->
     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
         <properties>
@@ -58,9 +49,6 @@
             </property>
         </properties>
     </rule>
-    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint">
-        <include-pattern>tests/*</include-pattern>
-    </rule>
     <rule ref="SlevomatCodingStandard.Classes.PropertySpacing">
         <properties>
             <property name="minLinesCountBeforeWithComment" value="1"/>
@@ -73,6 +61,4 @@
             <property name="searchAnnotations" value="true"/>
         </properties>
     </rule>
-    <exclude-pattern>*/Fake/*</exclude-pattern>
-    <exclude-pattern>*/tmp/*</exclude-pattern>
 </ruleset>

phpstan.neon

@@ -3,5 +3,3 @@ parameters:
   paths:
     - src
     - tests
-  excludePaths:
-      - 'tests/Fake'

psalm.xml

@@ -5,6 +5,8 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="false"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />

src/Annotation/Stream.php

@@ -6,10 +6,9 @@
 
 use Attribute;
 use Ray\Di\Di\Qualifier;
-use function is_string;
-use function var_dump;
 
-#[Attribute(Attribute::TARGET_METHOD), Qualifier]
+#[Attribute(Attribute::TARGET_METHOD)]
+#[Qualifier]
 final class Stream
 {
 }

src/StreamModule.php

@@ -13,7 +13,7 @@
 class StreamModule extends AbstractModule
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     protected function configure(): void
     {

src/StreamProvider.php

@@ -14,7 +14,7 @@
 class StreamProvider implements ProviderInterface
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      *
      * @return resource
      */

src/StreamRenderer.php

@@ -27,12 +27,12 @@ final class StreamRenderer implements RenderInterface
 
     public function __construct(
         private readonly RenderInterface $renderer,
-        private readonly StreamerInterface $streamer
+        private readonly StreamerInterface $streamer,
     ) {
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function render(ResourceObject $ro)
     {
@@ -44,7 +44,7 @@ public function render(ResourceObject $ro)
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getView(ResourceObject $ro): string
     {

src/StreamResponder.php

@@ -21,7 +21,7 @@ public function __construct(private readonly StreamerInterface $streamer)
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function __invoke(ResourceObject $resourceObject, array $server): void
     {
@@ -38,7 +38,7 @@ public function __invoke(ResourceObject $resourceObject, array $server): void
 
         // code
         if (PHP_SAPI !== 'cli') {
-            http_response_code($resourceObject->code);
+            http_response_code($resourceObject->code); // @codeCoverageIgnore
         }
 
         // stream body

src/StreamTransferInject.php

@@ -5,6 +5,7 @@
 namespace BEAR\Streamer;
 
 use BEAR\Resource\RenderInterface;
+use BEAR\Resource\ResourceObject;
 use BEAR\Resource\TransferInterface;
 use BEAR\Streamer\Annotation\Stream;
 use Ray\Di\Di\Inject;
@@ -14,7 +15,7 @@ trait StreamTransferInject
     /** @var TransferInterface */
     private $responder;
 
-    /** @return static */
+    /** @return ResourceObject */
     #[Inject]
     #[Stream]
     public function setRenderer(RenderInterface $render)
@@ -30,7 +31,7 @@ public function setTransfer(TransferInterface $responder): void
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function transfer(TransferInterface $responder, array $server): void
     {

src/Streamer.php

@@ -18,6 +18,7 @@
 
 use const PREG_SET_ORDER;
 
+/** @psalm-type Match = array<int, array<int, string>> */
 final class Streamer implements StreamerInterface
 {
     /** @var array<resource> */
@@ -47,7 +48,7 @@ public function getStream(string $string)
         $hash = array_keys($this->streams);
         $regex = sprintf('/(%s)/', implode('|', $hash));
         preg_match_all($regex, $string, $match, PREG_SET_ORDER);
-        /** @var array<int, string> $match */
+        /** @var Match $match */
         $list = $this->collect($match);
         $bodies = (array) preg_split($regex, $string);
         foreach ($bodies as $body) {
@@ -64,7 +65,7 @@ public function getStream(string $string)
     }
 
     /**
-     * @param array<int, string> $match
+     * @param Match $match
      *
      * @return array<int, string>
      */

tests/Fake/Resource/Page/StreamArray.php

@@ -9,7 +9,7 @@ class StreamArray extends ResourceObject
 {
     use StreamTransferInject;
 
-    public function onGet()
+    public function onGet(): static
     {
         $this->body = [
             'msg' =>'hello world',

tests/Fake/Resource/Page/StreamString.php

@@ -9,7 +9,7 @@ class StreamString extends ResourceObject
     /**
      * Ignore renderer, just stream $this->body
      */
-    public function onGet()
+    public function onGet(): static
     {
         $this->body = fopen(__DIR__ . '/message.txt', 'r');
 

tests/Fake/Resource/Page/TextArray.php

@@ -6,7 +6,7 @@
 
 class TextArray extends ResourceObject
 {
-    public function onGet()
+    public function onGet(): static
     {
         $this->body =[
             'greeting' => 'Hello BEAR'

tests/Fake/Resource/Page/TextString.php

@@ -6,7 +6,7 @@
 
 class TextString extends ResourceObject
 {
-    public function onGet()
+    public function onGet(): static
     {
         $this->body = 'Hello BEAR';
 

tests/IntegrateTest.php

@@ -12,6 +12,7 @@
 use BEAR\Streamer\Resource\Page\StreamArray;
 use PHPUnit\Framework\TestCase;
 use Ray\Di\Injector;
+use Stringable;
 
 use function assert;
 use function method_exists;
@@ -77,8 +78,9 @@ public function testRender(string $uri, string $expected): void
         $ro = $this->resource->newInstance($uri);
         $ro->setRenderer($this->renderer);
         assert(method_exists($ro, 'onGet'));
-        $view = (string) $ro->onGet();
-        $stream = $this->streamer->getStream($view);
+        $view = $ro->onGet();
+        assert($view instanceof Stringable);
+        $stream = $this->streamer->getStream((string) $view);
         rewind($stream);
         $view = stream_get_contents($stream);
         $this->assertSame($expected, $view);

tests/bootstrap.php

@@ -7,7 +7,4 @@
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
-// no annotation in PHP 8
-if (PHP_MAJOR_VERSION >= 8) {
-    ServiceLocator::setReader(new AttributeReader());
-}
+ServiceLocator::setReader(new AttributeReader());

tests/header.php

@@ -6,7 +6,7 @@
 
 use function func_get_args;
 
-function header(string $string, bool $replace = true, ?string $http_response_code = null): void
+function header(string $string, bool $replace = true, string|null $http_response_code = null): void
 {
     /** @var array<string> $args */
     $args = func_get_args();

vendor-bin/tools/composer.json

@@ -1,16 +1,16 @@
 {
-    "require": {
-        "doctrine/coding-standard": "^11",
-        "phpmd/phpmd": "^2.9",
-        "phpmetrics/phpmetrics": "^2.7",
-        "phpstan/phpstan": "^0.12",
-        "psalm/plugin-phpunit": "^0.13",
-        "squizlabs/php_codesniffer": "^3.5",
-        "vimeo/psalm": "^4.2"
+    "require-dev": {
+        "doctrine/coding-standard": "^12",
+        "phpmd/phpmd": "^2.15",
+        "phpmetrics/phpmetrics": "^2.8",
+        "phpstan/phpstan": "^2.0",
+        "squizlabs/php_codesniffer": "^3.11",
+        "vimeo/psalm": "^5.26"
     },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
     }
 }
+