Merge pull request #4 from lmc-eu/feature/require-php-81

Require php8.1

.github/workflows/tests.yaml

@@ -12,10 +12,10 @@ jobs:
 
         strategy:
             matrix:
-                php-version: ['7.4']
+                php-version: ['8.1']
                 dependencies: ['']
                 include:
-                    - { php-version: '7.4', dependencies: '--prefer-lowest --prefer-stable' }
+                    - { php-version: '8.1', dependencies: '--prefer-lowest --prefer-stable' }
 
         name: Unit tests - PHP ${{ matrix.dependencies }}
 
@@ -65,7 +65,7 @@ jobs:
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: '7.4'
+                  php-version: '8.1'
                   extensions: json, mbstring
 
             - name: Install dependencies

CHANGELOG.md

@@ -3,6 +3,8 @@
 <!-- There should always be "Unreleased" section at the beginning. -->
 
 ## Unreleased
+- Require php 8.1
+    - [**BC**] Use new language features and change method signatures
 
 ## 2.0.0 - 2021-08-10
 - [**BC**] Add an `$initiator` to `ResponseDecoders` `supports` method

composer.json

@@ -1,32 +1,29 @@
 {
     "name": "lmc/cqrs-http",
-    "type": "library",
     "description": "A library containing base implementations to help with Http Queries and Commands",
     "license": "MIT",
+    "type": "library",
     "require": {
-        "php": "^7.4",
+        "php": "^8.1",
         "ext-json": "*",
         "ext-mbstring": "*",
         "fig/http-message-util": "^1.1",
-        "lmc/cqrs-types": "^2.0",
+        "lmc/cqrs-types": "^3.0",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
         "psr/http-message": "^1.0"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.5",
-        "guzzlehttp/psr7": "^1.8",
-        "lmc/coding-standard": "^3.0",
+        "guzzlehttp/psr7": "^2.1",
+        "lmc/coding-standard": "^3.3",
         "nyholm/psr7": "^1.4",
         "php-parallel-lint/php-parallel-lint": "^1.2",
         "phpstan/extension-installer": "^1.1",
-        "phpstan/phpstan": "^0.12.96",
-        "phpstan/phpstan-phpunit": "^0.12.18",
+        "phpstan/phpstan": "^1.4",
+        "phpstan/phpstan-phpunit": "^1.0",
         "phpunit/phpunit": "^9.5"
     },
-    "config": {
-        "sort-packages": true
-    },
     "autoload": {
         "psr-4": {
             "Lmc\\Cqrs\\Http\\": "src/"
@@ -37,6 +34,14 @@
             "Lmc\\Cqrs\\Http\\": "tests/"
         }
     },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true,
+            "ergebnis/composer-normalize": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        },
+        "sort-packages": true
+    },
     "scripts": {
         "all": [
             "@lint",

ecs.php

@@ -3,7 +3,6 @@
 declare(strict_types=1);
 
 use Lmc\CodingStandard\Sniffs\Naming\ClassNameSuffixByParentSniff;
-use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
 use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestAnnotationFixer;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symplify\EasyCodingStandard\ValueObject\Option;
@@ -13,7 +12,9 @@
 
     $parameters->set(
         Option::SKIP,
-        ['SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff.ReferencedGeneralException' => ['tests/Exception/*.php']]
+        [
+            'SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff.ReferencedGeneralException' => ['tests/Exception/*.php'],
+        ],
     );
 
     $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
@@ -26,6 +27,5 @@
     $services->set(ClassNameSuffixByParentSniff::class)
         ->property('extraParentTypesToSuffixes', ['*ApplicatorInterface' => 'Applicator']);
 
-    $services->set(NoSuperfluousPhpdocTagsFixer::class)
-        ->call('configure', [['allow_mixed' => true]]);
+    $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs-8.1.php');
 };

phpstan.neon

@@ -1,12 +1,15 @@
 parameters:
     checkMissingIterableValueType: false
-    level: 7
+    treatPhpDocTypesAsCertain: false
+    level: 8
     paths:
         - src
         - tests/
 
-    reportUnmatchedIgnoredErrors: false
+    reportUnmatchedIgnoredErrors: true
 
     ignoreErrors:
-        - '#Cannot access offset .size. on array.*#'
-        - '#Method Lmc\\Cqrs\\Base\\Query\\AbstractHttpQuery::assertHeaderFieldValue\(\) has parameter \$value with no typehint specified.#'
+        -
+            message: "#^Else branch is unreachable because ternary operator condition is always true\\.$#"
+            count: 1
+            path: src/Command/AbstractHttpPostCommand.php

src/Command/AbstractHttpCommand.php

@@ -14,11 +14,8 @@
  */
 abstract class AbstractHttpCommand implements CommandInterface, ProfileableInterface
 {
-    protected RequestFactoryInterface $requestFactory;
-
-    public function __construct(RequestFactoryInterface $requestFactory)
+    public function __construct(private RequestFactoryInterface $requestFactory)
     {
-        $this->requestFactory = $requestFactory;
     }
 
     final public function getRequestType(): string
@@ -39,8 +36,7 @@ public function modifyRequest(RequestInterface $request): RequestInterface
     /** @see RequestMethodInterface */
     abstract public function getHttpMethod(): string;
 
-    /** @return UriInterface|string */
-    abstract public function getUri();
+    abstract public function getUri(): UriInterface|string;
 
     public function getProfilerId(): string
     {

src/Command/AbstractHttpPostCommand.php

@@ -15,7 +15,9 @@ final public function getHttpMethod(): string
 
     public function createRequest(): RequestInterface
     {
-        return parent::createRequest()->withBody($this->createBody());
+        return ($request = parent::createRequest()->withBody($this->createBody())) instanceof RequestInterface
+            ? $request
+            : throw new \LogicException('Implementation of the RequestInterface->withBody(...) does not return a RequestInterface.');
     }
 
     abstract public function createBody(): StreamInterface;

src/Decoder/HttpMessageResponseDecoder.php

@@ -11,16 +11,15 @@
  */
 class HttpMessageResponseDecoder implements ResponseDecoderInterface
 {
-    public function supports($response, $initiator): bool
+    public function supports(mixed $response, mixed $initiator): bool
     {
         return $response instanceof MessageInterface;
     }
 
     /**
-     * @param mixed $response
      * @return StreamInterface|MessageInterface
      */
-    public function decode($response)
+    public function decode(mixed $response): mixed
     {
         return $response instanceof MessageInterface
             ? $response->getBody()

src/Decoder/StreamResponseDecoder.php

@@ -10,24 +10,22 @@
  */
 class StreamResponseDecoder implements ResponseDecoderInterface
 {
-    public function supports($response, $initiator): bool
+    public function supports(mixed $response, mixed $initiator): bool
     {
         return $response instanceof StreamInterface;
     }
 
     /**
-     * @param mixed $response
      * @return StreamInterface|string
      */
-    public function decode($response)
+    public function decode(mixed $response): mixed
     {
         return $response instanceof StreamInterface
             ? $this->decodeStream($response)
             : $response;
     }
 
-    /** @return StreamInterface|string */
-    private function decodeStream(StreamInterface $stream)
+    private function decodeStream(StreamInterface $stream): StreamInterface|string
     {
         try {
             if (!empty($contents = $stream->getContents())) {

src/Exception/HttpBadRequestException.php

@@ -8,18 +8,20 @@
 
 class HttpBadRequestException extends \RuntimeException implements CqrsExceptionInterface
 {
-    private RequestInterface $request;
-    private ResponseInterface $response;
+    private static function createMessage(?string $reasonPhrase): string
+    {
+        return empty($reasonPhrase)
+            ? 'HTTP Bad Request'
+            : $reasonPhrase;
+    }
 
     public function __construct(
-        RequestInterface $request,
-        ResponseInterface $response,
+        private RequestInterface $request,
+        private ResponseInterface $response,
         int $code = 0,
-        ?\Throwable $previous = null
+        ?\Throwable $previous = null,
     ) {
-        parent::__construct($response->getReasonPhrase() ?? 'HTTP Bad Request', $code, $previous);
-        $this->request = $request;
-        $this->response = $response;
+        parent::__construct(self::createMessage($response->getReasonPhrase()), $code, $previous);
     }
 
     public function getRequest(): RequestInterface

src/Exception/HttpServerErrorException.php

@@ -8,18 +8,20 @@
 
 class HttpServerErrorException extends \RuntimeException implements CqrsExceptionInterface
 {
-    private RequestInterface $request;
-    private ResponseInterface $response;
+    private static function createMessage(?string $reasonPhrase): string
+    {
+        return empty($reasonPhrase)
+            ? 'HTTP Server Error'
+            : $reasonPhrase;
+    }
 
     public function __construct(
-        RequestInterface $request,
-        ResponseInterface $response,
+        private RequestInterface $request,
+        private ResponseInterface $response,
         int $code = 0,
-        ?\Throwable $previous = null
+        ?\Throwable $previous = null,
     ) {
-        parent::__construct($response->getReasonPhrase() ?? 'HTTP Server Error', $code, $previous);
-        $this->request = $request;
-        $this->response = $response;
+        parent::__construct(self::createMessage($response->getReasonPhrase()), $code, $previous);
     }
 
     public function getRequest(): RequestInterface

src/Handler/HttpQueryHandler.php

@@ -17,11 +17,8 @@
  */
 class HttpQueryHandler extends AbstractQueryHandler
 {
-    private ClientInterface $client;
-
-    public function __construct(ClientInterface $client)
+    public function __construct(private ClientInterface $client)
     {
-        $this->client = $client;
     }
 
     /** @phpstan-param QueryInterface<mixed> $query */

src/Handler/HttpSendCommandHandler.php

@@ -17,11 +17,8 @@
  */
 class HttpSendCommandHandler extends AbstractSendCommandHandler
 {
-    private ClientInterface $client;
-
-    public function __construct(ClientInterface $client)
+    public function __construct(private ClientInterface $client)
     {
-        $this->client = $client;
     }
 
     /** @phpstan-param CommandInterface<mixed> $command */

src/Query/AbstractHttpGetQuery.php

@@ -24,7 +24,7 @@ public function getCacheKey(): CacheKey
         return new CacheKey(sprintf(
             '%s:%s',
             static::class,
-            $this->getUri()
+            $this->getUri(),
         ));
     }
 }

src/Query/AbstractHttpQuery.php

@@ -13,11 +13,8 @@
  */
 abstract class AbstractHttpQuery implements QueryInterface, ProfileableInterface
 {
-    protected RequestFactoryInterface $requestFactory;
-
-    public function __construct(RequestFactoryInterface $requestFactory)
+    public function __construct(private RequestFactoryInterface $requestFactory)
     {
-        $this->requestFactory = $requestFactory;
     }
 
     final public function getRequestType(): string
@@ -38,8 +35,7 @@ public function modifyRequest(RequestInterface $request): RequestInterface
     /** @see RequestMethodInterface */
     abstract public function getHttpMethod(): string;
 
-    /** @return UriInterface|string */
-    abstract public function getUri();
+    abstract public function getUri(): UriInterface|string;
 
     public function getProfilerId(): string
     {

tests/Decoder/HttpMessageResponseDecoderTest.php

@@ -15,14 +15,10 @@ protected function setUp(): void
     }
 
     /**
-     * @param mixed $message
-     * @param mixed $expected
-     *
      * @dataProvider provideMessage
-     *
      * @test
      */
-    public function shouldDecodeNyholmMessage($message, bool $isSupported, $expected): void
+    public function shouldDecodeNyholmMessage(mixed $message, bool $isSupported, mixed $expected): void
     {
         $decoded = $this->decoder->decode($message);
 

tests/Decoder/StreamResponseDecoderTest.php

@@ -15,14 +15,10 @@ protected function setUp(): void
     }
 
     /**
-     * @param mixed $message
-     * @param mixed $expected
-     *
      * @dataProvider provideMessage
-     *
      * @test
      */
-    public function shouldDecodeNyholmMessage($message, bool $isSupported, $expected): void
+    public function shouldDecodeNyholmMessage(mixed $message, bool $isSupported, mixed $expected): void
     {
         $decoded = $this->decoder->decode($message);
 

tests/Fixture/DummyHttpGetQuery.php

@@ -7,11 +7,8 @@
 
 class DummyHttpGetQuery extends AbstractHttpGetQuery
 {
-    private string $uri;
-
-    public function __construct(string $uri, RequestFactoryInterface $requestFactory)
+    public function __construct(private string $uri, RequestFactoryInterface $requestFactory)
     {
-        $this->uri = $uri;
         parent::__construct($requestFactory);
     }
 

tests/Fixture/DummyHttpPostCommand.php

@@ -8,13 +8,8 @@
 
 class DummyHttpPostCommand extends AbstractHttpPostCommand
 {
-    private string $uri;
-    private StreamInterface $body;
-
-    public function __construct(string $uri, StreamInterface $body, RequestFactoryInterface $requestFactory)
+    public function __construct(private string $uri, private StreamInterface $body, RequestFactoryInterface $requestFactory)
     {
-        $this->uri = $uri;
-        $this->body = $body;
         parent::__construct($requestFactory);
     }