CodingFlow.FluentValidation 0.2.2

CodingFlow Fluent Validation

Minimal, easy to use fluent validations API inspired by FluentValidation.

When you need to validate any type, even primitives in an easy and direct way, this library fits the bill. FluentValidation by Jeremy Skinner requires creating a separate validator class to register validation rules, and then instantiating the validator class. This library on the other hand, let's you add validation directly.

Usage

After installing the nuget package from Nuget.org, add this using statement to the file where you want to validate:

<a id='snippet-StandardUsing'></a>

using static CodingFlow.FluentValidation.Validations;

^{<a href='/Examples/BasicExample.cs#L2-L4' title='Snippet source file'>snippet source</a> | <a href='#snippet-StandardUsing' title='Start of snippet'>anchor</a>}

Then you can add validation like this:

<a id='snippet-BasicExample'></a>

var input = 11;

var result = RuleFor(input)
    .BetweenInclusive(4, 6)
    .Result();

// Check results
bool isValid = result.IsValid;
var errors = result.Errors;

^{<a href='/Examples/BasicExample.cs#L12-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-BasicExample' title='Start of snippet'>anchor</a>}

Validators

There are several built-in validators available out-of-the-box. You can also provide your own validation logic via the predicate validator (aka Must).

NotEmpty Validator

Ensures the value is not null for reference types or a default value for value types. For strings, ensures it is not null, an empty string, or only whitespace.

<a id='snippet-NotEmptyExample'></a>

RuleFor(input)
    .NotEmpty()
    .Result();

^{<a href='/Examples/NotEmptyExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-NotEmptyExample' title='Start of snippet'>anchor</a>}

BetweenInclusive Validator

Ensures a number of any type (int, float, double, etc.) is greater than or equal to a minimum and less than or equal to a maximum.

<a id='snippet-BetweenInclusiveExample'></a>

RuleFor(input)
    .BetweenInclusive(6, 14)
    .Result();

^{<a href='/Examples/BetweenInclusiveExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenInclusiveExample' title='Start of snippet'>anchor</a>}

BetweenExclusive Validator

Ensures a number of any type (int, float, double, etc.) is greater than a minimum and less than a maximum.

<a id='snippet-BetweenExclusiveExample'></a>

RuleFor(input)
    .BetweenExclusive(6, 14)
    .Result();

^{<a href='/Examples/BetweenExclusiveExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-BetweenExclusiveExample' title='Start of snippet'>anchor</a>}

Equal Validator

Ensures the input is considered equal to the provided value. For reference types it checks if the two references are to the same instance (reference equality). For value types, it checks it the types and values are the same (value equality).

<a id='snippet-EqualExample'></a>

RuleFor(input)
    .Equal(8)
    .Result();

^{<a href='/Examples/EqualExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-EqualExample' title='Start of snippet'>anchor</a>}

MinimumLength Validator

Ensures the string has a minimum length.

<a id='snippet-MinimumLengthExample'></a>

RuleFor(input)
    .MinimumLength(5) // Must be at least 5 characters long.
    .Result();

^{<a href='/Examples/MinimumLengthExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MinimumLengthExample' title='Start of snippet'>anchor</a>}

MaximumLength Validator

Ensures the string has a maximum length.

<a id='snippet-MaximumLengthExample'></a>

RuleFor(input)
    .MaximumLength(5) // Must be at most 5 characters long.
    .Result();

^{<a href='/Examples/MaximumLengthExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MaximumLengthExample' title='Start of snippet'>anchor</a>}

Regular Expression Validator

Aka Matches, ensure the string passes a regular expression test.

<a id='snippet-MatchesExample'></a>

RuleFor(input)
    .Matches("cat")
    .Result();

^{<a href='/Examples/MatchesExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MatchesExample' title='Start of snippet'>anchor</a>}

Predicate Validator

The predicate (aka Must) validator allows you to provide your own validation logic by providing a delegate.

<a id='snippet-MustExample'></a>

RuleFor(input)
    .Must(input => input == 7)
    .Result();

^{<a href='/Examples/MustExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-MustExample' title='Start of snippet'>anchor</a>}

IsGuid Validator

Ensures the string can be parsed into a valid GUID.

<a id='snippet-IsGuidExample'></a>

RuleFor(input)
    .IsGuid()
    .Result();

^{<a href='/Examples/IsGuidExample.cs#L12-L16' title='Snippet source file'>snippet source</a> | <a href='#snippet-IsGuidExample' title='Start of snippet'>anchor</a>}

Customizing

Custom Error Messages

The WithMessage method can be used to change the validation error message for a validator.

<a id='snippet-WithMessageExample'></a>

RuleFor(input)
    .Equal(8).WithMessage("The two numbers are not equal.")
.Result();

^{<a href='/Examples/WithMessageExample.cs#L13-L17' title='Snippet source file'>snippet source</a> | <a href='#snippet-WithMessageExample' title='Start of snippet'>anchor</a>}

Integrations

Vogen

Extensions to integrate with Vogen validation methods.

To get started, install the Vogen extensions nuget package, CodingFlow.FluentValidation.VogenExtensions.

To get the final result of the fluent validation chain, call VogenResult() instead of Result():

<a id='snippet-VogenExample'></a>

[ValueObject]
public readonly partial struct Age
{
    public static Validation Validate(int value)
    {
        return RuleFor(value)
            .BetweenInclusive(0, 200)
            .VogenResult();
    }
}

^{<a href='/Examples/VogenExamples/Age.cs#L8-L19' title='Snippet source file'>snippet source</a> | <a href='#snippet-VogenExample' title='Start of snippet'>anchor</a>}