command structure

README.md

@@ -74,17 +74,19 @@ DROP TABLE IF EXISTS public.entity;
 
 ```php
 use DI\Container;
-use kuaukutsu\poc\migration\Migration;
-use kuaukutsu\poc\migration\MigrationCollection;
 use kuaukutsu\poc\migration\internal\connection\PDO\Driver;
 use kuaukutsu\poc\migration\example\presentation\DownCommand;
+use kuaukutsu\poc\migration\example\presentation\CreateCommand;
 use kuaukutsu\poc\migration\example\presentation\FixtureCommand;
+use kuaukutsu\poc\migration\example\presentation\VerifyCommand;
 use kuaukutsu\poc\migration\example\presentation\InitCommand;
 use kuaukutsu\poc\migration\example\presentation\RedoCommand;
 use kuaukutsu\poc\migration\example\presentation\UpCommand;
+use kuaukutsu\poc\migration\tools\PrettyConsoleOutput;
+use kuaukutsu\poc\migration\Migration;
+use kuaukutsu\poc\migration\MigrationCollection;
 use kuaukutsu\poc\migration\Migrator;
 use kuaukutsu\poc\migration\MigratorInterface;
-use kuaukutsu\poc\migration\tools\PrettyConsoleOutput;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
@@ -120,7 +122,9 @@ $console->setCommandLoader(
             'migrate:up' => UpCommand::class,
             'migrate:down' => DownCommand::class,
             'migrate:redo' => RedoCommand::class,
+            'migrate:verify' => VerifyCommand::class,
             'migrate:fixture' => FixtureCommand::class,
+            'migrate:create' => CreateCommand::class,
         ],
     )
 );

example/mysql.php

@@ -4,7 +4,7 @@
 
 use kuaukutsu\poc\migration\internal\connection\PDO\Driver;
 use kuaukutsu\poc\migration\tools\PrettyConsoleOutput;
-use kuaukutsu\poc\migration\InputArgs;
+use kuaukutsu\poc\migration\InputOptions;
 use kuaukutsu\poc\migration\Migration;
 use kuaukutsu\poc\migration\MigrationCollection;
 use kuaukutsu\poc\migration\Migrator;
@@ -28,7 +28,7 @@
 );
 
 foreach (range(1, 1000) as $row) {
-    $migrator->create(new InputArgs(dbName: "mysql/main", migrationName: $row . "-test"));
+    $migrator->create(new InputOptions(dbName: "mysql/main", migrationName: $row . "-test"));
 }
 
 try {
@@ -38,7 +38,7 @@
 }
 
 try {
-    $migrator->up(new InputArgs(limit: 100));
+    $migrator->up(new InputOptions(limit: 100));
 } catch (Throwable $exception) {
     echo $exception->getMessage() . PHP_EOL;
 }

example/presentation/CommandOptions.php

@@ -6,14 +6,14 @@
 
 use InvalidArgumentException;
 use Symfony\Component\Console\Input\InputInterface;
-use kuaukutsu\poc\migration\InputArgs;
+use kuaukutsu\poc\migration\InputOptions;
 
 trait CommandOptions
 {
     /**
      * @throws InvalidArgumentException
      */
-    protected function getArguments(InputInterface $input): InputArgs
+    protected function getOptions(InputInterface $input): InputOptions
     {
         $options = [];
         if ($input->hasOption('limit')) {
@@ -44,7 +44,7 @@ protected function getArguments(InputInterface $input): InputArgs
             $options['migrationName'] = $this->getMigrationName($input);
         }
 
-        return new InputArgs(...$options);
+        return new InputOptions(...$options);
     }
 
     /**

example/presentation/CreateCommand.php

@@ -47,7 +47,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->create($this->getArguments($input));
+            $this->migrator->create($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             $output->writeln($e->getMessage());
             return Command::INVALID;

example/presentation/DownCommand.php

@@ -64,7 +64,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->down($this->getArguments($input));
+            $this->migrator->down($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             if ($e instanceof InitializationException) {
                 $output->writeln('Calling the command "migrate:init" may help fix the error.');

example/presentation/FixtureCommand.php

@@ -57,7 +57,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->fixture($this->getArguments($input));
+            $this->migrator->fixture($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             $output->writeln($e->getMessage());
             return Command::INVALID;

example/presentation/RedoCommand.php

@@ -64,7 +64,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->redo($this->getArguments($input));
+            $this->migrator->redo($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             if ($e instanceof InitializationException) {
                 $output->writeln('Calling the command "migrate:init" may help fix the error.');

example/presentation/UpCommand.php

@@ -72,7 +72,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->up($this->getArguments($input));
+            $this->migrator->up($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             if ($e instanceof InitializationException) {
                 $output->writeln('Calling the command "migrate:init" may help fix the error.');

example/presentation/VerifyCommand.php

@@ -58,7 +58,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         try {
-            $this->migrator->verify($this->getArguments($input));
+            $this->migrator->verify($this->getOptions($input));
         } catch (InvalidArgumentException | MigratorException $e) {
             if ($e instanceof InitializationException) {
                 $output->writeln('Calling the command "migrate:init" may help fix the error.');

src/Config.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace kuaukutsu\poc\migration;
+
+/**
+ * @api
+ */
+final readonly class Config
+{
+    /**
+     * @param non-empty-string $table
+     */
+    public function __construct(
+        public string $table = 'migration',
+        public template\FactoryInterface $templFactory = new template\Factory(),
+    ) {
+    }
+}

src/InputArgs.php → src/InputOptions.php

@@ -8,7 +8,7 @@
  * @api
  * @infection-ignore-all
  */
-final readonly class InputArgs
+final readonly class InputOptions
 {
     /**
      * @param non-negative-int $limit

src/Migration.php

@@ -4,10 +4,9 @@
 
 namespace kuaukutsu\poc\migration;
 
+use kuaukutsu\poc\migration\command\CommandInterface;
 use kuaukutsu\poc\migration\connection\DriverInterface;
 use kuaukutsu\poc\migration\exception\ConnectionException;
-use kuaukutsu\poc\migration\internal\command\CommandInterface;
-use kuaukutsu\poc\migration\internal\command\Params;
 
 /**
  * @api
@@ -21,15 +20,13 @@
 
     /**
      * @param non-empty-string $path
-     * @param non-empty-string $table
      */
     public function __construct(
         public string $path,
         private DriverInterface $driver,
-        public string $table = 'migration',
-        public template\FactoryInterface $templFactory = new template\Factory(),
+        public Config $config = new Config(),
     ) {
-        $this->name = $this->driver->getName() . '/' . $this->driver->getDbName();
+        $this->name = $this->driver->getName() . '/' . $this->driver->getSourceName();
     }
 
     /**
@@ -53,6 +50,6 @@ public function getSetupPath(): string
      */
     public function getCommand(): CommandInterface
     {
-        return $this->driver->makeCommand(new Params(table: $this->table));
+        return $this->driver->makeCommand($this->config);
     }
 }

src/Migrator.php

@@ -42,30 +42,58 @@ public function init(): void
     }
 
     #[Override]
-    public function up(InputArgs $args = new InputArgs()): void
+    public function create(InputOptions $args = new InputOptions()): void
+    {
+        if ($args->dbName === null) {
+            throw new ConfigurationException(
+                "DBName must be declared."
+            );
+        }
+
+        if ($args->migrationName === null) {
+            throw new ConfigurationException(
+                "Migration Name must be declared."
+            );
+        }
+
+        foreach ($this->selectDb($args) as $migration) {
+            $this->actionWorkflow->create($migration, $args->migrationName);
+        }
+    }
+
+    #[Override]
+    public function up(InputOptions $args = new InputOptions()): void
     {
         foreach ($this->selectDb($args) as $migration) {
             $this->actionWorkflow->up($migration, $args);
         }
     }
 
     #[Override]
-    public function down(InputArgs $args = new InputArgs()): void
+    public function down(InputOptions $args = new InputOptions()): void
     {
         foreach ($this->selectDb($args) as $migration) {
             $this->actionWorkflow->down($migration, $args);
         }
     }
 
     #[Override]
-    public function redo(InputArgs $args = new InputArgs()): void
+    public function fixture(InputOptions $args = new InputOptions()): void
+    {
+        foreach ($this->selectDb($args) as $migration) {
+            $this->actionWorkflow->fixture($migration, $args);
+        }
+    }
+
+    #[Override]
+    public function redo(InputOptions $args = new InputOptions()): void
     {
         $this->down($args);
         $this->up($args->withResetLimit());
     }
 
     #[Override]
-    public function verify(InputArgs $args = new InputArgs()): void
+    public function verify(InputOptions $args = new InputOptions()): void
     {
         foreach ($this->selectDb($args) as $migration) {
             $version = $this->actionWorkflow->up(
@@ -82,39 +110,11 @@ public function verify(InputArgs $args = new InputArgs()): void
         }
     }
 
-    #[Override]
-    public function fixture(InputArgs $args = new InputArgs()): void
-    {
-        foreach ($this->selectDb($args) as $migration) {
-            $this->actionWorkflow->fixture($migration, $args);
-        }
-    }
-
-    #[Override]
-    public function create(InputArgs $args = new InputArgs()): void
-    {
-        if ($args->dbName === null) {
-            throw new ConfigurationException(
-                "DBName must be declared."
-            );
-        }
-
-        if ($args->migrationName === null) {
-            throw new ConfigurationException(
-                "Migration Name must be declared."
-            );
-        }
-
-        foreach ($this->selectDb($args) as $migration) {
-            $this->actionWorkflow->create($migration, $args->migrationName);
-        }
-    }
-
     /**
      * @return iterable<Migration>
      * @throws ConfigurationException
      */
-    private function selectDb(InputArgs $args): iterable
+    private function selectDb(InputOptions $args): iterable
     {
         if ($args->dbName === null) {
             return $this->collection;

src/MigratorInterface.php

@@ -18,47 +18,47 @@ interface MigratorInterface
      */
     public function init(): void;
 
+    /**
+     * @throws ConfigurationException
+     */
+    public function create(InputOptions $args = new InputOptions()): void;
+
     /**
      * @throws ActionException
      * @throws ConfigurationException If the driver is not implemented
      * @throws ConnectionException
      * @throws InitializationException initialization step is required
      */
-    public function up(InputArgs $args = new InputArgs()): void;
+    public function up(InputOptions $args = new InputOptions()): void;
 
     /**
      * @throws ActionException
      * @throws ConfigurationException If the driver is not implemented
      * @throws ConnectionException
      * @throws InitializationException initialization step is required
      */
-    public function down(InputArgs $args = new InputArgs()): void;
+    public function down(InputOptions $args = new InputOptions()): void;
 
     /**
      * @throws ActionException
      * @throws ConfigurationException If the driver is not implemented
      * @throws ConnectionException
-     * @throws InitializationException initialization step is required
      */
-    public function redo(InputArgs $args = new InputArgs()): void;
+    public function fixture(InputOptions $args = new InputOptions()): void;
 
     /**
      * @throws ActionException
      * @throws ConfigurationException If the driver is not implemented
      * @throws ConnectionException
      * @throws InitializationException initialization step is required
      */
-    public function verify(InputArgs $args = new InputArgs()): void;
+    public function redo(InputOptions $args = new InputOptions()): void;
 
     /**
      * @throws ActionException
      * @throws ConfigurationException If the driver is not implemented
      * @throws ConnectionException
+     * @throws InitializationException initialization step is required
      */
-    public function fixture(InputArgs $args = new InputArgs()): void;
-
-    /**
-     * @throws ConfigurationException
-     */
-    public function create(InputArgs $args = new InputArgs()): void;
+    public function verify(InputOptions $args = new InputOptions()): void;
 }

src/internal/command/CommandInterface.php → src/command/CommandInterface.php

@@ -2,18 +2,17 @@
 
 declare(strict_types=1);
 
-namespace kuaukutsu\poc\migration\internal\command;
+namespace kuaukutsu\poc\migration\command;
 
 use Throwable;
-use kuaukutsu\poc\migration\internal\command;
 use kuaukutsu\poc\migration\Context;
 
 interface CommandInterface
 {
     /**
      * @return array<non-empty-string, non-negative-int>
      */
-    public function fetchApplied(command\Args $args = new command\Args()): array;
+    public function fetchApplied(Options $options = new Options()): array;
 
     /**
      * @return bool true: request completed; false: request rejected