Bundles support

src/AntiMattr/MongoDB/Migrations/Configuration/ConfigurationBuilder.php

@@ -1,6 +1,5 @@
 <?php
-
-declare(strict_types=1);
+declare(strict_types = 1);
 
 /*
  * This file is part of the AntiMattr MongoDB Migrations Library, a library by Matthew Fitzgerald.
@@ -13,14 +12,16 @@
 
 namespace AntiMattr\MongoDB\Migrations\Configuration;
 
+use AntiMattr\MongoDB\Migrations\Configuration\Interfaces\ConfigurationBuilderInterface;
+use AntiMattr\MongoDB\Migrations\Configuration\Interfaces\ConfigurationInterface;
 use AntiMattr\MongoDB\Migrations\OutputWriter;
 use Doctrine\MongoDB\Connection;
 use Symfony\Component\Yaml\Yaml;
 
 /**
  * @author Douglas Reith <douglas@reith.com.au>
  */
-class ConfigurationBuilder
+class ConfigurationBuilder implements ConfigurationBuilderInterface
 {
     /**
      * @var \Doctrine\MongoDB\Connection
@@ -56,19 +57,19 @@ private function __construct()
     }
 
     /**
-     * @return ConfigurationBuilder
+     * @return ConfigurationBuilderInterface
      */
-    public static function create(): ConfigurationBuilder
+    public static function create(): ConfigurationBuilderInterface
     {
         return new static();
     }
 
     /**
      * @param Connection $connection
      *
-     * @return ConfigurationBuilder
+     * @return self
      */
-    public function setConnection(Connection $connection): ConfigurationBuilder
+    public function setConnection(Connection $connection): ConfigurationBuilderInterface
     {
         $this->connection = $connection;
 
@@ -78,9 +79,9 @@ public function setConnection(Connection $connection): ConfigurationBuilder
     /**
      * @param OutputWriter $outputWriter
      *
-     * @return ConfigurationBuilder
+     * @return self
      */
-    public function setOutputWriter(OutputWriter $outputWriter): ConfigurationBuilder
+    public function setOutputWriter(OutputWriter $outputWriter): ConfigurationBuilderInterface
     {
         $this->outputWriter = $outputWriter;
 
@@ -90,9 +91,9 @@ public function setOutputWriter(OutputWriter $outputWriter): ConfigurationBuilde
     /**
      * @param string|null $configFile
      *
-     * @return ConfigurationBuilder
+     * @return self
      */
-    public function setOnDiskConfiguration(?string $configFile = null): ConfigurationBuilder
+    public function setOnDiskConfiguration(?string $configFile = null): ConfigurationBuilderInterface
     {
         $this->configFile = $configFile;
 
@@ -135,18 +136,17 @@ public function setOnDiskConfiguration(?string $configFile = null): Configuratio
     }
 
     /**
-     * @return Configuration
+     * @return ConfigurationInterface
      */
-    public function build(): Configuration
+    public function build(): ConfigurationInterface
     {
-        $config = new Configuration($this->connection, $this->outputWriter);
+        $config = $this->createConfigurationInstance($this->connection, $this->outputWriter);
 
         $config->setName($this->configParams['name'])
-            ->setFile($this->configFile)
-            ->setMigrationsDatabaseName($this->configParams['database'])
-            ->setMigrationsCollectionName($this->configParams['collection_name'])
-            ->setMigrationsNamespace($this->configParams['migrations_namespace'])
-        ;
+               ->setFile($this->configFile)
+               ->setMigrationsDatabaseName($this->configParams['database'])
+               ->setMigrationsCollectionName($this->configParams['collection_name'])
+               ->setMigrationsNamespace($this->configParams['migrations_namespace']);
 
         if (!empty($this->configParams['migrations_directory'])) {
             $migrationsDirectory = $this->getDirectoryRelativeToFile(
@@ -155,7 +155,7 @@ public function build(): Configuration
             );
 
             $config->setMigrationsDirectory($migrationsDirectory)
-                ->registerMigrationsFromDirectory($migrationsDirectory);
+                   ->registerMigrationsFromDirectory($migrationsDirectory);
         }
 
         if (!empty($this->configParams['migrations_script_directory'])) {
@@ -188,27 +188,27 @@ private function loadXmlFile(string $configFile): array
         $configArr = [];
 
         if (isset($xml->name)) {
-            $configArr['name'] = (string) $xml->name;
+            $configArr['name'] = (string)$xml->name;
         }
 
         if (isset($xml->database['name'])) {
-            $configArr['database'] = (string) $xml->database['name'];
+            $configArr['database'] = (string)$xml->database['name'];
         }
 
         if (isset($xml->collection['name'])) {
-            $configArr['collection_name'] = (string) $xml->collection['name'];
+            $configArr['collection_name'] = (string)$xml->collection['name'];
         }
 
         if (isset($xml->{'migrations-namespace'})) {
-            $configArr['migrations_namespace'] = (string) $xml->{'migrations-namespace'};
+            $configArr['migrations_namespace'] = (string)$xml->{'migrations-namespace'};
         }
 
         if (isset($xml->{'migrations-directory'})) {
-            $configArr['migrations_directory'] = (string) $xml->{'migrations-directory'};
+            $configArr['migrations_directory'] = (string)$xml->{'migrations-directory'};
         }
 
         if (isset($xml->{'migrations-script-directory'})) {
-            $configArr['migrations_script_directory'] = (string) $xml->{'migrations-script-directory'};
+            $configArr['migrations_script_directory'] = (string)$xml->{'migrations-script-directory'};
         }
 
         if (isset($xml->migrations->migration)) {
@@ -245,4 +245,19 @@ protected function getDirectoryRelativeToFile(string $configFile, ?string $direc
 
         return $directory;
     }
+
+    /**
+     * Create configuration instance
+     *
+     * @param Connection   $connection
+     * @param OutputWriter $outputWriter
+     *
+     * @return ConfigurationInterface
+     */
+    protected function createConfigurationInstance(
+        Connection $connection,
+        OutputWriter $outputWriter
+    ): ConfigurationInterface {
+        return new Configuration($connection, $outputWriter);
+    }
 }

src/AntiMattr/MongoDB/Migrations/Configuration/Interfaces/ConfigurationBuilderInterface.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+
+
+namespace AntiMattr\MongoDB\Migrations\Configuration\Interfaces;
+
+use AntiMattr\MongoDB\Migrations\OutputWriter;
+use Doctrine\MongoDB\Connection;
+
+/**
+ * Interface ConfigurationBuilderInterface
+ * @package AntiMattr\MongoDB\Migrations\Configuration\Interfaces
+ * @author Watari <watari.mailbox@gmail.com>
+ */
+interface ConfigurationBuilderInterface
+{
+
+    /**
+     * @return ConfigurationBuilderInterface
+     */
+    public static function create(): ConfigurationBuilderInterface;
+
+    /**
+     * @param Connection $connection
+     *
+     * @return self
+     */
+    public function setConnection(Connection $connection): self;
+
+    /**
+     * @param OutputWriter $outputWriter
+     *
+     * @return self
+     */
+    public function setOutputWriter(OutputWriter $outputWriter): self;
+
+    /**
+     * @param string|null $configFile
+     *
+     * @return self
+     */
+    public function setOnDiskConfiguration(?string $configFile = null): self;
+
+    /**
+     * @return ConfigurationInterface
+     */
+    public function build(): ConfigurationInterface;
+}