Upgrade to php-cs-fixer v3

Author: kelunik

.php-cs-fixer.dist.php

@@ -0,0 +1,11 @@
+<?php
+
+$config = new Amp\CodeStyle\Config();
+$config->getFinder()
+    ->in(__DIR__ . '/examples')
+    ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/test');
+
+$config->setCacheFile(__DIR__ . '/.php_cs.cache');
+
+return $config;

.php_cs.dist

@@ -45,7 +45,7 @@
         "amphp/phpunit-util": "v3.x-dev",
         "amphp/http-client": "v5.x-dev",
         "amphp/log": "v2.x-dev",
-        "amphp/php-cs-fixer-config": "dev-master",
+        "amphp/php-cs-fixer-config": "^2-dev",
         "league/uri-components": "^2",
         "monolog/monolog": "^2 || ^1.23",
         "phpunit/phpunit": "^9"

composer.json

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-require \dirname(__DIR__) . "/vendor/autoload.php";
+require dirname(__DIR__) . "/vendor/autoload.php";
 
 use Amp\ByteStream;
 use Amp\Http\Server\HttpServer;
@@ -43,6 +43,6 @@
 // Await SIGINT or SIGTERM to be received.
 $signal = trapSignal([\SIGINT, \SIGTERM]);
 
-$logger->info(\sprintf("Received signal %d, stopping HTTP server", $signal));
+$logger->info(sprintf("Received signal %d, stopping HTTP server", $signal));
 
 $server->stop();

examples/delayed-response.php

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-require \dirname(__DIR__) . "/vendor/autoload.php";
+require dirname(__DIR__) . "/vendor/autoload.php";
 
 use Amp\ByteStream;
 use Amp\Http\Server\HttpServer;
@@ -33,6 +33,6 @@
 // Await SIGINT or SIGTERM to be received.
 $signal = trapSignal([\SIGINT, \SIGTERM]);
 
-$logger->info(\sprintf("Received signal %d, stopping HTTP server", $signal));
+$logger->info(sprintf("Received signal %d, stopping HTTP server", $signal));
 
 $server->stop();

examples/exception.php

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-require \dirname(__DIR__) . "/vendor/autoload.php";
+require dirname(__DIR__) . "/vendor/autoload.php";
 
 use Amp\ByteStream;
 use Amp\Http\Server\HttpServer;
@@ -45,6 +45,6 @@
 // Await SIGINT or SIGTERM to be received.
 $signal = trapSignal([\SIGINT, \SIGTERM]);
 
-$logger->info(\sprintf("Received signal %d, stopping HTTP server", $signal));
+$logger->info(sprintf("Received signal %d, stopping HTTP server", $signal));
 
 $server->stop();

examples/hello-world.php

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-require \dirname(__DIR__) . "/vendor/autoload.php";
+require dirname(__DIR__) . "/vendor/autoload.php";
 
 use Amp\ByteStream;
 use Amp\Http\Server\HttpServer;
@@ -44,6 +44,6 @@
 // Await SIGINT or SIGTERM to be received.
 $signal = trapSignal([\SIGINT, \SIGTERM]);
 
-$logger->info(\sprintf("Received signal %d, stopping HTTP server", $signal));
+$logger->info(sprintf("Received signal %d, stopping HTTP server", $signal));
 
 $server->stop();

examples/state.php

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-require \dirname(__DIR__) . "/vendor/autoload.php";
+require dirname(__DIR__) . "/vendor/autoload.php";
 
 use Amp\ByteStream;
 use Amp\ByteStream\ReadableIterableStream;
@@ -47,6 +47,6 @@
 // Await SIGINT or SIGTERM to be received.
 $signal = trapSignal([\SIGINT, \SIGTERM]);
 
-$logger->info(\sprintf("Received signal %d, stopping HTTP server", $signal));
+$logger->info(sprintf("Received signal %d, stopping HTTP server", $signal));
 
 $server->stop();

examples/stream.php

