[RFC] Global Loop (simplified)

src/GlobalLoop.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace React\EventLoop;
+
+final class GlobalLoop
+{
+    /**
+     * @var LoopInterface
+     */
+    private static $loop;
+
+    private static $factory;
+
+    private static $didRun = false;
+    private static $disableRunOnShutdown = false;
+
+    public static function setFactory(callable $factory = null)
+    {
+        if (self::$didRun) {
+            throw new \LogicException(
+                'Setting a factory after the global loop has been started is not allowed.'
+            );
+        }
+
+        self::$factory = $factory;
+    }
+
+    public function disableRunOnShutdown()
+    {
+        self::$disableRunOnShutdown = true;
+    }
+
+    /**
+     * @return LoopInterface
+     */
+    public static function get()
+    {
+        if (self::$loop) {
+            return self::$loop;
+        }
+
+        register_shutdown_function(function () {
+            if (self::$disableRunOnShutdown || self::$didRun || !self::$loop) {
+                return;
+            }
+
+            self::$loop->run();
+        });
+
+        self::$loop = self::create();
+
+        self::$loop->futureTick(function () {
+            self::$didRun = true;
+        });
+
+        return self::$loop;
+    }
+
+    public static function reset()
+    {
+        self::$loop = null;
+        self::$didRun = false;
+    }
+
+    /**
+     * @return LoopInterface
+     */
+    public static function create()
+    {
+        if (self::$factory) {
+            return self::createFromCustomFactory(self::$factory);
+        }
+
+        return Factory::create();
+    }
+
+    private static function createFromCustomFactory(callable $factory)
+    {
+        $loop = call_user_func($factory);
+
+        if (!$loop instanceof LoopInterface) {
+            throw new \LogicException(
+                sprintf(
+                    'The GlobalLoop factory must return an instance of LoopInterface but returned %s.',
+                    is_object($loop) ? get_class($loop) : gettype($loop)
+                )
+            );
+        }
+
+        return $loop;
+    }
+}

tests/GlobalLoopTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace React\Tests\EventLoop;
+
+use React\EventLoop\GlobalLoop;
+
+class GlobalLoopTest extends TestCase
+{
+    public function tearDown()
+    {
+        GlobalLoop::reset();
+        GlobalLoop::setFactory(null);
+    }
+
+    public function testCreatesDefaultLoop()
+    {
+        $this->assertInstanceOf('React\EventLoop\LoopInterface', GlobalLoop::get());
+    }
+
+    public function testSubsequentGetCallsReturnSameInstance()
+    {
+        $this->assertSame(GlobalLoop::get(), GlobalLoop::get());
+    }
+
+    public function testSubsequentGetCallsReturnNotSameInstanceWhenResetting()
+    {
+        $loop = GlobalLoop::get();
+
+        GlobalLoop::reset();
+
+        $this->assertNotSame($loop, GlobalLoop::get());
+    }
+
+    public function testCreatesLoopWithFactory()
+    {
+        $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')
+            ->getMock();
+
+        $factory = $this->createCallableMock();
+        $factory
+            ->expects($this->once())
+            ->method('__invoke')
+            ->will($this->returnValue($loop));
+
+        GlobalLoop::setFactory($factory);
+
+        $this->assertSame($loop, GlobalLoop::get());
+    }
+
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessage The GlobalLoop factory must return an instance of LoopInterface but returned NULL.
+     */
+    public function testThrowsExceptionWhenFactoryDoesNotReturnALoopInterface()
+    {
+        $factory = $this->createCallableMock();
+        $factory
+            ->expects($this->once())
+            ->method('__invoke');
+
+        GlobalLoop::setFactory($factory);
+
+        GlobalLoop::get();
+    }
+
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessage Setting a factory after the global loop has been started is not allowed.
+     */
+    public function testThrowsExceptionWhenSettingAFactoryAfterLoopIsCreated()
+    {
+        GlobalLoop::get()->run();
+
+        GlobalLoop::setFactory(null);
+    }
+}