update with latest cs fixer

dbu · dbu · commit ee440ee34c14 · 2024-01-04T20:04:11.000+01:00
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -15,6 +15,9 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
+      - name: Remove phpspec
+        run: composer remove --dev friends-of-phpspec/phpspec-code-coverage phpspec/phpspec
+
       - name: PHPStan
         uses: OskarStark/phpstan-ga@0.12.32
         env:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## unreleased
+
+- Cleaned up phpdoc.
+
 ## 2.7.1 - 2023-11-30
 
 - Allow installation with Symfony 7.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -57,18 +57,6 @@ parameters:
             count: 1
             path: src/Plugin/RedirectPlugin.php
 
-        # phpstan is confused by the optional dependencies. we check for existence first
-        -
-            message: "#^Method Http\\\\Client\\\\Common\\\\Plugin\\\\RedirectPlugin::guessStreamFactory\\(\\) should return Psr\\\\Http\\\\Message\\\\StreamFactoryInterface\\|null but returns Nyholm\\\\Psr7\\\\Factory\\\\Psr17Factory\\.$#"
-            count: 1
-            path: src/Plugin/RedirectPlugin.php
-
-        # phpstan is confused by the optional dependencies. we check for existence first
-        -
-            message: "#^Call to static method streamFor\\(\\) on an unknown class GuzzleHttp\\\\Psr7\\\\Utils\\.$#"
-            count: 1
-            path: src/Plugin/RedirectPlugin.php
-
         -
             message: "#^Method Http\\\\Client\\\\Common\\\\Plugin\\\\RetryPlugin\\:\\:retry\\(\\) should return Psr\\\\Http\\\\Message\\\\ResponseInterface but returns mixed\\.$#"
             count: 1
