MarceloCastelo.IO.OutputEnvelop.FluentValidation 2.1.0

MCIO.OutputEnvelop.FluentValidation

Uma extensão do pacote MarceloCastelo.IO.OutputEnvelop que integra com o pacote FluentValidation.

📦 Pacotes

Nome	Versão	Link	Repository
MarceloCastelo.IO.OutputEnvelop		Nuget.org	Link
MarceloCastelo.IO.OutputEnvelop.FluentValidation		Nuget.org	Esse aqui 😃

🏷️ Labels

Categoria	Descrição	Labels (todos os ícones são clicáveis e levam as ferramentas externas)
Licença	MIT
Segurança	Vulnerabilidades
Qualidade	Visão geral
Qualidade	Cobertura de testes
Qualidade	Teste de mutação
Qualidade	Manutenabilidade
Qualidade	Confiabilidade
Qualidade	Bugs
Qualidade	Dívidas técnicas
Qualidade	Linhas duplicadas (%)
Qualidade	Melhorias de código
Pipeline	Compilação e testes
Pipeline	Publicação

📄 Introdução

O pacote FluentValidation é amplamente utilizado em projetos .NET devido à sua robustez e flexibilidade, especialmente em validações de domínio. O pacote MarceloCastelo.IO.OutputEnvelop pode ser utilizado no lugar do FluentValidation. No entanto, é importante que eles possam funcionar lado a lado para proporcionar maior flexibilidade no projeto. Este pacote realiza a integração necessária para que possam coexistir harmoniosamente.

📖 Conteúdo

• MCIO.OutputEnvelop.FluentValidation
  • :package: Pacotes
  • :label: Labels
  • :page_facing_up: Introdução
  • :book: Conteúdo
  • :package: Dependências
  • :books: Utilização básica
  • :books: Exemplo completo
  • :rocket: Executando localmente
  • :rocket: Benchmark
  • :people_holding_hands: Contribuindo
  • :people_holding_hands: Autores

📦 Dependências

voltar ao topo

• .NET Standard 2.0.
• Pacote FluentValidation.

📚 Utilização básica

voltar ao topo

• Sem objeto de retorno

using MCIO.OutputEnvelop;

var validationResult = someValidator.Validate(input);
var outputEnvelop = validationResult.ToOutputEnvelop();

• Com objeto de retorno

using MCIO.OutputEnvelop;

var customer = new Customer();
var validationResult = someValidator.Validate(input);
var outputEnvelop = validationResult.ToOutputEnvelop(customer);

📚 Exemplo completo

voltar ao topo

public class Customer
{
    // Fields
    private static RegisterNewCustomerInputValidator _registerNewCustomerInputValidator = new();

    // Properties
    public int Id { get; }
    public string Name { get; }
    public DateOnly BirthDate { get; }

    // Constructors
    private Customer(int id, string name, DateOnly birthDate)
    {
        Id = id;
        Name = name;
        BirthDate = birthDate;
    }

    // Public Methods
    // Validation result is a out variable for test reasons
    public static OutputEnvelop<Customer> RegisterNew(RegisterNewCustomerInput input, out ValidationResult validationResult)
    {
        // Validation
        validationResult = _registerNewCustomerInputValidator.Validate(input);
        if (!validationResult.IsValid)
            return validationResult.ToOutputEnvelop<Customer>(output: null!);

        // Process and return
        return validationResult.ToOutputEnvelop(
            output: validationResult.IsValid ? new Customer(id: input.Id, name: input.Name, birthDate: input.BirthDate) : null!
        );
    }

    // Inputs
    public record RegisterNewCustomerInput(int Id, string Name, DateOnly BirthDate);

