-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract a factory for migration config/manager
Looks like we're going to need this in most migrations commands.
- Loading branch information
Showing
4 changed files
with
150 additions
and
157 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org) | ||
| * | ||
| * Licensed under The MIT License | ||
| * Redistributions of files must retain the above copyright notice. | ||
| * | ||
| * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org) | ||
| * @link https://cakephp.org CakePHP(tm) Project | ||
| * @license https://www.opensource.org/licenses/mit-license.php MIT License | ||
| */ | ||
| namespace Migrations\Migration; | ||
|
|
||
| use Cake\Console\ConsoleIo; | ||
| use Cake\Core\Plugin; | ||
| use Cake\Datasource\ConnectionManager; | ||
| use Cake\Utility\Inflector; | ||
| use Migrations\Config\Config; | ||
| use Migrations\Config\ConfigInterface; | ||
| use RuntimeException; | ||
|
|
||
| /** | ||
| * Factory for Config and Manager | ||
| * | ||
| * Used by Console commands. | ||
| * | ||
| * @internal | ||
| */ | ||
| class ManagerFactory | ||
| { | ||
| /** | ||
| * Constructor | ||
| * | ||
| * ## Options | ||
| * | ||
| * - source - The directory in app/config that migrations should be read from. | ||
| * - plugin - The plugin name that migrations are being run on. | ||
| * - connection - The connection name. | ||
| * - dry-run - Whether or not dry-run mode should be enabled. | ||
| * | ||
| * @param array $options The command line options for creating config/manager. | ||
| */ | ||
| public function __construct(protected array $options) | ||
| { | ||
| } | ||
|
|
||
| public function getOption(string $name): mixed | ||
| { | ||
| if (!isset($this->options[$name])) { | ||
| return null; | ||
| } | ||
|
|
||
| return $this->options[$name]; | ||
| } | ||
|
|
||
| public function createConfig(): ConfigInterface | ||
| { | ||
| $folder = (string)$this->getOption('source'); | ||
|
|
||
| // Get the filepath for migrations and seeds(not implemented yet) | ||
| $dir = ROOT . DS . 'config' . DS . $folder; | ||
| if (defined('CONFIG')) { | ||
| $dir = CONFIG . $folder; | ||
| } | ||
| $plugin = $this->getOption('plugin'); | ||
| if ($plugin && is_string($plugin)) { | ||
| $dir = Plugin::path($plugin) . 'config' . DS . $folder; | ||
| } | ||
|
|
||
| // Get the phinxlog table name. Plugins have separate migration history. | ||
| // The names and separate table history is something we could change in the future. | ||
| $table = 'phinxlog'; | ||
| if ($plugin && is_string($plugin)) { | ||
| $prefix = Inflector::underscore($plugin) . '_'; | ||
| $prefix = str_replace(['\\', '/', '.'], '_', $prefix); | ||
| $table = $prefix . $table; | ||
| } | ||
| $templatePath = dirname(__DIR__) . DS . 'templates' . DS; | ||
| $connectionName = (string)$this->getOption('connection'); | ||
|
|
||
| // TODO this all needs to go away. But first Environment and Manager need to work | ||
| // with Cake's ConnectionManager. | ||
| $connectionConfig = ConnectionManager::getConfig($connectionName); | ||
| if (!$connectionConfig) { | ||
| throw new RuntimeException("Could not find connection `{$connectionName}`"); | ||
| } | ||
|
|
||
| /** @var array<string, string> $connectionConfig */ | ||
| $adapter = $connectionConfig['scheme'] ?? null; | ||
| $adapterConfig = [ | ||
| 'adapter' => $adapter, | ||
| 'connection' => $connectionName, | ||
| 'database' => $connectionConfig['database'], | ||
| 'migration_table' => $table, | ||
| 'dryrun' => $this->getOption('dry-run'), | ||
| ]; | ||
|
|
||
| $configData = [ | ||
| 'paths' => [ | ||
| 'migrations' => $dir, | ||
| ], | ||
| 'templates' => [ | ||
| 'file' => $templatePath . 'Phinx/create.php.template', | ||
| ], | ||
| 'migration_base_class' => 'Migrations\AbstractMigration', | ||
| 'environment' => $adapterConfig, | ||
| // TODO do we want to support the DI container in migrations? | ||
| ]; | ||
|
|
||
| return new Config($configData); | ||
| } | ||
|
|
||
| /** | ||
| * Get the migration manager for the current CLI options and application configuration. | ||
| * | ||
| * @param \Cake\Console\ConsoleIo $io The command io. | ||
| * @param \Migrations\Config\ConfigInterface $config A config instance. Providing null will create a new Config | ||
| * based on the factory constructor options. | ||
| * @return \Migrations\Migration\Manager | ||
| */ | ||
| public function createManager(ConsoleIo $io, ConfigInterface|null $config = null): Manager | ||
| { | ||
| $config ??= $this->createConfig(); | ||
|
|
||
| return new Manager($config, $io); | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters