Configurable adapter factory

composer.json

@@ -8,7 +8,7 @@
         "php": "^8.4",
         "ext-json": "*",
         "ext-pdo": "*",
-        "symfony/console": "^8.0",
+        "symfony/console": "^7.4 || ^8.0",
         "symfony/finder": "^7.0"
     },
     "require-dev": {

docs/configuration/index.md

@@ -11,6 +11,7 @@ Configuration array can consist of five parts:
 - `dependencies` - array - list of dependencies which can be used in __construct of Migration classes. Key is type of dependency (class or interface name which will be used in __construct) and value is object of this type
 - `template` - string - path to template file for migrations (used in create, dump and diff commands)
 - `indent` - string - indentation in created migrations. Available values: 2spaces, 3spaces, 4spaces, 5spaces, tab [default: 4spaces]
+- `adapter_factory_class` - string - fully qualified class name of a custom adapter factory. The class must implement `Phoenix\Database\Adapter\AdapterFactoryInterface`. This allows adding custom database adapters. [default: `Phoenix\Database\Adapter\AdapterFactory`]
 
 ### Example
 Let's say you want to create configuration file, where `log_table_name` is "my_phoenix_log", you have two `migration_dirs` (first and second, which are located in the same directory as configuration file), also two `environments` both uses mysql adapter, and your `default_environment` is "local". Now we show you, how this config looks like using different type of configuration files:

src/Command/AbstractCommand.php

@@ -7,7 +7,6 @@
 use InvalidArgumentException;
 use Phoenix\Config\Config;
 use Phoenix\Config\Parser\ConfigParserFactory;
-use Phoenix\Database\Adapter\AdapterFactory;
 use Phoenix\Database\Adapter\AdapterInterface;
 use Phoenix\Exception\ConfigException;
 use Phoenix\Exception\DatabaseQueryExecuteException;
@@ -69,7 +68,8 @@ final public function execute(InputInterface $input, OutputInterface $output): i
         if (!$environmentConfig) {
             throw new InvalidArgumentException('Environment ' . $environment . ' doesn\'t exist');
         }
-        $this->adapter = AdapterFactory::instance($environmentConfig);
+        $adapterFactoryClass = $this->getConfig()->getAdapterFactoryClass();
+        $this->adapter = $adapterFactoryClass::instance($environmentConfig);
 
         $this->manager = new Manager($this->getConfig(), $this->adapter);
         $this->check();

src/Command/DiffCommand.php

@@ -4,7 +4,6 @@
 
 namespace Phoenix\Command;
 
-use Phoenix\Database\Adapter\AdapterFactory;
 use Phoenix\Database\Element\Structure;
 use Phoenix\Dumper\Dumper;
 use Phoenix\Exception\InvalidArgumentValueException;
@@ -66,7 +65,8 @@ private function getStructure(string $type): Structure
             throw new InvalidArgumentValueException(ucfirst($type) . ' environment "' . $env . '" doesn\'t exist in config');
         }
 
-        $adapter = AdapterFactory::instance($config);
+        $adapterFactoryClass = $this->getConfig()->getAdapterFactoryClass();
+        $adapter = $adapterFactoryClass::instance($config);
         return $adapter->getStructure();
     }
 

src/Config/Config.php

@@ -4,6 +4,8 @@
 
 namespace Phoenix\Config;
 
+use Phoenix\Database\Adapter\AdapterFactory;
+use Phoenix\Database\Adapter\AdapterFactoryInterface;
 use Phoenix\Exception\ConfigException;
 use Phoenix\Exception\InvalidArgumentValueException;
 
@@ -20,6 +22,7 @@
         'dependencies' => [],
         'template' => __DIR__ . '/../Templates/DefaultTemplate.phoenix',
         'indent' => '4spaces',
