Remove unused stream factory (#9)

* Remove unused stream factory

* Restore useless parameter and emit deprecation notice if passed

This ensures we don't add another parameter which might be a BC break compared to v0.1.0 then.

* Make deprecation notice opt-in

Author: kelunik

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+ - Ignore useless `StreamFactory` parameter in the constructor of `Http\Adapter\Artax\Client` and emit deprecation notice if it's not `null`.
+
 ## v0.1.0
 
 Initial release.

src/Client.php

@@ -9,7 +9,6 @@
 use Http\Client\Exception\RequestException;
 use Http\Client\HttpClient;
 use Http\Discovery\MessageFactoryDiscovery;
-use Http\Discovery\StreamFactoryDiscovery;
 use Http\Message\ResponseFactory;
 use Http\Message\StreamFactory;
 use Psr\Http\Message\RequestInterface;
@@ -19,13 +18,23 @@ class Client implements HttpClient
 {
     private $client;
     private $responseFactory;
-    private $streamFactory;
 
-    public function __construct(Artax\Client $client = null, ResponseFactory $responseFactory = null, StreamFactory $streamFactory = null)
-    {
+    /**
+     * @param Artax\Client    $client          HTTP client implementation.
+     * @param ResponseFactory $responseFactory Response factory to use or `null` to attempt auto-discovery.
+     * @param StreamFactory   $streamFactory   This parameter will be ignored and removed in the next major version.
+     */
+    public function __construct(
+        Artax\Client $client = null,
+        ResponseFactory $responseFactory = null,
+        StreamFactory $streamFactory = null
+    ) {
         $this->client = $client ?? new Artax\DefaultClient();
         $this->responseFactory = $responseFactory ?? MessageFactoryDiscovery::find();
-        $this->streamFactory = $streamFactory ?? StreamFactoryDiscovery::find();
+
+        if ($streamFactory !== null || \func_num_args() === 3) {
+            @\trigger_error('The $streamFactory parameter is deprecated and ignored.', \E_USER_DEPRECATED);
+        }
     }
 
     /** {@inheritdoc} */

tests/ClientTest.php

@@ -3,9 +3,9 @@
 namespace Http\Adapter\Artax\Test;
 
 use Amp\Artax;
+use Http\Adapter\Artax\Client;
 use Http\Client\HttpClient;
 use Http\Client\Tests\HttpClientTest;
-use Http\Adapter\Artax\Client;
 
 class ClientTest extends HttpClientTest
 {
@@ -17,4 +17,21 @@ protected function createHttpAdapter()
 
         return new Client($client);
     }
+
+    public function testStreamFactoryDeprecation()
+    {
+        $invoked = false;
+
+        try {
+            \set_error_handler(function () use (&$invoked) {
+                $invoked = true;
+            }, \E_USER_DEPRECATED);
+
+            new Client(null, null, null);
+        } finally {
+            \restore_error_handler();
+        }
+
+        $this->assertTrue($invoked);
+    }
 }