feat: create console commands

Author: calebdw

.gitignore

@@ -2,6 +2,7 @@
 coverage/
 vendor/
 workbench/vendor
+workbench/storage/
 .phpunit.result.cache
 .pint.cache
 composer.lock

README.md

@@ -303,6 +303,24 @@ SqlEntity::withoutEntities(
 
 After the callback, all affected entities are automatically recreated in dependency order.
 
+### 💻 Console Commands
+
+The package provides console commands to create and drop your SQL entities.
+
+```bash
+php artisan sql-entities:create [entities] [--connection=CONNECTION ...]
+
+# Create all entities
+php artisan sql-entities:create
+# Create a specific entity
+php artisan sql-entities:create 'Database\Entities\Views\RecentOrdersView'
+# Create all entities on a specific connection
+php artisan sql-entities:create -c reporting
+
+# Similarly, drop all entities
+php artisan sql-entities:drop
+```
+
 ### 🚀 Automatic syncing when migrating (Optional)
 
 You may want to automatically drop all SQL entities before migrating, and then

composer.json

@@ -37,6 +37,7 @@
   },
   "require": {
     "php": "^8.4",
+    "illuminate/console": "^11.0 || ^12.0",
     "illuminate/contracts": "^11.0 || ^12.0",
     "illuminate/database": "^11.0 || ^12.0",
     "illuminate/support": "^11.0 || ^12.0"

phpstan.neon.dist

@@ -4,5 +4,5 @@ parameters:
   level: 8
   paths:
     - src
-    - workbench/app
-    - workbench/database
+    # - workbench/app
+    # - workbench/database

src/Console/Commands/CreateCommand.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CalebDW\SqlEntities\Console\Commands;
+
+use CalebDW\SqlEntities\SqlEntityManager;
+use Illuminate\Console\Command;
+use Override;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+
+#[AsCommand('sql-entities:create', 'Create SQL entities.')]
+class CreateCommand extends Command
+{
+    public function __invoke(SqlEntityManager $manager): int
+    {
+        $connections = $this->option('connection');
+        $entities    = $this->argument('entities');
+
+        /** @phpstan-ignore argument.type */
+        $manager->createAll($entities, $connections);
+
+        return self::SUCCESS;
+    }
+
+    /** @return array<mixed> */
+    #[Override]
+    protected function getArguments(): array
+    {
+        return [
+            new InputArgument(
+                'entities',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'The entities to create.',
+                null,
+            ),
+        ];
+    }
+
+    /** @return array<mixed> */
+    #[Override]
+    protected function getOptions(): array
+    {
+        return [
+            new InputOption(
+                'connection',
+                'c',
+                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                'The connection(s) to use.',
+            ),
+        ];
+    }
+}

src/Console/Commands/DropCommand.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CalebDW\SqlEntities\Console\Commands;
+
+use CalebDW\SqlEntities\SqlEntityManager;
+use Illuminate\Console\Command;
+use Override;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+
+#[AsCommand('sql-entities:drop', 'Drop SQL entities.')]
+class DropCommand extends Command
+{
+    public function __invoke(SqlEntityManager $manager): int
+    {
+        $connections = $this->option('connection');
+        $entities    = $this->argument('entities');
+
+        /** @phpstan-ignore argument.type */
+        $manager->dropAll($entities, $connections);
+
+        return self::SUCCESS;
+    }
+
+    /** @return array<mixed> */
+    #[Override]
+    protected function getArguments(): array
+    {
+        return [
+            new InputArgument(
+                'entities',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'The entities to create.',
+                null,
+            ),
+        ];
+    }
+
+    /** @return array<mixed> */
+    #[Override]
+    protected function getOptions(): array
+    {
+        return [
+            new InputOption(
+                'connection',
+                'c',
+                InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY,
+                'The connection(s) to use.',
+            ),
+        ];
+    }
+}

src/ServiceProvider.php

@@ -4,25 +4,19 @@
 
 namespace CalebDW\SqlEntities;
 
+use CalebDW\SqlEntities\Console\Commands\CreateCommand;
+use CalebDW\SqlEntities\Console\Commands\DropCommand;
 use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Support\Composer;
 use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Contracts\Support\DeferrableProvider;
 use Illuminate\Support\Collection;
 use Illuminate\Support\ServiceProvider as IlluminateServiceProvider;
 use Override;
 use ReflectionClass;
 use Symfony\Component\Finder\Finder;
 
-class ServiceProvider extends IlluminateServiceProvider implements DeferrableProvider
+class ServiceProvider extends IlluminateServiceProvider
 {
-    /** @return list<string> */
-    #[Override]
-    public function provides(): array
-    {
-        return [SqlEntityManager::class, 'sql-entities']; // @codeCoverageIgnore
-    }
-
     #[Override]
     public function register(): void
     {
@@ -37,6 +31,16 @@ public function register(): void
         $this->app->alias(SqlEntityManager::class, 'sql-entities');
     }
 
+    public function boot(): void
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                CreateCommand::class,
+                DropCommand::class,
+            ]);
+        }
+    }
+
     /** @return Collection<int, SqlEntity> */
     protected function getEntities(Application $app): Collection
     {

testbench.yaml

@@ -1,4 +1,4 @@
 ---
+laravel: ./workbench
 providers:
   - CalebDW\SqlEntities\ServiceProvider
-laravel: ./workbench

tests/Feature/Commands/CreateCommandTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\SqlEntityManager;
+
+beforeEach(function () {
+    test()->manager = test()->mock(SqlEntityManager::class);
+});
+
+it('can create entities', function () {
+    test()->manager
+        ->shouldReceive('createAll')
+        ->once()
+        ->with(null, null);
+
+    test()->artisan('sql-entities:create')
+        ->assertExitCode(0);
+});

tests/Feature/Commands/DropCommandTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use CalebDW\SqlEntities\SqlEntityManager;
+
+beforeEach(function () {
+    test()->manager = test()->mock(SqlEntityManager::class);
+});
+
+it('can drop entities', function () {
+    test()->manager
+        ->shouldReceive('dropAll')
+        ->once()
+        ->with(null, null);
+
+    test()->artisan('sql-entities:drop')
+        ->assertExitCode(0);
+});

tests/TestCase.php

@@ -4,22 +4,10 @@
 
 namespace CalebDW\SqlEntities\Tests;
 
-use Illuminate\Foundation\Testing\RefreshDatabase;
 use Orchestra\Testbench\Concerns\WithWorkbench;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
-use function Orchestra\Testbench\workbench_path;
-
 abstract class TestCase extends OrchestraTestCase
 {
-    use RefreshDatabase;
     use WithWorkbench;
-
-    /** @inheritDoc */
-    protected function defineDatabaseMigrations(): void
-    {
-        $this->loadMigrationsFrom(
-            workbench_path('database/migrations'),
-        );
-    }
 }