Pitasoft.Error 5.2.2

Pitasoft.Error

Pitasoft.Error is a class library designed to facilitate the handling and management of error collections in .NET applications. It allows grouping errors by property, handling change notifications, and serializing/deserializing error collections to/from JSON.

English | Español

English

Key Features

• ErrorCollection: A robust collection for storing errors associated with property names.
• IErrorCollectionContainer: A standard interface for objects (like ViewModels) that expose an ErrorCollection.
• High Performance: Optimized for low memory allocation and fast execution, especially in filtering and mass clearing operations.
• Advanced Filtering: Flexible error retrieval using Intersect or Except operations with JointActionErrors.
• INotifyDataErrorInfo Support: Fully implements INotifyDataErrorInfo for seamless integration with WPF, Avalonia UI, MAUI, and other data-binding frameworks.
• UI Integration Samples: Includes sample projects for WPF and Avalonia UI showing real-time validation patterns.
• Notifications: Support for events when the error collection changes.
• JSON Serialization: Built-in extensions to convert error collections to JSON and vice versa.
• Multi-target Support: Compatible with .NET 8.0, .NET 9.0, and .NET 10.0.
• Fluent API: Chainable methods for fast and readable error collection setup.
• Exception Error Detection: Automatic error message extraction from complex exception hierarchies.

Installation

You can install this package via NuGet:

dotnet add package Pitasoft.Error

Basic Usage

Creating an Error Collection and Adding/Clearing Errors

using Pitasoft.Error;

var errors = new ErrorCollection();
errors.Add("Name", "The name is required.");
errors.Add("Email", "The email format is invalid.");

if (errors.AnyError())
{
    // Handle errors
}

// Clear errors for a specific property
errors.Clear("Name");

// Clear all errors
errors.ClearAll();

Note: The Remove and RemoveAll methods are now deprecated in favor of Clear and ClearAll to maintain naming consistency with standard .NET collections.

UI Frameworks Integration (MVVM)

ErrorCollection is designed to be easily integrated into ViewModels. You can implement IErrorCollectionContainer to provide a standard way of exposing errors:

public class MyViewModel : INotifyDataErrorInfo, IErrorCollectionContainer
{
    public ErrorCollection Errors { get; set; } = new();

    public event EventHandler<DataErrorsChangedEventArgs>? ErrorsChanged
    {
        add => Errors.ErrorsChanged += value;
        remove => Errors.ErrorsChanged -= value;
    }

    public System.Collections.IEnumerable GetErrors(string? propertyName) => 
        ((INotifyDataErrorInfo)Errors).GetErrors(propertyName);

    public bool HasErrors => Errors.HasErrors;

    private string _name;
    public string Name
    {
        get => _name;
        set
        {
            _name = value;
            ValidateName();
        }
    }

    private void ValidateName()
    {
        Errors.Clear(nameof(Name));
        if (string.IsNullOrWhiteSpace(Name))
            Errors.Add(nameof(Name), "Name is required");
    }
}

Check the Pitasoft.Error.WpfSample and Pitasoft.Error.AvaloniaSample projects for complete implementations.

Advanced Filtering

You can filter errors using JointActionErrors to include or exclude specific properties:

// Get errors only for specific properties
var relevantErrors = errors.GetErrors(JointActionErrors.Intersect, "Username", "Password");

// Get errors for all properties EXCEPT the ones specified
var otherErrors = errors.GetErrors(JointActionErrors.Except, "IsAcceptedTerms");

// Check if any error exists for specific properties
bool hasCriticalErrors = errors.AnyError(JointActionErrors.Intersect, "System", "Database");

Using Static Creation Methods

var errors = ErrorCollection.Create("General", "An unexpected error has occurred.");

JSON Serialization

using Pitasoft.Error.Extensions;

string json = errors.ToJson();

Deserialization from JSON

string json = "{\"name\":[\"Error 1\"]}";
var errors = json.ToErrorCollection();

Event Notifications

You can subscribe to changes in the error collection:

var errors = new ErrorCollection();
errors.ErrorsChanged += (sender, e) => 
{
    Console.WriteLine($"Property '{e.PropertyName}' was updated. Action: {e.Action}");
};

errors.Add("Username", "Already exists.");

Exception Handling

Easily convert exceptions into error collections:

try 
{
    // Some code that throws
}
catch (Exception ex)
{
    // Using static creation method
    var errors = ErrorCollection.Create(ex, deep: true);
    
    // OR using extension method
    var errorsExt = ex.ToErrorCollection(deep: true);

    // OR using implicit operator
    ErrorCollection errorsImplicit = ex;
    
    // All inner exceptions are now captured in the collection
}

License

This project is licensed under the terms specified in the License.txt file.

Benchmarks

The project is highly optimized for performance. Below is a comparison of typical operations between .NET 8.0 and .NET 10.0:

The new version of .NET 10.0 shows a significant improvement in both execution time and memory allocation efficiency for several operations.

Author

Sebastián Martínez Pérez - Pitasoft, S.L.

Español

Pitasoft.Error es una biblioteca de clases diseñada para facilitar el manejo y la gestión de colecciones de errores en aplicaciones .NET. Permite agrupar errores por propiedad, manejar notificaciones de cambios y serializar/deserializar colecciones de errores a JSON.

Características principales

