add php-cs-fixer step to build

dbu · dbu · commit 509e513b17e9 · 2022-09-28T17:33:47.000+02:00
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -21,3 +21,16 @@ jobs:
           REQUIRE_DEV: false
         with:
           args: analyze --no-progress
+
+  php-cs-fixer:
+      name: PHP-CS-Fixer
+      runs-on: ubuntu-latest
+
+      steps:
+          - name: Checkout code
+            uses: actions/checkout@v2
+
+          - name: PHP-CS-Fixer
+            uses: docker://oskarstark/php-cs-fixer-ga
+            with:
+                args: --dry-run --diff
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
-/.php_cs
-/.php_cs.cache
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
 /behat.yml
 /build/
 /composer.lock
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,18 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
+    ->name('*.php')
+;
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'single_line_throw' => false,
+    ])
+    ->setFinder($finder)
+;
diff --git a/src/Deferred.php b/src/Deferred.php
@@ -146,7 +146,10 @@ public function wait($unwrap = true)
             return $this->value;
         }
 
-        /** @var ClientExceptionInterface */
+        if (null === $this->failure) {
+            throw new \RuntimeException('Internal Error: Promise is not fulfilled but has no exception stored');
+        }
+
         throw $this->failure;
     }
 }
diff --git a/src/HttpClientPool/HttpClientPool.php b/src/HttpClientPool/HttpClientPool.php
@@ -46,9 +46,9 @@ public function addHttpClient($client): void
     /**
      * Return an http client given a specific strategy.
      *
-     * @throws HttpClientNotFoundException When no http client has been found into the pool
-     *
      * @return HttpClientPoolItem Return a http client that can do both sync or async
+     *
+     * @throws HttpClientNotFoundException When no http client has been found into the pool
      */
     abstract protected function chooseHttpClient(): HttpClientPoolItem;
 
diff --git a/src/Plugin/AddHostPlugin.php b/src/Plugin/AddHostPlugin.php
@@ -31,7 +31,7 @@ final class AddHostPlugin implements Plugin
      * @param array{'replace'?: bool} $config
      *
      * Configuration options:
-     *   - replace: True will replace all hosts, false will only add host when none is specified.
+     *   - replace: True will replace all hosts, false will only add host when none is specified
      */
     public function __construct(UriInterface $host, array $config = [])
     {
diff --git a/src/Plugin/AddPathPlugin.php b/src/Plugin/AddPathPlugin.php
@@ -70,7 +70,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
         if (substr($path, 0, strlen($prepend)) !== $prepend) {
             $request = $request->withUri($request->getUri()
                  ->withPath($prepend.$path)
-             );
+            );
         }
 
         return $next($request);
diff --git a/src/Plugin/ContentTypePlugin.php b/src/Plugin/ContentTypePlugin.php
@@ -39,7 +39,7 @@ final class ContentTypePlugin implements Plugin
      *
      * Configuration options:
      *   - skip_detection: true skip detection if stream size is bigger than $size_limit
