legodion/lucid

Declare database migrations and factory definitions inside Laravel models.

This package's canonical repository appears to be gone and the package has been frozen as a result. Email us for help if needed.

1.0.11 2022-03-26 12:35 UTC

Requires

• doctrine/dbal: ^2.0|^3.0
• laravel/framework: ^7.0|^8.0|^9.0

MIT

• database
• migrations
• php
• factory
• laravel
• models
• eloquent
• definitions

README

This package allows you to declare database migrations and factory definitions inside of your Laravel models.

Running the lucid:migrate command will automatically apply any changes you've made inside your migration methods to the database via Doctrine DBAL. If using the HasNewFactory trait and definition method, it will use the returned array inside the definition method to seed with when using the -s option.

The lucid:migrate command will also run your file-based (traditional) Laravel migrations first, and then your model method migrations after. If you need your model-based migrations to run in a specific order, you may add a $migrationOrder property to your models with an integer value (default is 0).

Installation

Require this package via Composer:

composer require legodion/lucid

Usage

Use the HasNewFactory trait, and declare migration and definition methods in your models:

use Faker\Generator;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Schema\Blueprint;
use Legodion\Lucid\Traits\HasNewFactory;

class MyModel extends Model
{
    use HasNewFactory;

    protected $guarded = [];
    protected $migrationOrder = 1; // optional

    public function migration(Blueprint $table)
    {
        $table->id();
        $table->string('name');
        $table->timestamp('created_at')->nullable();
        $table->timestamp('updated_at')->nullable();
    }

    public function definition(Generator $faker)
    {
        return [
            'name' => $faker->name(),
            'created_at' => $faker->dateTimeThisMonth(),
        ];
    }
}

Commands

Migrating

Apply the changes inside your migration methods to your database:

php artisan lucid:migrate {--f|--fresh} {--s|--seed}

Use the -f option for fresh migrations, and/or the -s option to run seeders afterwards.

Making Models

Create a model containing the migration and definition methods:

php artisan lucid:model {name} {--r|--resource}

Use the -r option to create a Laravel Nova resource for the model at the same time.

Making Nova Resources

Create a Laravel Nova resource without all the comments:

php artisan lucid:resource {name} {--m|--model}

Use the -m option to create a model for the Nova resource at the same time.