Merge pull request #15 from TechNobre/main

Deploy version 2.3.0

Author: NelsonBN

CHANGELOG.md

@@ -3,11 +3,21 @@
 
 
 
+## [2.3.0] - 2022-04-05
+[Full Changelog](https://github.com/TechNobre/PowerUtils.GuardClauses.Validations/compare/v2.2.1...v2.3.0)
+
+
+### New Features
+- Added Guard `Guard.Validate.IfLengthOutOfRange()`;
+
+
+
+
 ## [2.2.1] - 2022-04-04
 [Full Changelog](https://github.com/TechNobre/PowerUtils.GuardClauses.Validations/compare/v2.2.0...v2.2.1)
 
 
-### Fixes
+### Fixed
 - Returned the same type as the input value for `Guard.Validate.IfNull()`;
 - Added again the the specific `Guard.Validate.IfNull()` for strings;
 

README.md

@@ -95,11 +95,12 @@ dotnet add package PowerUtils.GuardClauses.Validations
   - `Guard.Validate.IfNullOrWhiteSpace()`;
   - `Guard.Validate.IfLongerThan()`;
   - `Guard.Validate.IfShorterThan()`;
-  - `Guard.Validate.IfNotEmail()`;
+  - `Guard.Validate.IfLengthOutOfRange()`;
   - `Guard.Validate.IfLengthEquals()`;
   - `Guard.Validate.IfLengthDifferent()`;
   - `Guard.Validate.IfEquals()`;
   - `Guard.Validate.IfDifferent()`;
+  - `Guard.Validate.IfNotEmail()`;
 - __short, ushort, int, uint, long, ulong, float, double, decimal:__
   - `Guard.Validate.IfGreaterThan()`;
   - `Guard.Validate.IfLessThan()`;

src/GuardClauses/GuardValidationStringExtensions.cs

@@ -144,7 +144,7 @@ public static string IfLongerThan(
         /// </summary>
         /// <param name="_"></param>
         /// <param name="value">Value to validate</param>
-        /// <param name="minLength">Max length</param>
+        /// <param name="minLength">Min length</param>
         /// <param name="parameterName">If not defined, the name of the variable passed by the <paramref name="value"/> parameter will be used</param>
         /// <exception cref="PropertyException">Exception thrown when the length of the value is less than</exception>
         [System.Obsolete("This method is deprecated. It will be removed on 2022/09/30. Use the new method 'string.IfShorterThan'")]
@@ -160,7 +160,7 @@ public static string IfLengthLessThan(
         /// </summary>
         /// <param name="_"></param>
         /// <param name="value">Value to validate</param>
-        /// <param name="minLength">Max length</param>
+        /// <param name="minLength">Min length</param>
         /// <param name="parameterName">If not defined, the name of the variable passed by the <paramref name="value"/> parameter will be used</param>
         /// <exception cref="PropertyException">Exception thrown when the value is shorter than</exception>
         public static string IfShorterThan(
@@ -363,5 +363,40 @@ public static string IfDifferent(
 
             return value;
         }
+
+        /// <summary>
+        /// Throws an <see cref="PropertyException" /> if <paramref name="value"/> has a length out of range. Error code 'MIN:{X}' or 'MAX:{X}'
+        /// </summary>
+        /// <param name="_"></param>
+        /// <param name="value">Value to validate</param>
+        /// <param name="minLength">Min length</param>
+        /// <param name="maxLength">Max length</param>
+        /// <param name="parameterName">If not defined, the name of the variable passed by the <paramref name="value"/> parameter will be used</param>
+        /// <exception cref="PropertyException">Exception thrown when the length of the value is out of range</exception>
+        public static string IfLengthOutOfRange(
+            this IGuardValidationClause _,
+            string value,
+            int minLength,
+            int maxLength,
+            [CallerArgumentExpression("value")] string parameterName = null
+        )
+        {
+            if(value == null)
+            {
+                return value;
+            }
+
+            if(value.Length < minLength)
+            {
+                throw new PropertyException(parameterName, ErrorCodes.GetMinFormatted(minLength));
+            }
+
+            if(value.Length > maxLength)
+            {
+                throw new PropertyException(parameterName, ErrorCodes.GetMaxFormatted(maxLength));
+            }
+
+            return value;
+        }
     }
 }

src/PowerUtils.GuardClauses.Validations.csproj

@@ -14,7 +14,7 @@
     <PackageId>PowerUtils.GuardClauses.Validations</PackageId>
     <title>PowerUtils.GuardClauses.Validations</title>
     <Product>PowerUtils.GuardClauses.Validations</Product>
-    <Version>2.2.1</Version>
+    <Version>2.3.0</Version>
 
     <Authors>Nelson Nobre</Authors>
     <Company>TechNobre</Company>

tests/PowerUtils.GuardClauses.Validations.Tests/GuardClausesTests/GuardValidationStringExtensionsTests.cs

@@ -979,7 +979,11 @@ public void IfNotEmail_WithSpace_Exception()
 
 
         // Assert
-        act.Validate<PropertyException>(HttpStatusCode.BadRequest, nameof(clientEmail), "INVALID");
+        act.Validate<PropertyException>(
+            HttpStatusCode.BadRequest,
+            nameof(clientEmail),
+            "INVALID"
+        );
     }
 
     [Fact]
@@ -994,7 +998,11 @@ public void IfNotEmail_FakeText_Exception()
 
 
         // Assert
-        act.Validate<PropertyException>(HttpStatusCode.BadRequest, nameof(clientEmail), "INVALID");
+        act.Validate<PropertyException>(
+            HttpStatusCode.BadRequest,
+            nameof(clientEmail),
+            "INVALID"
+        );
     }
 
     [Fact]
@@ -1012,4 +1020,74 @@ public void IfNotEmail_Email_Valid()
         act.Should()
             .Be(clientEmail);
     }
+
+    [Fact]
+    public void IfLengthOutOfRange_Null_Valid()
+    {
+        // Arrange
+        string name = null;
+
+
+        // Act
+        var act = Record.Exception(() => Guard.Validate.IfLengthOutOfRange(name, 4, 7));
+
+
+        // Assert
+        act.Should()
+            .Be(name);
+    }
+
+    [Fact]
+    public void IfLengthOutOfRange_Short_Exception()
+    {
+        // Arrange
+        var name = "ola";
+
+
+        // Act
+        var act = Record.Exception(() => Guard.Validate.IfLengthOutOfRange(name, 4, 7));
+
+
+        // Assert
+        act.Validate<PropertyException>(
+            HttpStatusCode.BadRequest,
+            nameof(name),
+            ErrorCodes.GetMinFormatted(4)
+        );
+    }
+
+    [Fact]
+    public void IfLengthOutOfRange_Longer_Exception()
+    {
+        // Arrange
+        var name = "Vel ut gubergren est ut sed blandit ipsum";
+
+
+        // Act
+        var act = Record.Exception(() => Guard.Validate.IfLengthOutOfRange(name, 4, 7));
+
+
+        // Assert
+        act.Validate<PropertyException>(
+            HttpStatusCode.BadRequest,
+            nameof(name),
+            ErrorCodes.GetMaxFormatted(7)
+        );
+    }
+
+    [Fact]
+    public void IfLengthOutOfRange_Valid_SameValue()
+    {
+        // Arrange
+        var name = "Power";
+
+
+        // Act
+        var act = Guard.Validate.IfLengthOutOfRange(name, 4, 7);
+
+
+        // Assert
+        act.Should()
+            .Be(name);
+    }
 }