first

Author: jdion84

composer.json

@@ -0,0 +1,36 @@
+{
+    "name": "jdion84/lucid",
+    "description": "Declare database schemas inside Laravel models.",
+    "keywords": [
+        "lucid",
+        "database",
+        "schemas",
+        "laravel",
+        "models"
+    ],
+    "license": "MIT",
+    "support": {
+        "source": "https://github.com/jdion84/lucid"
+    },
+    "authors": [
+        {
+            "name": "Kevin Dion",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "doctrine/dbal": "^3.7"
+    },
+    "autoload": {
+        "psr-4": {
+            "Jdion84\\Lucid\\": "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Jdion84\\Lucid\\LucidServiceProvider"
+            ]
+        }
+    }
+}

license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Kevin Dion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

readme.md

@@ -0,0 +1,63 @@
+# Lucid
+
+Declare database schemas inside Laravel models.
+
+## Installation
+
+Require this package via composer:
+
+```console
+composer require jdion84/lucid
+```
+
+## Usage
+
+Create a new model class with a schema method:
+
+```console
+php artisan make:schema Post
+```
+
+Or, add a schema method to an existing model:
+
+```php
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Jdion84\Lucid\Table;
+
+class Post extends Model
+{
+    use HasFactory;
+
+    public function schema(Table $table)
+    {
+        $table->id();
+        $table->string('title')->index();
+        $table->text('body');
+        $table->timestamp('created_at');
+        $table->timestamp('updated_at');
+    }
+}
+```
+
+Migrate & sync model schema methods with the database:
+
+```console
+php artisan migrate:schemas
+```
+
+## Commands
+
+Create a new model class with a schema method:
+
+```console
+php artisan make:schema {name} {--p|pivot} {--force}
+```
+
+Migrate & sync model schema methods with the database:
+
+```console
+migrate:schemas {--f|fresh} {--s|seed} {--force}
+```

src/Console/MakeSchemaCommand.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Jdion84\Lucid\Console;
+
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+class MakeSchemaCommand extends GeneratorCommand
+{
+    protected $name = 'make:schema';
+
+    protected $description = 'Create a new model class with a schema method';
+
+    protected $type = 'Model';
+
+    public function handle()
+    {
+        if (parent::handle() === false && !$this->option('force')) {
+            return false;
+        }
+
+        if ($this->argument('name') == 'User') {
+            $this->backupUserMigration();
+        }
+
+        if (!$this->option('pivot')) {
+            $this->createFactory();
+        }
+    }
+
+    protected function backupUserMigration()
+    {
+        $file = database_path('migrations/2014_10_12_000000_create_users_table.php');
+
+        if (file_exists($file)) {
+            rename($file, "$file.bak");
+        }
+    }
+
+    protected function createFactory()
+    {
+        $this->call('make:factory', [
+            'name' => "{$this->argument('name')}Factory",
+        ]);
+    }
+
+    protected function getStub()
+    {
+        if ($this->argument('name') == 'User') {
+            return __DIR__ . '/../../stubs/User.php';
+        }
+
+        if ($this->option('pivot')) {
+            return __DIR__ . '/../../stubs/Pivot.php';
+        }
+
+        return __DIR__ . '/../../stubs/Model.php';
+    }
+
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace . '\\Models';
+    }
+
+    protected function getOptions()
+    {
+        return [
+            ['pivot', 'p', InputOption::VALUE_NONE, 'Indicates if the generated model should be a pivot'],
+            ['force', null, InputOption::VALUE_NONE, 'Create the class even if the model already exists'],
+        ];
+    }
+}

