Add project files.

6 files changed, 431 insertions, 0 deletions

diff --git a/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.csproj b/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.csproj
new file mode 100644
index 0000000..4ffeb9d
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.csproj
@@ -0,0 +1,33 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <Platforms>AnyCPU;x64</Platforms>
+    <Authors>Vaughn Nugent</Authors>
+    <Copyright>Copyright © 2022 Vaughn Nugent</Copyright>
+    <PackageProjectUrl>https://www.vaughnnugent.com/resources</PackageProjectUrl>
+    <Version>1.0.0.1</Version>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <DocumentationFile></DocumentationFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="ErrorProne.NET.Structs" Version="0.1.2">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="FluentValidation" Version="11.2.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\VNLib\Plugins\VNLib.Plugins.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.xml b/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.xml
new file mode 100644
index 0000000..a5ebbcb
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.xml
@@ -0,0 +1,134 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>VNLib.Plugins.Extensions.Validation</name>
+    </assembly>
+    <members>
+        <member name="T:VNLib.Plugins.Extensions.Validation.ValErrWebMessage">
+            <summary>
+            Extends the <see cref="T:VNLib.Plugins.WebMessage"/> class with provisions for a collection of validations
+            </summary>
+        </member>
+        <member name="P:VNLib.Plugins.Extensions.Validation.ValErrWebMessage.Errors">
+            <summary>
+            A collection of error messages to send to clients
+            </summary>
+        </member>
+        <member name="T:VNLib.Plugins.Extensions.Validation.ValidationExtensions">
+            <summary>
+            Defines extenstion methods for <see cref="T:FluentValidation.IRuleBuilder`2"/>
+            </summary>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.GetErrorsAsCollection(FluentValidation.Results.ValidationResult)">
+            <summary>
+            Gets a collection of Json-serializable validation errors
+            </summary>
+            <param name="result"></param>
+            <returns>A collection of json errors to return to a user</returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneNumber``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Tests the the property against <see cref="F:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneRegex"/> 
+            to determine if the string matches the proper phone number form
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="validator"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.EmptyPhoneNumber``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Tests the the property against <see cref="F:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneRegex"/> 
+            to determine if the string matches the proper phone number form, or allows emtpy strings
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="validator"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.SpecialCharacters``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Checks a string against <see cref="!:Statics.SpecialCharacters"/>.
+            If the string is null or empty, it is allowed.
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.IllegalCharacters``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Checks a string against <see cref="!:Statics.IllegalChars"/>.
+            If the string is null or empty, it is allowed.
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Alpha``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Makes sure a field contains at least 1 character a-Z
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Determines if all characters are only a-Z (allows whitespace)
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Numeric``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Makes sure a field contains at least 1 numeral
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.NumericOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Determines if all characters are only 0-9 (not whitespace is allowed)
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaNumeric``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Makes sure the field contains at least 1 alpha numeric character (whitespace included)
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaNumericOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Determines if all characters are only alpha-numeric (whitespace allowed)
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Password``1(FluentValidation.IRuleBuilder{``0,System.String})">
+            <summary>
+            Tests the string against the password regular expression to determine if the 
+            value meets the basic password requirements
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <returns></returns>
+        </member>
+        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Length``1(FluentValidation.IRuleBuilder{``0,System.String},System.Range)">
+            <summary>
+            Defines a length validator on the current rule builder, but only for string properties.
+            Validation will fail if the length of the string is outside of the specified range.
+            The range is inclusive
+            </summary>
+            <typeparam name="T"></typeparam>
+            <param name="builder"></param>
+            <param name="lengthRange">The length range of the specified string</param>
+            <returns></returns>
+        </member>
+    </members>
+</doc>
diff --git a/VNLib.Plugins.Extensions.Validation/ValErrWebMessage.cs b/VNLib.Plugins.Extensions.Validation/ValErrWebMessage.cs
new file mode 100644
index 0000000..118397a
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/ValErrWebMessage.cs
@@ -0,0 +1,17 @@
+using System.Collections;
+using System.Text.Json.Serialization;
+
+namespace VNLib.Plugins.Extensions.Validation
+{
+    /// <summary>
+    /// Extends the <see cref="WebMessage"/> class with provisions for a collection of validations
+    /// </summary>
+    public class ValErrWebMessage:WebMessage
+    {
+        /// <summary>
+        /// A collection of error messages to send to clients
+        /// </summary>
+        [JsonPropertyName("errors")]
+        public ICollection Errors { get; set; }
+    }
+}
diff --git a/VNLib.Plugins.Extensions.Validation/ValidationErrorMessage.cs b/VNLib.Plugins.Extensions.Validation/ValidationErrorMessage.cs
new file mode 100644
index 0000000..f7130c4
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/ValidationErrorMessage.cs
@@ -0,0 +1,12 @@
+using System.Text.Json.Serialization;
+
+namespace VNLib.Plugins.Extensions.Validation
+{
+    public class ValidationErrorMessage
+    {
+        [JsonPropertyName("property")]
+        public string PropertyName { get; set; }
+        [JsonPropertyName("message")]
+        public string ErrorMessage { get; set; }
+    }
+}
diff --git a/VNLib.Plugins.Extensions.Validation/ValidationExtensions.cs b/VNLib.Plugins.Extensions.Validation/ValidationExtensions.cs
new file mode 100644
index 0000000..fd7880e
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/ValidationExtensions.cs
@@ -0,0 +1,54 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+using FluentValidation;
+using FluentValidation.Results;
+
+#nullable enable
+
+namespace VNLib.Plugins.Extensions.Validation
+{
+    /// <summary>
+    /// Provides shortcut methods to aid programmatic validation of objects
+    /// </summary>
+    public static class ValidationExtensions
+    {
+        /// <summary>
+        /// If <paramref name="assertion"/> evalues to false, sets the specified assertion message
+        /// to the <see cref="WebMessage.Result"/> to the specified string
+        /// </summary>
+        /// <param name="webm"></param>
+        /// <param name="assertion">The result of the assertion</param>
+        /// <param name="message">The error message to store when the value is false</param>
+        /// <returns>The inverse of <paramref name="assertion"/></returns>
+        public static bool Assert(this WebMessage webm, [DoesNotReturnIf(false)] bool assertion, string message)
+        {
+            if(!assertion)
+            {
+                webm.Success = false;
+                webm.Result = message;
+            }
+            return !assertion;
+        }
+        /// <summary>
+        /// Validates the specified instance, and stores errors to the specified <paramref name="webMessage"/>
+        /// and sets the <see cref="ValErrWebMessage.IsError"/>
+        /// </summary>
+        /// <param name="instance">The instance to validate</param>
+        /// <param name="validator"></param>
+        /// <param name="webMessage">The <see cref="ValErrWebMessage"/> to store errors to</param>
+        /// <returns>True if the result of the validation is valid, false otherwise and the <paramref name="webMessage"/> is not modified</returns>
+        public static bool Validate<T>(this IValidator<T> validator, T instance, ValErrWebMessage webMessage)
+        {
+            //Validate value
+            ValidationResult result = validator.Validate(instance);
+            //If not valid, set errors on web message
+            if (!result.IsValid)
+            {
+                webMessage.Success = false;
+                webMessage.Errors = result.GetErrorsAsCollection();
+            }
+            return result.IsValid;
+        }
+    }
+}
diff --git a/VNLib.Plugins.Extensions.Validation/ValidatorExtensions.cs b/VNLib.Plugins.Extensions.Validation/ValidatorExtensions.cs
new file mode 100644
index 0000000..172074d
--- /dev/null
+++ b/VNLib.Plugins.Extensions.Validation/ValidatorExtensions.cs
@@ -0,0 +1,181 @@
+using System;
+using System.Collections;
+using System.Text.RegularExpressions;
+
+using FluentValidation;
+using FluentValidation.Results;
+
+namespace VNLib.Plugins.Extensions.Validation
+{
+    /// <summary>
+    /// Defines extenstion methods for <see cref="IRuleBuilder{T, TProperty}"/>
+    /// </summary>
+    public static class ValidatorExtensions
+    {
+        public static readonly Regex PhoneRegex = new(@"^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$", RegexOptions.Compiled);
+
+        public static readonly Regex AlphaRegx = new(@"[a-zA-Z]*", RegexOptions.Compiled);
+        public static readonly Regex NumericRegx = new(@"[0-9]*", RegexOptions.Compiled);
+        public static readonly Regex AlphaNumRegx = new(@"[a-zA-Z0-9]*", RegexOptions.Compiled);
+
+        public static readonly Regex OnlyAlphaRegx = new(@"^[a-zA-Z\s]*$", RegexOptions.Compiled);
+        public static readonly Regex OnlyNumericRegx = new(@"^[0-9]*$", RegexOptions.Compiled);
+        public static readonly Regex OnlyAlphaNumRegx = new(@"^[a-zA-Z0-9\s]*$", RegexOptions.Compiled);
+
+        public static readonly Regex PasswordRegx = new(@"^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$ %^&*-])", RegexOptions.Compiled);
+        public static readonly Regex IllegalRegx = new(@"[\r\n\t\a\b\e\f|^~`<>{}]", RegexOptions.Compiled);
+        public static readonly Regex SpecialCharactersRegx = new(@"[\r\n\t\a\b\e\f#?!@$%^&*\+\-\~`|<>\{}]", RegexOptions.Compiled);
+
+
+        /// <summary>
+        /// Gets a collection of Json-serializable validation errors
+        /// </summary>
+        /// <param name="result"></param>
+        /// <returns>A collection of json errors to return to a user</returns>
+        public static ICollection GetErrorsAsCollection(this ValidationResult result)
+        {
+            return result.Errors.ConvertAll(static err => new ValidationErrorMessage { ErrorMessage = err.ErrorMessage, PropertyName = err.PropertyName });
+        }
+
+        /// <summary>
+        /// Tests the the property against <see cref="PhoneRegex"/> 
+        /// to determine if the string matches the proper phone number form
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> PhoneNumber<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static phone => phone?.Length > 0 && PhoneRegex.IsMatch(phone))
+                          .WithMessage("{PropertyValue} is not a valid phone number.");
+        }
+        /// <summary>
+        /// Tests the the property against <see cref="PhoneRegex"/> 
+        /// to determine if the string matches the proper phone number form, or allows emtpy strings
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> EmptyPhoneNumber<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static phone => !(phone?.Length).HasValue || PhoneRegex.IsMatch(phone))
+                          .WithMessage("{PropertyValue} is not a valid phone number.");
+        }
+
+        /// <summary>
+        /// Checks a string against <see cref="Statics.SpecialCharacters"/>.
+        /// If the string is null or empty, it is allowed.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> SpecialCharacters<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || !SpecialCharactersRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} contains illegal characters");
+        }
+        /// <summary>
+        /// Checks a string against <see cref="Statics.IllegalChars"/>.
+        /// If the string is null or empty, it is allowed.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> IllegalCharacters<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || !IllegalRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} contains illegal characters");
+        }
+        /// <summary>
+        /// Makes sure a field contains at least 1 character a-Z
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> Alpha<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || AlphaRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} requires at least one a-Z character.");
+        }
+        /// <summary>
+        /// Determines if all characters are only a-Z (allows whitespace)
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> AlphaOnly<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || OnlyAlphaRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} can only be a alpha character from a-Z.");
+        }
+        /// <summary>
+        /// Makes sure a field contains at least 1 numeral
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> Numeric<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || NumericRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} requires at least one number.");
+        }
+        /// <summary>
+        /// Determines if all characters are only 0-9 (not whitespace is allowed)
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> NumericOnly<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || OnlyNumericRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} can only be a number 0-9.");
+        }
+        /// <summary>
+        /// Makes sure the field contains at least 1 alpha numeric character (whitespace included)
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> AlphaNumeric<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || AlphaNumRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} must contain at least one alpha-numeric character.");
+        }
+        /// <summary>
+        /// Determines if all characters are only alpha-numeric (whitespace allowed)
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> AlphaNumericOnly<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || OnlyAlphaNumRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} can only contain alpha numeric characters.");
+        }
+        /// <summary>
+        /// Tests the string against the password regular expression to determine if the 
+        /// value meets the basic password requirements
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> Password<T>(this IRuleBuilder<T, string> builder)
+        {
+            return builder.Must(static str => str == null || PasswordRegx.IsMatch(str))
+                          .WithMessage("{PropertyName} does not meet password requirements.");
+        }
+        /// <summary>
+        /// Defines a length validator on the current rule builder, but only for string properties.
+        /// Validation will fail if the length of the string is outside of the specified range.
+        /// The range is inclusive
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="builder"></param>
+        /// <param name="lengthRange">The length range of the specified string</param>
+        /// <returns></returns>
+        public static IRuleBuilderOptions<T, string> Length<T>(this IRuleBuilder<T, string> builder, Range lengthRange)
+        {
+            return builder.Length(lengthRange.Start.Value, lengthRange.End.Value);
+        }
+    }
+}