Phema.Validation 3.1.8

Phema.Validation

A simple, lightweight, fluent and extensible validation library for .NET Core

Installation

$> dotnet add package Phema.Validation

Core concepts

• IValidationContext - Scoped service to store all validation details
• IValidationCondition - Contains a validation checks (e.g. Is(() => ...))
• IValidationDetail - When IValidationCondition is not valid adds to IValidationContext.ValidationDetails
• ValidationSeverity - Validation error level, used in IValidationContext.ValidationSeverity and IValidationDetail.ValidationSeverity
• IValidationScope - Is a nested validation context with validation path and severity override

Usage (ASP.NET Core, HostedService examples)

// Add `IValidationContext` as scoped service
services.AddValidation(options => ...);

// Get or inject
var validationContext = serviceProvider.GetRequiredService<IValidationContext>();

// Validation key will be `Name` using default validation part provider
validationContext.When(person, p => p.Name)
  .Is(name => name == null)
  .AddValidationError("Name must be set");

// Validation key will be `Address.Locations[0].Latitude` using default validation part provider
validationContext.When(person, p => p.Address.Locations[0].Latitude)
  .Is(latitude => ...custom check...)
  .AddValidationError("Some custom check failed");

Validation conditions

• Monads are not composable, so Is and IsNot, IsNull and IsNotNull... duplication

// Check for Phema.Validation.Conditions namespace
validationContext.When(person, p => p.Name)
  .IsNullOrWhitespace()
  .AddValidationError("Name must be set");

// Use multiple conditions (joined with AND)
validationContext.When(person, p => p.Name)
  .IsNotNull()
  // AND
  .HasLengthGreater(20)
  // .IsNull()
  // .IsEqual()
  // .IsNotUrl()
  // .IsNotEmail()
  // .IsMatch(regex)
  .AddValidationError("Name should be less than 20");

// DateTime conditions
validationContext.When(task, t => t.DueDate)
  .IsNotUtc()
  .AddValidationError("Due date must be in Utc");

// Type checks
validationContext.When(person, p => p.Car)
  .IsType<Ferrari>()
  .Is(ferarriCar => ...Some Ferrari specific checks...)
  .AddValidationError("You have Ferrari car, but ...");

Validation details

// Null if valid
var validationDetails = validationContext.When(person, p => p.Age)
  // Validation check is failed, validation condition is valid
  .Is(() => false)
  .AddValidationError("Age must be set");

// Use deconstruction
var (key, message) = validationContext.When(person, p => p.Age)
  .IsNull()
  .AddValidationError("Age must be set");

// More deconstruction
var (key, message, severity) = validationContext.When(person, p => p.Age)
  .IsNull()
  .AddValidationError("Age must be set");

Check validation

// Throw exception when details severity greater than ValidationContext.ValidationSeverity
validationContext.When(person, p => p.Address)
  .IsNull()
  .AddValidationFatal("Address is not presented!!!"); // If invalid throw ValidationConditionException

// Check if context is valid
validationContext.IsValid();
validationContext.EnsureIsValid(); // If invalid throw ValidationContextException

// Check concrete validation details
validationContext.IsValid(person, p => p.Age);
validationContext.IsNotValid(person, p => p.Age);
validationContext.EnsureIsValid(person, p => p.Age);

Compose and reuse validation rules with extensions

• Call is allocation free
• Static checks

// Extensions
public static void ValidateCustomer(this IValidationContext validationContext, Customer customer)
{
  // Some checks
}

validationContext.ValidateCustomer(customer);

• Write your own middleware or validation components/validators on top of IValidationContext

Validation part resolvers

• ValidationPartResolver is a delegate, trying to get string valdiation part from MemberInfo
• Use built in resolvers with ValidationPartResolvers static class: Default, DataMember, PascalCase, CamelCase

// Configure DataMember validation part resolver
services.AddValidation(options =>
  options.ValidationPartResolver = ValidationPartResolvers.DataMember);

// Override validation parts with `DataMemberAttribute`
[DataMember(Name = "name")]
public string Name { get; set; }

Validation scopes

• Use scopes when you need to have:
  • Same nested validation path multiple times
  • Empty validation details collection (syncing with parent context/scope)
  • ValidationSeverity override

// Validation key will be `Child.*ValidationPart*`
ValidateChild(validationContext.CreateScope(parent, p => p.Child))

// Validation key will be `Address.Locations[0].*ValidationPart*`
ValidateLocation(validationContext.CreateScope(person, p => p.Address.Locations[0]))

// Override local scope ValidationSeverity
using (var scope = validationContext.CreateScope(person, p => p.Address, ValidationSeverity.Warning))
{
  // Some scope validation checks syncing with validationContext
}

High performance with non-expression constructions

validationContext.When("key", value)
  .IsNull()
  .AddValidationError("Value is null");

validationContext.CreateScope("key", ValidationSeverity.Warning);

validationContext.IsValid("key");
validationContext.IsNotValid("key");
validationContext.EnsureIsValid("key");