dbt/model-factory

10.0.1 2024-08-07 15:23 UTC

Requires

• php: ^8.1|^8.2
• fakerphp/faker: ^1.9.3
• illuminate/database: ^10.0
• illuminate/support: ^10.0
• laravel/legacy-factories: ^1.3

Requires (Dev)

• laravel/pint: ^1.17
• orchestra/testbench: ^8.0
• phpunit/phpunit: ^9.5
• rector/rector: ^1.2
• vimeo/psalm: ^4.0

MIT

README

Class-based Model Factories for Laravel

This package is alternative to keeping your model factories in plain PHP files.

Getting Started

Prerequisites

This package requires PHP 7.1.3 or higher, illuminate/support@^5.7, and illuminate/database@^5.7.

Installing

Via Composer:

composer require dbt/model-factory

Testing

Run:

composer test

Configuring

Publish the model-factory.php configuration file with php artisan vendor:publish command, or copy the file from this repository. The service provider should be auto-discovered by Laravel.

A model factory looks like this:

use Dbt\ModelFactory\ModelFactory;

class MyModelFactory extends ModelFactory
{
    protected $model = MyModel::class;

    /**
     * This is the main factory definition.
     * @return array
     */
    public function definition (): array
    {
        return [
            'my_string_column' => $this->faker->name,
        ];
    }

    /**
     * This will happen after the model is created.
     * @return void
     */
    public function after (MyModel $model): void
    {
        // Do some stuff to the model.
    }

    /**
     * This is a factory state.
     * @return array
     */
    public function myState (): array
    {
        return [
            'my_int_column' => rand(1, 10),
        ];
    }

     /**
      * This will happen after the model is created in the given state.
      * @return void
      */
     public function afterMyState (MyModel $model): void
     {
         // Do some stuff to the model.
     }
}

To register your model factory, include it in the config file:

'classes' => [
    // ...
    MyModelFactory::class,
];

Usage

With the factory(...) function

Your model factories will be registered with Laravel as usual, so they can be called with Laravel's global factory() function:

// Factory without state.
$model = factory(MyModel::class)->create();

// Factory with state.
$modelWithState = factory(MyModel::class)->states('myState')->create();

With the Create class

If you prefer a slightly more expressive way to create models for testing, try out the Create class:

$model = Create::a(new MyModel, new Count(10), new States('myState'), new Overrides(['column' => 'value'])); 

The method definition requires a model followed by variadic Params, in any order, and in any combination.

// Create a model with defaults.
$model = Create::a(new MyModel);

// The following are all equivalent:
Create::a(new MyModel, new Count(...), new States(...), new Overrides(...));
Create::a(new MyModel, new States(...), new Count(...), new Overrides(...));
Create::a(new MyModel, new States(...), new Overrides(...), new Count(...));

// Etc.

License

MIT. Do as you wish.