diff --git a/src/Deferred.php b/src/Deferred.php
@@ -51,9 +51,6 @@ public function __construct(callable $waitCallback)
         $this->onRejectedCallbacks = [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function then(callable $onFulfilled = null, callable $onRejected = null): Promise
     {
         $deferred = new self($this->waitCallback);
@@ -86,9 +83,6 @@ public function then(callable $onFulfilled = null, callable $onRejected = null):
         return $deferred;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getState(): string
     {
         return $this->state;
@@ -128,9 +122,6 @@ public function reject(ClientExceptionInterface $exception): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function wait($unwrap = true)
     {
         if (Promise::PENDING === $this->state) {
diff --git a/src/HttpAsyncClientDecorator.php b/src/HttpAsyncClientDecorator.php
@@ -20,8 +20,6 @@ trait HttpAsyncClientDecorator
     protected $httpAsyncClient;
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
      */
     public function sendAsyncRequest(RequestInterface $request)
diff --git a/src/HttpAsyncClientEmulator.php b/src/HttpAsyncClientEmulator.php
@@ -17,15 +17,11 @@
 trait HttpAsyncClientEmulator
 {
     /**
-     * {@inheritdoc}
-     *
      * @see HttpClient::sendRequest
      */
     abstract public function sendRequest(RequestInterface $request): ResponseInterface;
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
      */
     public function sendAsyncRequest(RequestInterface $request)
diff --git a/src/HttpClientDecorator.php b/src/HttpClientDecorator.php
@@ -21,8 +21,6 @@ trait HttpClientDecorator
     protected $httpClient;
 
     /**
-     * {@inheritdoc}
-     *
      * @see ClientInterface::sendRequest
      */
     public function sendRequest(RequestInterface $request): ResponseInterface
diff --git a/src/HttpClientEmulator.php b/src/HttpClientEmulator.php
@@ -15,8 +15,6 @@
 trait HttpClientEmulator
 {
     /**
-     * {@inheritdoc}
-     *
      * @see HttpClient::sendRequest
      */
     public function sendRequest(RequestInterface $request): ResponseInterface
@@ -27,8 +25,6 @@ public function sendRequest(RequestInterface $request): ResponseInterface
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
      */
     abstract public function sendAsyncRequest(RequestInterface $request);
diff --git a/src/HttpClientPool/HttpClientPool.php b/src/HttpClientPool/HttpClientPool.php
@@ -52,17 +52,11 @@ public function addHttpClient($client): void
      */
     abstract protected function chooseHttpClient(): HttpClientPoolItem;
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendAsyncRequest(RequestInterface $request)
     {
         return $this->chooseHttpClient()->sendAsyncRequest($request);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         return $this->chooseHttpClient()->sendRequest($request);
diff --git a/src/HttpClientPool/HttpClientPoolItem.php b/src/HttpClientPool/HttpClientPoolItem.php
@@ -69,9 +69,6 @@ public function __construct($client, int $reenableAfter = null)
         $this->reenableAfter = $reenableAfter;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         if ($this->isDisabled()) {
@@ -92,9 +89,6 @@ public function sendRequest(RequestInterface $request): ResponseInterface
         return $response;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendAsyncRequest(RequestInterface $request)
     {
         if ($this->isDisabled()) {
diff --git a/src/HttpClientPool/LeastUsedClientPool.php b/src/HttpClientPool/LeastUsedClientPool.php
@@ -15,9 +15,6 @@
  */
 final class LeastUsedClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $clientPool = array_filter($this->clientPool, function (HttpClientPoolItem $clientPoolItem) {
diff --git a/src/HttpClientPool/RandomClientPool.php b/src/HttpClientPool/RandomClientPool.php
@@ -13,9 +13,6 @@
  */
 final class RandomClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $clientPool = array_filter($this->clientPool, function (HttpClientPoolItem $clientPoolItem) {
diff --git a/src/HttpClientPool/RoundRobinClientPool.php b/src/HttpClientPool/RoundRobinClientPool.php
@@ -13,9 +13,6 @@
  */
 final class RoundRobinClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $last = current($this->clientPool);
diff --git a/src/HttpClientRouter.php b/src/HttpClientRouter.php
@@ -12,8 +12,6 @@
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * {@inheritdoc}
- *
  * @author Joel Wurtz <joel.wurtz@gmail.com>
  */
 final class HttpClientRouter implements HttpClientRouterInterface
@@ -23,17 +21,11 @@ final class HttpClientRouter implements HttpClientRouterInterface
      */
     private $clients = [];
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         return $this->chooseHttpClient($request)->sendRequest($request);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendAsyncRequest(RequestInterface $request)
     {
         return $this->chooseHttpClient($request)->sendAsyncRequest($request);
diff --git a/src/Plugin/AddHostPlugin.php b/src/Plugin/AddHostPlugin.php
@@ -48,9 +48,6 @@ public function __construct(UriInterface $host, array $config = [])
         $this->replace = $options['replace'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if ($this->replace || '' === $request->getUri()->getHost()) {
diff --git a/src/Plugin/AuthenticationPlugin.php b/src/Plugin/AuthenticationPlugin.php
@@ -26,9 +26,6 @@ public function __construct(Authentication $authentication)
         $this->authentication = $authentication;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $request = $this->authentication->authenticate($request);
diff --git a/src/Plugin/BaseUriPlugin.php b/src/Plugin/BaseUriPlugin.php
@@ -24,7 +24,7 @@ final class BaseUriPlugin implements Plugin
     /**
      * @var AddPathPlugin|null
      */
-    private $addPathPlugin = null;
+    private $addPathPlugin;
 
     /**
      * @param UriInterface $uri        Has to contain a host name and can have a path
@@ -39,9 +39,6 @@ public function __construct(UriInterface $uri, array $hostConfig = [])
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $addHostNext = function (RequestInterface $request) use ($next, $first) {
diff --git a/src/Plugin/ContentLengthPlugin.php b/src/Plugin/ContentLengthPlugin.php
@@ -16,9 +16,6 @@
  */
 final class ContentLengthPlugin implements Plugin
 {
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if (!$request->hasHeader('Content-Length')) {
diff --git a/src/Plugin/ContentTypePlugin.php b/src/Plugin/ContentTypePlugin.php
@@ -57,9 +57,6 @@ public function __construct(array $config = [])
         $this->sizeLimit = $options['size_limit'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if (!$request->hasHeader('Content-Type')) {
diff --git a/src/Plugin/CookiePlugin.php b/src/Plugin/CookiePlugin.php
@@ -33,9 +33,6 @@ public function __construct(CookieJar $cookieJar)
         $this->cookieJar = $cookieJar;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $cookies = [];
diff --git a/src/Plugin/DecoderPlugin.php b/src/Plugin/DecoderPlugin.php
@@ -48,9 +48,6 @@ public function __construct(array $config = [])
         $this->useContentEncoding = $options['use_content_encoding'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $encodings = extension_loaded('zlib') ? ['gzip', 'deflate'] : ['identity'];
diff --git a/src/Plugin/ErrorPlugin.php b/src/Plugin/ErrorPlugin.php
@@ -54,9 +54,6 @@ public function __construct(array $config = [])
         $this->onlyServerException = $options['only_server_exception'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $promise = $next($request);
diff --git a/src/Plugin/HeaderAppendPlugin.php b/src/Plugin/HeaderAppendPlugin.php
@@ -34,9 +34,6 @@ public function __construct(array $headers)
         $this->headers = $headers;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         foreach ($this->headers as $header => $headerValue) {
diff --git a/src/Plugin/HeaderDefaultsPlugin.php b/src/Plugin/HeaderDefaultsPlugin.php
@@ -30,9 +30,6 @@ public function __construct(array $headers)
         $this->headers = $headers;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         foreach ($this->headers as $header => $headerValue) {
diff --git a/src/Plugin/HeaderRemovePlugin.php b/src/Plugin/HeaderRemovePlugin.php
@@ -28,9 +28,6 @@ public function __construct(array $headers)
         $this->headers = $headers;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         foreach ($this->headers as $header) {
diff --git a/src/Plugin/HeaderSetPlugin.php b/src/Plugin/HeaderSetPlugin.php
@@ -30,9 +30,6 @@ public function __construct(array $headers)
         $this->headers = $headers;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         foreach ($this->headers as $header => $headerValue) {
diff --git a/src/Plugin/HistoryPlugin.php b/src/Plugin/HistoryPlugin.php
@@ -29,9 +29,6 @@ public function __construct(Journal $journal)
         $this->journal = $journal;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $journal = $this->journal;
diff --git a/src/Plugin/QueryDefaultsPlugin.php b/src/Plugin/QueryDefaultsPlugin.php
@@ -31,9 +31,6 @@ public function __construct(array $queryParams)
         $this->queryParams = $queryParams;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $uri = $request->getUri();
diff --git a/src/Plugin/RedirectPlugin.php b/src/Plugin/RedirectPlugin.php
@@ -158,9 +158,6 @@ public function __construct(array $config = [])
         $this->streamFactory = $options['stream_factory'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         // Check in storage
diff --git a/src/Plugin/RequestMatcherPlugin.php b/src/Plugin/RequestMatcherPlugin.php
@@ -38,9 +38,6 @@ public function __construct(RequestMatcher $requestMatcher, ?Plugin $delegateOnM
         $this->failurePlugin = $delegateOnNoMatch;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if ($this->requestMatcher->matches($request)) {
diff --git a/src/Plugin/RequestSeekableBodyPlugin.php b/src/Plugin/RequestSeekableBodyPlugin.php
@@ -15,9 +15,6 @@
  */
 final class RequestSeekableBodyPlugin extends SeekableBodyPlugin
 {
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if (!$request->getBody()->isSeekable()) {
diff --git a/src/Plugin/ResponseSeekableBodyPlugin.php b/src/Plugin/ResponseSeekableBodyPlugin.php
diff --git a/src/Plugin/RetryPlugin.php b/src/Plugin/RetryPlugin.php
diff --git a/src/PluginClient.php b/src/PluginClient.php
diff --git a/src/PluginClientBuilder.php b/src/PluginClientBuilder.php

Original file line number	Diff line number	Diff line change
`@@ -51,9 +51,6 @@ public function __construct(callable $waitCallback)`
`51`	`51`	`$this->onRejectedCallbacks = [];`
`52`	`52`	`}`
`53`	`53`
`54`		`- /**`
`55`		`- * {@inheritdoc}`
`56`		`- */`
`57`	`54`	`public function then(callable $onFulfilled = null, callable $onRejected = null): Promise`
`58`	`55`	`{`
`59`	`56`	`$deferred = new self($this->waitCallback);`
`@@ -86,9 +83,6 @@ public function then(callable $onFulfilled = null, callable $onRejected = null):`
`86`	`83`	`return $deferred;`
`87`	`84`	`}`
`88`	`85`
`89`		`- /**`
`90`		`- * {@inheritdoc}`
`91`		`- */`
`92`	`86`	`public function getState(): string`
`93`	`87`	`{`
`94`	`88`	`return $this->state;`
`@@ -128,9 +122,6 @@ public function reject(ClientExceptionInterface $exception): void`
`128`	`122`	`}`
`129`	`123`	`}`
`130`	`124`
`131`		`- /**`
`132`		`- * {@inheritdoc}`
`133`		`- */`
`134`	`125`	`public function wait($unwrap = true)`
`135`	`126`	`{`
`136`	`127`	`if (Promise::PENDING === $this->state) {`
Original file line number	Diff line number	Diff line change
`@@ -52,17 +52,11 @@ public function addHttpClient($client): void`
`52`	`52`	`*/`
`53`	`53`	`abstract protected function chooseHttpClient(): HttpClientPoolItem;`
`54`	`54`
`55`		`- /**`
`56`		`- * {@inheritdoc}`
`57`		`- */`
`58`	`55`	`public function sendAsyncRequest(RequestInterface $request)`
`59`	`56`	`{`
`60`	`57`	`return $this->chooseHttpClient()->sendAsyncRequest($request);`
`61`	`58`	`}`
`62`	`59`
`63`		`- /**`
`64`		`- * {@inheritdoc}`
`65`		`- */`
`66`	`60`	`public function sendRequest(RequestInterface $request): ResponseInterface`
`67`	`61`	`{`
`68`	`62`	`return $this->chooseHttpClient()->sendRequest($request);`
Original file line number	Diff line number	Diff line change
`@@ -69,9 +69,6 @@ public function __construct($client, int $reenableAfter = null)`
`69`	`69`	`$this->reenableAfter = $reenableAfter;`
`70`	`70`	`}`
`71`	`71`
`72`		`- /**`
`73`		`- * {@inheritdoc}`
`74`		`- */`
`75`	`72`	`public function sendRequest(RequestInterface $request): ResponseInterface`
`76`	`73`	`{`
`77`	`74`	`if ($this->isDisabled()) {`
`@@ -92,9 +89,6 @@ public function sendRequest(RequestInterface $request): ResponseInterface`
`92`	`89`	`return $response;`
`93`	`90`	`}`
`94`	`91`
`95`		`- /**`
`96`		`- * {@inheritdoc}`
`97`		`- */`
`98`	`92`	`public function sendAsyncRequest(RequestInterface $request)`
`99`	`93`	`{`
`100`	`94`	`if ($this->isDisabled()) {`