✨ feature: Create Pluralize Extension for Enumerable (#56)

* Add Pluralize Extension for Enumerable

* Add Unit Test

Author: TylerCarrol

TJC.StringExtensions.Tests/Pluralize/PluralizeExtensionsTests.cs

@@ -6,7 +6,7 @@ namespace TJC.StringExtensions.Tests.Pluralize;
 public class PluralizeExtensionsTests
 {
     [TestMethod]
-    public void Pluralize_ObjectCollection_CountZero_ReturnsNonPluralized()
+    public void Pluralize_ObjectCollection_CountZero_ReturnsPluralized()
     {
         // Arrange
         var objects = new List<object>();
@@ -31,6 +31,19 @@ public void Pluralize_ObjectCollection_CountOne_ReturnsNonPluralized()
         Assert.AreEqual("item", result);
     }
 
+    [TestMethod]
+    public void Pluralize_ObjectCollection_CountTwo_ReturnsPluralized()
+    {
+        // Arrange
+        var objects = new List<object>();
+
+        // Act
+        var result = "item".Pluralize(objects);
+
+        // Assert
+        Assert.AreEqual("items", result);
+    }
+
     [DataRow(0, "items")]
     [DataRow(1, "item")]
     [DataRow(2, "items")]

TJC.StringExtensions/Pluralize/PluralizeExtensions.cs

@@ -6,7 +6,7 @@
 public static class PluralizeExtensions
 {
     /// <summary>
-    /// Pluralized a string based upon the number of objects within a collection
+    /// Pluralize a string based upon the number of objects within a collection.
     /// </summary>
     /// <param name="objects">Collection to check if we require a pluralized output or not</param>
     /// <param name="nonPluralized">Non-Pluralized form of the string</param>
@@ -18,7 +18,19 @@ public static string Pluralize(this IEnumerable<object> objects,
         nonPluralized.Pluralize(objects.Count(), pluralized);
 
     /// <summary>
-    /// Pluralized a string based upon the value of number
+    /// Pluralize a string based upon the number of objects within a collection.
+    /// </summary>
+    /// <param name="objects">Collection to check if we require a pluralized output or not</param>
+    /// <param name="nonPluralized">Non-Pluralized form of the string</param>
+    /// <param name="pluralized">(Optional) Pluralized form of the string. If omitted, will return the Non-Pluralized form of the string with an 's' on the end</param>
+    /// <returns></returns>
+    public static string Pluralize(this string nonPluralized,
+                                   IEnumerable<object> objects,
+                                   string? pluralized = null) =>
+        nonPluralized.Pluralize(objects.Count(), pluralized);
+
+    /// <summary>
+    /// Pluralize a string based upon the value of number.
     /// </summary>
     /// <param name="nonPluralized">Non-Pluralized form of the string</param>
     /// <param name="number">Number (Pluralize unless equal to 1)</param>
@@ -30,7 +42,7 @@ public static string Pluralize(this string nonPluralized,
         nonPluralized.Pluralize(!number.IsOne(), pluralized);
 
     /// <summary>
-    /// Pluralized a string based upon the value of number
+    /// Pluralize a string based upon the value of number.
     /// </summary>
     /// <param name="nonPluralized">Non-Pluralized form of the string</param>
     /// <param name="number">Number (Pluralize unless equal to 1)</param>
@@ -42,7 +54,7 @@ public static string Pluralize(this string nonPluralized,
         nonPluralized.Pluralize(!number.IsOne(), pluralized);
 
     /// <summary>
-    /// Pluralized a string based upon a boolean
+    /// Pluralize a string based upon a boolean.
     /// </summary>
     /// <param name="nonPluralized">Non-Pluralized form of the string</param>
     /// <param name="pluralize">Should we pluralize or not</param>