Respect configured namespaces for blueprint import (#470)

* feat: use configured namespaces for import of blueprints

* chore: add namespaces to docs

* feat: add tests

* fix: better names

Author: macaws

README.md

@@ -150,6 +150,22 @@ By default, the Eloquent Driver stores all data in a single `data` column. Howev
 
 6. And that's it! Statamic will now read and write data to the new columns in the `entries` table, rather than the `data` column.
 
+### Selecting specific blueprint types for Eloquent
+
+By default, setting the driver for blueprints to `eloquent` will apply to *all* blueprints. However, if you only wish to move certain groups of blueprint over, you can do so by setting an array of namespaces, such as:
+
+```php
+// config/statamic/eloquent-driver.php
+
+'blueprints' => [
+    'driver' => 'eloquent',
+    'model' => \Statamic\Eloquent\Fields\BlueprintModel::class,
+    'namespaces' => ['forms', 'navigation'],
+],
+```
+
+The above example will set all forms and navigation blueprints to use eloquent, while keeping the rest as files.
+
 ## Upgrading
 
 After updating to a new version of the Eloquent Driver, please ensure you run `php artisan migrate` to update your database to the latest schema.

src/Commands/ImportBlueprints.php

@@ -25,7 +25,8 @@ class ImportBlueprints extends Command
     protected $signature = 'statamic:eloquent:import-blueprints
         {--force : Force the import to run, with all prompts answered "yes"}
         {--only-blueprints : Only import blueprints}
-        {--only-fieldsets : Only import fieldsets}';
+        {--only-fieldsets : Only import fieldsets}
+        {--all-blueprints : Import all blueprints, regardless of configured namespaces}';
 
     /**
      * The console command description.
@@ -79,6 +80,10 @@ private function importBlueprints(): void
                 Str::after(Str::before($path, '.yaml'), $directory.'/')
             );
 
+            if (! $this->shouldImportBlueprint($namespace)) {
+                return;
+            }
+
             $contents = YAML::file($path)->parse();
             // Ensure sections are ordered correctly.
             if (isset($contents['tabs']) && is_array($contents['tabs'])) {
@@ -173,6 +178,16 @@ private function getNamespaceAndHandle(string $blueprint): array
         return [$namespace, $handle];
     }
 
+    private function shouldImportBlueprint($namespace = null): bool
+    {
+        $eloquentNamespaces = config('statamic.eloquent-driver.blueprints.namespaces', 'all');
+        if ($this->option('all-blueprints') || $eloquentNamespaces === 'all') {
+            return true;
+        }
+
+        return in_array($namespace, $eloquentNamespaces);
+    }
+
     private function shouldImportBlueprints(): bool
     {
         return $this->option('only-blueprints')

tests/Commands/ImportBlueprintsTest.php

@@ -106,6 +106,64 @@ public function it_imports_blueprints_with_console_question()
         $this->assertCount(0, FieldsetModel::all());
     }
 
+    #[Test]
+    public function it_imports_only_the_configured_namespaces()
+    {
+        config()->set('statamic.eloquent-driver.blueprints.namespaces', ['forms']);
+
+        BlueprintFacade::make('contact')->setNamespace('forms')->setContents([
+            'fields' => [
+                ['handle' => 'name', 'field' => ['type' => 'text']],
+                ['handle' => 'email', 'field' => ['type' => 'text'], 'validate' => 'required'],
+            ],
+        ])->save();
+
+        BlueprintFacade::make('images')->setNamespace('assets')->setContents([
+            'fields' => [
+                ['handle' => 'title', 'field' => ['type' => 'text']],
+                ['handle' => 'email', 'field' => ['type' => 'text'], 'validate' => 'required'],
+            ],
+        ])->save();
+
+        $this->artisan('statamic:eloquent:import-blueprints')
+            ->expectsQuestion('Do you want to import blueprints?', true)
+            ->expectsQuestion('Do you want to import fieldsets?', false)
+            ->expectsOutputToContain('Blueprints imported successfully.')
+            ->assertExitCode(0);
+
+        $this->assertCount(1, BlueprintModel::query()->where('namespace', 'forms')->get());
+        $this->assertCount(0, BlueprintModel::query()->where('namespace', 'assets')->get());
+    }
+
+    #[Test]
+    public function it_imports_everything_when_all_namespaces_flag_is_passed()
+    {
+        config()->set('statamic.eloquent-driver.blueprints.namespaces', ['forms']);
+
+        BlueprintFacade::make('contact')->setNamespace('forms')->setContents([
+            'fields' => [
+                ['handle' => 'name', 'field' => ['type' => 'text']],
+                ['handle' => 'email', 'field' => ['type' => 'text'], 'validate' => 'required'],
+            ],
+        ])->save();
+
+        BlueprintFacade::make('images')->setNamespace('assets')->setContents([
+            'fields' => [
+                ['handle' => 'title', 'field' => ['type' => 'text']],
+                ['handle' => 'email', 'field' => ['type' => 'text'], 'validate' => 'required'],
+            ],
+        ])->save();
+
+        $this->artisan('statamic:eloquent:import-blueprints', ['--all-blueprints' => true])
+            ->expectsQuestion('Do you want to import blueprints?', true)
+            ->expectsQuestion('Do you want to import fieldsets?', false)
+            ->expectsOutputToContain('Blueprints imported successfully.')
+            ->assertExitCode(0);
+
+        $this->assertCount(1, BlueprintModel::query()->where('namespace', 'forms')->get());
+        $this->assertCount(1, BlueprintModel::query()->where('namespace', 'assets')->get());
+    }
+
     #[Test]
     public function it_imports_fieldsets_with_console_question()
     {