@@ -19,7 +19,6 @@
  */
 class ClientException extends \Exception
 {
-    /** @var Driver\Client */
     private Driver\Client $client;
 
     public function __construct(Driver\Client $client, string $message, int $code = 0, \Throwable $previous = null)

src/ClientException.php

@@ -15,8 +15,6 @@ interface Client
     /**
      * Listen for requests on the client and parse them using the given HTTP driver.
      *
-     * @param HttpDriverFactory $driverFactory
-     *
      * @throws \Error If the client has already been started.
      */
     public function start(HttpDriverFactory $driverFactory): void;
@@ -45,8 +43,6 @@ public function isWaitingOnResponse(): bool;
 
     /**
      * Integer ID of this client.
-     *
-     * @return int
      */
     public function getId(): int;
 
@@ -72,8 +68,6 @@ public function isEncrypted(): bool;
 
     /**
      * If the client is encrypted a TlsInfo object is returned, otherwise null.
-     *
-     * @return TlsInfo|null
      */
     public function getTlsInfo(): ?TlsInfo;
 

src/Driver/Client.php

@@ -10,16 +10,6 @@
 
 interface ClientFactory
 {
-    /**
-     * @param Socket $socket
-     * @param RequestHandler $requestHandler
-     * @param ErrorHandler $errorHandler
-     * @param PsrLogger $logger
-     * @param Options $options
-     * @param TimeoutCache $timeoutCache
-     *
-     * @return Client
-     */
     public function createClient(
         Socket $socket,
         RequestHandler $requestHandler,

src/Driver/ClientFactory.php

@@ -117,10 +117,6 @@ private function updateTimeout(): void
 
     /**
      * HTTP/1.x response writer.
-     *
-     * @param Future $lastWrite
-     * @param Response $response
-     * @param Request|null $request
      */
     private function send(Future $lastWrite, Response $response, ?Request $request = null): void
     {
@@ -806,8 +802,6 @@ static function (int $bodySize) use (&$maxBodySize): void {
 
     /**
      * Creates an error response from the error handler and sends that response to the client.
-     *
-     * @param ClientException $exception
      */
     private function sendErrorResponse(ClientException $exception): Future
     {
@@ -825,7 +819,6 @@ private function sendErrorResponse(ClientException $exception): Future
     /**
      * Filters and updates response headers based on protocol and connection header from the request.
      *
-     * @param Response $response
      * @param string $protocol Request protocol.
      * @param array $connection Request connection header.
      *

src/Driver/Http1Driver.php

@@ -67,7 +67,6 @@ final class Http2Driver implements HttpDriver, Http2Processor
 
     private int $maxFrameSize = self::DEFAULT_MAX_FRAME_SIZE;
 
-    /** @var bool */
     private bool $allowsPush;
 
     /** @var int Last used local stream ID. */
@@ -118,12 +117,7 @@ public function __construct(Options $options, PsrLogger $logger)
     }
 
     /**
-     * @param Client      $client
-     * @param callable    $onMessage
-     * @param callable    $write
      * @param string|null $settings HTTP2-Settings header content from upgrade request or null for direct HTTP/2.
-     *
-     * @return \Generator
      */
     public function setup(Client $client, \Closure $onMessage, \Closure $write, ?string $settings = null): \Generator
     {
@@ -316,7 +310,6 @@ private function send(int $id, Response $response, Request $request): void
     /**
      * @param int|null        $lastId ID of last processed frame. Null to use the last opened frame ID or 0 if no
      *                                streams have been opened.
-     * @param \Throwable|null $reason
      */
     private function shutdown(?int $lastId = null, ?\Throwable $reason = null): void
     {
@@ -548,8 +541,6 @@ private function releaseStream(int $id, ClientException $exception = null): void
 
     /**
      * @param string|null $settings HTTP2-Settings header content from upgrade request or null for direct HTTP/2.
-     *
-     * @return \Generator
      */
     private function parser(?string $settings = null): \Generator
     {

src/Driver/Http2Driver.php

@@ -33,9 +33,6 @@ public function setup(Client $client, \Closure $onMessage, \Closure $write): \Ge
 
     /**
      * Write the given response to the client using the write callback provided to `setup()`.
-     *
-     * @param Request $request
-     * @param Response $response
      */
     public function write(Request $request, Response $response): void;
 

src/Driver/HttpDriver.php

@@ -10,15 +10,6 @@ interface HttpDriverFactory
 {
     /**
      * Selects an HTTP driver based on the given client.
-     *
-     * @param Client       $client
-     * @param ErrorHandler $errorHandler
-     *
-     * @param PsrLogger    $logger
-     *
-     * @param Options      $options
-     *
-     * @return HttpDriver
      */
     public function selectDriver(
         Client $client,

src/Driver/HttpDriverFactory.php

@@ -67,8 +67,6 @@ public function __construct(
     /**
      * Listen for requests on the client and parse them using the HTTP driver generated from the given factory.
      *
-     * @param HttpDriverFactory $driverFactory
-     *
      * @throws \Error If the client has already been started.
      */
     public function start(HttpDriverFactory $driverFactory): void
@@ -303,10 +301,7 @@ private function write(string $data, bool $close = false): void
     /**
      * Invoked by the HTTP parser when a request is parsed.
      *
-     * @param Request $request
      * @param string $buffer Remaining buffer in the parser.
-     *
-     * @return Future
      */
     private function onMessage(Request $request, string $buffer = ''): Future
     {
@@ -323,9 +318,6 @@ private function onMessage(Request $request, string $buffer = ''): Future
 
     /**
      * Respond to a parsed request.
-     *
-     * @param Request $request
-     * @param string $buffer
      */
     private function respond(Request $request, string $buffer): void
     {
@@ -396,8 +388,6 @@ private function makeOptionsResponse(): Response
 
     /**
      * Used if an exception is thrown from a request handler.
-     *
-     * @param Request $request
      */
     private function makeExceptionResponse(Request $request): Response
     {
@@ -421,9 +411,6 @@ private function makeExceptionResponse(Request $request): Response
     /**
      * Invokes the export function on Response with the socket upgraded from the HTTP server.
      *
-     * @param callable $upgrade
-     * @param Request $request
-     * @param Response $response
      * @param string $buffer Remaining buffer read from the socket.
      */
     private function export(callable $upgrade, Request $request, Response $response, string $buffer): void

src/Driver/RemoteClient.php

@@ -70,9 +70,6 @@ public function update(int $id, int $expiresAt): void
         }
     }
 
-    /**
-     * @param int $id
-     */
     public function clear(int $id): void
     {
         if (!isset($this->pointers[$id])) {
@@ -101,8 +98,6 @@ public function extract(int $now): ?int
     /**
      * @param int  $node   Rebuild the data array from the given node downward.
      * @param bool $remove Remove the given node from the data array if true.
-     *
-     * @return int
      */
     private function rebuild(int $node, bool $remove): int
     {

src/Driver/TimeoutCache.php

@@ -8,8 +8,6 @@ interface ErrorHandler
      * @param int          $statusCode Error status code, 4xx or 5xx.
      * @param string|null  $reason Reason message. Will use the status code's default reason if not provided.
      * @param Request|null $request Null if the error occurred before parsing the request completed.
-     *
-     * @return Response
      */
     public function handleError(int $statusCode, string $reason = null, Request $request = null): Response;
 }