Merge pull request #56 from clue-labs/default-loop

Simplify usage by supporting new default loop

Author: clue

README.md

@@ -65,18 +65,34 @@ the [examples](examples) to get started.
 ### Factory
 
 The `Factory` is responsible for creating your [`Client`](#client) instance.
-It also registers everything with the main [`EventLoop`](https://github.com/reactphp/event-loop#usage).
 
 ```php
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Clue\React\Quassel\Factory();
 ```
 
-If you need custom DNS, proxy or TLS settings, you can explicitly pass a
-custom instance of the [`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):
+This class takes an optional `LoopInterface|null $loop` parameter that can be used to
+pass the event loop instance to use for this object. You can use a `null` value
+here in order to use the [default loop](https://github.com/reactphp/event-loop#loop).
+This value SHOULD NOT be given unless you're sure you want to explicitly use a
+given event loop instance.
+
+If you need custom connector settings (DNS resolution, TLS parameters, timeouts,
+proxy servers etc.), you can explicitly pass a custom instance of the
+[`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):
 
 ```php
-$factory = new Factory($loop, $connector);
+$connector = new React\Socket\Connector(null, array(
+    'dns' => '127.0.0.1',
+    'tcp' => array(
+        'bindto' => '192.168.10.1:0'
+    ),
+    'tls' => array(
+        'verify_peer' => false,
+        'verify_peer_name' => false
+    )
+));
+
+$factory = new Clue\React\Quassel\Factory(null, $connector);
 ```
 
 #### createClient()

composer.json

@@ -19,10 +19,10 @@
     "require": {
     	"php": ">=5.3",
         "clue/qdatastream": "^0.8",
-        "react/event-loop": "^1.0 || ^0.5 || ^0.4 || ^0.3",
+        "react/event-loop": "^1.2",
         "react/promise": "~2.0|~1.1",
-        "react/socket": "^1.0 || ^0.8 || ^0.7",
-        "react/stream": "^1.0 || ^0.7 || ^0.6 || ^0.5 || ^0.4.6"
+        "react/socket": "^1.8",
+        "react/stream": "^1.2"
     },
     "require-dev": {
         "clue/block-react": "^1.1",

examples/01-channels.php

@@ -17,8 +17,7 @@
 echo 'Password: ';
 $pass = trim(fgets(STDIN));
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 $uri = rawurlencode($user) . ':' . rawurlencode($pass) . '@' . $host;
 
@@ -90,5 +89,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

examples/02-chatbot.php

@@ -25,8 +25,7 @@
     die('Keyword MUST contain at least 3 characters to avoid excessive spam');
 }
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 $uri = rawurlencode($user) . ':' . rawurlencode($pass) . '@' . $host;
 
@@ -61,5 +60,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

examples/03-pingbot.php

@@ -19,8 +19,7 @@
 echo 'Password: ';
 $pass = trim(fgets(STDIN));
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 $uri = rawurlencode($user) . ':' . rawurlencode($pass) . '@' . $host;
 
@@ -127,5 +126,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

examples/04-connect.php

@@ -19,8 +19,7 @@
 echo 'Password: ';
 $pass = trim(fgets(STDIN));
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 $uri = rawurlencode($user) . ':' . rawurlencode($pass) . '@' . $host;
 
@@ -88,5 +87,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

examples/05-backlog.php

@@ -22,8 +22,7 @@
 echo 'Channel to export (empty=all): ';
 $channel = trim(fgets(STDIN));
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 $uri = rawurlencode($user) . ':' . rawurlencode($pass) . '@' . $host;
 
@@ -96,5 +95,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

examples/11-debug.php

@@ -2,7 +2,6 @@
 
 use Clue\React\Quassel\Factory;
 use Clue\React\Quassel\Client;
-use Clue\React\Quassel\Io\Protocol;
 use Clue\React\Quassel\Models\BufferInfo;
 
 require __DIR__ . '/../vendor/autoload.php';
@@ -19,8 +18,7 @@
 echo 'Password: ';
 $user['password'] = trim(fgets(STDIN));
 
-$loop = \React\EventLoop\Factory::create();
-$factory = new Factory($loop);
+$factory = new Factory();
 
 echo '[1/5] Connecting' . PHP_EOL;
 $factory->createClient($host)->then(function (Client $client) use ($user) {
@@ -110,5 +108,3 @@
 })->then(null, function ($e) {
     echo $e;
 });
-
-$loop->run();

src/Factory.php

@@ -4,6 +4,7 @@
 
 use Clue\React\Quassel\Io\Prober;
 use Clue\React\Quassel\Io\Protocol;
+use React\EventLoop\Loop;
 use React\EventLoop\LoopInterface;
 use React\Promise;
 use React\Socket\ConnectorInterface;
@@ -13,15 +14,24 @@
 
 class Factory
 {
-    public function __construct(LoopInterface $loop, ConnectorInterface $connector = null, Prober $prober = null)
+    /** @var LoopInterface */
+    private $loop;
+
+    /** @var ConnectorInterface */
+    private $connector;
+
+    /** @var Prober */
+    private $prober;
+
+    public function __construct(LoopInterface $loop = null, ConnectorInterface $connector = null, Prober $prober = null)
     {
+        $this->loop = $loop ?: Loop::get();
         if ($connector === null) {
             $connector = new Connector($loop);
         }
         if ($prober === null) {
             $prober = new Prober();
         }
-        $this->loop = $loop;
         $this->connector = $connector;
         $this->prober = $prober;
     }