-     *   - size_limit: size stream limit for which the detection as to be skipped.
+     *   - size_limit: size stream limit for which the detection as to be skipped
      */
     public function __construct(array $config = [])
     {
diff --git a/src/Plugin/DecoderPlugin.php b/src/Plugin/DecoderPlugin.php
@@ -34,7 +34,7 @@ final class DecoderPlugin implements Plugin
      * @param array{'use_content_encoding'?: bool} $config
      *
      * Configuration options:
-     *   - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).
+     *   - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true)
      */
     public function __construct(array $config = [])
     {
diff --git a/src/Plugin/ErrorPlugin.php b/src/Plugin/ErrorPlugin.php
@@ -40,7 +40,7 @@ final class ErrorPlugin implements Plugin
      * @param array{'only_server_exception'?: bool} $config
      *
      * Configuration options:
-     *   - only_server_exception: Whether this plugin should only throw 5XX Exceptions (default to false).
+     *   - only_server_exception: Whether this plugin should only throw 5XX Exceptions (default to false)
      */
     public function __construct(array $config = [])
     {
@@ -72,10 +72,10 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
      * @param RequestInterface  $request  Request of the call
      * @param ResponseInterface $response Response of the call
      *
+     * @return ResponseInterface If status code is not in 4xx or 5xx return response
+     *
      * @throws ClientErrorException If response status code is a 4xx
      * @throws ServerErrorException If response status code is a 5xx
-     *
-     * @return ResponseInterface If status code is not in 4xx or 5xx return response
      */
     private function transformResponseToException(RequestInterface $request, ResponseInterface $response): ResponseInterface
     {
diff --git a/src/Plugin/RedirectPlugin.php b/src/Plugin/RedirectPlugin.php
@@ -107,7 +107,7 @@ final class RedirectPlugin implements Plugin
      * Configuration options:
      *   - preserve_header: True keeps all headers, false remove all of them, an array is interpreted as a list of header names to keep
      *   - use_default_for_multiple: Whether the location header must be directly used for a multiple redirection status code (300)
-     *   - strict: When true, redirect codes 300, 301, 302 will not modify request method and body.
+     *   - strict: When true, redirect codes 300, 301, 302 will not modify request method and body
      */
     public function __construct(array $config = [])
     {
@@ -242,7 +242,7 @@ private function createUri(ResponseInterface $redirectResponse, RequestInterface
             if ('' === $path) {
                 $path = $originalPath;
             } elseif (($pos = strrpos($originalPath, '/')) !== false) {
-                $path = substr($originalPath, 0, $pos+1).$path;
+                $path = substr($originalPath, 0, $pos + 1).$path;
             } else {
                 $path = '/'.$path;
             }
diff --git a/src/PluginChain.php b/src/PluginChain.php
@@ -5,6 +5,7 @@
 namespace Http\Client\Common;
 
 use function array_reverse;
+
 use Http\Client\Common\Exception\LoopException;
 use Http\Promise\Promise;
 use Psr\Http\Message\RequestInterface;
diff --git a/src/PluginClient.php b/src/PluginClient.php
@@ -124,7 +124,6 @@ private function configure(array $options = []): array
      */
     private function createPluginChain(array $plugins, callable $clientCallable): callable
     {
-        /** @var callable(RequestInterface): Promise */
         return new PluginChain($plugins, $clientCallable, $this->options);
     }
 }
diff --git a/src/PluginClientFactory.php b/src/PluginClientFactory.php
@@ -39,11 +39,11 @@ public static function setFactory(callable $factory): void
     /**
      * @param ClientInterface|HttpAsyncClient $client
      * @param Plugin[]                        $plugins
-     * @param array{'client_name'?: string}    $options
+     * @param array{'client_name'?: string}   $options
      *
      * Configuration options:
      *   - client_name: to give client a name which may be used when displaying client information
-     *     like in the HTTPlugBundle profiler.
+     *     like in the HTTPlugBundle profiler
      *
      * @see PluginClient constructor for PluginClient specific $options.
      */
diff --git a/tests/Plugin/RedirectPluginTest.php b/tests/Plugin/RedirectPluginTest.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Plugin;
@@ -29,18 +30,18 @@ function () {}
     public function provideRedirections(): array
     {
         return [
-            'no path on target' => ["https://example.com/path?query=value", "https://example.com?query=value", "https://example.com?query=value"],
-            'root path on target' => ["https://example.com/path?query=value", "https://example.com/?query=value", "https://example.com/?query=value"],
-            'redirect to query' => ["https://example.com", "https://example.com?query=value", "https://example.com?query=value"],
-            'redirect to different domain without port' => ["https://example.com:8000", "https://foo.com?query=value", "https://foo.com?query=value"],
-            'network-path redirect, preserve scheme' => ["https://example.com:8000", "//foo.com/path?query=value", "https://foo.com/path?query=value"],
-            'absolute-path redirect, preserve host' => ["https://example.com:8000", "/path?query=value", "https://example.com:8000/path?query=value"],
-            'relative-path redirect, append' => ["https://example.com:8000/path/", "sub/path?query=value", "https://example.com:8000/path/sub/path?query=value"],
-            'relative-path on non-folder' => ["https://example.com:8000/path/foo", "sub/path?query=value", "https://example.com:8000/path/sub/path?query=value"],
-            'relative-path moving up' => ["https://example.com:8000/path/", "../other?query=value", "https://example.com:8000/other?query=value"],
-            'relative-path with ./' => ["https://example.com:8000/path/", "./other?query=value", "https://example.com:8000/path/other?query=value"],
-            'relative-path with //' => ["https://example.com:8000/path/", "other//sub?query=value", "https://example.com:8000/path/other//sub?query=value"],
-            'relative-path redirect with only query' => ["https://example.com:8000/path", "?query=value", "https://example.com:8000/path?query=value"],
+            'no path on target' => ['https://example.com/path?query=value', 'https://example.com?query=value', 'https://example.com?query=value'],
+            'root path on target' => ['https://example.com/path?query=value', 'https://example.com/?query=value', 'https://example.com/?query=value'],
+            'redirect to query' => ['https://example.com', 'https://example.com?query=value', 'https://example.com?query=value'],
+            'redirect to different domain without port' => ['https://example.com:8000', 'https://foo.com?query=value', 'https://foo.com?query=value'],
+            'network-path redirect, preserve scheme' => ['https://example.com:8000', '//foo.com/path?query=value', 'https://foo.com/path?query=value'],
+            'absolute-path redirect, preserve host' => ['https://example.com:8000', '/path?query=value', 'https://example.com:8000/path?query=value'],
+            'relative-path redirect, append' => ['https://example.com:8000/path/', 'sub/path?query=value', 'https://example.com:8000/path/sub/path?query=value'],
+            'relative-path on non-folder' => ['https://example.com:8000/path/foo', 'sub/path?query=value', 'https://example.com:8000/path/sub/path?query=value'],
+            'relative-path moving up' => ['https://example.com:8000/path/', '../other?query=value', 'https://example.com:8000/other?query=value'],
+            'relative-path with ./' => ['https://example.com:8000/path/', './other?query=value', 'https://example.com:8000/path/other?query=value'],
+            'relative-path with //' => ['https://example.com:8000/path/', 'other//sub?query=value', 'https://example.com:8000/path/other//sub?query=value'],
+            'relative-path redirect with only query' => ['https://example.com:8000/path', '?query=value', 'https://example.com:8000/path?query=value'],
        ];
     }
 
diff --git a/tests/PluginChainTest.php b/tests/PluginChainTest.php
@@ -9,15 +9,13 @@
 use Http\Client\Common\PluginChain;
 use Http\Promise\Promise;
 use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
 use Psr\Http\Message\RequestInterface;
 
 class PluginChainTest extends TestCase
 {
     private function createPlugin(callable $func): Plugin
     {
-        return new class ($func) implements Plugin
-        {
+        return new class($func) implements Plugin {
             public $func;
 
             public function __construct(callable $func)

Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,10 @@ public function wait($unwrap = true)`
`146`	`146`	`return $this->value;`
`147`	`147`	`}`
`148`	`148`
`149`		`- /** @var ClientExceptionInterface */`
	`149`	`+ if (null === $this->failure) {`
	`150`	`+ throw new \RuntimeException('Internal Error: Promise is not fulfilled but has no exception stored');`
	`151`	`+ }`
	`152`	`+`
`150`	`153`	`throw $this->failure;`
`151`	`154`	`}`
`152`	`155`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ final class AddHostPlugin implements Plugin`
`31`	`31`	`* @param array{'replace'?: bool} $config`
`32`	`32`	`*`
`33`	`33`	`* Configuration options:`
`34`		`- * - replace: True will replace all hosts, false will only add host when none is specified.`
	`34`	`+ * - replace: True will replace all hosts, false will only add host when none is specified`
`35`	`35`	`*/`
`36`	`36`	`public function __construct(UriInterface $host, array $config = [])`
`37`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl`
`70`	`70`	`if (substr($path, 0, strlen($prepend)) !== $prepend) {`
`71`	`71`	`$request = $request->withUri($request->getUri()`
`72`	`72`	`->withPath($prepend.$path)`
`73`		`- );`
	`73`	`+ );`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`return $next($request);`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ final class ContentTypePlugin implements Plugin`
`39`	`39`	`*`
`40`	`40`	`* Configuration options:`
`41`	`41`	`* - skip_detection: true skip detection if stream size is bigger than $size_limit`
`42`		`- * - size_limit: size stream limit for which the detection as to be skipped.`
	`42`	`+ * - size_limit: size stream limit for which the detection as to be skipped`
`43`	`43`	`*/`
`44`	`44`	`public function __construct(array $config = [])`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ final class DecoderPlugin implements Plugin`
`34`	`34`	`* @param array{'use_content_encoding'?: bool} $config`
`35`	`35`	`*`
`36`	`36`	`* Configuration options:`
`37`		`- * - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true).`
	`37`	`+ * - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true)`
`38`	`38`	`*/`
`39`	`39`	`public function __construct(array $config = [])`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ final class ErrorPlugin implements Plugin`
`40`	`40`	`* @param array{'only_server_exception'?: bool} $config`
`41`	`41`	`*`
`42`	`42`	`* Configuration options:`
`43`		`- * - only_server_exception: Whether this plugin should only throw 5XX Exceptions (default to false).`
	`43`	`+ * - only_server_exception: Whether this plugin should only throw 5XX Exceptions (default to false)`
`44`	`44`	`*/`
`45`	`45`	`public function __construct(array $config = [])`
`46`	`46`	`{`
`@@ -72,10 +72,10 @@ public function handleRequest(RequestInterface $request, callable $next, callabl`
`72`	`72`	`* @param RequestInterface $request Request of the call`
`73`	`73`	`* @param ResponseInterface $response Response of the call`
`74`	`74`	`*`
	`75`	`+ * @return ResponseInterface If status code is not in 4xx or 5xx return response`
	`76`	`+ *`
`75`	`77`	`* @throws ClientErrorException If response status code is a 4xx`
`76`	`78`	`* @throws ServerErrorException If response status code is a 5xx`
`77`		`- *`
`78`		`- * @return ResponseInterface If status code is not in 4xx or 5xx return response`
`79`	`79`	`*/`
`80`	`80`	`private function transformResponseToException(RequestInterface $request, ResponseInterface $response): ResponseInterface`
`81`	`81`	`{`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,6 @@ private function configure(array $options = []): array`
`124`	`124`	`*/`
`125`	`125`	`private function createPluginChain(array $plugins, callable $clientCallable): callable`
`126`	`126`	`{`
`127`		`- /** @var callable(RequestInterface): Promise */`
`128`	`127`	`return new PluginChain($plugins, $clientCallable, $this->options);`
`129`	`128`	`}`
`130`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,11 +39,11 @@ public static function setFactory(callable $factory): void`
`39`	`39`	`/**`
`40`	`40`	`* @param ClientInterface\|HttpAsyncClient $client`
`41`	`41`	`* @param Plugin[] $plugins`
`42`		`- * @param array{'client_name'?: string} $options`
	`42`	`+ * @param array{'client_name'?: string} $options`
`43`	`43`	`*`
`44`	`44`	`* Configuration options:`
`45`	`45`	`* - client_name: to give client a name which may be used when displaying client information`
`46`		`- * like in the HTTPlugBundle profiler.`
	`46`	`+ * like in the HTTPlugBundle profiler`
`47`	`47`	`*`
`48`	`48`	`* @see PluginClient constructor for PluginClient specific $options.`
`49`	`49`	`*/`