Merge pull request #87 from async-interop/driver-registry-merge

Merge Registry into Driver

Author: WyriHaximus

src/Loop/Driver.php

@@ -2,8 +2,13 @@
 
 namespace Interop\Async\Loop;
 
-interface Driver
+abstract class Driver
 {
+    /**
+     * @var array
+     */
+    private $registry = [];
+
     /**
      * Start the event loop.
      *
@@ -13,7 +18,7 @@ interface Driver
      *
      * @return void
      */
-    public function run();
+    abstract public function run();
 
     /**
      * Stop the event loop.
@@ -23,7 +28,7 @@ public function run();
      *
      * @return void
      */
-    public function stop();
+    abstract public function stop();
 
     /**
      * Defer the execution of a callback.
@@ -37,7 +42,7 @@ public function stop();
      *
      * @return string An unique identifier that can be used to cancel, enable or disable the watcher.
      */
-    public function defer(callable $callback, $data = null);
+    abstract public function defer(callable $callback, $data = null);
 
     /**
      * Delay the execution of a callback.
@@ -52,7 +57,7 @@ public function defer(callable $callback, $data = null);
      *
      * @return string An unique identifier that can be used to cancel, enable or disable the watcher.
      */
-    public function delay($delay, callable $callback, $data = null);
+    abstract public function delay($delay, callable $callback, $data = null);
 
     /**
      * Repeatedly execute a callback.
@@ -67,7 +72,7 @@ public function delay($delay, callable $callback, $data = null);
      *
      * @return string An unique identifier that can be used to cancel, enable or disable the watcher.
      */
-    public function repeat($interval, callable $callback, $data = null);
+    abstract public function repeat($interval, callable $callback, $data = null);
 
     /**
      * Execute a callback when a stream resource becomes readable.
@@ -80,7 +85,7 @@ public function repeat($interval, callable $callback, $data = null);
      *
      * @return string An unique identifier that can be used to cancel, enable or disable the watcher.
      */
-    public function onReadable($stream, callable $callback, $data = null);
+    abstract public function onReadable($stream, callable $callback, $data = null);
 
     /**
      * Execute a callback when a stream resource becomes writable.
@@ -93,7 +98,7 @@ public function onReadable($stream, callable $callback, $data = null);
      *
      * @return string An unique identifier that can be used to cancel, enable or disable the watcher.
      */
-    public function onWritable($stream, callable $callback, $data = null);
+    abstract public function onWritable($stream, callable $callback, $data = null);
 
     /**
      * Execute a callback when a signal is received.
@@ -112,7 +117,7 @@ public function onWritable($stream, callable $callback, $data = null);
      *
      * @throws UnsupportedFeatureException If signal handling is not supported.
      */
-    public function onSignal($signo, callable $callback, $data = null);
+    abstract public function onSignal($signo, callable $callback, $data = null);
 
     /**
      * Enable a watcher.
@@ -126,7 +131,7 @@ public function onSignal($signo, callable $callback, $data = null);
      *
      * @throws InvalidWatcherException If the watcher identifier is invalid.
      */
-    public function enable($watcherId);
+    abstract public function enable($watcherId);
 
     /**
      * Disable a watcher. Disabling a watcher MUST NOT invalidate the watcher.
@@ -137,7 +142,7 @@ public function enable($watcherId);
      *
      * @throws InvalidWatcherException If the watcher identifier is invalid.
      */
-    public function disable($watcherId);
+    abstract public function disable($watcherId);
 
     /**
      * Cancel a watcher. This will detatch the event loop from all resources that are associated to the watcher. After
@@ -148,7 +153,7 @@ public function disable($watcherId);
      *
      * @return void
      */
-    public function cancel($watcherId);
+    abstract public function cancel($watcherId);
 
     /**
      * Reference a watcher.
@@ -162,7 +167,7 @@ public function cancel($watcherId);
      *
      * @throws InvalidWatcherException If the watcher identifier is invalid.
      */
-    public function reference($watcherId);
+    abstract public function reference($watcherId);
 
     /**
      * Unreference a watcher.
@@ -176,7 +181,7 @@ public function reference($watcherId);
      *
      * @throws InvalidWatcherException If the watcher identifier is invalid.
      */
-    public function unreference($watcherId);
+    abstract public function unreference($watcherId);
 
     /**
      * Stores information in the loop bound registry. This can be used to store loop bound information. Stored
@@ -189,19 +194,29 @@ public function unreference($watcherId);
      *
      * @return void
      */
-    public function storeState($key, $value);
+    final public function storeState($key, $value)
+    {
+        if ($value === null) {
+            unset($this->registry[$key]);
+        } else {
+            $this->registry[$key] = $value;
+        }
+    }
 
     /**
      * Fetches information stored bound to the loop. Stored information is package private. Packages MUST NOT retrieve
      * the stored state of other packages.
      *
      * Therefore packages SHOULD use the following prefix to keys: `vendor.package.`
      *
-     * @param string $key Namespaced storage key.
+     * @param string $key namespaced storage key
      *
      * @return mixed previously stored value or null if it doesn't exist
      */
-    public function fetchState($key);
+    final public function fetchState($key)
+    {
+        return isset($this->registry[$key]) ? $this->registry[$key] : null;
+    }
 
     /**
      * Set a callback to be executed when an error occurs.
@@ -213,7 +228,7 @@ public function fetchState($key);
      *
      * @return void
      */
-    public function setErrorHandler(callable $callback = null);
+    abstract public function setErrorHandler(callable $callback = null);
 
     /**
      * Retrieve an associative array of information about the event loop driver.
@@ -235,7 +250,7 @@ public function setErrorHandler(callable $callback = null);
      *
      * @return array
      */
-    public function info();
+    abstract public function info();
 
     /**
      * Get the underlying loop handle.
@@ -247,5 +262,5 @@ public function info();
      *
      * @return null|object|resource The loop handle the event loop operates on. Null if there is none.
      */
-    public function getHandle();
+    abstract public function getHandle();
 }

src/Loop/Registry.php

@@ -2,10 +2,10 @@
 
 namespace Interop\Async\Loop\Test;
 
-class DummyDriver implements \Interop\Async\Loop\Driver
-{
-    use \Interop\Async\Loop\Registry;
+use Interop\Async\Loop\Driver;
 
+class DummyDriver extends Driver
+{
     public $defers;
     public $handler;
     public static $id = "a";

test/DummyDriver.php

@@ -8,7 +8,7 @@ class RegistryTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->registry = $this->getMockForTrait(Registry::class);
+        $this->registry = $this->getMockForAbstractClass(Driver::class);
     }
 
     /** @test */