ORM Eloquent: Factory

Quando vamos realizar testes na aplicação, persistimos alguns registros para validações mais simples, tarefa árdua pois precisamos simular dados fictícios para inserir na aplicação.

Há serviços on-line onde podemos baixar esses dados em formato json, mas mesmo esses facilitadores apresentam limitações no schema, resultando em mais trabalho para adequar o schema ao contexto do projeto.

Felizmente, o ORM Eloquent disponível no Laravel possui uma classe com métodos para geração de diversos tipos de dados fictícios, onde a grande vantagem é poder utilizar os modelos da própria aplicação para persistir as informações.

Estou me referindo à classe abstrata Illuminate\Database\Eloquent\Factories\Factory.

Ao longo deste artigo vou mostrar alguns métodos para criação de informações fictícias para cada modelo. Não haverá interação com a camada de persistência e todo o conteúdo deste artigo pode ser encontrado na documentação oficial aqui.

⚠️ É recomendável conhecimento prévio sobre Laravel.

Conteúdo

Este artigo está organizado de forma a facilitar a busca por informações. Se você quiser mais detalhes acerca do funcionamento da classe Factory, sugiro ler os itens 1 e 2.

Mas se você está buscando saber como gerar tipos específicos, então seu destino está entre os itens 3 e 8.

Boa leitura. 😄

1. Por onde começar
2. Gerando informações fictícias
3. Dados pessoais
4. Endereço
5. Texto
6. Números
7. Data e hora
8. Outros

Por onde começar

A maneira mais prática de criar uma classe que estenda de \Eloquent\Factories\Factory é através do Artisan. Utilizando qualquer terminal, acesse o diretório raiz da aplicação e digite o seguinte comando:

php artisan make:factory <nome_da_factory>

Assim que o comando for executado um novo arquivo será criado no no diretório \database\factories\ com o conteúdo mostrado logo a seguir:

<?php

namespace Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

/**
 * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Model>
 */
class SampleFactory extends Factory
{
    /**
     * Define the model's default state.
     *
     * @return array<string, mixed>
     */
    public function definition()
    {
        return [
            //
        ];
    }
}

A classe que acabamos de criar possui apenas um método, chamado definition onde toda mágica acontece e como podemos ver na assinatura desse método o retorno é um array de string/valor, ou algo como 'propriedade' => 'valor'.

Embora a declaração do método indique que ele retornará o estado padrão do modelo esta classe é totalmente desacoplada do modelo (Illuminate\Database\Eloquent\Model) dentro de aplicações Laravel.

Há duas formas de retornarmos informações para o método definition. A primeira é utilizar a propriedade protegida faker que extende de abastrata Eloquent\Factories\Factory ou através do helper fake().

A principal diferença é que no helper fake() podemos passar o dialeto ($locale) para geração das informações, aumentando a assertividade dos dados.

Abaixo está a assinatura do método fake().

/**
 * Get a faker instance.
 *
 * @param  ?string  $locale
 * @return \Faker\Generator
 */
function fake($locale = null)

Gerando informações fictícias

Para o mesmo tipo de dado o método fake() disponibiliza, quando disponível, duas formas de gerar informações.

A primeira é consultando diretamente uma propriedade.
Por exemplo, para criar nomes fictícios utilizamos o seguinte código:

fake()->name

E a segunda é chamando um método que retorna o nome, também fictício, conforme o código abaixo:

fake()->name()

A vantagem é no método name() é a existência do argumento opcional $gender que define o gênero do nome a ser criado.

A seguir vou listar vários tipos de dados que podem ser gerados, agrupando-os em categorias para facilitar a busca e utilização.

Dados pessoais

Este grupo de métodos retorna diversas informações pessoais, de nomes a números de telefone. A tabela a seguir traz o nome da propriedade e qual retorno fornecido.

Endereço

Esta categoria traz opções diversas opções para endereço como podemos ver na tabela a seguir.

Texto

"...Lorem ipsum em design gráfico e editoração é um texto padrão em latim utilizado na produção gráfica para preencher os espaços de texto em publicações...". Fonte: Wikipedia.

Esta categoria possibilita a geração de palavras únicas até parágrafos completos.

Mas, diferentemente das categorias anteriores onde os retornos são sempre strings, algumas propriedades desta categoria retornam array de strings.

Este comportamento pode ser evitado utilizando o método correspondente no lugar da propriedade.

Por exemplo, a propriedade fake()->words retornará um array com 3 strings diferentes, ao passo que o método fake()-words(3, true) também retornar 3 palavras mas em uma única string.

A tabela a seguir traz as propriedades com seus respectivos retornos e para cada propriedade há um método correspondente.

Números

Este grupo destina-se a geração de números fictícios, sejam inteiros ou reais. Vamos à tabela com os métodos e os respectivos retornos.

⚠️ Suprimi o fake()-> para melhorar a visualização da tabela.

Data e hora

Esta categoria retorna informações de data e hora, fictícios.

Outros

Esta categoria traz propriedades bastante diversas e por isso, vou listar somente algumas.

Muita coisa não é mesmo?!

Espero ter ajudado.

Até breve. 😎