Skip to content

Yet another guard clause project for .Net C#'ers

License

Notifications You must be signed in to change notification settings

dmarciano/Ensure.That

 
 

Repository files navigation

Ensure.That

Ensure.That is a simple guard clause argument validation lib, that helps you with validation of your arguments.

It's developed for .NET 4.5.1 as well as .NET Standard 1.1 and .NET Standard 2.0 and available via NuGet.

Build Status NuGet

Using extension methods

This was supposed to be removed but after some wishes from the community it has been kept it with some slight changes.

If you are worried that the constructed public struct Param<T> {} created for the argument being validated will hurt your performance you can use any of the other constructs e.g. contextual Ensure.String or EnsureArg.

Ensure.That(myString).IsNotNullOrWhiteSpace();
Ensure.That(myString, nameof(myArg)).IsNotNullOrWhiteSpace();
Ensure.That(myString, nameof(myArg), opts => opts.WithMessage("Foo")).IsNotNullOrWhiteSpace();

Using contextual validation

This flavour was introduced in the v7.0.0 release.

Ensure.String.IsNotNullOrWhiteSpace(myString);
Ensure.String.IsNotNullOrWhiteSpace(myString, nameof(myArg));
Ensure.String.IsNotNullOrWhiteSpace(myString, nameof(myArg), opts => opts.WithMessage("Foo"));

Using static simple methods

The EnsureArg flavour was added in the v5.0.0 release.

EnsureArg.IsNotNullOrWhiteSpace(myString);
EnsureArg.IsNotNullOrWhiteSpace(myString, nameof(myArg));
EnsureArg.IsNotNullOrWhiteSpace(myString, nameof(myArg), opts => opts.WithMessage("Foo"));

Samples

The Samples above just uses string validation, but there are more. E.g.:

  • Strings
  • Numerics
  • Collections (arrays, lists, collections, dictionaries)
  • Booleans
  • Guids

Get up and running with the source code

The main solution is maintained using Visual Studio 2017.

Unit-tests are written using xUnit and there are no integration tests, hence you should just be able to:

  • Pull
  • Compile
  • Run the tests

Easiest done using:

git clone ...

and

dotnet test src/Ensure.That.sln

About

Yet another guard clause project for .Net C#'ers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 98.2%
  • HTML 1.8%