src/Console/MigrateSchemasCommand.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace Jdion84\Lucid\Console;
+
+use Illuminate\Console\Command;
+use Illuminate\Console\ConfirmableTrait;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\Pivot;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Schema\Builder;
+use Illuminate\Support\Str;
+use Jdion84\Lucid\Table;
+use Symfony\Component\Finder\Finder;
+
+class MigrateSchemasCommand extends Command
+{
+    use ConfirmableTrait;
+
+    protected $signature = 'migrate:schemas {--f|fresh} {--s|seed} {--force}';
+
+    protected $description = 'Migrate & sync model schema methods with the database';
+
+    public function handle()
+    {
+        if (!$this->confirmToProceed()) {
+            return 1;
+        }
+
+        $this->migrate();
+
+        $this->syncModelSchemaMethods();
+
+        if ($this->option('seed')) {
+            $this->seed();
+        }
+
+        return 0;
+    }
+
+    protected function migrate()
+    {
+        $command = $this->option('fresh')
+            ? 'migrate:fresh'
+            : 'migrate';
+
+        $this->call($command, [
+            '--force' => true,
+        ]);
+    }
+
+    protected function syncModelSchemaMethods()
+    {
+        $this->components->info('Syncing model schema methods.');
+
+        $path = app_path('Models');
+
+        $namespace = app()->getNamespace();
+
+        foreach ((new Finder)->in($path)->files() as $file) {
+            $model = $namespace . str_replace(
+                ['/', '.php'],
+                ['\\', ''],
+                Str::after($file->getRealPath(), realpath(app_path()) . DIRECTORY_SEPARATOR)
+            );
+
+            if (method_exists($model, 'schema')) {
+                $this->syncModelSchemaMethod(app($model));
+            }
+        }
+
+        $this->newLine();
+    }
+
+    protected function syncModelSchemaMethod(Model|Pivot $model)
+    {
+        $builder = $model->getConnection()->getSchemaBuilder();
+
+        $temporaryTable = $this->createTemporaryTable($model, $builder);
+
+        if (!$builder->hasTable($model->getTable())) {
+            $this->createTable($model, $builder, $temporaryTable);
+        } else {
+            $this->updateTable($model, $builder, $temporaryTable);
+        }
+    }
+
+    protected function createTemporaryTable(Model|Pivot $model, Builder $builder)
+    {
+        $temporaryTable = "{$model->getTable()}_table";
+
+        $builder->dropIfExists($temporaryTable);
+
+        $builder->create($temporaryTable, function (Blueprint $table) use ($model) {
+            $model->schema(new Table($table));
+        });
+
+        return $temporaryTable;
+    }
+
+    protected function createTable(Model|Pivot $model, Builder $builder, $temporaryTable)
+    {
+        $this->components->task(
+            "Creating {$model->getTable()} table",
+            function () use ($builder, $temporaryTable, $model) {
+                $builder->rename($temporaryTable, $model->getTable());
+            }
+        );
+    }
+
+    protected function updateTable(Model|Pivot $model, Builder $builder, $temporaryTable)
+    {
+        $manager = $model->getConnection()->getDoctrineSchemaManager();
+
+        $tableDifference = $manager->createComparator()->compareTables(
+            $manager->introspectTable($model->getTable()),
+            $manager->introspectTable($temporaryTable),
+        );
+
+        if (!$tableDifference->isEmpty()) {
+            $this->components->task(
+                "Updating {$model->getTable()} table",
+                function () use ($manager, $tableDifference) {
+                    $manager->alterTable($tableDifference);
+                }
+            );
+        }
+
+        $builder->drop($temporaryTable);
+    }
+
+    protected function seed()
+    {
+        $this->call('db:seed', [
+            '--force' => true,
+        ]);
+    }
+}

src/LucidServiceProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Jdion84\Lucid;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\ServiceProvider;
+use Jdion84\Lucid\Console\MakeSchemaCommand;
+use Jdion84\Lucid\Console\MigrateSchemasCommand;
+
+class LucidServiceProvider extends ServiceProvider
+{
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                MakeSchemaCommand::class,
+                MigrateSchemasCommand::class,
+            ]);
+        }
+
+        Model::unguard();
+    }
+}