Refactor the getConnection into a chainloader

doctrine · Jan 17, 2016 · 7de41d0 · 7de41d0
1 parent 12da9b8
commit 7de41d0
Show file tree

Hide file tree

Showing 6 changed files with 287 additions and 22 deletions.
diff --git a/lib/Doctrine/DBAL/Migrations/Configuration/Connection/ConnectionLoaderInterface.php b/lib/Doctrine/DBAL/Migrations/Configuration/Connection/ConnectionLoaderInterface.php
@@ -0,0 +1,33 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Migrations\Configuration\Connection;
+
+
+use Doctrine\DBAL\Connection;
+
+interface ConnectionLoaderInterface
+{
+    /**
+     * read the input and return a Configuration, returns `false` if the config
+     * is not supported
+     * @return Connection|null
+     */
+    public function chosen();
+}
diff --git a/...ne/DBAL/Migrations/Configuration/Connection/Loader/ArrayConnectionConfigurationLoader.php b/...ne/DBAL/Migrations/Configuration/Connection/Loader/ArrayConnectionConfigurationLoader.php
@@ -0,0 +1,58 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Migrations\Configuration\Connection\Loader;
+
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DriverManager;
+use Doctrine\DBAL\Migrations\Configuration\Connection\ConnectionLoaderInterface;
+
+class ArrayConnectionConfigurationLoader implements ConnectionLoaderInterface
+{
+    private $filename;
+
+    public function __construct($filename)
+    {
+        $this->filename = $filename;
+    }
+
+    /**
+     * read the input and return a Configuration, returns `false` if the config
+     * is not supported
+     * @return Connection|null
+     */
+    public function chosen()
+    {
+        if (empty($this->filename)) {
+            return null;
+        }
+
+        if (!file_exists($this->filename)) {
+            return null;
+        }
+
+        $params = include $this->filename;
+        if (!is_array($params)) {
+            throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
+        }
+
+        return DriverManager::getConnection($params);
+    }
+}
diff --git a/...ne/DBAL/Migrations/Configuration/Connection/Loader/ConnectionConfigurationChainLoader.php b/...ne/DBAL/Migrations/Configuration/Connection/Loader/ConnectionConfigurationChainLoader.php
@@ -0,0 +1,52 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Migrations\Configuration\Connection\Loader;
+
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Migrations\Configuration\Connection\ConnectionLoaderInterface;
+
+final class ConnectionConfigurationChainLoader implements ConnectionLoaderInterface
+{
+    /** @var  ConnectionLoaderInterface[] */
+    private $loaders;
+
+
+    public function __construct(array $loaders)
+    {
+        $this->loaders = $loaders;
+    }
+
+    /**
+     * read the input and return a Configuration, returns `false` if the config
+     * is not supported
+     * @return Connection|null
+     */
+    public function chosen()
+    {
+        foreach($this->loaders as $loader) {
+            if (null !== $confObj = $loader->chosen()) {
+                return $confObj;
+            }
+        }
+
+        return null;
+    }
+}
diff --git a/...octrine/DBAL/Migrations/Configuration/Connection/Loader/ConnectionConfigurationLoader.php b/...octrine/DBAL/Migrations/Configuration/Connection/Loader/ConnectionConfigurationLoader.php
@@ -0,0 +1,54 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Migrations\Configuration\Connection\Loader;
+
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DriverManager;
+use Doctrine\DBAL\Migrations\Configuration\Configuration;
+use Doctrine\DBAL\Migrations\Configuration\Connection\ConnectionLoaderInterface;
+
+class ConnectionConfigurationLoader implements ConnectionLoaderInterface
+{
+    /** @var Configuration */
+    private $configuration;
+
+    public function __construct(Configuration $configuration=null)
+    {
+        if ($configuration !== null) {
+            $this->configuration = $configuration;
+        }
+    }
+
+    /**
+     * read the input and return a Configuration, returns `false` if the config
+     * is not supported
+     * @return Connection|null
+     */
+    public function chosen()
+    {
+        if ($this->configuration) {
+
+            return $this->configuration->getConnection();
+        }
+
+        return null;
+    }
+}
diff --git a/lib/Doctrine/DBAL/Migrations/Configuration/Connection/Loader/ConnectionHelperLoader.php b/lib/Doctrine/DBAL/Migrations/Configuration/Connection/Loader/ConnectionHelperLoader.php
@@ -0,0 +1,70 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\DBAL\Migrations\Configuration\Connection\Loader;
+
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Migrations\Configuration\Connection\ConnectionLoaderInterface;
+use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
+use Symfony\Component\Console\Helper\HelperSet;
+
+class ConnectionHelperLoader implements ConnectionLoaderInterface
+{
+    /**
+     * @var string
+     */
+    private $helperName;
+
+    /** @var  HelperSet */
+    private $helperSet;
+
+
+    /**
+     * ConnectionHelperLoader constructor.
+     * @param HelperSet $helperSet
+     * @param string $helperName
+     */
+    public function __construct(HelperSet $helperSet = null, $helperName)
+    {
+        $this->helperName = $helperName;
+        if ($helperSet === null) {
+            $helperSet = new HelperSet();
+        }
+        $this->helperSet = $helperSet;
+    }
+
+    /**
+     * read the input and return a Configuration, returns `false` if the config
+     * is not supported
+     * @return Connection|null
+     */
+    public function chosen()
+    {
+        if ($this->helperSet->has($this->helperName)) {
+            $connectionHelper = $this->helperSet->get($this->helperName);
+            if ($connectionHelper instanceof ConnectionHelper) {
+
+                return $connectionHelper->getConnection();
+            }
+        }
+
+        return null;
+    }
+}
diff --git a/lib/Doctrine/DBAL/Migrations/Tools/Console/Command/AbstractCommand.php b/lib/Doctrine/DBAL/Migrations/Tools/Console/Command/AbstractCommand.php
@@ -21,6 +21,10 @@
 
 use Doctrine\DBAL\DriverManager;
 use Doctrine\DBAL\Migrations\Configuration\Configuration;