• ErrorCollection: Una colección robusta para almacenar errores asociados a nombres de propiedades.
• IErrorCollectionContainer: Interfaz estándar para objetos (como ViewModels) que exponen una ErrorCollection.
• Alto Rendimiento: Optimizada para minimizar las asignaciones de memoria y maximizar la velocidad, especialmente en operaciones de filtrado y limpieza masiva.
• Filtrado Avanzado: Recuperación flexible de errores mediante operaciones Intersect o Except con JointActionErrors.
• Soporte INotifyDataErrorInfo: Implementa completamente INotifyDataErrorInfo para una integración fluida con WPF, Avalonia UI, MAUI y otros marcos de trabajo con enlace de datos.
• Ejemplos de Integración UI: Incluye proyectos de ejemplo para WPF y Avalonia UI que muestran patrones de validación en tiempo real.
• Notificaciones: Soporte para eventos cuando la colección de errores cambia.
• Serialización JSON: Extensiones integradas para convertir colecciones de errores a JSON y viceversa.
• Soporte Multi-target: Compatible con .NET 8.0, .NET 9.0 y .NET 10.0.
• Fluent API: Métodos encadenables para una configuración rápida y legible de las colecciones de errores.
• Detección de Errores de Excepción: Extracción automática de mensajes de error de jerarquías de excepciones complejas.

Instalación

Puedes instalar este paquete a través de NuGet:

dotnet add package Pitasoft.Error

Uso básico

Crear una colección de errores, añadir y limpiar errores

using Pitasoft.Error;

var errors = new ErrorCollection();
errors.Add("Nombre", "El nombre es obligatorio.");
errors.Add("Email", "El formato del email no es válido.");

if (errors.AnyError())
{
    // Manejar errores
}

// Limpiar errores de una propiedad específica
errors.Clear("Nombre");

// Limpiar todos los errores
errors.ClearAll();

Nota: Los métodos Remove y RemoveAll han sido marcados como obsoletos en favor de Clear y ClearAll para mantener la consistencia con las colecciones estándar de .NET.

Integración con Frameworks de UI (MVVM)

ErrorCollection está diseñado para integrarse fácilmente en ViewModels. Puedes implementar IErrorCollectionContainer para proporcionar una forma estándar de exponer errores:

public class MiViewModel : INotifyDataErrorInfo, IErrorCollectionContainer
{
    public ErrorCollection Errors { get; set; } = new();

    public event EventHandler<DataErrorsChangedEventArgs>? ErrorsChanged
    {
        add => Errors.ErrorsChanged += value;
        remove => Errors.ErrorsChanged -= value;
    }

    public System.Collections.IEnumerable GetErrors(string? propertyName) => 
        ((INotifyDataErrorInfo)Errors).GetErrors(propertyName);

    public bool HasErrors => Errors.HasErrors;

    private string _nombre;
    public string Nombre
    {
        get => _nombre;
        set
        {
            _nombre = value;
            ValidarNombre();
        }
    }

    private void ValidarNombre()
    {
        Errors.Clear(nameof(Nombre));
        if (string.IsNullOrWhiteSpace(Nombre))
            Errors.Add(nameof(Nombre), "El nombre es obligatorio");
    }
}

Consulta los proyectos Pitasoft.Error.WpfSample y Pitasoft.Error.AvaloniaSample para implementaciones completas.

Filtrado Avanzado

Puedes filtrar errores usando JointActionErrors para incluir o excluir propiedades específicas:

// Obtener errores solo para propiedades específicas
var erroresRelevantes = errors.GetErrors(JointActionErrors.Intersect, "Usuario", "Password");

// Obtener errores para todas las propiedades EXCEPTO las especificadas
var otrosErrores = errors.GetErrors(JointActionErrors.Except, "AceptaTerminos");

// Comprobar si existe algún error para propiedades específicas
bool tieneErroresCriticos = errors.AnyError(JointActionErrors.Intersect, "Sistema", "BaseDeDatos");

Uso de métodos estáticos de creación

var errors = ErrorCollection.Create("General", "Ha ocurrido un error inesperado.");

Serialización a JSON

using Pitasoft.Error.Extensions;

string json = errors.ToJson();

Deserialización desde JSON

string json = "{\"nombre\":[\"Error 1\"]}";
var errors = json.ToErrorCollection();

Notificaciones de Eventos

Puedes suscribirte a los cambios en la colección de errores:

var errors = new ErrorCollection();
errors.ErrorsChanged += (sender, e) => 
{
    Console.WriteLine($"La propiedad '{e.PropertyName}' ha sido actualizada. Acción: {e.Action}");
};

errors.Add("Usuario", "Ya existe.");

Manejo de Excepciones

Convierte fácilmente excepciones en colecciones de errores:

try 
{
    // Código que lanza una excepción
}
catch (Exception ex)
{
    // Usando el método de creación estático
    var errors = ErrorCollection.Create(ex, deep: true);
    
    // O usando el método de extensión
    var errorsExt = ex.ToErrorCollection(deep: true);

    // O usando el operador implícito
    ErrorCollection errorsImplicit = ex;
    
    // Todas las excepciones internas se capturan ahora en la colección
}

Licencia

Este proyecto está bajo la licencia especificada en el archivo License.txt.

Benchmarks

El proyecto está altamente optimizado. A continuación se muestra una comparativa de operaciones típicas entre .NET 8.0 y .NET 10.0:

La nueva versión de .NET 10.0 muestra una mejora significativa tanto en tiempo de ejecución como en eficiencia de asignación de memoria para varias operaciones.

Autor

Sebastián Martínez Pérez - Pitasoft, S.L.