Slender.Tools.VerifyGuards 1.0.0

<h3 align=center> <img src="https://raw.githubusercontent.com/Robertscorp/Slender.Tools.VerifyGuards/master/media/VerifyGuards.svg?sanitize=true" width=50%> </h3>

Slender.Tools.VerifyGuards is a simple .NET library for easily writing tests for guard clauses.

Usage

public class MyClass
{

    public MyClass(string notNullableValue, string nullableValue)
    {
        if (notNullableValue is null) throw new ArgumentNullException(nameof(notNullableValue));
    }
    
    public void InstanceMethod(string notNullableValue, string nullableValue)
    {
        if (notNullableValue is null) throw new ArgumentNullException(nameof(notNullableValue));
    }
    
    public static void StaticMethod(string notNullableValue, string nullableValue)
    {
        if (notNullableValue is null) throw new ArgumentNullException(nameof(notNullableValue));
    }

}

Verifying Guards for Constructors

Verify.Guards(() => new MyClass(Is.NotNullable<string>(), Is.Nullable<string>()));

Verifying Guards for Instance Methods

Accessing an instance through an expression parameter

Verify.Guards((MyClass c) => c.InstanceMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Accessing an instance through a field

private readonly MyClass m_MyClass = new MyClass(string.Empty, default);
Verify.Guards(() => this.m_MyClass.InstanceMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Accessing an instance through a variable

var _MyClass = new MyClass(string.Empty, default);
Verify.Guards(() => _MyClass.InstanceMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Accessing an instance through a contructor

Verify.Guards(() => new MyClass(string.Empty, default).InstanceMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Accessing an instance through a method parameter

public void VerifyGuardsForInstanceMethod(MyClass myClass)
    => Verify.Guards(() => myClass.InstanceMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Verifying Guards for Static Methods

Verify.Guards(() => MyClass.StaticMethod(Is.NotNullable<string>(), Is.Nullable<string>()));

Resolving Guard Exceptions

Need some help resolving a GuardException? Check out the links below.

• 'Param' has been defined as not nullable, but is a nullable value type.
• 'Param' has been defined as not nullable, but is not guarded against null values.
• 'Param' has been defined as nullable, but is a non-nullable value type.
• 'Param' has been defined as nullable, but is guarded against null values.
• Could not get an instance of 'Dependency'. If possible, manually provide an instance of 'Dependency' to resolve this issue.
• Could not parse expression tree, the specified expression is not supported.

Docs

Interested in learning more? Check out the docs.

Leave a Star ⭐

Like the project? Please leave a star!