+use Doctrine\DBAL\Migrations\Configuration\Connection\Loader\ArrayConnectionConfigurationLoader;
+use Doctrine\DBAL\Migrations\Configuration\Connection\Loader\ConnectionConfigurationLoader;
+use Doctrine\DBAL\Migrations\Configuration\Connection\Loader\ConnectionHelperLoader;
+use Doctrine\DBAL\Migrations\Configuration\Connection\Loader\ConnectionConfigurationChainLoader;
 use Doctrine\DBAL\Migrations\OutputWriter;
 use Doctrine\DBAL\Migrations\Tools\Console\Helper\ConfigurationHelper;
 use Symfony\Component\Console\Command\Command;
@@ -156,29 +160,23 @@ private function getOutputWriter(OutputInterface $output)
     private function getConnection(InputInterface $input)
     {
         if (!$this->connection) {
-            if ($input->getOption('db-configuration')) {
-                if (!file_exists($input->getOption('db-configuration'))) {
-                    throw new \InvalidArgumentException("The specified connection file is not a valid file.");
-                }
-
-                $params = include $input->getOption('db-configuration');
-                if (!is_array($params)) {
-                    throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
-                }
-                $this->connection = DriverManager::getConnection($params);
-            } elseif (file_exists('migrations-db.php')) {
-                $params = include 'migrations-db.php';
-                if (!is_array($params)) {
-                    throw new \InvalidArgumentException('The connection file has to return an array with database configuration parameters.');
-                }
-                $this->connection = DriverManager::getConnection($params);
-            } elseif ($this->getHelperSet()->has('connection')) {
-                $this->connection = $this->getHelper('connection')->getConnection();
-            } elseif ($this->configuration) {
-                $this->connection = $this->configuration->getConnection();
-            } else {
-                throw new \InvalidArgumentException('You have to specify a --db-configuration file or pass a Database Connection as a dependency to the Migrations.');
+            $chainLoader = new ConnectionConfigurationChainLoader(
+                [
+                    new ArrayConnectionConfigurationLoader($input->getOption('db-configuration')),
+                    new ArrayConnectionConfigurationLoader('migrations-db.php'),
+                    new ConnectionHelperLoader($this->getHelperSet(), 'connection'),
+                    new ConnectionConfigurationLoader($this->configuration),
+                ]
+            );
+            $connection = $chainLoader->chosen();
+
+            if ($connection) {
+                $this->connection = $connection;
+
+                return $this->connection;
             }
+
+            throw new \InvalidArgumentException('You have to specify a --db-configuration file or pass a Database Connection as a dependency to the Migrations.');
         }
 
         return $this->connection;