Merge pull request #23 from clue-labs/reject-reason

Support custom rejection reason for ConnectionManagerReject

Author: clue

README.md

@@ -96,10 +96,37 @@ $delayed = new ConnectionManagerDelayed($connector, 0.5, $loop);
 
 ### Reject
 
-The `ConnectionManagerReject()` simply rejects every single connection attempt.
+The `ConnectionManagerReject(null|string|callable $reason)` simply rejects every single connection attempt.
 This is particularly useful for the below [`ConnectionManagerSelective`](#selective) to reject connection attempts
 to only certain destinations (for example blocking advertisements or harmful sites).
 
+The constructor accepts an optional rejection reason which will be used for
+rejecting the resulting promise.
+
+You can explicitly pass a `string` value which will be used as the message for
+the `Exception` instance:
+
+```php
+$connector = new ConnectionManagerReject('Blocked');
+$connector->connect('www.google.com:80')->then(null, function ($e) {
+    assert($e instanceof \Exception);
+    assert($e->getMessage() === 'Blocked');
+});
+```
+
+You can explicitly pass a `callable` value which will be used to either
+`throw` or `return` a custom `Exception` instance:
+
+```php
+$connector = new ConnectionManagerReject(function ($uri) {
+    throw new RuntimeException($uri . ' blocked');
+});
+$connector->connect('www.google.com:80')->then(null, function ($e) {
+    assert($e instanceof \RuntimeException);
+    assert($e->getMessage() === 'www.google.com:80 blocked');
+});
+```
+
 ### Swappable
 
 The `ConnectionManagerSwappable($connector)` is a simple decorator for other `ConnectionManager`s to

src/ConnectionManagerReject.php

@@ -9,8 +9,33 @@
 // a simple connection manager that rejects every single connection attempt
 class ConnectionManagerReject implements ConnectorInterface
 {
-    public function connect($_)
+    private $reason = 'Connection rejected';
+
+    /**
+     * @param null|string|callable $reason
+     */
+    public function __construct($reason = null)
+    {
+        if ($reason !== null) {
+            $this->reason = $reason;
+        }
+    }
+
+    public function connect($uri)
     {
-        return Promise\reject(new Exception('Connection rejected'));
+        $reason = $this->reason;
+        if (!is_string($reason)) {
+            try {
+                $reason = $reason($uri);
+            } catch (\Exception $e) {
+                $reason = $e;
+            }
+        }
+
+        if (!$reason instanceof \Exception) {
+            $reason = new Exception($reason);
+        }
+
+        return Promise\reject($reason);
     }
 }

tests/ConnectionManagerRejectTest.php

@@ -13,4 +13,51 @@ public function testReject()
 
         $promise->then($this->expectCallableNever(), $this->expectCallableOnce());
     }
+
+    public function testRejectWithCustomMessage()
+    {
+        $cm = new ConnectionManagerReject('Blocked');
+        $promise = $cm->connect('www.google.com:80');
+
+        $text = null;
+        $promise->then($this->expectCallableNever(), function (Exception $e) use (&$text) {
+            $text = $e->getMessage();
+        });
+
+        $this->assertEquals('Blocked', $text);
+    }
+
+    public function testRejectThrowsCustomException()
+    {
+        $cm = new ConnectionManagerReject(function ($uri) {
+            throw new RuntimeException('Blocked ' . $uri);
+        });
+
+        $promise = $cm->connect('www.google.com:80');
+
+        $exception = null;
+        $promise->then($this->expectCallableNever(), function ($e) use (&$exception) {
+            $exception = $e;
+        });
+
+        $this->assertInstanceOf('RuntimeException', $exception);
+        $this->assertEquals('Blocked www.google.com:80', $exception->getMessage());
+    }
+
+    public function testRejectReturnsCustomException()
+    {
+        $cm = new ConnectionManagerReject(function ($uri) {
+            return new RuntimeException('Blocked ' . $uri);
+        });
+
+        $promise = $cm->connect('www.google.com:80');
+
+        $exception = null;
+        $promise->then($this->expectCallableNever(), function ($e) use (&$exception) {
+            $exception = $e;
+        });
+
+        $this->assertInstanceOf('RuntimeException', $exception);
+        $this->assertEquals('Blocked www.google.com:80', $exception->getMessage());
+    }
 }