Skip to content

biellts/universidade-automatiza / .claude/skills/backend-criar-value-object

backend-criar-value-object

Verified

Cria um novo Value Object (VO) com factory estático, validação e igualdade estrutural. Use este skill quando solicitado a criar um novo Value Object, tipo de valor, VO ou campo validado do domínio como título, e-mail, nota, código etc.

FileKindSize
SKILL.mdskill md4.5 KB
---
name: backend-criar-value-object
description: Cria um novo Value Object (VO) com factory estático, validação e igualdade estrutural. Use este skill quando solicitado a criar um novo Value Object, tipo de valor, VO ou campo validado do domínio como título, e-mail, nota, código etc.
---

Para criar um novo Value Object (VO), siga o processo abaixo:

## 1. Localização

Crie o arquivo em:
```
src/apps/Automatiza.Modules.{Modulo}/Domain/Entities/{Entidade}/ValueObjects/{NomeDoVO}.cs
```
Namespace: `Automatiza.Modules.{Modulo}.Domain.Entities.{Entidade}` — `ValueObjects/` não entra no namespace. Os exemplos usam o módulo Catálogo.

`ValueObject` e `TextValueObject` estão em `Automatiza.SeedWork.DomainObjects.ValueObjects` (importe no arquivo do VO).

## 2. VO textual (herda de `TextValueObject`)

Use quando o VO é uma string com validação de obrigatoriedade, tamanho, padrão ou transformação. O `ErrorOrCreate` faz `Trim`, valida e gera os códigos `{ErrorPrefix}_VAZIO`, `_CURTO`, `_LONGO` e `_FORMATO_INVALIDO`. Real (`TituloTrilha`):

```csharp
using Automatiza.SeedWork.DomainObjects.ValueObjects;

namespace Automatiza.Modules.Catalogo.Domain.Entities.Trilha;

public class TituloTrilha : TextValueObject
{
    public const int TamanhoMinimo = 3;
    public const int TamanhoMaximo = 150;

    private TituloTrilha() { } // EF Core

    private TituloTrilha(string valor) : base(valor) { }

    public static Result<TituloTrilha> Criar(string? valor) =>
        ErrorOrCreate(valor, new Options
        {
            MinLength = TamanhoMinimo,
            MaxLength = TamanhoMaximo,
            ErrorPrefix = "TRILHA_TITULO",
            FieldName = "Título da trilha"
        }, texto => new TituloTrilha(texto));
}
```

`Options` também aceita `Required = false` (vazio vira sucesso com valor `default`), `Pattern`, `ToUpperCase`/`ToLowerCase`, `CustomTransform` e `CustomValidation` (que devolve `Result`).

`TextValueObject` fornece `Text`, `ToString()`, `GetEqualityComponents()` e conversão implícita para `string?`.

## 3. VO com validação própria (herda de `ValueObject`)

Use quando o valor não é texto ou tem regra própria. Esqueleto — o exemplo é **ilustrativo** (o módulo Avaliação ainda não existe), usando a regra oficial de aprovação com 70% do `AGENTS.md`:

```csharp
using Automatiza.SeedWork.DomainObjects.ValueObjects;

namespace Automatiza.Modules.Avaliacao.Domain.Entities.{Entidade};

public class NotaAvaliacao : ValueObject
{
    public const decimal NotaMinimaAprovacao = 70m;

    private NotaAvaliacao() { } // EF Core

    private NotaAvaliacao(decimal percentual) => Percentual = percentual;

    public decimal Percentual { get; private set; }

    public bool Aprovada => Percentual >= NotaMinimaAprovacao;

    public static Result<NotaAvaliacao> Criar(decimal percentual)
    {
        if (percentual is < 0m or > 100m)
            return {Entidade}Errors.NotaForaDoIntervalo;

        return new NotaAvaliacao(percentual); // conversão implícita T → Result<T>
    }

    protected override IEnumerable<object> GetEqualityComponents()
    {
        yield return Percentual;
    }
}
```

## 4. Regras obrigatórias

- O construtor com parâmetros é **sempre `private`** — a única forma de criar o VO é o factory `Criar(...)`.
- Um construtor `private` **sem parâmetros** para o EF Core rehidratar o VO sem passar pela validação (dado já gravado não pode virar exceção na leitura).
- `Criar(...)` retorna `Result<T>` — nunca lança exceção.
- Propriedades com `private set` (o EF precisa gravar nelas na rehidratação).
- Limites como `const` públicas: o mapeamento (`HasMaxLength`) e os testes usam a mesma constante.
- Implemente `GetEqualityComponents()` em VOs que herdam de `ValueObject`.
- Códigos de erro prefixados pela entidade (`TRILHA_TITULO`), em `SCREAMING_SNAKE_CASE`.
- Notas e valores financeiros em `decimal`, nunca `double`/`float`.

## 5. Mapeamento EF Core do VO

No mapeamento da entidade dona — ver a skill `backend-criar-mapping-ef-core`. O VO é um tipo complexo (`ComplexProperty`), gravado em colunas da própria tabela. É o único caso em que se usa `HasColumnName`: sem ele, a convenção snake_case geraria `titulo_text`.

```csharp
builder.ComplexProperty(t => t.Titulo, titulo =>
    titulo.Property(x => x.Text).HasColumnName("titulo").HasMaxLength(TituloTrilha.TamanhoMaximo).IsRequired());
```

Na leitura com Dapper, a coluna volta como tipo primitivo no record de resposta (`string Titulo`), não como VO.

Regras gerais: `AGENTS.md`.
reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.Stars: 322kUpdated Claude CodeCodexVerifiedInstall
dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependenciesStars: 322kUpdated Claude CodeCodexVerifiedInstall
executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is availableStars: 322kUpdated Claude CodeCodexVerifiedInstall