Add ReserverFactory.

This creates the various reserver implementations.

Author: rayward

lib/Resque/Reserver/ReserverFactory.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace Resque\Reserver;
+
+use Psr\Log\LoggerInterface;
+
+class ReserverFactory
+{
+    /** @var string */
+    const DEFAULT_RESERVER = 'queue_order';
+
+    /** @var LoggerInterface */
+    private $logger;
+
+    /**
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Creates a reserver given its name in snake case format.
+     *
+     * @param string $name
+     * @return ReserverInterface
+     * @throws UnknownReserverException
+     */
+    public function createReserverFromName($name, array $queues)
+    {
+        $parts = explode('_', $name);
+        $parts = array_map(function ($word) {
+            return ucfirst(strtolower($word));
+        }, $parts);
+
+        $methodName = 'create' . implode('', $parts) . 'Reserver';
+
+        if (!method_exists($this, $methodName)) {
+            throw new UnknownReserverException("Unknown reserver '$name' - could not find factory method $methodName");
+        }
+
+        return $this->$methodName($queues);
+    }
+
+    /**
+     * Creates the default reserver.
+     *
+     * @param array $queues
+     * @return ReserverInterface
+     */
+    public function createDefaultReserver(array $queues)
+    {
+        return $this->createReserverFromName(self::DEFAULT_RESERVER, $queues);
+    }
+
+    /**
+     * @param array $queues
+     * @return QueueOrderReserver
+     */
+    public function createQueueOrderReserver(array $queues)
+    {
+        return new QueueOrderReserver($this->logger, $queues);
+    }
+
+    /**
+     * @param array $queues
+     * @return RandomQueueOrderReserver
+     */
+    public function createRandomQueueOrderReserver(array $queues)
+    {
+        return new RandomQueueOrderReserver($this->logger, $queues);
+    }
+
+    /**
+     * @param array $queues
+     * @return BlockingListPopReserver
+     */
+    public function createBlockingListPopReserver(array $queues)
+    {
+        $timeout = getenv('BPLOP_TIMEOUT');
+        if ($timeout === false) {
+            $timeout = getenv('INTERVAL');
+        }
+
+        if ($timeout === false || $timeout < 0) {
+            $timeout = BlockingListPopReserver::DEFAULT_TIMEOUT;
+        }
+
+        return new BlockingListPopReserver($this->logger, $queues, (int)$timeout);
+    }
+}

lib/Resque/Reserver/UnknownReserverException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Resque\Reserver;
+
+class UnknownReserverException extends \UnexpectedValueException
+{
+    /**
+     * @param string $reserver The name of the reserver.
+     */
+    public function __construct($reserver)
+    {
+        parent::__construct("Unknown reserver '$reserver'");
+    }
+}

test/Resque/Tests/Reserver/ReserverFactoryTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Resque\Tests\Reserver;
+
+use Resque\Reserver\ReserverFactory;
+use Resque;
+
+class ReserverFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    private function getFactory()
+    {
+        return new ReserverFactory(new \Resque_Log());
+    }
+
+    /**
+     * @expectedException Resque\Reserver\UnknownReserverException
+     * @expectedExceptionMessage Unknown reserver 'foo'
+     */
+    public function testCreateReserverFromNameThrowsExceptionForUnknownReserver()
+    {
+        $this->getFactory()->createReserverFromName('foo', array());
+    }
+
+    public function createReserverFromNameDataProvider()
+    {
+        return array(
+            array('queue_order', '\Resque\Reserver\QueueOrderReserver'),
+            array('RANDOM_QUEUE_ORDER', '\Resque\Reserver\RandomQueueOrderReserver'),
+            array('Blocking_List_Pop', '\Resque\Reserver\BlockingListPopReserver'),
+        );
+    }
+
+    /**
+     * @dataProvider createReserverFromNameDataProvider
+     */
+    public function testCreateReserverFromNameCreatesExpectedReserver($name, $expectedReserver)
+    {
+        $queues = array(
+            'queue_a',
+            'queue_b',
+            'queue_c',
+            'queue_d',
+        );
+
+        $reserver = $this->getFactory()->createReserverFromName($name, $queues);
+        $this->assertInstanceOf($expectedReserver, $reserver);
+
+        // account for shuffling by RandomQueueOrderReserver
+        $actualQueues = $reserver->getQueues();
+        sort($actualQueues);
+
+        $this->assertEquals($queues, $actualQueues);
+    }
+
+    public function testCreateDefaultReserverCreatesExpectedReserver()
+    {
+        $reserver = $this->getFactory()->createDefaultReserver(array());
+        $this->assertInstanceOf('\Resque\Reserver\QueueOrderReserver', $reserver);
+    }
+}