Merge pull request #193 from GrahamCampbell/type-errors

Consitent implementation of union type checking

Author: dbu

spec/FlexibleHttpClientSpec.php

@@ -32,11 +32,11 @@ public function it_is_an_async_http_client()
         $this->shouldImplement(HttpAsyncClient::class);
     }
 
-    public function it_throw_exception_if_invalid_client()
+    public function it_throw_type_error_if_invalid_client()
     {
         $this->beConstructedWith(null);
 
-        $this->shouldThrow(\LogicException::class)->duringInstantiation();
+        $this->shouldThrow(\TypeError::class)->duringInstantiation();
     }
 
     public function it_emulates_an_async_client(

src/FlexibleHttpClient.php

@@ -24,8 +24,10 @@ final class FlexibleHttpClient implements HttpClient, HttpAsyncClient
      */
     public function __construct($client)
     {
-        if (!($client instanceof ClientInterface) && !($client instanceof HttpAsyncClient)) {
-            throw new \LogicException(sprintf('Client must be an instance of %s or %s', ClientInterface::class, HttpAsyncClient::class));
+        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
+            throw new \TypeError(
+                sprintf('%s::__construct(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
         }
 
         $this->httpClient = $client;

src/HttpClientPool/HttpClientPool.php

@@ -29,6 +29,12 @@ abstract class HttpClientPool implements HttpClientPoolInterface
      */
     public function addHttpClient($client): void
     {
+        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient && !$client instanceof HttpClientPoolItem) {
+            throw new \TypeError(
+                sprintf('%s::addHttpClient(): Argument #1 ($client) must be of type %s|%s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, HttpClientPoolItem::class, get_debug_type($client))
+            );
+        }
+
         if (!$client instanceof HttpClientPoolItem) {
             $client = new HttpClientPoolItem($client);
         }

src/HttpClientPool/HttpClientPoolItem.php

@@ -59,6 +59,12 @@ class HttpClientPoolItem implements HttpClient, HttpAsyncClient
      */
     public function __construct($client, int $reenableAfter = null)
     {
+        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
+            throw new \TypeError(
+                sprintf('%s::__construct(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
+        }
+
         $this->client = new FlexibleHttpClient($client);
         $this->reenableAfter = $reenableAfter;
     }

src/HttpClientRouter.php

@@ -46,6 +46,12 @@ public function sendAsyncRequest(RequestInterface $request)
      */
     public function addClient($client, RequestMatcher $requestMatcher): void
     {
+        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
+            throw new \TypeError(
+                sprintf('%s::addClient(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
+        }
+
         $this->clients[] = [
             'matcher' => $requestMatcher,
             'client' => new FlexibleHttpClient($client),

src/PluginClient.php

@@ -50,8 +50,6 @@ final class PluginClient implements HttpClient, HttpAsyncClient
      *
      *     @var int      $max_restarts
      * }
-     *
-     * @throws \RuntimeException if client is not an instance of HttpClient or HttpAsyncClient
      */
     public function __construct($client, array $plugins = [], array $options = [])
     {
@@ -60,7 +58,9 @@ public function __construct($client, array $plugins = [], array $options = [])
         } elseif ($client instanceof ClientInterface) {
             $this->client = new EmulatedHttpAsyncClient($client);
         } else {
-            throw new \LogicException(sprintf('Client must be an instance of %s or %s', ClientInterface::class, HttpAsyncClient::class));
+            throw new \TypeError(
+                sprintf('%s::__construct(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
         }
 
         $this->plugins = $plugins;

src/PluginClientBuilder.php

@@ -45,12 +45,14 @@ public function removeOption(string $name): self
     }
 
     /**
-     * @param ClientInterface | HttpAsyncClient $client
+     * @param ClientInterface|HttpAsyncClient $client
      */
     public function createClient($client): PluginClient
     {
         if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
-            throw new \RuntimeException('You must provide a valid http client');
+            throw new \TypeError(
+                sprintf('%s::createClient(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
         }
 
         $plugins = $this->plugins;

src/PluginClientFactory.php

@@ -47,6 +47,12 @@ public static function setFactory(callable $factory)
      */
     public function createClient($client, array $plugins = [], array $options = []): PluginClient
     {
+        if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
+            throw new \TypeError(
+                sprintf('%s::createClient(): Argument #1 ($client) must be of type %s|%s, %s given', self::class, ClientInterface::class, HttpAsyncClient::class, get_debug_type($client))
+            );
+        }
+
         if (static::$factory) {
             $factory = static::$factory;