refactoring

config.template.yaml

@@ -1,9 +1,9 @@
 databases:
   connections:
-    - dsn: "sqlite::memory:"
+    - db: ":memory:"
       name: database1
       engine: sqlite
-    - dsn: "sqlite::memory:"
+    - db: ":memory:"
       name: database2
       engine: sqlite
 

src/BaseModuleInterface.php

@@ -26,9 +26,4 @@ public function getConfigTreeBuilder();
      * Load the settings of the module
      */
     public function loadConfig(array $config);
-
-    /**
-     * @return array
-     */
-    public function getConfig();
 }

src/Config.php

@@ -2,7 +2,9 @@
 
 namespace DBChecker;
 
-use DBChecker\DBAL\AbstractDBAL;
+use DBChecker\InputModules\AbstractDBAL;
+use DBChecker\InputModules\InputModuleManager;
+use DBChecker\modules\DataBase\DatabasesModule;
 use DBChecker\modules\ModuleManager;
 use Symfony\Component\Yaml\Yaml;
 
@@ -15,6 +17,8 @@ public function __construct($yamlPath)
         $settings = Yaml::parseFile($yamlPath);
 
         $this->moduleManager = new ModuleManager();
+
+        $this->moduleManager->loadModule(new InputModuleManager(), $settings);
         foreach (ModuleManager::ENABLED_MODULES as $module)
         {
             $this->moduleManager->loadModule(new $module(), $settings);
@@ -29,7 +33,7 @@ public function getModuleWorkers()
         yield from $this->moduleManager->getWorkers();
     }
 
-    public function getDBALs() : array
+    public function getDBALs() : \Generator
     {
         return $this->moduleManager->getDatabaseModule()->getDBALs();
     }

src/DBAL/AbstractDBAL.php → src/InputModules/AbstractDBAL.php

@@ -1,9 +1,8 @@
 <?php
 
-namespace DBChecker\DBAL;
+namespace DBChecker\InputModules;
 
 use BadMethodCallException;
-use DBChecker\DBQueries\AbstractDbQueries;
 
 abstract class AbstractDBAL implements
     \DBChecker\modules\MissingCompressionDetect\DBQueriesInterface,

src/DBQueries/AbstractDbQueries.php → src/InputModules/AbstractDbQueries.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace DBChecker\DBQueries;
+namespace DBChecker\InputModules;
 
 abstract class  AbstractDbQueries
 {

src/InputModules/InputModuleInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace DBChecker\InputModules;
+
+interface InputModuleInterface extends \DBChecker\BaseModuleInterface
+{
+    public function getDbal() : AbstractDBAL;
+}

src/InputModules/InputModuleManager.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace DBChecker\InputModules;
+
+use DBChecker\BaseModuleInterface;
+use DBChecker\InputModules\MySQL\MySQLModule;
+use DBChecker\InputModules\SQLite\SQLiteModule;
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+class InputModuleManager implements BaseModuleInterface
+{
+    private $modules = [];
+
+    public function getName()
+    {
+        return 'databases';
+    }
+
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $treeBuilder->root($this->getName())
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->arrayNode('connections')
+                ->requiresAtLeastOneElement()
+                ->arrayPrototype()
+                    ->ignoreExtraKeys(false)
+                    ->children()
+                        ->enumNode('engine')
+                            ->values(['mysql', 'sqlite'])
+                            ->isRequired()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end();
+        return $treeBuilder;
+    }
+
+    private function findEngineModule($engineName) : BaseModuleInterface
+    {
+        foreach ([MySQLModule::class, SQLiteModule::class] as $engineModule)
+        {
+            /** @var BaseModuleInterface $module */
+            $module = new $engineModule();
+            if ($module->getName() === $engineName)
+            {
+                return $module;
+            }
+        }
+        throw new \InvalidArgumentException("Unknown module $engineName");
+    }
+
+    public function loadConfig(array $config)
+    {
+        foreach ($config['connections'] as $cnx)
+        {
+            $module = $this->findEngineModule($cnx['engine']);
+            unset($cnx['engine']);
+            $module->loadConfig($cnx);
+            $this->modules[] = $module;
+        }
+    }
+
+    public function getDBALs()
+    {
+        foreach ($this->modules as $module)
+        {
+            yield $module->getDbal();
+        }
+    }
+}

src/DBAL/MySQLDBAL.php → src/InputModules/MySQL/MySQLDBAL.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace DBChecker\DBAL;
+namespace DBChecker\InputModules\MySQL;
 
