Merge pull request #58 from leepeuker/improve-cli-database-management

Improve cli database management

README.md

@@ -95,7 +95,7 @@ volumes:
 
 ## Important: First steps
 
-- Run database migrations: `docker exec movary php bin/console.php database:migration --migrate`
+- Run database migrations: `docker exec movary php bin/console.php database:migration:migrate`
 - Create a user: `docker exec movary php bin/console.php user:create [email protected] your-password`
 
 List all available cli commands: `docker exec movary php bin/console.php`

bin/console.php

@@ -6,7 +6,9 @@
 $application->add($container->get(Movary\Command\SyncTrakt::class));
 $application->add($container->get(Movary\Command\SyncTmdb::class));
 // $application->add($container->get(Movary\Command\SyncLetterboxd::class));
-$application->add($container->get(Movary\Command\DatabaseMigration::class));
+$application->add($container->get(Movary\Command\DatabaseMigrationStatus::class));
+$application->add($container->get(Movary\Command\DatabaseMigrationMigrate::class));
+$application->add($container->get(Movary\Command\DatabaseMigrationRollback::class));
 $application->add($container->get(Movary\Command\UserCreate::class));
 $application->add($container->get(Movary\Command\UserDelete::class));
 $application->add($container->get(Movary\Command\UserUpdate::class));

bootstrap.php

@@ -12,7 +12,9 @@
         \Movary\Api\Tmdb\Client::class => DI\factory([Factory::class, 'createTmdbApiClient']),
         \Movary\HttpController\SettingsController::class => DI\factory([Factory::class, 'createSettingsController']),
         \Movary\ValueObject\Http\Request::class => DI\factory([Factory::class, 'createCurrentHttpRequest']),
-        \Movary\Command\DatabaseMigration::class => DI\factory([Factory::class, 'createDatabaseMigrationCommand']),
+        \Movary\Command\DatabaseMigrationStatus::class => DI\factory([Factory::class, 'createDatabaseMigrationStatusCommand']),
+        \Movary\Command\DatabaseMigrationMigrate::class => DI\factory([Factory::class, 'createDatabaseMigrationMigrateCommand']),
+        \Movary\Command\DatabaseMigrationRollback::class => DI\factory([Factory::class, 'createDatabaseMigrationRollbackCommand']),
         \Psr\Http\Client\ClientInterface::class => DI\factory([Factory::class, 'createHttpClient']),
         \Psr\Log\LoggerInterface::class => DI\factory([Factory::class, 'createFileLogger']),
         \Doctrine\DBAL\Connection::class => DI\factory([Factory::class, 'createDbConnection']),

src/Command/DatabaseMigrationMigrate.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Command;
+
+use Phinx\Console\PhinxApplication;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DatabaseMigrationMigrate extends Command
+{
+    protected static $defaultName = 'database:migration:migrate';
+
+    public function __construct(
+        private readonly PhinxApplication $phinxApplication,
+        private readonly string $phinxConfigurationFile
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure() : void
+    {
+        $this->setDescription('Execute missing database migrations.');
+    }
+
+    // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
+    protected function execute(InputInterface $input, OutputInterface $output) : int
+    {
+        $command = $this->phinxApplication->find('migrate');
+
+        $arguments = [
+            'command' => $command,
+            '--configuration' => $this->phinxConfigurationFile,
+        ];
+
+        return $command->run(new ArrayInput($arguments), $output);
+    }
+}

src/Command/DatabaseMigrationRollback.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Command;
+
+use Phinx\Console\PhinxApplication;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DatabaseMigrationRollback extends Command
+{
+    protected static $defaultName = 'database:migration:rollback';
+
+    public function __construct(
+        private readonly PhinxApplication $phinxApplication,
+        private readonly string $phinxConfigurationFile
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure() : void
+    {
+        $this->setDescription('Rollback last database migration.');
+    }
+
+    // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
+    protected function execute(InputInterface $input, OutputInterface $output) : int
+    {
+        $command = $this->phinxApplication->find('rollback');
+
+        $arguments = [
+            'command' => $command,
+            '--configuration' => $this->phinxConfigurationFile,
+        ];
+
+        return $command->run(new ArrayInput($arguments), $output);
+    }
+}

src/Command/DatabaseMigrationStatus.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Movary\Command;
+
+use Phinx\Console\PhinxApplication;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class DatabaseMigrationStatus extends Command
+{
+    protected static $defaultName = 'database:migration:status';
+
+    public function __construct(
+        private readonly PhinxApplication $phinxApplication,
+        private readonly string $phinxConfigurationFile
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure() : void
+    {
+        $this->setDescription('Status of database migrations.');
+    }
+
+    // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
+    protected function execute(InputInterface $input, OutputInterface $output) : int
+    {
+        $command = $this->phinxApplication->find('status');
+
+        $arguments = [
+            'command' => $command,
+            '--configuration' => $this->phinxConfigurationFile,
+        ];
+
+        return $command->run(new ArrayInput($arguments), $output);
+    }
+}

src/Command/SyncTrakt.php

@@ -35,7 +35,7 @@ public function __construct(
 
     protected function configure() : void
     {
-        $this->setDescription('Sync trakt.tv movie history and rating with local database')
+        $this->setDescription('Sync trakt.tv movie history and rating with local database.')
              ->addOption(self::OPTION_NAME_USER_ID, [], InputOption::VALUE_REQUIRED, 'Id of user to sync to.')
              ->addOption(self::OPTION_NAME_HISTORY, [], InputOption::VALUE_NONE, 'Sync movie history.')
              ->addOption(self::OPTION_NAME_RATINGS, [], InputOption::VALUE_NONE, 'Sync movie ratings.')

src/Factory.php

@@ -40,9 +40,25 @@ public static function createCurrentHttpRequest() : Request
         return Request::createFromGlobals();
     }
 
-    public static function createDatabaseMigrationCommand(ContainerInterface $container) : Command\DatabaseMigration
+    public static function createDatabaseMigrationMigrateCommand(ContainerInterface $container) : Command\DatabaseMigrationMigrate
     {
-        return new Command\DatabaseMigration(
+        return new Command\DatabaseMigrationMigrate(
+            $container->get(PhinxApplication::class),
+            __DIR__ . '/../settings/phinx.php'
+        );
+    }
+
+    public static function createDatabaseMigrationRollbackCommand(ContainerInterface $container) : Command\DatabaseMigrationRollback
+    {
+        return new Command\DatabaseMigrationRollback(
+            $container->get(PhinxApplication::class),
+            __DIR__ . '/../settings/phinx.php'
+        );
+    }
+
+    public static function createDatabaseMigrationStatusCommand(ContainerInterface $container) : Command\DatabaseMigrationStatus
+    {
+        return new Command\DatabaseMigrationStatus(
             $container->get(PhinxApplication::class),
             __DIR__ . '/../settings/phinx.php'
         );