IsItValid 1.0.0

IsItValid

IsItValid is a powerful and flexible validation library designed to simplify data validation in .NET applications. It provides a fluent API for defining and enforcing validation rules on various data types, including primitives, strings, collections, dates, and custom objects. With built-in support for common validation scenarios and extensibility for custom rules, IsItValid ensures data integrity and consistency in your applications.

Documentation

The library contains the following methods required for validating data of various types:

Base methods

• RuleFor() - Sets the value to be validated.
• AddRule() - Adds a custom validation rule to the validation pipeline.
• Validate() - Validates the current value against all registered rules.
• ThrowIfInvalid() - Throws an exception if the current value fails any validation rule.
• NotEmpty() - Adds a rule to ensure the value is not empty.
• Empty() - Adds a rule to ensure the value is empty.
• NotNull() - Adds a rule to ensure the value is not null.
• Null() - Adds a rule to ensure the value is null.
• Type() - Adds a rule to ensure the value is of the specified type.
• NotType() - Adds a rule to ensure the value is not of the specified type.

Boolean methods

• True() - Adds a rule to ensure that the specified condition evaluates to true for the current value.
• False() - Adds a rule to ensure that the specified condition evaluates to false for the current value.

Collection methods

• Count() - Adds a rule to ensure that the enumerable value contains exactly the specified number of elements.
• MinCount() - Adds a rule to ensure that the enumerable value contains at least the specified number of elements.
• MaxCount() - Adds a rule to ensure that the enumerable value contains no more than the specified number of elements.
• ContainElement() - Adds a rule to ensure that the enumerable value contains the specified element.
• DoesNotContainElement() - Adds a rule to ensure that the enumerable value does not contain the specified element.
• All() - Adds a rule to ensure that all elements in the enumerable value satisfy the specified condition.
• Any() - Adds a rule to ensure that at least one element in the enumerable value satisfies the specified condition.
• Distinct() - Adds a rule to ensure that all elements in the enumerable value are distinct.
• Ascending() - Adds a rule to ensure that the enumerable value is sorted in ascending order.
• Ascending() - Adds a rule to ensure that the enumerable is sorted in descending order based on a specified property.
• Descending() - Adds a rule to ensure that the enumerable value is sorted in descending order.
• Descending() - Adds a rule to ensure that the enumerable is sorted in descending order based on a specified property.

Date methods

• After() - Adds a rule to ensure that the value occurs after the specified DateTime.
• Before() - Adds a rule to ensure that the value occurs before the specified DateTime.
• InRange() - Adds a rule to ensure that the value falls within the specified range (inclusive).
• NotInRange() - Adds a rule to ensure that the value falls outside the specified range (exclusive).

Numeric methods

• GreaterThan() - Adds a rule to ensure that the numeric value is greater than the specified value.
• GreaterThanOrEqualTo() - Adds a rule to ensure that the numeric value is greater than or equal to the specified value.
• LessThan() - Adds a rule to ensure that the numeric value is less than the specified value.
• LessThanOrEqualTo() - Adds a rule to ensure that the numeric value is less than or equal to the specified value.
• EqualTo() - Adds a rule to ensure that the numeric value is equal to the specified value.
• NotEqualTo() - Adds a rule to ensure that the numeric value is not equal to the specified value.
• InRange() - Adds a rule to ensure that the numeric value falls within the specified range (inclusive).
• NotInRange() - Adds a rule to ensure that the numeric value falls outside the specified range (exclusive).
• Positive() - Adds a rule to ensure that the numeric value is positive.
• Negative() - Adds a rule to ensure that the numeric value is negative.
• Even() - Adds a rule to ensure that the numeric value is even.
• Odd() - Adds a rule to ensure that the numeric value is odd.

String methods

• MinLength() - Adds a rule to ensure that the string value has a minimum length.
• MaxLength() - Adds a rule to ensure that the string value has a maximum length.
• Length() - Adds a rule to ensure that the string value has an exact length.
• Match() - Adds a rule to ensure that the string value matches the specified regular expression pattern.
• DoesNotMatch() - Adds a rule to ensure that the string value does not match the specified regular expression pattern.
• Email() - Adds a rule to ensure that the string value is a valid email address.
• Url() - Adds a rule to ensure that the string value is a valid URL.
• Phone() - Adds a rule to ensure that the string value is a valid phone number.
• StartWith() - Adds a rule to ensure that the string value starts with the specified substring.
• EndWith() - Adds a rule to ensure that the string value ends with the specified substring.
• Contain() - Adds a rule to ensure that the string value contains the specified substring.
• DoesNotContain() - Adds a rule to ensure that the string value does not contain the specified substring.
• EqualTo() - Adds a rule to ensure that the string value is equal to the specified string.
• NotEqualTo() - Adds a rule to ensure that the string value is not equal to the specified string.
• Guid() - Adds a rule to ensure the value is a valid GUID.
• IpAddress() - Adds a rule to ensure the value is a valid IP address.

Usage

It is necessary to initialize an instance of the ValidationBuilder class:

private readonly ValidationBuilder validator = new();

To create the next validation rule, you need to use the RuleFor() method:

 var valid = validator.RuleFor(data).Count(3).Validate();

Next, you can use methods to validate the variable, field, or property that you passed to the RuleFor() method parameter:

validator.RuleFor(asc).Ascending(v => ((TestClass)v).Number).Validate();
validator.RuleFor(name).Type<string>().Validate();
validator.RuleFor(name).Empty().ThrowIfInvalid<ArgumentException>();
validator.RuleFor(age).True(v => (int)v == 20).Validate();
validator.RuleFor(age).GreaterThanOrEqualTo(20).Validate();
validator.RuleFor(password).Match(pattern).Validate();
validator.RuleFor(name).MinLength(2).MaxLength(6).Validate();

Installation

To install the package, use the following command:

dotnet add package IsItValid

or via NuGet Package Manager:

Install-Package IsItValid