-use DBChecker\DBQueries\MySQLQueries;
+use DBChecker\InputModules\AbstractDBAL;
 
 /**
  * @property MySQLQueries $queries

src/InputModules/MySQL/MySQLModule.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace DBChecker\InputModules\MySQL;
+
+use DBChecker\InputModules\AbstractDBAL;
+use DBChecker\InputModules\InputModuleInterface;
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+class MySQLModule implements InputModuleInterface
+{
+    private $dbal;
+
+    public function getName()
+    {
+        return "mysql";
+    }
+
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $treeBuilder->root($this->getName())
+            ->children()
+                ->scalarNode('name')
+                    ->info('A name to use instead of the db name in the output')
+                    ->defaultNull()
+                ->end()
+                ->scalarNode('db')->info('The database name')->end()
+                ->scalarNode('login')->defaultNull()->end()
+                ->scalarNode('password')->defaultNull()->end()
+                ->scalarNode('host')->defaultValue('localhost')->end()
+                ->integerNode('port')->end()
+            ->end();
+        return $treeBuilder;
+    }
+
+    public function loadConfig(array $config)
+    {
+        $dsn = "mysql:dbname={$config['db']};host={$config['host']};port={$config['port']}";
+        $pdo = new \PDO($dsn, $config['login'], $config['password']);
+        $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+
+        $queries = new MySQLQueries($pdo, $config['name'] ?? $config['db']);
+        $this->dbal = new MySQLDBAL($queries);
+    }
+
+    public function getDbal() : AbstractDBAL
+    {
+        return $this->dbal;
+    }
+}

src/DBQueries/MySQLQueries.php → src/InputModules/MySQL/MySQLQueries.php

@@ -1,9 +1,8 @@
 <?php
 
-namespace DBChecker\DBQueries;
+namespace DBChecker\InputModules\MySQL;
 
-use DBChecker\DBAL\AbstractDBAL;
-use DBChecker\DBAL\MySQLDBAL;
+use DBChecker\InputModules\AbstractDbQueries;
 
 class MySQLQueries extends AbstractDbQueries
 {

src/DBAL/SQLiteDBAL.php → src/InputModules/SQLite/SQLiteDBAL.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace DBChecker\DBAL;
+namespace DBChecker\InputModules\SQLite;
 
-use DBChecker\DBQueries\SQLiteQueries;
+use DBChecker\InputModules\AbstractDBAL;
 
 /**
  * @property SQLiteQueries $queries

src/InputModules/SQLite/SQLiteModule.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace DBChecker\InputModules\SQLite;
+
+use DBChecker\InputModules\AbstractDBAL;
+use DBChecker\InputModules\InputModuleInterface;
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+class SQLiteModule implements InputModuleInterface
+{
+    private $dbal;
+
+    public function getName()
+    {
+        return "sqlite";
+    }
+
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $treeBuilder->root($this->getName())
+            ->children()
+                ->scalarNode('name')
+                    ->info('A name to use instead of the db name in the output')
+                    ->defaultNull()
+                ->end()
+            ->end();
+        return $treeBuilder;
+    }
+
+    public function loadConfig(array $config)
+    {
+        $pdo = new \PDO("sqlite:{$config['db']}");
+        $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+
+        $queries = new SQLiteQueries($pdo, $config['name'] ?? $config['db']);
+        $this->dbal = new SQLiteDBAL($queries);
+    }
+
+    public function getDbal() : AbstractDBAL
+    {
+        return $this->dbal;
+    }
+}

src/DBQueries/SQLiteQueries.php → src/InputModules/SQLite/SQLiteQueries.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace DBChecker\DBQueries;
+namespace DBChecker\InputModules\SQLite;
+
+use DBChecker\InputModules\AbstractDbQueries;
 
 class SQLiteQueries extends AbstractDbQueries
 {

src/ModuleWorkerInterface.php

@@ -2,7 +2,7 @@
 
 namespace DBChecker;
 
-use DBChecker\DBAL\AbstractDBAL;
+use DBChecker\InputModules\AbstractDBAL;
 
 interface ModuleWorkerInterface
 {

src/modules/AnalyzeTableCheck/AnalyzeTableCheck.php

@@ -2,7 +2,7 @@
 
 namespace DBChecker\modules\AnalyzeTableCheck;
 
-use DBChecker\DBAL\AbstractDBAL;
+use DBChecker\InputModules\AbstractDBAL;
 use DBChecker\ModuleWorkerInterface;
 
 class AnalyzeTableCheck implements ModuleWorkerInterface

src/modules/AnalyzeTableCheck/AnalyzeTableCheckModule.php

@@ -2,7 +2,6 @@
 
 namespace DBChecker\modules\AnalyzeTableCheck;
 
-use DBChecker\Config;
 use DBChecker\ModuleInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 
@@ -24,11 +23,6 @@ public function loadConfig(array $config)
     {
     }
 
-    public function getConfig()
-    {
-        return [];
-    }
-
     public function getWorker()
     {
         return new AnalyzeTableCheck();