EnsureFramework 2.0.0-alpha

EnsureFramework

EnsureFramework is designed to take the pain out of null checking and making sure (ensuring) your methods are being used the way they were intended and throwing exceptions when unsupported values are passed to them.

You can make sure values are in a specific range or simply make sure that an argument is not null.

It was designed to be readable and fluent based, meaning you can chain ensurables together and the first one that fails will result in the exception.

Ensuring implicitly checks for null so there is no need to have a .IsNull() call. So if you want to ensure it is not null, you can just Ensure.Arg(myArg).

101

1. Add the namespace

   namespace EnsureFramework;
   

2. Ensure things!

   public void MyMethod(string anArgument)
   {
       Ensure.Arg(anArgument).IsNotEmpty();
   }
   

Other things

You can ensure your arguments directly using the argument-string override or with the expression override. You need to be aware that if performance is desired the argument-string override is the best.

Supported types

There are extensions for common types in .NET but not much else outside of that. We support:

• IComparable ⫽ for example...
  • System.Decimal
  • System.Enum
  • System.String
  • System.DateTime
  • System.Boolean
  • System.Byte
  • System.Char
  • System.DateTimeOffset
  • System.Double
  • System.Guid
  • System.Int16
  • System.Int32
  • System.Int64
  • System.SByte
  • System.Single
  • System.TimeSpan
  • System.Tuple<T1>
  • System.Tuple<T1,T2>
  • System.Tuple<T1,T2,T3>
  • System.Tuple<T1,T2,T3,T4>
  • System.Tuple<T1,T2,T3,T4,T5>
  • System.Tuple<T1,T2,T3,T4,T5,T6>
  • System.Tuple<T1,T2,T3,T4,T5,T6,T7>
  • System.Tuple<T1,T2,T3,T4,T5,T6,T7,TRest>
  • System.UInt16
  • System.UInt32
  • System.UInt64
  • System.ValueTuple
  • System.ValueTuple<T1>
  • System.ValueTuple<T1,T2>
  • System.ValueTuple<T1,T2,T3>
  • System.ValueTuple<T1,T2,T3,T4>
  • System.ValueTuple<T1,T2,T3,T4,T5>
  • System.ValueTuple<T1,T2,T3,T4,T5,T6>
  • System.ValueTuple<T1,T2,T3,T4,T5,T6,T7>
  • System.ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>
  • System.Version
• IEnumerable
  • List
  • Collection
  • Dictionary
• Dictionary
• Guid
• Int32/int
• Object
• String

Well Mike, my type isn't supported...

That's cool friend, just create your own by adding extension methods to your project. Here is a simple one that should point you in the right direction:

public static IArgumentAssertionBuilder<User> IsAnAdult(this IArgumentAssertionBuilder<User> @this)
{
    if (@this.Argument.DateOfBirth >= DateTime.Today.AddYears(-18))
    {
        throw new ArgumentException("User is underage", @this.ArgumentName);
    }
    return @this;
}

Check out the code and tests for a bit more info - the project is quite simple.