Refactored and added testing

Author: Joshua-Lester3

EssentialCSharp.Web.Tests/SiteMappingTests.cs

@@ -78,4 +78,61 @@ public void FindCSyntaxFundamentalsSanitizedWithAnchorReturnsCorrectSiteMap()
         Assert.NotNull(foundSiteMap);
         Assert.Equal(CSyntaxFundamentalsSiteMapping, foundSiteMap);
     }
+
+    [Fact]
+    public void FindPercentComplete_KeyIsNull_ThrowsArgumentNullException()
+    {
+        // Arrange
+
+        // Act
+
+        // Assert
+        Assert.Throws<ArgumentNullException>(() =>
+        {
+            GetSiteMap().FindPercentComplete(null!);
+        });
+    }
+
+    [Theory]
+    [InlineData("   ")]
+    [InlineData("")]
+    public void FindPercentComplete_KeyIsWhiteSpace_ThrowsArgumentException(string key)
+    {
+        // Arrange
+
+        // Act
+
+        // Assert
+        Assert.Throws<ArgumentException>(() =>
+        {
+            GetSiteMap().FindPercentComplete(key);
+        });
+    }
+
+    [Theory]
+    [InlineData("hello-world", "50.00")]
+    [InlineData("c-syntax-fundamentals", "100.00")]
+    public void FindPercentComplete_ValidKey_Success(string key, string result)
+    {
+        // Arrange
+
+        // Act
+        string percent = GetSiteMap().FindPercentComplete(key);
+
+        // Assert
+        Assert.Equal(result, percent);
+    }
+
+    [Fact]
+    public void FindPercentComplete_EmptySiteMappings_ReturnsZeroPercent()
+    {
+        // Arrange
+        IList<SiteMapping> siteMappings = new List<SiteMapping>();
+
+        // Act
+        string percent = siteMappings.FindPercentComplete("test");
+
+        // Assert
+        Assert.Equal("0.00", percent);
+    }
 }

EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs

@@ -1,4 +1,7 @@
-namespace EssentialCSharp.Web.Extensions;
+using EssentialCSharp.Common;
+using System.Globalization;
+
+namespace EssentialCSharp.Web.Extensions;
 
 public static class SiteMappingListExtensions
 {
@@ -23,4 +26,43 @@ public static class SiteMappingListExtensions
         }
         return null;
     }
+    /// <summary>
+    /// Finds percent complete based on a key.
+    /// </summary>
+    /// <param name="siteMappings">IList of SiteMappings</param>
+    /// <param name="key">If null, uses the first key in the list</param>
+    /// <returns>Returns a formatted double for use as the percent complete.</returns>
+    public static string FindPercentComplete(this IList<SiteMapping> siteMappings, string key)
+    {
+        ArgumentNullException.ThrowIfNullOrWhiteSpace(key);
+        int currentMappingCount = 0;
+        int overallMappingCount = 0;
+        bool currentPageFound = false;
+        IEnumerable<IGrouping<int, SiteMapping>> chapterGroupings = siteMappings.GroupBy(x => x.ChapterNumber).OrderBy(g => g.Key);
+        foreach (IGrouping<int, SiteMapping> chapterGrouping in chapterGroupings)
+        {
+            IEnumerable<IGrouping<int, SiteMapping>> pageGroupings = chapterGrouping.GroupBy(x => x.PageNumber).OrderBy(g => g.Key);
+            foreach (IGrouping<int, SiteMapping> pageGrouping in pageGroupings)
+            {
+                foreach (SiteMapping siteMapping in pageGrouping)
+                {
+                    if (!currentPageFound)
+                    {
+                        currentMappingCount++;
+                    }
+                    overallMappingCount++;
+                    if (siteMapping.Key == key)
+                    {
+                        currentPageFound = true;
+                    }
+                }
+            }
+        }
+        if (overallMappingCount is 0)
+        {
+            return "0.00";
+        }
+        double result = (double)currentMappingCount / overallMappingCount * 100;
+        return string.Format(CultureInfo.InvariantCulture, "{0:0.00}", result);
+    }
 }

EssentialCSharp.Web/Services/ISiteMappingService.cs

@@ -3,5 +3,4 @@
 public interface ISiteMappingService
 {
     IList<SiteMapping> SiteMappings { get; }
-    string GetPercentComplete(string currentPageKey);
 }

EssentialCSharp.Web/Services/SiteMappingService.cs

@@ -12,33 +12,4 @@ public SiteMappingService(IWebHostEnvironment webHostEnvironment)
         List<SiteMapping>? siteMappings = System.Text.Json.JsonSerializer.Deserialize<List<SiteMapping>>(File.OpenRead(path)) ?? throw new InvalidOperationException("No table of contents found");
         SiteMappings = siteMappings;
     }
-
-    public string GetPercentComplete(string currentPageKey)
-    {
-        int currentMappingCount = 1;
-        int overallMappingCount = 1;
-        bool currentPageFound = false;
-        IEnumerable<IGrouping<int, SiteMapping>> chapterGroupings = SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(g => g.Key);
-        foreach (IGrouping<int, SiteMapping> chapterGrouping in chapterGroupings)
-        {
-            IEnumerable<IGrouping<int, SiteMapping>> pageGroupings = chapterGrouping.GroupBy(x => x.PageNumber).OrderBy(g => g.Key);
-            foreach (IGrouping<int, SiteMapping> pageGrouping in pageGroupings)
-            {
-                foreach (SiteMapping siteMapping in pageGrouping)
-                {
-                    if (siteMapping.Key == currentPageKey)
-                    {
-                        currentPageFound = true;
-                    }
-                    if (!currentPageFound)
-                    {
-                        currentMappingCount++;
-                    }
-                    overallMappingCount++;
-                }
-            }
-        }
-        double result = (double)currentMappingCount / overallMappingCount * 100;
-        return string.Format(CultureInfo.InvariantCulture, "{0:0.00}", result);
-    }
 }

EssentialCSharp.Web/Views/Shared/_Layout.cshtml

@@ -296,7 +296,7 @@
                 Items = GetItems(x, 1)
             });
 
-            var percentComplete = _SiteMappings.GetPercentComplete(ViewBag.CurrentPageKey);
+            var percentComplete = _SiteMappings.SiteMappings.FindPercentComplete((string) ViewBag.CurrentPageKey);
         }
             PERCENT_COMPLETE = @Json.Serialize(percentComplete);
             PREVIOUS_PAGE = @Json.Serialize(ViewBag.PreviousPage)