Skip to content

Add support for comparisons #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mediocresurgeon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for comparisons #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 74 additions & 1 deletion Argument.Tests/ArgumentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,44 @@ public static IEnumerable<object[]> OutOfRangeVariants {
yield return SimpleDataRow(name => Argument.PositiveOrZero(name, -1));
yield return SimpleDataRow(name => Argument.PositiveOrZero(name, int.MinValue));


yield return SimpleDataRow(name => Argument.PositiveNonZero(name, -1L));
yield return SimpleDataRow(name => Argument.PositiveNonZero(name, long.MinValue));
yield return SimpleDataRow(name => Argument.PositiveNonZero(name, 0L));
yield return SimpleDataRow(name => Argument.PositiveOrZero(name, -1L));
yield return SimpleDataRow(name => Argument.PositiveOrZero(name, long.MinValue));

yield return SimpleDataRow(name => Argument.GreaterThan(name, 0, 0));
yield return SimpleDataRow(name => Argument.GreaterThan(name, -1, 0));
yield return SimpleDataRow(name => Argument.GreaterThan(name, int.MinValue, 0));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, -1, 0));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, int.MinValue, 0));
yield return SimpleDataRow(name => Argument.LessThan(name, 0, 0));
yield return SimpleDataRow(name => Argument.LessThan(name, 1, 0));
yield return SimpleDataRow(name => Argument.LessThan(name, int.MaxValue, 0));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, 1, 0));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, int.MaxValue, 0));

yield return SimpleDataRow(name => Argument.GreaterThan(name, 0.0, 0.0));
yield return SimpleDataRow(name => Argument.GreaterThan(name, -double.Epsilon, 0.0));
yield return SimpleDataRow(name => Argument.GreaterThan(name, double.MinValue, 0.0));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, -double.Epsilon, 0.0));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, double.MinValue, 0.0));
yield return SimpleDataRow(name => Argument.LessThan(name, 0.0, 0.0));
yield return SimpleDataRow(name => Argument.LessThan(name, double.Epsilon, 0.0));
yield return SimpleDataRow(name => Argument.LessThan(name, double.MaxValue, 0.0));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, double.Epsilon, 0.0));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, double.MaxValue, 0.0));

yield return SimpleDataRow(name => Argument.GreaterThan(name, 0m, 0m));
yield return SimpleDataRow(name => Argument.GreaterThan(name, NegativeEpsilon, 0m));
yield return SimpleDataRow(name => Argument.GreaterThan(name, decimal.MinValue, 0m));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, NegativeEpsilon, 0m));
yield return SimpleDataRow(name => Argument.GreaterThanOrEqualTo(name, decimal.MinValue, 0m));
yield return SimpleDataRow(name => Argument.LessThan(name, 0m, 0m));
yield return SimpleDataRow(name => Argument.LessThan(name, PositiveEpsilon, 0m));
yield return SimpleDataRow(name => Argument.LessThan(name, decimal.MaxValue, 0m));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, PositiveEpsilon, 0m));
yield return SimpleDataRow(name => Argument.LessThanOrEqualTo(name, decimal.MaxValue, 0m));
}
}

Expand All @@ -136,6 +167,38 @@ public static IEnumerable<object[]> SuccessVariants {
yield return SuccessDataRow(long.MaxValue, value => Argument.PositiveOrZero("x", value));
yield return SuccessDataRow(0L, value => Argument.PositiveOrZero("x", value));

yield return SuccessDataRow(1, value => Argument.GreaterThan("x", value, 0));
yield return SuccessDataRow(int.MaxValue, value => Argument.GreaterThan("x", value, 0));
yield return SuccessDataRow(0, value => Argument.GreaterThanOrEqualTo("x", value, 0));
yield return SuccessDataRow(1, value => Argument.GreaterThanOrEqualTo("x", value, 0));
yield return SuccessDataRow(int.MaxValue, value => Argument.GreaterThanOrEqualTo("x", value, 0));
yield return SuccessDataRow(-1, value => Argument.LessThan("x", value, 0));
yield return SuccessDataRow(int.MinValue, value => Argument.LessThan("x", value, 0));
yield return SuccessDataRow(0, value => Argument.LessThanOrEqualTo("x", value, 0));
yield return SuccessDataRow(-1, value => Argument.LessThanOrEqualTo("x", value, 0));
yield return SuccessDataRow(int.MinValue, value => Argument.LessThanOrEqualTo("x", value, 0));

yield return SuccessDataRow(double.Epsilon, value => Argument.GreaterThan("x", value, 0.0));
yield return SuccessDataRow(double.MaxValue, value => Argument.GreaterThan("x", value, 0.0));
yield return SuccessDataRow(0.0, value => Argument.GreaterThanOrEqualTo("x", value, 0.0));
yield return SuccessDataRow(double.Epsilon, value => Argument.GreaterThanOrEqualTo("x", value, 0.0));
yield return SuccessDataRow(double.MaxValue, value => Argument.GreaterThanOrEqualTo("x", value, 0.0));
yield return SuccessDataRow(-double.Epsilon, value => Argument.LessThan("x", value, 0.0));
yield return SuccessDataRow(double.MinValue, value => Argument.LessThan("x", value, 0.0));
yield return SuccessDataRow(0.0, value => Argument.LessThanOrEqualTo("x", value, 0.0));
yield return SuccessDataRow(-double.Epsilon, value => Argument.LessThanOrEqualTo("x", value, 0.0));
yield return SuccessDataRow(double.MinValue, value => Argument.LessThanOrEqualTo("x", value, 0.0));

yield return SuccessDataRow(PositiveEpsilon, value => Argument.GreaterThan("x", value, 0m));
yield return SuccessDataRow(decimal.MaxValue, value => Argument.GreaterThan("x", value, 0m));
yield return SuccessDataRow(0m, value => Argument.GreaterThanOrEqualTo("x", value, 0m));
yield return SuccessDataRow(PositiveEpsilon, value => Argument.GreaterThanOrEqualTo("x", value, 0m));
yield return SuccessDataRow(decimal.MaxValue, value => Argument.GreaterThanOrEqualTo("x", value, 0m));
yield return SuccessDataRow(NegativeEpsilon, value => Argument.LessThan("x", value, 0m));
yield return SuccessDataRow(decimal.MinValue, value => Argument.LessThan("x", value, 0m));
yield return SuccessDataRow(0m, value => Argument.LessThanOrEqualTo("x", value, 0m));
yield return SuccessDataRow(NegativeEpsilon, value => Argument.LessThanOrEqualTo("x", value, 0m));
yield return SuccessDataRow(decimal.MinValue, value => Argument.LessThanOrEqualTo("x", value, 0m));
}
}

