Merge pull request #27 from sunrise-php/release/v1.4.1

fenric · web-flow · commit c5509957643b · 2021-10-13T08:53:19.000+05:00
v1.4.1
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -10,40 +10,40 @@ jobs:
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction --no-suggest --prefer-source
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php72:
     docker:
       - image: circleci/php:7.2-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction --no-suggest --prefer-source
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php73:
     docker:
       - image: circleci/php:7.3-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction --no-suggest --prefer-source
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php74:
     docker:
       - image: circleci/php:7.4-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction --no-suggest --prefer-source
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
   php80:
     docker:
       - image: circleci/php:8.0-cli-node-browsers
     steps:
       - checkout
       - run: php -v
-      - run: composer install --no-interaction --prefer-source --no-suggest
-      - run: php vendor/bin/phpunit --colors=always
+      - run: composer install --no-interaction --no-suggest --prefer-source
+      - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text
 workflows:
   version: 2
   build:
diff --git a/.editorconfig b/.editorconfig
@@ -11,8 +11,5 @@ indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.md]
-trim_trailing_whitespace = false
-
 [*.yml]
 indent_size = 2
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,8 @@
-.php_cs.cache
-.phpunit.result.cache
-composer.lock
-coverage.xml
-phpbench.json
-phpcs.xml
-phpunit.xml
-vendor/
+/.php_cs.cache
+/.phpunit.result.cache
+/composer.lock
+/coverage.xml
+/phpbench.json
+/phpcs.xml
+/phpunit.xml
+/vendor/
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,4 +1,7 @@
 build:
+  environment:
+    php:
+      version: '8.0'
   nodes:
     analysis:
       tests:
@@ -7,7 +10,7 @@ build:
     coverage:
       tests:
         override:
-          - command: php vendor/bin/phpunit --coverage-clover coverage.xml
+          - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml
             coverage:
               file: coverage.xml
               format: clover
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,12 +1,11 @@
-## HTTP cURL client for PHP 7.1+ (incl. PHP 8) based on PSR-18
+# HTTP cURL client for PHP 7.1+ (incl. PHP 8) based on PSR-18
 
