Add GatewayFactory registration methods

Author: amacneil

src/Omnipay/Common/GatewayFactory.php

@@ -2,58 +2,59 @@
 
 namespace Omnipay\Common;
 
-use RecursiveDirectoryIterator;
-use RecursiveIteratorIterator;
-use ReflectionClass;
 use Guzzle\Http\ClientInterface;
 use Omnipay\Common\Exception\RuntimeException;
 use Symfony\Component\HttpFoundation\Request as HttpRequest;
 
 class GatewayFactory
 {
-    public static function create($class, ClientInterface $httpClient = null, HttpRequest $httpRequest = null)
-    {
-        $class = Helper::getGatewayClassName($class);
+    private static $gateways = array();
 
-        if (!class_exists($class)) {
-            throw new RuntimeException("Class '$class' not found");
-        }
+    /**
+     * All available gateways
+     *
+     * @return array An array of gateway names
+     */
+    public static function all()
+    {
+        return static::$gateways;
+    }
 
-        $gateway = new $class($httpClient, $httpRequest);
+    /**
+     * Replace the list of available gateways
+     *
+     * @param array $gateways An array of gateway names
+     */
+    public static function replace(array $gateways)
+    {
+        static::$gateways = $gateways;
+    }
 
-        return $gateway;
+    /**
+     * Register a new gateway
+     *
+     * @param string $className Gateway name
+     */
+    public static function register($className)
+    {
+        static::$gateways[] = $className;
     }
 
     /**
-     * Get a list of supported gateways, in friendly format (e.g. PayPal_Express)
+     * Create a new gateway instance
+     *
+     * @param string               $class       Gateway name
+     * @param ClientInterface|null $httpClient  A Guzzle HTTP Client implementation
+     * @param HttpRequest|null     $httpRequest A Symfony HTTP Request implementation
      */
-    public static function find($directory = null)
+    public static function create($class, ClientInterface $httpClient = null, HttpRequest $httpRequest = null)
     {
-        $result = array();
-
-        // find all gateways in the Billing directory
-        $directory = dirname(__DIR__);
-        $it = new RecursiveDirectoryIterator($directory);
-        foreach (new RecursiveIteratorIterator($it) as $file) {
-            $filepath = $file->getPathName();
-            if ('Gateway.php' === substr($filepath, -11)) {
-                // determine class name
-                $type = substr($filepath, 0, -11);
-                $type = str_replace(array($directory, DIRECTORY_SEPARATOR), array('', '_'), $type);
-                $type = trim($type, '_');
-                $class = Helper::getGatewayClassName($type);
-
-                // ensure class exists and is not abstract
-                if (class_exists($class)) {
-                    $reflection = new ReflectionClass($class);
-                    if (!$reflection->isAbstract() and
-                        $reflection->implementsInterface('\\Omnipay\\Common\\GatewayInterface')) {
-                        $result[] = $type;
-                    }
-                }
-            }
+        $class = Helper::getGatewayClassName($class);
+
+        if (!class_exists($class)) {
+            throw new RuntimeException("Class '$class' not found");
         }
 
-        return $result;
+        return new $class($httpClient, $httpRequest);
     }
 }

tests/Omnipay/Common/GatewayFactoryTest.php

@@ -2,14 +2,45 @@
 
 namespace Omnipay\Common;
 
+use Mockery as m;
 use Omnipay\TestCase;
 
 class GatewayFactoryTest extends TestCase
 {
-    public function testCreate()
+    public function tearDown()
     {
-        $gateway = GatewayFactory::create('Stripe');
-        $this->assertInstanceOf('\\Omnipay\\Stripe\\Gateway', $gateway);
+        GatewayFactory::replace(array());
+    }
+
+    public function testReplace()
+    {
+        $gateways = array('Foo');
+        GatewayFactory::replace($gateways);
+
+        $this->assertSame($gateways, GatewayFactory::all());
+    }
+
+    public function testRegister()
+    {
+        GatewayFactory::register('Bar');
+
+        $this->assertSame(array('Bar'), GatewayFactory::all());
+    }
+
+    public function testCreateShortName()
+    {
+        m::mock('alias:Omnipay\\SpareChange\\BankGateway');
+
+        $gateway = GatewayFactory::create('SpareChange_Bank');
+        $this->assertInstanceOf('\\Omnipay\\SpareChange\\BankGateway', $gateway);
+    }
+
+    public function testCreateFullyQualified()
+    {
+        m::mock('alias:Omnipay\\Tests\\FooGateway');
+
+        $gateway = GatewayFactory::create('\\Omnipay\\Tests\\FooGateway');
+        $this->assertInstanceOf('\\Omnipay\\Tests\\FooGateway', $gateway);
     }
 
     /**
@@ -20,11 +51,4 @@ public function testCreateInvalid()
     {
         $gateway = GatewayFactory::create('Invalid');
     }
-
-    public function testFind()
-    {
-        $gateways = GatewayFactory::find();
-        $this->assertContains('PayPal_Express', $gateways);
-        $this->assertContains('Stripe', $gateways);
-    }
 }