+        'adapter_factory_class' => AdapterFactory::class,
     ];
 
     /**
@@ -111,4 +114,17 @@
     {
         return $this->configuration['indent'];
     }
+
+    /**
+     * @return class-string<AdapterFactoryInterface>
+     * @throws InvalidArgumentValueException
+     */
+    public function getAdapterFactoryClass(): string
+    {
+        $class = $this->configuration['adapter_factory_class'];
+        if (!is_subclass_of($class, AdapterFactoryInterface::class)) {
+            throw new InvalidArgumentValueException('Adapter factory class "' . $class . '" must implement ' . AdapterFactoryInterface::class);
+        }
+        return $class;
+    }
 }

src/Database/Adapter/AdapterFactory.php

@@ -8,7 +8,7 @@
 use Phoenix\Config\EnvironmentConfig;
 use Phoenix\Exception\InvalidArgumentValueException;
 
-final class AdapterFactory
+final class AdapterFactory implements AdapterFactoryInterface
 {
     public static function instance(EnvironmentConfig $config): AdapterInterface
     {

src/Database/Adapter/AdapterFactoryInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phoenix\Database\Adapter;
+
+use Phoenix\Config\EnvironmentConfig;
+
+interface AdapterFactoryInterface
+{
+    public static function instance(EnvironmentConfig $config): AdapterInterface;
+}

tests/Config/ConfigTest.php

@@ -6,8 +6,10 @@
 
 use Phoenix\Config\Config;
 use Phoenix\Config\EnvironmentConfig;
+use Phoenix\Database\Adapter\AdapterFactory;
 use Phoenix\Exception\ConfigException;
 use Phoenix\Exception\InvalidArgumentValueException;
+use Phoenix\Tests\Mock\Database\Adapter\MockAdapterFactory;
 use PHPUnit\Framework\TestCase;
 use Ramsey\Uuid\UuidFactory;
 use Ramsey\Uuid\UuidFactoryInterface;
@@ -191,4 +193,50 @@ public function testDependencies(): void
         $this->expectExceptionMessage('Dependency for type "Ramsey\Uuid\UuidFactory" not found. Register it via $configuration[\'dependencies\'][\'Ramsey\Uuid\UuidFactory\']');
         $config->getDependency(UuidFactory::class);
     }
+
+    public function testDefaultAdapterFactoryClass(): void
+    {
+        $config = new Config([
+            'migration_dirs' => [
+                'first_dir',
+            ],
+            'environments' => [
+                'first' => [],
+            ],
+        ]);
+
+        $this->assertEquals(AdapterFactory::class, $config->getAdapterFactoryClass());
+    }
+
+    public function testInvalidAdapterFactoryClass(): void
+    {
+        $config = new Config([
+            'migration_dirs' => [
+                'first_dir',
+            ],
+            'environments' => [
+                'first' => [],
+            ],
+            'adapter_factory_class' => 'Invalid\NonExistent\Class',
+        ]);
+
+        $this->expectException(InvalidArgumentValueException::class);
+        $this->expectExceptionMessage('Adapter factory class "Invalid\NonExistent\Class" must implement Phoenix\Database\Adapter\AdapterFactoryInterface');
+        $config->getAdapterFactoryClass();
+    }
+
+    public function testCustomAdapterFactoryClass(): void
+    {
+        $config = new Config([
+            'migration_dirs' => [
+                'first_dir',
+            ],
+            'environments' => [
+                'first' => [],
+            ],
+            'adapter_factory_class' => MockAdapterFactory::class,
+        ]);
+
+        $this->assertEquals(MockAdapterFactory::class, $config->getAdapterFactoryClass());
+    }
 }

tests/Mock/Database/Adapter/MockAdapterFactory.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phoenix\Tests\Mock\Database\Adapter;
+
+use Phoenix\Config\EnvironmentConfig;
+use Phoenix\Database\Adapter\AdapterFactoryInterface;
+use Phoenix\Database\Adapter\AdapterInterface;
+
+final class MockAdapterFactory implements AdapterFactoryInterface
+{
+    public static function instance(EnvironmentConfig $config): AdapterInterface
+    {
+        throw new \RuntimeException('Mock adapter factory should not be instantiated in tests');
+    }
+}