Ability to set model connection (#680)

Author: jasonmccreary

src/Generators/MigrationGenerator.php

@@ -94,6 +94,16 @@ protected function populateStub(string $stub, Model $model): string
             $stub = $this->disableForeignKeyConstraints($stub);
         }
 
+        if ($model->usesCustomDatabaseConnection()) {
+            $property = str_replace(
+                ['{{ name }}', 'by the model.'],
+                [$model->databaseConnection(), 'by the migration.'],
+                $this->filesystem->stub('model.connection.stub')
+            );
+
+            $stub = Str::replaceFirst('{', '{' . PHP_EOL . $property, $stub);
+        }
+
         return $stub;
     }
 

src/Generators/ModelGenerator.php

@@ -171,6 +171,10 @@ protected function buildProperties(Model $model): string
     {
         $properties = [];
 
+        if ($model->usesCustomDatabaseConnection()) {
+            $properties[] = str_replace('{{ name }}', $model->databaseConnection(), $this->filesystem->stub('model.connection.stub'));
+        }
+
         if ($model->usesCustomTableName() || $model->isPivot()) {
             $properties[] = str_replace('{{ name }}', $model->tableName(), $this->filesystem->stub('model.table.stub'));
         }

src/Lexers/ModelLexer.php

@@ -132,6 +132,10 @@ private function buildModel(string $name, array $columns): Model
         $model = new Model($name);
 
         if (isset($columns['meta']) && is_array($columns['meta'])) {
+            if (isset($columns['meta']['connection'])) {
+                $model->setDatabaseConnection($columns['meta']['connection']);
+            }
+
             if (isset($columns['meta']['table'])) {
                 $model->setTableName($columns['meta']['table']);
             }

src/Models/Model.php

@@ -19,6 +19,8 @@ class Model implements BlueprintModel
 
     private string|bool $softDeletes = false;
 
+    private ?string $connection;
+
     private string $table;
 
     private array $columns = [];
@@ -124,6 +126,21 @@ public function setPivot(): void
         $this->pivot = true;
     }
 
+    public function usesCustomDatabaseConnection(): bool
+    {
+        return isset($this->connection);
+    }
+
+    public function databaseConnection(): ?string
+    {
+        return $this->connection;
+    }
+
+    public function setDatabaseConnection(string $connection)
+    {
+        $this->connection = $connection;
+    }
+
     public function usesCustomTableName(): bool
     {
         return isset($this->table);

stubs/model.connection.stub

@@ -0,0 +1,6 @@
+    /**
+     * The database connection that should be used by the model.
+     *
+     * @var string
+     */
+    protected $connection = '{{ name }}';

tests/Feature/Generators/MigrationGeneratorTest.php

@@ -54,6 +54,12 @@ public function output_generates_migrations($definition, $path, $model): void
             ->with('migration.stub')
             ->andReturn($this->stub('migration.stub'));
 
+        if ($definition === 'drafts/model-with-meta.yaml') {
+            $this->filesystem->expects('stub')
+                ->with('model.connection.stub')
+                ->andReturn($this->stub('model.connection.stub'));
+        }
+
         $now = Carbon::now();
         Carbon::setTestNow($now);
 

tests/Feature/Generators/ModelGeneratorTest.php

@@ -60,6 +60,10 @@ public function output_generates_models($definition, $path, $model): void
         }
 
         if ($definition === 'drafts/model-with-meta.yaml') {
+            $this->filesystem->expects('stub')
+                ->with('model.connection.stub')
+                ->andReturn($this->stub('model.connection.stub'));
+
             $this->filesystem->expects('stub')
                 ->with('model.table.stub')
                 ->andReturn($this->stub('model.table.stub'));

tests/fixtures/drafts/model-with-meta.yaml

@@ -1,6 +1,7 @@
 models:
   Post:
     meta:
+      connection: read-only
       pivot: true
       table: post
     title: string:400

tests/fixtures/migrations/model-with-meta.php

@@ -6,6 +6,13 @@
 
 return new class extends Migration
 {
+    /**
+     * The database connection that should be used by the migration.
+     *
+     * @var string
+     */
+    protected $connection = 'read-only';
+
     /**
      * Run the migrations.
      */

tests/fixtures/models/model-with-meta.php

@@ -9,6 +9,13 @@ class Post extends Pivot
 {
     use HasFactory;
 
+    /**
+     * The database connection that should be used by the model.
+     *
+     * @var string
+     */
+    protected $connection = 'read-only';
+
     /**
      * The table associated with the model.
      *