-[![Gitter](https://badges.gitter.im/sunrise-php/support.png)](https://gitter.im/sunrise-php/support)
 [![Build Status](https://circleci.com/gh/sunrise-php/http-client-curl.svg?style=shield)](https://circleci.com/gh/sunrise-php/http-client-curl)
 [![Code Coverage](https://scrutinizer-ci.com/g/sunrise-php/http-client-curl/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-client-curl/?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunrise-php/http-client-curl/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-client-curl/?branch=master)
-[![Total Downloads](https://poser.pugx.org/sunrise/http-client-curl/downloads)](https://packagist.org/packages/sunrise/http-client-curl)
-[![Latest Stable Version](https://poser.pugx.org/sunrise/http-client-curl/v/stable)](https://packagist.org/packages/sunrise/http-client-curl)
-[![License](https://poser.pugx.org/sunrise/http-client-curl/license)](https://packagist.org/packages/sunrise/http-client-curl)
+[![Total Downloads](https://poser.pugx.org/sunrise/http-client-curl/downloads?format=flat)](https://packagist.org/packages/sunrise/http-client-curl)
+[![Latest Stable Version](https://poser.pugx.org/sunrise/http-client-curl/v/stable?format=flat)](https://packagist.org/packages/sunrise/http-client-curl)
+[![License](https://poser.pugx.org/sunrise/http-client-curl/license?format=flat)](https://packagist.org/packages/sunrise/http-client-curl)
 
 ---
 
@@ -18,7 +17,7 @@ composer require sunrise/http-client-curl
 
 ## How to use?
 
-### Sunrise HTTP Factory
+### Sunrise
 
 ```bash
 composer require sunrise/http-factory
@@ -33,7 +32,7 @@ $client = new Client(new ResponseFactory());
 $request = (new RequestFactory)->createRequest('GET', 'http://php.net/');
 $response = $client->sendRequest($request);
 
-// just use PSR-7 Response object...
+// just use PSR-7 response...
 ```
 
 ### Zend Diactoros
@@ -51,7 +50,7 @@ $client = new Client(new ResponseFactory());
 $request = (new RequestFactory)->createRequest('GET', 'http://php.net/');
 $response = $client->sendRequest($request);
 
-// just use PSR-7 Response object...
+// just use PSR-7 response...
 ```
 
 ### cURL options
@@ -70,14 +69,13 @@ $client = new Client(new ResponseFactory(), [
 $requests = [
     (new RequestFactory)->createRequest('GET', 'http://php.net/'),
     (new RequestFactory)->createRequest('GET', 'http://php.net/'),
-    (new RequestFactory)->createRequest('GET', 'http://php.net/'),
 ];
 
 $client = new Client(new ResponseFactory());
 $responses = $client->sendRequests(...$request);
 
 foreach ($responses as $response) {
-    // just use PSR-7 Response object...
+    // just use PSR-7 response...
 }
 ```
 
diff --git a/composer.json b/composer.json
@@ -51,8 +51,12 @@
     },
     "scripts": {
         "test": [
-            "phpunit --colors=always --coverage-text",
-            "phpcs"
+            "phpcs",
+            "XDEBUG_MODE=coverage phpunit --coverage-text"
+        ],
+        "build": [
+            "phpdoc -d src/ -t phpdoc/",
+            "XDEBUG_MODE=coverage phpunit --coverage-html coverage/"
         ]
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -6,7 +6,7 @@
         </include>
     </coverage>
     <testsuites>
-        <testsuite name="Sunrise HTTP CURL Client Test Suite">
+        <testsuite name="sunrise.http.curlClient.testSuite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
diff --git a/src/Client.php b/src/Client.php
@@ -56,7 +56,7 @@
 use const CURLOPT_URL;
 
 /**
- * HTTP Client based on cURL
+ * HTTP client based on cURL
  *
  * @link http://php.net/manual/en/intro.curl.php
  * @link https://curl.haxx.se/libcurl/c/libcurl-errors.html
@@ -69,15 +69,11 @@ class Client implements ClientInterface
 {
 
     /**
-     * Response Factory
-     *
      * @var ResponseFactoryInterface
      */
     protected $responseFactory;
 
     /**
-     * cURL options
-     *
      * @var array
      */
     protected $curlOptions;
@@ -97,7 +93,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function sendRequest(RequestInterface $request) : ResponseInterface
     {
@@ -139,7 +135,7 @@ public function sendRequests(RequestInterface ...$requests) : array
         }
 
         do {
-           curl_multi_exec($curlMultiHandle, $active);
+            curl_multi_exec($curlMultiHandle, $active);
         } while ($active);
 
         $responses = [];
@@ -155,7 +151,7 @@ public function sendRequests(RequestInterface ...$requests) : array
     }
 
     /**
-     * Creates CurlHandle using the given Request
+     * Creates CurlHandle using the given request
      *
      * @param RequestInterface $request
      *
@@ -194,7 +190,7 @@ private function createCurlHandleFromRequest(RequestInterface $request)
     }
 
     /**
-     * Creates Response using the given CurlHandle
+     * Creates response using the given CurlHandle
      *
      * @param resource $curlHandle
      *
@@ -225,7 +221,7 @@ private function createResponseFromCurlHandle($curlHandle) : ResponseInterface
     }
 
     /**
-     * Fills the given Response with the header fields using the given header
+     * Fills the given response with the header fields using the given header
      *
      * @param ResponseInterface $response
      * @param string $header
diff --git a/src/Exception/ClientException.php b/src/Exception/ClientException.php
@@ -14,8 +14,8 @@
 /**
  * Import classes
  */
-use RuntimeException;
 use Psr\Http\Client\ClientExceptionInterface;
+use RuntimeException;
 
 /**
  * ClientException
diff --git a/src/Exception/NetworkException.php b/src/Exception/NetworkException.php
@@ -14,9 +14,9 @@
 /**
  * Import classes
  */
-use Throwable;
 use Psr\Http\Client\NetworkExceptionInterface;
 use Psr\Http\Message\RequestInterface;
+use Throwable;
 
 /**
  * NetworkException
@@ -25,8 +25,6 @@ class NetworkException extends ClientException implements NetworkExceptionInterf
 {
 
     /**
-     * Request instance
-     *
      * @var RequestInterface
      */
     protected $request;
@@ -37,21 +35,21 @@ class NetworkException extends ClientException implements NetworkExceptionInterf
      * @param RequestInterface $request
      * @param string $message
      * @param int $code
-     * @param Throwable $previous
+     * @param Throwable|null $previous
      */
     public function __construct(
         RequestInterface $request,
         string $message = '',
         int $code = 0,
-        Throwable $previous = null
+        ?Throwable $previous = null
     ) {
         $this->request = $request;
 
         parent::__construct($message, $code, $previous);
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getRequest() : RequestInterface
     {
diff --git a/src/Exception/RequestException.php b/src/Exception/RequestException.php
@@ -14,9 +14,9 @@
 /**
  * Import classes
  */
-use Throwable;
 use Psr\Http\Client\RequestExceptionInterface;
 use Psr\Http\Message\RequestInterface;
+use Throwable;
 
 /**
  * RequestException
@@ -25,8 +25,6 @@ class RequestException extends ClientException implements RequestExceptionInterf
 {
 
     /**
-     * Request instance
-     *
      * @var RequestInterface
      */
     protected $request;
@@ -37,21 +35,21 @@ class RequestException extends ClientException implements RequestExceptionInterf
      * @param RequestInterface $request
      * @param string $message
      * @param int $code
-     * @param Throwable $previous
+     * @param Throwable|null $previous
      */
     public function __construct(
         RequestInterface $request,
         string $message = '',
         int $code = 0,
-        Throwable $previous = null
+        ?Throwable $previous = null
     ) {
         $this->request = $request;
 
         parent::__construct($message, $code, $previous);
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getRequest() : RequestInterface
     {
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Sunrise\Http\Client\Curl\Tests;
 
 use RuntimeException;

Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,12 @@`
`51`	`51`	`},`
`52`	`52`	`"scripts": {`
`53`	`53`	`"test": [`
`54`		`- "phpunit --colors=always --coverage-text",`
`55`		`- "phpcs"`
	`54`	`+ "phpcs",`
	`55`	`+ "XDEBUG_MODE=coverage phpunit --coverage-text"`
	`56`	`+ ],`
	`57`	`+ "build": [`
	`58`	`+ "phpdoc -d src/ -t phpdoc/",`
	`59`	`+ "XDEBUG_MODE=coverage phpunit --coverage-html coverage/"`
`56`	`60`	`]`
`57`	`61`	`}`
`58`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@`
`56`	`56`	`use const CURLOPT_URL;`
`57`	`57`
`58`	`58`	`/**`
`59`		`- * HTTP Client based on cURL`
	`59`	`+ * HTTP client based on cURL`
`60`	`60`	`*`
`61`	`61`	`* @link http://php.net/manual/en/intro.curl.php`
`62`	`62`	`* @link https://curl.haxx.se/libcurl/c/libcurl-errors.html`
`@@ -69,15 +69,11 @@ class Client implements ClientInterface`
`69`	`69`	`{`
`70`	`70`
`71`	`71`	`/**`
`72`		`- * Response Factory`
`73`		`- *`
`74`	`72`	`* @var ResponseFactoryInterface`
`75`	`73`	`*/`
`76`	`74`	`protected $responseFactory;`
`77`	`75`
`78`	`76`	`/**`
`79`		`- * cURL options`
`80`		`- *`
`81`	`77`	`* @var array`
`82`	`78`	`*/`
`83`	`79`	`protected $curlOptions;`
`@@ -97,7 +93,7 @@ public function __construct(`
`97`	`93`	`}`
`98`	`94`
`99`	`95`	`/**`
`100`		`- * {@inheritDoc}`
	`96`	`+ * {@inheritdoc}`
`101`	`97`	`*/`
`102`	`98`	`public function sendRequest(RequestInterface $request) : ResponseInterface`
`103`	`99`	`{`
`@@ -139,7 +135,7 @@ public function sendRequests(RequestInterface ...$requests) : array`
`139`	`135`	`}`
`140`	`136`
`141`	`137`	`do {`
`142`		`- curl_multi_exec($curlMultiHandle, $active);`
	`138`	`+ curl_multi_exec($curlMultiHandle, $active);`
`143`	`139`	`} while ($active);`
`144`	`140`
`145`	`141`	`$responses = [];`
`@@ -155,7 +151,7 @@ public function sendRequests(RequestInterface ...$requests) : array`
`155`	`151`	`}`
`156`	`152`
`157`	`153`	`/**`
`158`		`- * Creates CurlHandle using the given Request`
	`154`	`+ * Creates CurlHandle using the given request`
`159`	`155`	`*`
`160`	`156`	`* @param RequestInterface $request`
`161`	`157`	`*`
`@@ -194,7 +190,7 @@ private function createCurlHandleFromRequest(RequestInterface $request)`
`194`	`190`	`}`
`195`	`191`
`196`	`192`	`/**`
`197`		`- * Creates Response using the given CurlHandle`
	`193`	`+ * Creates response using the given CurlHandle`
`198`	`194`	`*`
`199`	`195`	`* @param resource $curlHandle`
`200`	`196`	`*`
`@@ -225,7 +221,7 @@ private function createResponseFromCurlHandle($curlHandle) : ResponseInterface`
`225`	`221`	`}`
`226`	`222`
`227`	`223`	`/**`
`228`		`- * Fills the given Response with the header fields using the given header`
	`224`	`+ * Fills the given response with the header fields using the given header`
`229`	`225`	`*`
`230`	`226`	`* @param ResponseInterface $response`
`231`	`227`	`* @param string $header`