CustomAssertions 1.1.0

CustomAssertions

A modern, fluent assertion library for .NET that provides type-safe, chainable assertions with comprehensive validation capabilities. Designed to work seamlessly with xUnit, NUnit, and MSTest.

✨ Features

• 🔗 Fluent API: Chain multiple assertions together for readable, expressive tests
• 🎯 Type-Safe: Strong typing with compile-time validation
• 📦 Comprehensive: Assertions for strings, integers, collections, dates, records, structs, tuples, and more
• 🧪 Test Framework Agnostic: Works with xUnit, NUnit, MSTest
• 🚀 Modern C#: Leverages latest C# features (records, pattern matching, nullable types)
• 📝 Well-Documented: Full XML documentation for IntelliSense support
• ⚡ Performant: Minimal overhead with efficient implementation
• 🔍 Detailed Error Messages: Clear, descriptive failure messages

📦 Installation

Via NuGet Package Manager

Install-Package CustomAssertions

Via .NET CLI

dotnet add package CustomAssertions

Via PackageReference

<PackageReference Include="CustomAssertions" Version="1.0.0" />

🚀 Quick Start

using CustomAssertions.ConcreteModels;
using Xunit;

public class ExampleTests
{
    [Fact]
    public void StringAssertion_Example()
    {
        var result = new StringAssertions("Hello, World!")
            .NotNullOrEmpty()
            .HasMinimumLength(5)
            .Contains("World")
            .MatchesRegex(@"^Hello.*!")
            .Validate();

        Assert.True(result);
    }

    [Fact]
    public void IntAssertion_Example()
    {
        var result = new IntAssertions(42)
            .IsPositive()
            .IsGreaterThan(10)
            .IsLessThan(100)
            .IsInRange(1, 50)
            .Validate();

        Assert.True(result);
    }
}

📚 Available Assertions

Type-Specific Assertions

• StringAssertions: null/empty checks, length validations, regex matching, contains/not contains
• IntAssertions: positive/negative/zero, comparisons, range validation
• LongAssertions: 64-bit integer validation, even/odd checks, range operations
• ByteAssertions: byte-specific comparisons and range validation
• DecimalAssertions: high-precision decimal validation, scale checks, financial operations
• FloatingPointAssertions: approximate equality, range, special values (NaN, Infinity)
• BoolAssertions: true/false validation, equality checks
• CharAssertions: letter, digit, case, punctuation, whitespace checks
• GuidAssertions: empty/not empty, version validation, format matching
• EnumAssertions: defined values, flag operations, name validation
• DateTimeAssertions: before/after, date range, weekend checks, component validation
• DateTimeOffsetAssertions: timezone-aware date/time validation, offset checks
• TimeSpanAssertions: duration validation, component checks, approximation

Collection & Complex Type Assertions

• CollectionAssertions: empty/not empty, contains item
• DictionaryAssertions: key/value existence, containment checks
• TupleAssertions: length, item validation, reference equality
• NullableAssertions: has value, conditional validation, value equality
• RecordAssertions: value equality for records, reference checks
• StructAssertions: default value, equality checks
• GenericAssertions: type checks, custom predicates, equality operations
• ExceptionAssertions: exception message, type, inner exception, stack trace validation

🏗️ Architecture

The library follows these design principles:

• SOLID Principles: Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion
• Fluent Interface Pattern: Enables method chaining for readable code
• Template Method Pattern: Base classes define structure, concrete classes implement specifics
• Curiously Recurring Template Pattern (CRTP): Type-safe fluent chaining

🔧 Requirements

• .NET 6.0 or higher (.NET 6, .NET 7, .NET 8, .NET 9 supported)
• C# 10 or higher (for modern language features)

📄 License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

Made with ❤️ by Darel Johnson

Copyright © 2024 Darel Johnson. All rights reserved.