style and doc

Author: Nyholm

src/ClassDiscovery.php

@@ -4,11 +4,6 @@
 
 use Http\Discovery\Exception\DiscoveryFailedException;
 use Http\Discovery\Exception\StrategyUnavailableException;
-use Http\Discovery\Exception\NotFoundException;
-use Http\Discovery\Strategy\DiactorosFactory;
-use Http\Discovery\Strategy\GuzzleFactory;
-use Http\Discovery\Strategy\HttpClients;
-use Http\Discovery\Strategy\Puli;
 
 /**
  * Registry that based find results on class existence.
@@ -25,35 +20,36 @@ abstract class ClassDiscovery
      * @var array
      */
     public static $strategies = [
-        Puli::class,
-        HttpClients::class,
-        GuzzleFactory::class,
-        DiactorosFactory::class,
+        Strategy\Puli::class,
+        Strategy\HttpClients::class,
+        Strategy\GuzzleFactory::class,
+        Strategy\DiactorosFactory::class,
     ];
 
     /**
      * Discovery cache to make the second time we use discovery faster.
+     *
      * @var array
      */
     private static $cache = [];
 
     /**
      * Finds a class.
      *
-     * @param $type
+     * @param string $type
      *
      * @return string
      *
-     * @throws NotFoundException
+     * @throws DiscoveryFailedException
      */
-    public static function findOneByType($type)
+    protected static function findOneByType($type)
     {
-        $exceptions = [];
-
+        // Look in the cache
         if (null !== $class = self::getFromCache($type)) {
             return $class;
         }
 
+        $exceptions = [];
         foreach (self::$strategies as $strategy) {
             try {
                 $bindings = call_user_func($strategy.'::find', $type);
@@ -80,7 +76,7 @@ public static function findOneByType($type)
     }
 
     /**
-     * Get a value from cache
+     * Get a value from cache.
      *
      * @param string $type
      *
@@ -92,11 +88,11 @@ private static function getFromCache($type)
             return self::$cache[$type];
         }
 
-        return null;
+        return;
     }
 
     /**
-     * Store a value in cache
+     * Store a value in cache.
      *
      * @param string $type
      * @param string $class

src/Exception/DiscoveryFailedException.php

@@ -15,7 +15,6 @@ final class DiscoveryFailedException extends \RuntimeException
     private $exceptions;
 
     /**
-     *
      * @param $exceptions
      */
     public function __construct($message, array $exceptions = [])

src/Exception/StrategyUnavailableException.php

@@ -4,11 +4,10 @@
 
 /**
  * This exception is thrown when we cannot use a discovery strategy. This is *not* thrown when
- * the discovery fails to find a class. 
+ * the discovery fails to find a class.
  *
  * @author Tobias Nyholm <[email protected]>
  */
 class StrategyUnavailableException extends \RuntimeException
 {
-
-}
+}

src/HttpAsyncClientDiscovery.php

@@ -3,6 +3,7 @@
 namespace Http\Discovery;
 
 use Http\Client\HttpAsyncClient;
+use Http\Discovery\Exception\DiscoveryFailedException;
 
 /**
  * Finds an HTTP Asynchronous Client.
@@ -15,11 +16,21 @@ final class HttpAsyncClientDiscovery extends ClassDiscovery
      * Finds an HTTP Async Client.
      *
      * @return HttpAsyncClient
+     *
+     * @throws NotFoundException
      */
     public static function find()
     {
-        $asyncClient = static::findOneByType('Http\Client\HttpAsyncClient');
+        try {
+            $asyncClient = static::findOneByType('Http\Client\HttpAsyncClient');
 
-        return new $asyncClient();
+            return new $asyncClient();
+        } catch (DiscoveryFailedException $e) {
+            throw new NotFoundException(
+                'No Httplug async clients found. Make sure to install a package providing "php-http/async-client-implementation". Example: "php-http/guzzle6-adapter".',
+                0,
+                $e
+            );
+        }
     }
 }

src/HttpClientDiscovery.php

@@ -3,6 +3,7 @@
 namespace Http\Discovery;
 
 use Http\Client\HttpClient;
+use Http\Discovery\Exception\DiscoveryFailedException;
 
 /**
  * Finds an HTTP Client.
@@ -15,11 +16,21 @@ final class HttpClientDiscovery extends ClassDiscovery
      * Finds an HTTP Client.
      *
      * @return HttpClient
+     *
+     * @throws NotFoundException
      */
     public static function find()
     {
-        $client = static::findOneByType('Http\Client\HttpClient');
+        try {
+            $client = static::findOneByType('Http\Client\HttpClient');
 
-        return new $client();
+            return new $client();
+        } catch (DiscoveryFailedException $e) {
+            throw new NotFoundException(
+                'No Httplug clients found. Make sure to install a package providing "php-http/client-implementation". Example: "php-http/guzzle6-adapter".',
+                0,
+                $e
+            );
+        }
     }
 }

src/MessageFactoryDiscovery.php

@@ -17,6 +17,8 @@ final class MessageFactoryDiscovery extends ClassDiscovery
      * Finds a Message Factory.
      *
      * @return MessageFactory