    public class RegisterNewCustomerInputValidator
        : AbstractValidator<RegisterNewCustomerInput>
    {
        // Constants
        public const string CUSTOMER_ID_IS_REQUIRED_MESSAGE_CODE = "CUSTOMER_ID_IS_REQUIRED";
        public const string CUSTOMER_ID_IS_REQUIRED_MESSAGE_DESCRIPTION = "Id is required";
        public const Severity CUSTOMER_ID_IS_REQUIRED_MESSAGE_SEVERITY = Severity.Error;

        public const string CUSTOMER_NAME_IS_REQUIRED_MESSAGE_CODE = "CUSTOMER_NAME_IS_REQUIRED";
        public const string CUSTOMER_NAME_IS_REQUIRED_MESSAGE_DESCRIPTION = "Name is required";
        public const Severity CUSTOMER_NAME_IS_REQUIRED_MESSAGE_SEVERITY = Severity.Error;

        public const string CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_CODE = "CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME";
        public const string CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_DESCRIPTION = "Name should have last name";
        public const Severity CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_SEVERITY = Severity.Warning;
        
        public const string CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_CODE = "CUSTOMER_BIRTHDATE_IS_REQUIRED";
        public const string CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_DESCRIPTION = "BirthDate is required";
        public const Severity CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_SEVERITY = Severity.Error;

        public const string CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_CODE = "CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH";
        public const string CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_DESCRIPTION = "BirthDate is required";
        public const Severity CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_SEVERITY = Severity.Error;

        public const string CUSTOMER_BIRTHDATE_DAY_MESSAGE_CODE = "CUSTOMER_BIRTHDATE_DAY";
        public const string CUSTOMER_BIRTHDATE_DAY_MESSAGE_DESCRIPTION = "Today is the customer birthday";
        public const Severity CUSTOMER_BIRTHDATE_DAY_MESSAGE_SEVERITY = Severity.Info;

        // Public Methods
        public RegisterNewCustomerInputValidator()
        {
            RuleFor(p => p.Id)
                .GreaterThan(0)
                .WithErrorCode(CUSTOMER_ID_IS_REQUIRED_MESSAGE_CODE)
                .WithMessage(CUSTOMER_ID_IS_REQUIRED_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_ID_IS_REQUIRED_MESSAGE_SEVERITY);

            RuleFor(p => p.Name)
                .NotEmpty()
                .WithErrorCode(CUSTOMER_NAME_IS_REQUIRED_MESSAGE_CODE)
                .WithMessage(CUSTOMER_NAME_IS_REQUIRED_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_NAME_IS_REQUIRED_MESSAGE_SEVERITY);
            
            RuleFor(p => p.Name)
                .MaximumLength(150)
                .WithErrorCode("CUSTOMER_NAME_SHOULD_HAVE_MAX_LENGTH")
                .WithMessage("Name should less than or equais 150 characters")
                .WithSeverity(Severity.Error);

            RuleFor(p => p.Name)
                .Must(name => name.Contains(" "))
                .WithErrorCode(CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_CODE)
                .WithMessage(CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_NAME_SHOULD_HAVE_LAST_NAME_MESSAGE_SEVERITY);

            RuleFor(p => p.BirthDate)
                .NotEmpty()
                .WithErrorCode(CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_CODE)
                .WithMessage(CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_BIRTHDATE_IS_REQUIRED_MESSAGE_SEVERITY);

            RuleFor(p => p.BirthDate)
                .LessThanOrEqualTo(DateOnly.FromDateTime(DateTime.Now))
                .WithErrorCode(CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_CODE)
                .WithMessage(CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_BIRTHDATE_SHOULD_HAVE_MAX_LENGTH_MESSAGE_SEVERITY);

            RuleFor(p => p.BirthDate)
                .Must(q => q != DateOnly.FromDateTime(DateTime.Now))
                .WithErrorCode(CUSTOMER_BIRTHDATE_DAY_MESSAGE_CODE)
                .WithMessage(CUSTOMER_BIRTHDATE_DAY_MESSAGE_DESCRIPTION)
                .WithSeverity(CUSTOMER_BIRTHDATE_DAY_MESSAGE_SEVERITY);
        }
    }
}

🚀 Executando localmente

voltar ao topo

Por se tratar de um pacote nuget, não existe uma execução. Porém, existe o script build-local-script que pode ser executado via PowerShell que realizará as seguintes ações:

1. Instalará a CLI do ReportGenerator localmente para visualização do relatório de cobertura no formato opencover.
2. Instalará a CLI do Stryker localmente para execução e visualização do relatório do teste de mutação.
3. Restore do projeto.
4. Build do projeto em modo release.
5. Execução dos testes de unidade.
6. Execução do teste de mutação.
7. Abertura do relatório de cobertura no navegador web padrão.
8. Abertura do relatório de teste mutante no navegador web padrão.

A partir do diretóio raiz do repositório, no PowerShell, execute o comando .\build-local-script.ps1.

Caso queira limpar todos os arquivos gerados, a partir do diretóio raiz do repositório, no PowerShell, execute o comando .\clear-local-script.ps1.

🚀 Benchmark

voltar ao topo

O benchmark abaixo (arquivo ExtensionMethodsBenchmark.cs) compara a utilização do objeto ValidationResult como retorno do método e gerando um OutputEnvelop a partir do ValidationResult gerado.

// * Summary *

BenchmarkDotNet v0.13.11, Windows 11 (10.0.22631.2861/23H2/2023Update/SunValley3)
AMD Ryzen 5 5600X, 1 CPU, 12 logical and 6 physical cores
.NET SDK 8.0.100
  [Host]     : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2
  Job-BHOBUW : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2

LaunchCount=1  RunStrategy=Throughput

// * Hints *
Outliers
  ExtensionMethodsBenchmark.'OutputEnvelop From Valid Input': LaunchCount=1, RunStrategy=Throughput      -> 1 outlier  was  detected (2.12 us)
  ExtensionMethodsBenchmark.'ValidationResult From Invalid Input': LaunchCount=1, RunStrategy=Throughput -> 1 outlier  was  removed (4.01 us)
  ExtensionMethodsBenchmark.'OutputEnvelop From Invalid Input': LaunchCount=1, RunStrategy=Throughput    -> 2 outliers were removed (4.16 us, 4.19 us)

🧑‍🤝‍🧑 Contribuindo

voltar ao topo

Você está mais que convidado para constribuir. Caso tenha interesse e queira participar do projeto, não deixe de ver nosso manual de contribuição.

🧑‍🤝‍🧑 Autores

voltar ao topo

• Marcelo Castelo Branco - @MarceloCas