From 245bea879d3a92ff4c735607cfe291c971635173 Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 22 Oct 2024 15:49:47 -0700 Subject: [PATCH 1/8] Counting mechanism works --- .../Controllers/HomeController.cs | 1 + .../Views/Shared/_Layout.cshtml | 27 +++++++++++++++++-- EssentialCSharp.Web/wwwroot/js/site.js | 6 +++++ 3 files changed, 32 insertions(+), 2 deletions(-) diff --git a/EssentialCSharp.Web/Controllers/HomeController.cs b/EssentialCSharp.Web/Controllers/HomeController.cs index f20f0ee0..690d063a 100644 --- a/EssentialCSharp.Web/Controllers/HomeController.cs +++ b/EssentialCSharp.Web/Controllers/HomeController.cs @@ -41,6 +41,7 @@ public IActionResult Index(string key) ViewBag.PageTitle = siteMapping.IndentLevel is 0 ? siteMapping.ChapterTitle + " " + siteMapping.RawHeading : siteMapping.RawHeading; ViewBag.NextPage = FlipPage(siteMapping!.ChapterNumber, siteMapping.PageNumber, true); + ViewBag.CurrentPageKey = siteMapping.Key; ViewBag.PreviousPage = FlipPage(siteMapping.ChapterNumber, siteMapping.PageNumber, false); ViewBag.HeadContents = headHtml; ViewBag.Contents = html; diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index 04a9367b..d764c3b5 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml @@ -123,6 +123,9 @@ {{chapterParentPage.title}} +
+ {{currentPageCount}} / {{totalPageCount}} +
@@ -292,8 +295,29 @@ Title = $"Chapter {x.Key}: {x.First().ChapterTitle}", Items = GetItems(x, 1) }); + var groupedTocData = _SiteMappings.SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(x => x.Key); + int currentPageCount = 0; + int overallCount = 0; + bool currentPageFound = false; + foreach (IGrouping group in groupedTocData) + { + var orderedGroup = group.OrderBy(x => x.PageNumber); + foreach (SiteMapping siteMapping in orderedGroup) + { + if (siteMapping.Key == ViewBag.CurrentPageKey) + { + currentPageFound = true; + } + if (!currentPageFound) + { + currentPageCount++; + } + overallCount++; + } + } } - + CURRENT_PAGE_COUNT = @Json.Serialize(currentPageCount) + TOTAL_PAGE_COUNT = @Json.Serialize(overallCount) PREVIOUS_PAGE = @Json.Serialize(ViewBag.PreviousPage) NEXT_PAGE = @Json.Serialize(ViewBag.NextPage) TOC_DATA = @Json.Serialize(tocData) @@ -343,6 +367,5 @@ - diff --git a/EssentialCSharp.Web/wwwroot/js/site.js b/EssentialCSharp.Web/wwwroot/js/site.js index a3e95e07..4df89c7b 100644 --- a/EssentialCSharp.Web/wwwroot/js/site.js +++ b/EssentialCSharp.Web/wwwroot/js/site.js @@ -18,6 +18,7 @@ import { useWindowSize } from "vue-window-size"; * @prop {TocItem[]} [items] */ /** @type {TocItem} */ +debugger; const tocData = markRaw(TOC_DATA); //Add new content or features here: @@ -194,6 +195,9 @@ const app = createApp({ const currentPage = findCurrentPage([], tocData) ?? []; + const currentPageCount = CURRENT_PAGE_COUNT; + const totalPageCount = TOTAL_PAGE_COUNT; + const chapterParentPage = currentPage.find((parent) => parent.level === 0); const sectionTitle = ref(currentPage?.[0]?.title || "Essential C#"); @@ -311,6 +315,8 @@ const app = createApp({ tocData, expandedTocs, currentPage, + currentPageCount, + totalPageCount, chapterParentPage, searchQuery, From a9cc80907d95091fb82db505e50602c0a4d63085 Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Wed, 23 Oct 2024 08:59:28 -0700 Subject: [PATCH 2/8] save changes --- EssentialCSharp.Web/Controllers/HomeController.cs | 2 ++ EssentialCSharp.Web/Views/Shared/_Layout.cshtml | 13 ++++++++++--- EssentialCSharp.Web/wwwroot/js/site.js | 2 ++ 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/EssentialCSharp.Web/Controllers/HomeController.cs b/EssentialCSharp.Web/Controllers/HomeController.cs index 690d063a..a902fe9e 100644 --- a/EssentialCSharp.Web/Controllers/HomeController.cs +++ b/EssentialCSharp.Web/Controllers/HomeController.cs @@ -53,6 +53,8 @@ public IActionResult Index(string key) } } + + [Route("/TermsOfService", Name = "TermsOfService")] public IActionResult TermsOfService() diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index d764c3b5..72849b16 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml @@ -124,7 +124,8 @@ {{chapterParentPage.title}}
- {{currentPageCount}} / {{totalPageCount}} +
{{currentPageCount}} / {{totalPageCount}}
@@ -296,9 +297,13 @@ Items = GetItems(x, 1) }); var groupedTocData = _SiteMappings.SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(x => x.Key); - int currentPageCount = 0; - int overallCount = 0; + int currentPageCount = 1; + int overallCount = 1; bool currentPageFound = false; + List keyList = new(); + + // Loop through each SiteMapping and increment the overallCount, + // currentPageFound (until you reach it), and build keyList out foreach (IGrouping group in groupedTocData) { var orderedGroup = group.OrderBy(x => x.PageNumber); @@ -312,12 +317,14 @@ { currentPageCount++; } + keyList.Add(siteMapping.Key); overallCount++; } } } CURRENT_PAGE_COUNT = @Json.Serialize(currentPageCount) TOTAL_PAGE_COUNT = @Json.Serialize(overallCount) + KEY_LIST = @Json.Serialize(keyList) PREVIOUS_PAGE = @Json.Serialize(ViewBag.PreviousPage) NEXT_PAGE = @Json.Serialize(ViewBag.NextPage) TOC_DATA = @Json.Serialize(tocData) diff --git a/EssentialCSharp.Web/wwwroot/js/site.js b/EssentialCSharp.Web/wwwroot/js/site.js index 4df89c7b..5a36d672 100644 --- a/EssentialCSharp.Web/wwwroot/js/site.js +++ b/EssentialCSharp.Web/wwwroot/js/site.js @@ -197,6 +197,7 @@ const app = createApp({ const currentPageCount = CURRENT_PAGE_COUNT; const totalPageCount = TOTAL_PAGE_COUNT; + const keyList = KEY_LIST const chapterParentPage = currentPage.find((parent) => parent.level === 0); @@ -317,6 +318,7 @@ const app = createApp({ currentPage, currentPageCount, totalPageCount, + keyList, chapterParentPage, searchQuery, From 12235d5774a4aefd87c843734c3ef13c92d1346f Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 12 Nov 2024 12:15:09 -0800 Subject: [PATCH 3/8] save --- EssentialCSharp.Web/Views/Shared/_Layout.cshtml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index 72849b16..c382e33c 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml @@ -124,7 +124,6 @@ {{chapterParentPage.title}}
- {{currentPageCount}} / {{totalPageCount}}
@@ -296,7 +295,7 @@ Title = $"Chapter {x.Key}: {x.First().ChapterTitle}", Items = GetItems(x, 1) }); - var groupedTocData = _SiteMappings.SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(x => x.Key); + var groupedTocData = _SiteMappings.SiteMappings.DistinctBy(x => (x.ChapterNumber, x.PageNumber)).GroupBy(x => x.ChapterNumber).OrderBy(x => x.Key); int currentPageCount = 1; int overallCount = 1; bool currentPageFound = false; From bcff469e1fa201dc8e02437e59167fb4c820c92e Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Fri, 22 Nov 2024 10:17:55 -0800 Subject: [PATCH 4/8] Reimplemented it to account for bug --- .../Services/ISiteMappingService.cs | 1 + .../Services/SiteMappingService.cs | 33 ++++++++++++++++++- .../Views/Shared/_Layout.cshtml | 33 +++---------------- EssentialCSharp.Web/wwwroot/js/site.js | 17 +++++----- 4 files changed, 46 insertions(+), 38 deletions(-) diff --git a/EssentialCSharp.Web/Services/ISiteMappingService.cs b/EssentialCSharp.Web/Services/ISiteMappingService.cs index fe8cfbc7..116821a5 100644 --- a/EssentialCSharp.Web/Services/ISiteMappingService.cs +++ b/EssentialCSharp.Web/Services/ISiteMappingService.cs @@ -3,4 +3,5 @@ public interface ISiteMappingService { IList SiteMappings { get; } + string GetPercentComplete(string currentPageKey); } diff --git a/EssentialCSharp.Web/Services/SiteMappingService.cs b/EssentialCSharp.Web/Services/SiteMappingService.cs index c086596f..cc84ec8f 100644 --- a/EssentialCSharp.Web/Services/SiteMappingService.cs +++ b/EssentialCSharp.Web/Services/SiteMappingService.cs @@ -1,4 +1,6 @@ -using EssentialCSharp.Web.Models; +using System.Globalization; +using EssentialCSharp.Common; +using EssentialCSharp.Web.Models; namespace EssentialCSharp.Web.Services; @@ -12,4 +14,33 @@ public SiteMappingService(IWebHostEnvironment webHostEnvironment) List? siteMappings = System.Text.Json.JsonSerializer.Deserialize>(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> chapterGroupings = SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(g => g.Key); + foreach (IGrouping chapterGrouping in chapterGroupings) + { + IEnumerable> pageGroupings = chapterGrouping.GroupBy(x => x.PageNumber).OrderBy(g => g.Key); + foreach (IGrouping 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); + } } diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index c382e33c..72d793c4 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml @@ -123,8 +123,8 @@ {{chapterParentPage.title}} -
- {{currentPageCount}} / {{totalPageCount}} +
+ Progress: {{percentComplete}}%
@@ -295,35 +295,10 @@ Title = $"Chapter {x.Key}: {x.First().ChapterTitle}", Items = GetItems(x, 1) }); - var groupedTocData = _SiteMappings.SiteMappings.DistinctBy(x => (x.ChapterNumber, x.PageNumber)).GroupBy(x => x.ChapterNumber).OrderBy(x => x.Key); - int currentPageCount = 1; - int overallCount = 1; - bool currentPageFound = false; - List keyList = new(); - // Loop through each SiteMapping and increment the overallCount, - // currentPageFound (until you reach it), and build keyList out - foreach (IGrouping group in groupedTocData) - { - var orderedGroup = group.OrderBy(x => x.PageNumber); - foreach (SiteMapping siteMapping in orderedGroup) - { - if (siteMapping.Key == ViewBag.CurrentPageKey) - { - currentPageFound = true; - } - if (!currentPageFound) - { - currentPageCount++; - } - keyList.Add(siteMapping.Key); - overallCount++; - } - } + var percentComplete = _SiteMappings.GetPercentComplete(ViewBag.CurrentPageKey); } - CURRENT_PAGE_COUNT = @Json.Serialize(currentPageCount) - TOTAL_PAGE_COUNT = @Json.Serialize(overallCount) - KEY_LIST = @Json.Serialize(keyList) + PERCENT_COMPLETE = @Json.Serialize(percentComplete); PREVIOUS_PAGE = @Json.Serialize(ViewBag.PreviousPage) NEXT_PAGE = @Json.Serialize(ViewBag.NextPage) TOC_DATA = @Json.Serialize(tocData) diff --git a/EssentialCSharp.Web/wwwroot/js/site.js b/EssentialCSharp.Web/wwwroot/js/site.js index 5a36d672..47477a5c 100644 --- a/EssentialCSharp.Web/wwwroot/js/site.js +++ b/EssentialCSharp.Web/wwwroot/js/site.js @@ -18,7 +18,6 @@ import { useWindowSize } from "vue-window-size"; * @prop {TocItem[]} [items] */ /** @type {TocItem} */ -debugger; const tocData = markRaw(TOC_DATA); //Add new content or features here: @@ -195,9 +194,7 @@ const app = createApp({ const currentPage = findCurrentPage([], tocData) ?? []; - const currentPageCount = CURRENT_PAGE_COUNT; - const totalPageCount = TOTAL_PAGE_COUNT; - const keyList = KEY_LIST + const percentComplete = ref(PERCENT_COMPLETE); const chapterParentPage = currentPage.find((parent) => parent.level === 0); @@ -260,6 +257,11 @@ const app = createApp({ return tocData.filter(item => filterItem(item, query)); }); + const isContentPage = computed(() => { + let path = window.location.pathname; + return path !== '/home' && path !== '/guidelines' && path !== '/about' && path !== '/announcements'; + }); + function filterItem(item, query) { let matches = normalizeString(item.title).includes(query); if (item.items && item.items.length) { @@ -316,14 +318,13 @@ const app = createApp({ tocData, expandedTocs, currentPage, - currentPageCount, - totalPageCount, - keyList, + percentComplete, chapterParentPage, searchQuery, filteredTocData, - enableTocFilter + enableTocFilter, + isContentPage }; }, }); From eaac78d286d0a7a2b7c3eea15d2a92510f514e25 Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 26 Nov 2024 11:09:29 -0800 Subject: [PATCH 5/8] Change style --- .../Views/Shared/_Layout.cshtml | 6 +++--- EssentialCSharp.Web/wwwroot/css/styles.css | 18 ++++++++++++------ 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index 72d793c4..914cbcb6 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml @@ -120,11 +120,11 @@
- + {{chapterParentPage.title}} -
- Progress: {{percentComplete}}% +
+ {{percentComplete}}%
diff --git a/EssentialCSharp.Web/wwwroot/css/styles.css b/EssentialCSharp.Web/wwwroot/css/styles.css index 497960ab..c7035d32 100644 --- a/EssentialCSharp.Web/wwwroot/css/styles.css +++ b/EssentialCSharp.Web/wwwroot/css/styles.css @@ -207,13 +207,16 @@ a:hover { } } +.menu { + white-space: nowrap; + overflow: hidden; + text-decoration: none; +} + .menu-brand { font-style: normal; font-weight: 400; font-size: 1.5rem; - text-decoration: none; - white-space: nowrap; - overflow: hidden; margin-left: 5px; } @@ -221,11 +224,14 @@ a:hover { font-style: normal; font-weight: 300; font-size: 1.2rem; - text-decoration: none; text-overflow: ellipsis; - overflow: hidden; cursor: pointer; - white-space: nowrap; +} + +.menu-progress { + font-style: normal; + font-weight: 200; + font-size: 1rem; } .has-tooltip { From b34c7ec62f835f4884202b58b683f54708803bed Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 26 Nov 2024 11:19:28 -0800 Subject: [PATCH 6/8] Cleaning up for PR --- EssentialCSharp.Web/Controllers/HomeController.cs | 2 -- EssentialCSharp.Web/Services/SiteMappingService.cs | 2 -- 2 files changed, 4 deletions(-) diff --git a/EssentialCSharp.Web/Controllers/HomeController.cs b/EssentialCSharp.Web/Controllers/HomeController.cs index a902fe9e..690d063a 100644 --- a/EssentialCSharp.Web/Controllers/HomeController.cs +++ b/EssentialCSharp.Web/Controllers/HomeController.cs @@ -53,8 +53,6 @@ public IActionResult Index(string key) } } - - [Route("/TermsOfService", Name = "TermsOfService")] public IActionResult TermsOfService() diff --git a/EssentialCSharp.Web/Services/SiteMappingService.cs b/EssentialCSharp.Web/Services/SiteMappingService.cs index cc84ec8f..cf459f29 100644 --- a/EssentialCSharp.Web/Services/SiteMappingService.cs +++ b/EssentialCSharp.Web/Services/SiteMappingService.cs @@ -1,6 +1,4 @@ using System.Globalization; -using EssentialCSharp.Common; -using EssentialCSharp.Web.Models; namespace EssentialCSharp.Web.Services; From 875c1c580c421e5ff64b14c87e261054c9e3987a Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 26 Nov 2024 12:08:23 -0800 Subject: [PATCH 7/8] Refactored and added testing --- EssentialCSharp.Web.Tests/SiteMappingTests.cs | 57 +++++++++++++++++++ .../Extensions/SiteMappingListExtensions.cs | 44 +++++++++++++- .../Services/ISiteMappingService.cs | 1 - .../Services/SiteMappingService.cs | 29 ---------- .../Views/Shared/_Layout.cshtml | 2 +- 5 files changed, 101 insertions(+), 32 deletions(-) diff --git a/EssentialCSharp.Web.Tests/SiteMappingTests.cs b/EssentialCSharp.Web.Tests/SiteMappingTests.cs index 140e982c..025fb662 100644 --- a/EssentialCSharp.Web.Tests/SiteMappingTests.cs +++ b/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(() => + { + GetSiteMap().FindPercentComplete(null!); + }); + } + + [Theory] + [InlineData(" ")] + [InlineData("")] + public void FindPercentComplete_KeyIsWhiteSpace_ThrowsArgumentException(string key) + { + // Arrange + + // Act + + // Assert + Assert.Throws(() => + { + 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 siteMappings = new List(); + + // Act + string percent = siteMappings.FindPercentComplete("test"); + + // Assert + Assert.Equal("0.00", percent); + } } diff --git a/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs b/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs index 058e7ff7..a4c4e350 100644 --- a/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs +++ b/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; } + /// + /// Finds percent complete based on a key. + /// + /// IList of SiteMappings + /// If null, uses the first key in the list + /// Returns a formatted double for use as the percent complete. + public static string FindPercentComplete(this IList siteMappings, string key) + { + ArgumentNullException.ThrowIfNullOrWhiteSpace(key); + int currentMappingCount = 0; + int overallMappingCount = 0; + bool currentPageFound = false; + IEnumerable> chapterGroupings = siteMappings.GroupBy(x => x.ChapterNumber).OrderBy(g => g.Key); + foreach (IGrouping chapterGrouping in chapterGroupings) + { + IEnumerable> pageGroupings = chapterGrouping.GroupBy(x => x.PageNumber).OrderBy(g => g.Key); + foreach (IGrouping 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); + } } diff --git a/EssentialCSharp.Web/Services/ISiteMappingService.cs b/EssentialCSharp.Web/Services/ISiteMappingService.cs index 116821a5..fe8cfbc7 100644 --- a/EssentialCSharp.Web/Services/ISiteMappingService.cs +++ b/EssentialCSharp.Web/Services/ISiteMappingService.cs @@ -3,5 +3,4 @@ public interface ISiteMappingService { IList SiteMappings { get; } - string GetPercentComplete(string currentPageKey); } diff --git a/EssentialCSharp.Web/Services/SiteMappingService.cs b/EssentialCSharp.Web/Services/SiteMappingService.cs index cf459f29..f95553ba 100644 --- a/EssentialCSharp.Web/Services/SiteMappingService.cs +++ b/EssentialCSharp.Web/Services/SiteMappingService.cs @@ -12,33 +12,4 @@ public SiteMappingService(IWebHostEnvironment webHostEnvironment) List? siteMappings = System.Text.Json.JsonSerializer.Deserialize>(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> chapterGroupings = SiteMappings.GroupBy(x => x.ChapterNumber).OrderBy(g => g.Key); - foreach (IGrouping chapterGrouping in chapterGroupings) - { - IEnumerable> pageGroupings = chapterGrouping.GroupBy(x => x.PageNumber).OrderBy(g => g.Key); - foreach (IGrouping 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); - } } diff --git a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml b/EssentialCSharp.Web/Views/Shared/_Layout.cshtml index 914cbcb6..0433a4ca 100644 --- a/EssentialCSharp.Web/Views/Shared/_Layout.cshtml +++ b/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) From c23fe65d29ca90f6da2d1c73e0510ec7875de9bc Mon Sep 17 00:00:00 2001 From: Joshua Lester Date: Tue, 26 Nov 2024 12:20:30 -0800 Subject: [PATCH 8/8] Adjust for when key is possibly null due to ViewBag --- EssentialCSharp.Web.Tests/SiteMappingTests.cs | 14 ++++++-------- .../Extensions/SiteMappingListExtensions.cs | 11 +++++++++-- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/EssentialCSharp.Web.Tests/SiteMappingTests.cs b/EssentialCSharp.Web.Tests/SiteMappingTests.cs index 025fb662..a04646bd 100644 --- a/EssentialCSharp.Web.Tests/SiteMappingTests.cs +++ b/EssentialCSharp.Web.Tests/SiteMappingTests.cs @@ -85,18 +85,16 @@ public void FindPercentComplete_KeyIsNull_ThrowsArgumentNullException() // Arrange // Act + string? percent = GetSiteMap().FindPercentComplete(null!); // Assert - Assert.Throws(() => - { - GetSiteMap().FindPercentComplete(null!); - }); + Assert.Null(percent); } [Theory] [InlineData(" ")] [InlineData("")] - public void FindPercentComplete_KeyIsWhiteSpace_ThrowsArgumentException(string key) + public void FindPercentComplete_KeyIsWhiteSpace_ThrowsArgumentException(string? key) { // Arrange @@ -112,12 +110,12 @@ public void FindPercentComplete_KeyIsWhiteSpace_ThrowsArgumentException(string k [Theory] [InlineData("hello-world", "50.00")] [InlineData("c-syntax-fundamentals", "100.00")] - public void FindPercentComplete_ValidKey_Success(string key, string result) + public void FindPercentComplete_ValidKey_Success(string? key, string result) { // Arrange // Act - string percent = GetSiteMap().FindPercentComplete(key); + string? percent = GetSiteMap().FindPercentComplete(key); // Assert Assert.Equal(result, percent); @@ -130,7 +128,7 @@ public void FindPercentComplete_EmptySiteMappings_ReturnsZeroPercent() IList siteMappings = new List(); // Act - string percent = siteMappings.FindPercentComplete("test"); + string? percent = siteMappings.FindPercentComplete("test"); // Assert Assert.Equal("0.00", percent); diff --git a/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs b/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs index a4c4e350..c95b4539 100644 --- a/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs +++ b/EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs @@ -32,9 +32,16 @@ public static class SiteMappingListExtensions /// IList of SiteMappings /// If null, uses the first key in the list /// Returns a formatted double for use as the percent complete. - public static string FindPercentComplete(this IList siteMappings, string key) + public static string? FindPercentComplete(this IList siteMappings, string? key) { - ArgumentNullException.ThrowIfNullOrWhiteSpace(key); + if (key is null) + { + return null; + } + if (key.Trim().Length is 0) + { + throw new ArgumentException("Parameter key is whitespace or empty: ", nameof(key)); + } int currentMappingCount = 0; int overallMappingCount = 0; bool currentPageFound = false;