+     *
+     * @throws NotFoundException
      */
     public static function find()
     {

src/Strategy/AbstractStrategy.php

@@ -3,8 +3,6 @@
 namespace Http\Discovery\Strategy;
 
 /**
- *
- *
  * @author Tobias Nyholm <[email protected]>
  */
 abstract class AbstractStrategy implements DiscoveryStrategy
@@ -22,4 +20,4 @@ public static function find($type)
 
         return [];
     }
-}
+}

src/Strategy/DiscoveryStrategy.php

@@ -2,18 +2,22 @@
 
 namespace Http\Discovery\Strategy;
 
+use Http\Discovery\Exception\StrategyUnavailableException;
+
 /**
  * @author Tobias Nyholm <[email protected]>
  */
 interface DiscoveryStrategy
 {
     /**
-     * Find a resource of a specific type. 
-     * 
+     * Find a resource of a specific type.
+     *
      * @param string $type
      *
      * @return array The return value is always an array with zero or more elements. Each
      *               element is an array with two keys ['class' => string, 'condition' => mixed].
+     *
+     * @throws StrategyUnavailableException if we cannot use this strategy.
      */
     public static function find($type);
 }

src/Strategy/GuzzleFactory.php

@@ -19,7 +19,7 @@ class GuzzleFactory extends AbstractStrategy
      */
     protected static $classes = [
         'Http\Message\MessageFactory' => [
-            ['class' => GuzzleMessageFactory::class, 'condition' => [Request::class, DiactorosMessageFactory::class]],
+            ['class' => GuzzleMessageFactory::class, 'condition' => [Request::class, GuzzleMessageFactory::class]],
         ],
         'Http\Message\StreamFactory' => [
             ['class' => GuzzleStreamFactory::class, 'condition' => [Request::class, GuzzleStreamFactory::class]],

src/Strategy/HttpClients.php

@@ -4,6 +4,10 @@
 
 use Http\Adapter\Guzzle6\Client as Guzzle6;
 use Http\Adapter\Guzzle5\Client as Guzzle5;
+use Http\Client\Curl\Client as Curl;
+use Http\Client\Socket\Client as Socket;
+use Http\Adapter\React\Client as React;
+use Http\Adapter\Buzz\Client as Buzz;
 
 /**
  * Find common HTTP clients.
@@ -18,10 +22,15 @@ class HttpClients extends AbstractStrategy
     protected static $classes = [
         'Http\Client\HttpAsyncClient' => [
             ['class' => Guzzle6::class, 'condition' => Guzzle6::class],
+            ['class' => React::class, 'condition' => React::class],
         ],
         'Http\Client\HttpClient' => [
             ['class' => Guzzle6::class, 'condition' => Guzzle6::class],
             ['class' => Guzzle5::class, 'condition' => Guzzle5::class],
+            ['class' => Curl::class, 'condition' => Curl::class],
+            ['class' => Socket::class, 'condition' => Socket::class],
+            ['class' => Buzz::class, 'condition' => Buzz::class],
+            ['class' => React::class, 'condition' => React::class],
         ],
     ];
 }

src/Strategy/Puli.php

@@ -3,7 +3,6 @@
 namespace Http\Discovery\Strategy;
 
 use Http\Discovery\Exception\PuliUnavailableException;
-use Puli\Discovery\Api\Discovery;
 
 /**
  * @author David de Boer <[email protected]>
@@ -12,17 +11,19 @@
 class Puli implements DiscoveryStrategy
 {
     /**
-     * @var GeneratedPuliFactory
+     * @var \Puli\GeneratedPuliFactory
      */
     private static $puliFactory;
 
     /**
-     * @var Discovery
+     * @var \Puli\Discovery\Api\Discovery
      */
     private static $puliDiscovery;
 
     /**
-     * @return GeneratedPuliFactory
+     * @return \Puli\GeneratedPuliFactory
+     *
+     * @throws PuliUnavailableException
      */
     public static function getPuliFactory()
     {
@@ -70,7 +71,9 @@ public static function resetPuliFactory()
     /**
      * Returns the Puli discovery layer.
      *
-     * @return Discovery
+     * @return \Puli\Discovery\Api\Discovery
+     *
+     * @throws PuliUnavailableException
      */
     public static function getPuliDiscovery()
     {
@@ -97,9 +100,9 @@ public static function find($type)
             if ($binding->hasParameterValue('depends')) {
                 $condition = $binding->getParameterValue('depends');
             }
-            $returnData[] = ['class'=>$binding->getClassName(), 'condition'=> $condition];
+            $returnData[] = ['class' => $binding->getClassName(), 'condition' => $condition];
         }
 
         return $returnData;
     }
-}
+}

src/StreamFactoryDiscovery.php

@@ -17,6 +17,8 @@ final class StreamFactoryDiscovery extends ClassDiscovery
      * Finds a Stream Factory.
      *
      * @return StreamFactory
+     *
+     * @throws NotFoundException
      */
     public static function find()
     {

src/UriFactoryDiscovery.php

@@ -17,6 +17,8 @@ final class UriFactoryDiscovery extends ClassDiscovery
      * Finds a URI Factory.
      *
      * @return UriFactory
+     *
+     * @throws NotFoundException
      */
     public static function find()
     {