Expand All @@ -148,4 +211,14 @@ private static object[] SuccessDataRow<T>(T argument, Expression<Func<T, T>> val
{
return new object[] { argument, validate };
}

/// <summary>
/// Represents the smallest possible <see cref="decimal"/> which is greater than zero.
/// </summary>
private static decimal PositiveEpsilon => new decimal(1, 0, 0, false, 28);

/// <summary>
/// Represents the smallest possible <see cref="decimal"/> which is less than zero.
/// </summary>
private static decimal NegativeEpsilon => new decimal(1, 0, 0, true, 28);
}
92 changes: 92 additions & 0 deletions Argument/Argument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,98 @@ public static long PositiveNonZero([NotNull, InvokerParameterName] string name,
return value;
}

/// <summary>
/// Verifies that a given argument value is greater than a given threshold and returns the value provided.
/// </summary>
/// <typeparam name="TValue">The type of the value to be tested.</typeparam>
/// <param name="name">Argument name.</param>
/// <param name="value">Argument value.</param>
/// <param name="threshold">The value to test against.</param>
/// <returns><paramref name="value"/> if it is greater than <paramref name="threshold"/>.</returns>
[AssertionMethod]
[ContractArgumentValidator]
public static TValue GreaterThan<TValue>(
[NotNull, InvokerParameterName] string name,
TValue value,
TValue threshold
)
where TValue : struct, IComparable, IComparable<TValue>
{
if (value.CompareTo(threshold) <= 0)
throw new ArgumentOutOfRangeException(name, value, $"Value cannot be less than or equal to {threshold}.");

return value;
}

/// <summary>
/// Verifies that a given argument value is greater than or equal to a given threshold and returns the value provided.
/// </summary>
/// <typeparam name="TValue">The type of the value to be tested.</typeparam>
/// <param name="name">Argument name.</param>
/// <param name="value">Argument value.</param>
/// <param name="threshold">The value to test against.</param>
/// <returns><paramref name="value"/> if it is greater than or equal to <paramref name="threshold"/>.</returns>
[AssertionMethod]
[ContractArgumentValidator]
public static TValue GreaterThanOrEqualTo<TValue>(
[NotNull, InvokerParameterName] string name,
TValue value,
TValue threshold
)
where TValue : struct, IComparable, IComparable<TValue>
{
if (value.CompareTo(threshold) < 0)
throw new ArgumentOutOfRangeException(name, value, $"Value cannot be less than {threshold}.");

return value;
}

/// <summary>
/// Verifies that a given argument value is less than a given threshold and returns the value provided.
/// </summary>
/// <typeparam name="TValue">The type of the value to be tested.</typeparam>
/// <param name="name">Argument name.</param>
/// <param name="value">Argument value.</param>
/// <param name="threshold">The value to test against.</param>
/// <returns><paramref name="value"/> if it is less than <paramref name="threshold"/>.</returns>
[AssertionMethod]
[ContractArgumentValidator]
public static TValue LessThan<TValue>(
[NotNull, InvokerParameterName] string name,
TValue value,
TValue threshold
)
where TValue : struct, IComparable, IComparable<TValue>
{
if (value.CompareTo(threshold) >= 0)
throw new ArgumentOutOfRangeException(name, value, $"Value cannot be greater than or equal to {threshold}.");

return value;
}

/// <summary>
/// Verifies that a given argument value is less than or equal to a given threshold and returns the value provided.
/// </summary>
/// <typeparam name="TValue">The type of the value to be tested.</typeparam>
/// <param name="name">Argument name.</param>
/// <param name="value">Argument value.</param>
/// <param name="threshold">The value to test against.</param>
/// <returns><paramref name="value"/> if it is less than or equal to <paramref name="threshold"/>.</returns>
[AssertionMethod]
[ContractArgumentValidator]
public static TValue LessThanOrEqualTo<TValue>(
[NotNull, InvokerParameterName] string name,
TValue value,
TValue threshold
)
where TValue : struct, IComparable, IComparable<TValue>
{
if (value.CompareTo(threshold) > 0)
throw new ArgumentOutOfRangeException(name, value, $"Value cannot be greater than {threshold}.");

return value;
}

/// <summary>
/// Provides an extensibility point that can be used by custom argument validation extension methods.
/// </summary>
Expand Down