Tooark.Enums 4.1.0

Tooark.Enums

Biblioteca que fornece tipos enumerados validados, permitindo a padronização para projetos .NET. Inclui métodos para conversão e validação de valores enumerados.

Conteúdo

• Instalação
• Como funcionam
• ECloudProvider
• EDocumentType
• EFileType
• Exemplos de Uso
• Dependências
• Contribuição
• Licença

Instalação

dotnet add package Tooark.Enums

O pacote não tem configuração: os enumeradores são valores estáticos, usados diretamente.

Como funcionam

Os três tipos são classes com instâncias estáticas, e não enum do C#. Isso permite que cada valor carregue mais do que um número — descrição, padrão de formato, função de validação — ao custo de não poderem ser usados como argumento de atributo, que exige constante.

Todos expõem o mesmo conjunto de operações:

Duas regras valem para os três:

• A descrição é normalizada. "aws", "AWS" e " Aws " resolvem para o mesmo valor.
• Id ou descrição não reconhecidos resolvem para o valor neutro — None em ECloudProvider e EDocumentType, Unknown em EFileType —, que é o membro previsto para isso. Já converter uma instância nula para int ou string lança InternalServerErrorException com Invalid.Parameter;null: não existe id nem descrição correta para devolver, e devolver zero seria inventar um dado.

Enumeradores

1. Provedor de Cloud

Funcionalidade: representa os provedores de cloud suportados.

Exemplo de Uso

2. Tipo de Documento

Funcionalidade: representa os tipos de documento, cada um com o próprio formato e verificação.

Métodos próprios:

• ToRegex(): devolve o padrão de formato do tipo de documento.
• IsValid: função que verifica os dígitos verificadores, aceitando o valor com ou sem máscara.

As duas verificações são camadas distintas e se complementam: ToRegex() cuida da forma e IsValid cuida do conteúdo. Uma validação completa aplica as duas, como fazem o value object Document do Tooark.ValueObjects e o DocumentValidationAttribute do Tooark.Attributes. Chamada isolada, IsValid aceita 529.982.247-25 e 52998224725 igualmente, e nunca lança para entrada inválida — devolve false.

O cálculo dos dígitos vem de DocumentDigit, no Tooark.Validations, o mesmo usado pelas validações daquele pacote — então new Validation().IsCpf(...) e EDocumentType.CPF.IsValid(...) sempre concordam.

Exemplo de Uso

3. Tipo de Arquivo

Funcionalidade: representa as categorias de arquivo.

Exemplo de Uso

Exemplos de Uso

Provedor de Cloud

using Tooark.Enums;

ECloudProvider provider = ECloudProvider.Amazon;

Console.WriteLine(provider.ToString()); // AWS
Console.WriteLine(provider.ToInt());    // 1

// Conversões implícitas, úteis para persistir e ler de volta
int id = provider;                      // 1
string description = provider;          // "AWS"

// A descrição não diferencia caixa
ECloudProvider daConfiguracao = "aws";  // Amazon
ECloudProvider doBanco = 1;             // Amazon

Tipo de Documento

using Tooark.Enums;

EDocumentType docType = EDocumentType.CPF;

Console.WriteLine(docType.ToString()); // CPF
Console.WriteLine(docType.ToInt());    // 1
Console.WriteLine(docType.ToRegex());  // ^\d{3}\.\d{3}\.\d{3}-\d{2}$

// IsValid confere os dígitos, com ou sem máscara
Console.WriteLine(docType.IsValid("529.982.247-25")); // True
Console.WriteLine(docType.IsValid("52998224725"));    // True
Console.WriteLine(docType.IsValid("529.982.247-24")); // False

Validação completa, aplicando formato e dígitos:

using System.Text.RegularExpressions;
using Tooark.Enums;

bool EhValido(string documento, EDocumentType tipo) =>
  Regex.IsMatch(documento, tipo.ToRegex()) && tipo.IsValid(documento);

Tipo de Arquivo

using Tooark.Enums;

EFileType fileType = EFileType.Image;

Console.WriteLine(fileType.ToString()); // Image
Console.WriteLine(fileType.ToInt());    // 2

// Valor não reconhecido resolve para Unknown
EFileType desconhecido = "planilha";    // Unknown

Dependências

Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests no repositório Tooark.Enums.

Licença

Este projeto está licenciado sob a licença BSD 3-Clause. Veja o arquivo LICENSE para mais detalhes.