Merge pull request #594 from wayofdev/feat/updates

Author: lotyp

composer.json

@@ -25,7 +25,7 @@
         "cycle/schema-migrations-generator": "^2.2",
         "cycle/schema-renderer": "^1.2",
         "illuminate/console": "^10.45",
-        "cycle/schema-builder": "^2.8.0",
+        "cycle/schema-builder": "^2.8",
         "illuminate/contracts": "^10.45",
         "illuminate/support": "^10.45",
         "laminas/laminas-hydrator": "^4.15",

composer.lock

@@ -218,6 +218,8 @@
                 Schema\Generator\RenderModifiers::class,
                 // Add @Table column declarations
                 Annotated\MergeIndexes::class,
+                // Add foreign keys
+                Schema\Generator\ForeignKeys::class,
             ],
             GeneratorLoader::GROUP_POSTPROCESS => [
                 // Typecast non string columns

config/cycle.php

@@ -44,7 +44,7 @@ protected function verifyEnvironment(?string $confirmationQuestion = null): bool
             return true;
         }
 
-        $this->line($confirmationQuestion, 'fg=red');
+        $this->error($confirmationQuestion);
 
         if (! $this->askConfirmation()) {
             $this->comment('Cancelling operation...');

src/Bridge/Laravel/Console/Commands/Migrations/AbstractCommand.php

@@ -48,7 +48,7 @@ public function handle(
 
         foreach ($this->migrator->getMigrations() as $migration) {
             if ($migration->getState()->getStatus() !== State::STATUS_EXECUTED) {
-                if ($this->isInteractive() && $this->output->confirm('Outstanding migrations found. Do you want to run `cycle:migrate` now?')) {
+                if ($this->isForced() || ($this->isInteractive() && $this->output->confirm('Outstanding migrations found. Do you want to run `cycle:migrate` now?'))) {
                     $this->call(DatabaseMigrateCommand::class, ['--force' => true]);
                 } else {
                     $this->warn('Outstanding migrations found, run `cycle:migrate` first.');

src/Bridge/Laravel/Console/Commands/ORM/MigrateCommand.php

@@ -14,6 +14,7 @@
 use Cycle\ORM\ORM;
 use Cycle\ORM\ORMInterface;
 use Cycle\ORM\SchemaInterface;
+use Cycle\ORM\Transaction\CommandGeneratorInterface;
 use Illuminate\Contracts\Foundation\Application;
 use WayOfDev\Cycle\Bridge\Laravel\Factories\SpiralFactory;
 use WayOfDev\Cycle\Schema\Config\SchemaConfig;
@@ -39,13 +40,16 @@ public function __invoke(Application $app): void
             );
         });
 
-        $app->singleton(ORMInterface::class, function (Application $app): ORMInterface {
-            $commandGenerator = null;
-            $loadEntityBehavior = config('cycle.entityBehavior.register', true);
+        if ($this->shouldLoadEntityBehavior() === true) {
+            $app->bind(CommandGeneratorInterface::class, function (Application $app): CommandGeneratorInterface {
+                return new EventDrivenCommandGenerator($app->get(SchemaInterface::class), $app);
+            });
+        }
 
-            if (true === $loadEntityBehavior) {
-                $commandGenerator = new EventDrivenCommandGenerator($app->get(SchemaInterface::class), $app);
-            }
+        $app->singleton(ORMInterface::class, function (Application $app): ORMInterface {
+            $commandGenerator = $this->shouldLoadEntityBehavior()
+                ? $app->get(CommandGeneratorInterface::class)
+                : null;
 
             return new ORM(
                 factory: $app->get(FactoryInterface::class),
@@ -60,4 +64,9 @@ public function __invoke(Application $app): void
             );
         });
     }
+
+    private function shouldLoadEntityBehavior(): bool
+    {
+        return config('cycle.entityBehavior.register', true);
+    }
 }

src/Bridge/Laravel/Providers/Registrators/RegisterORM.php

@@ -30,7 +30,7 @@ class User
     public ?User $friend = null;
 
     #[HasMany(target: User::class, outerKey: 'userId', nullable: true)]
-    public iterable|null $friends = [];
+    public ?iterable $friends = [];
 
     #[HasMany(target: User::class, outerKey: 'userId', nullable: true, collection: 'array')]
     public ?array $friendsAsArray = [];

tests/app/Entities/User.php

@@ -13,13 +13,33 @@ class MigrateCommandTest extends TestCase
     /**
      * @test
      */
-    public function it_runs_handle(): void
+    public function it_migrates_in_safe_environment(): void
     {
         /** @var Database $database */
         $database = $this->app->make(DatabaseInterface::class);
 
         $this::assertSame([], $database->getTables());
 
+        $this->artisanCall('cycle:migrate:init');
+        $this->artisanCall('cycle:orm:migrate');
+
+        // @phpstan-ignore-next-line
+        $this::assertCount(1, $database->getTables());
+    }
+
+    /**
+     * @test
+     */
+    public function it_migrates_in_production_with_force_option(): void
+    {
+        // Set the application environment to production
+        config()->set('cycle.migrations.safe', false);
+
+        /** @var Database $database */
+        $database = $this->app->make(DatabaseInterface::class);
+
+        $this::assertSame([], $database->getTables());
+
         $this->artisanCall('cycle:migrate:init');
         $this->artisanCall('cycle:orm:migrate', ['--force' => true]);
 
@@ -29,4 +49,22 @@ public function it_runs_handle(): void
         $this->artisanCall('cycle:migrate', ['--force' => true]);
         $this::assertCount(4, $database->getTables());
     }
+
+    /**
+     * @test
+     */
+    public function it_warns_about_unsafe_migrations(): void
+    {
+        // Set the application environment to production
+        config()->set('cycle.migrations.safe', false);
+
+        $this->artisanCall('cycle:migrate:init');
+
+        // Simulate running the command and answering 'no' to the confirmation question
+        $this->artisan('cycle:migrate')
+            ->expectsOutput('Confirmation is required to run migrations!')
+            ->expectsQuestion('Would you like to continue?', false)
+            ->expectsOutput('Cancelling operation...')
+            ->assertFailed();
+    }
 }

tests/src/Bridge/Laravel/Console/Commands/Migrations/MigrateCommandTest.php

@@ -4,7 +4,11 @@
 
 namespace WayOfDev\Tests\Bridge\Laravel\Console\Commands\ORM;
 
+use Cycle\ORM\SchemaInterface;
 use Illuminate\Support\Facades\File;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
+use WayOfDev\Cycle\Contracts\CacheManager;
 use WayOfDev\Tests\TestCase;
 
 use function file_put_contents;
@@ -36,7 +40,10 @@ protected function setUp(): void
     public function it_runs_migrate(): void
     {
         $this->assertConsoleCommandOutputContainsStrings('cycle:orm:migrate', ['-n' => true], self::USER_MIGRATION);
-        $this->assertConsoleCommandOutputContainsStrings('cycle:orm:migrate', ['-n' => true], 'Outstanding migrations found');
+
+        $this->assertConsoleCommandOutputContainsStrings('cycle:orm:migrate', ['-n' => true], [
+            'Outstanding migrations found',
+        ]);
     }
 
     /**
@@ -89,4 +96,25 @@ class Tag
 
         File::delete($entity);
     }
+
+    /**
+     * @test
+     *
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    public function it_passes_schema_defaults_to_compiler(): void
+    {
+        config()->set('cycle.schema.defaults', [
+            SchemaInterface::TYPECAST_HANDLER => ['foo'],
+        ]);
+
+        $this->artisanCall('cycle:orm:migrate', ['-n' => true]);
+        $this->artisanCall('cycle:migrate', ['--force' => true]);
+        $this->artisanCall('cycle:orm:migrate', ['-n' => true]);
+
+        $cacheManager = $this->app->get(CacheManager::class);
+
+        $this::assertSame(['foo'], $cacheManager->get()['role'][SchemaInterface::TYPECAST_HANDLER]);
+    }
 }

tests/src/Bridge/Laravel/Console/Commands/ORM/MigrateCommandTest.php

@@ -49,4 +49,29 @@ public function it_runs_handle_in_debug_mode(): void
 
         $this::assertSame(1, $u->id);
     }
+
+    /**
+     * @test
+     */
+    public function it_fails_in_production_without_force(): void
+    {
+        // Set the application environment to production
+        config()->set('cycle.migrations.safe', false);
+
+        $warningOutput = 'This operation is not recommended for production environment.';
+        $confirmationQuestion = 'Would you like to continue?';
+
+        // Simulate running the command and answering 'no' to the confirmation question
+        $this->artisan('cycle:orm:sync')
+            ->expectsOutput($warningOutput)
+            ->expectsQuestion($confirmationQuestion, false)
+            ->expectsOutput('Cancelling operation...')
+            ->assertFailed();
+
+        // To test the affirmative path, simulate answering 'yes'
+        $this->artisan('cycle:orm:sync')
+            ->expectsOutput($warningOutput)
+            ->expectsQuestion($confirmationQuestion, 'yes')
+            ->assertSuccessful();
+    }
 }