Merge pull request #14 from clue-labs/repeat

Change $retries to $tries

Author: clue

README.md

@@ -60,11 +60,15 @@ All classes are located in the `ConnectionManager\Extra` namespace.
 
 ### Repeat
 
-The `ConnectionManagerRepeat($connector, $repeat)` retries connecting to the given location up to a maximum
-of `$repeat` times when the connection fails.
+The `ConnectionManagerRepeat($connector, $tries)` tries connecting to the given location up to a maximum
+of `$tries` times when the connection fails.
+
+If you pass a value of `3` to it, it will first issue a normal connection attempt
+and then retry up to 2 times if the connection attempt fails:
 
 ```php
-$connectorRepeater = new \ConnectionManager\Extra\ConnectionManagerRepeat($connector, 3);
+$connectorRepeater = new ConnectionManagerRepeat($connector, 3);
+
 $connectorRepeater->create('www.google.com', 80)->then(function ($stream) {
     echo 'connection successfully established';
     $stream->close();

src/ConnectionManagerRepeat.php

@@ -11,25 +11,20 @@
 class ConnectionManagerRepeat implements ConnectorInterface
 {
     protected $connectionManager;
-    protected $maximumRepetitions;
+    protected $maximumTries;
 
-    public function __construct(ConnectorInterface $connectionManager, $maximumRepetitons)
+    public function __construct(ConnectorInterface $connectionManager, $maximumTries)
     {
-        if ($maximumRepetitons < 1) {
-            throw new InvalidArgumentException('Maximum number of repetitions must be >= 1');
+        if ($maximumTries < 1) {
+            throw new InvalidArgumentException('Maximum number of tries must be >= 1');
         }
         $this->connectionManager = $connectionManager;
-        $this->maximumRepetitions = $maximumRepetitons;
+        $this->maximumTries = $maximumTries;
     }
 
     public function create($host, $port)
     {
-        return $this->tryConnection($this->maximumRepetitions, $host, $port);
-    }
-
-    public function tryConnection($repeat, $host, $port)
-    {
-        $tries = $repeat + 1;
+        $tries = $this->maximumTries;
         $connector = $this->connectionManager;
 
         return new Promise(function ($resolve, $reject) use ($host, $port, &$pending, &$tries, $connector) {
@@ -39,7 +34,7 @@ public function tryConnection($repeat, $host, $port)
                     $pending = $connector->create($host, $port);
                     $pending->then($resolve, $try);
                 } else {
-                    $reject(new Exception('Connection still fails even after repeating', 0, $error));
+                    $reject(new Exception('Connection still fails even after retrying', 0, $error));
                 }
             };
 

tests/ConnectionManagerRepeatTest.php

@@ -17,14 +17,14 @@ public function testRepeatRejected()
         $promise->then($this->expectCallableNever(), $this->expectCallableOnce());
     }
 
-    public function testOneRepetitionWillStartTwoConnectionAttempts()
+    public function testTwoTriesWillStartTwoConnectionAttempts()
     {
         $promise = Promise\reject(new \RuntimeException('nope'));
 
         $connector = $this->getMock('React\SocketClient\ConnectorInterface');
         $connector->expects($this->exactly(2))->method('create')->with('google.com', 80)->willReturn($promise);
 
-        $cm = new ConnectionManagerRepeat($connector, 1);
+        $cm = new ConnectionManagerRepeat($connector, 2);
 
         $promise = $cm->create('google.com', 80);