fix: Misc code quality improvements (#871)

- Refactor path handling to use Path.Join for improved readabilitu

Author: BenjaminMichaelis

EssentialCSharp.Chat.Shared/Services/AIChatService.cs

@@ -341,21 +341,17 @@ private static async Task<ResponseCreationOptions> CreateResponseOptionsAsync(
         string responseText = string.Empty;
         string responseId = response.Value.Id;
 
-        foreach (var outputItem in response.Value.OutputItems)
-        {
 #pragma warning disable OPENAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
-            if (outputItem is MessageResponseItem messageItem &&
-                messageItem.Role == MessageRole.Assistant)
-            {
-                var textContent = messageItem.Content?.FirstOrDefault()?.Text;
-                if (!string.IsNullOrEmpty(textContent))
-                {
-                    responseText = textContent;
-                    break;
-                }
-            }
-#pragma warning restore OPENAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+        var assistantMessage = response.Value.OutputItems
+            .OfType<MessageResponseItem>()
+            .FirstOrDefault(m => m.Role == MessageRole.Assistant &&
+                                 !string.IsNullOrEmpty(m.Content?.FirstOrDefault()?.Text));
+
+        if (assistantMessage is not null)
+        {
+            responseText = assistantMessage.Content?.FirstOrDefault()?.Text ?? string.Empty;
         }
+#pragma warning restore OPENAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
         return (responseText, responseId);
     }

EssentialCSharp.Chat.Shared/Services/ChunkingResultExtensions.cs

@@ -1,5 +1,6 @@
 using System.Security.Cryptography;
 using System.Text;
+using System.Linq;
 using EssentialCSharp.Chat.Common.Models;
 
 namespace EssentialCSharp.Chat.Common.Services;
@@ -8,24 +9,24 @@ public static partial class ChunkingResultExtensions
 {
     public static List<BookContentChunk> ToBookContentChunks(this FileChunkingResult result)
     {
-        var chunks = new List<BookContentChunk>();
         int? chapterNumber = ExtractChapterNumber(result.FileName);
 
-        foreach (var chunk in result.Chunks)
-        {
-            string chunkText = chunk;
-            string contentHash = ComputeSha256Hash(chunkText);
-
-            chunks.Add(new BookContentChunk
+        var chunks = result.Chunks
+            .Select(chunkText =>
             {
-                Id = Guid.NewGuid().ToString(),
-                FileName = result.FileName,
-                Heading = ExtractHeading(chunkText),
-                ChunkText = chunkText,
-                ChapterNumber = chapterNumber,
-                ContentHash = contentHash
-            });
-        }
+                var contentHash = ComputeSha256Hash(chunkText);
+                return new BookContentChunk
+                {
+                    Id = Guid.NewGuid().ToString(),
+                    FileName = result.FileName,
+                    Heading = ExtractHeading(chunkText),
+                    ChunkText = chunkText,
+                    ChapterNumber = chapterNumber,
+                    ContentHash = contentHash
+                };
+            })
+            .ToList();
+
         return chunks;
     }
 

EssentialCSharp.Chat/Program.cs

@@ -328,7 +328,7 @@ void WriteChunkingResult(FileChunkingResult result, TextWriter writer)
                         outputDirectory.Create();
                     foreach (var result in results)
                     {
-                        var outputFile = Path.Combine(outputDirectory.FullName, Path.GetFileNameWithoutExtension(result.FileName) + ".chunks.txt");
+                        var outputFile = Path.Join(outputDirectory.FullName, Path.GetFileNameWithoutExtension(result.FileName) + ".chunks.txt");
                         using var writer = new StreamWriter(outputFile, false);
                         WriteChunkingResult(result, writer);
                         Console.WriteLine($"Wrote: {outputFile}");

EssentialCSharp.Web.Tests/ListingSourceCodeServiceTests.cs

@@ -133,7 +133,7 @@ private static ListingSourceCodeService CreateService()
     private static DirectoryInfo GetTestDataPath()
     {
         string baseDirectory = AppContext.BaseDirectory;
-        string testDataPath = Path.Combine(baseDirectory, "TestData");
+        string testDataPath = Path.Join(baseDirectory, "TestData");
 
         DirectoryInfo testDataDirectory = new(testDataPath);
 

EssentialCSharp.Web.Tests/WebApplicationFactory.cs

@@ -59,7 +59,7 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
             // Replace IListingSourceCodeService with one backed by TestData
             services.RemoveAll<IListingSourceCodeService>();
 
-            string testDataPath = Path.Combine(AppContext.BaseDirectory, "TestData");
+            string testDataPath = Path.Join(AppContext.BaseDirectory, "TestData");
             var fileProvider = new PhysicalFileProvider(testDataPath);
             services.AddSingleton<IListingSourceCodeService>(sp =>
             {

EssentialCSharp.Web/Areas/Identity/Pages/Account/Logout.cshtml.cs

@@ -11,15 +11,8 @@ public async Task<IActionResult> OnPost(string? returnUrl = null)
     {
         await signInManager.SignOutAsync();
         logger.LogInformation("User logged out.");
-        if (returnUrl is not null)
-        {
-            return LocalRedirect(returnUrl);
-        }
-        else
-        {
             // This needs to be a redirect so that the browser performs a new
             // request and the identity for the user gets updated.
-            return RedirectToPage();
-        }
+            return returnUrl is not null ? LocalRedirect(returnUrl) : RedirectToPage();
     }
 }

EssentialCSharp.Web/Controllers/HomeController.cs

@@ -22,7 +22,7 @@ public IActionResult Index()
         }
         else if (siteMapping is not null)
         {
-            string filePath = Path.Combine(hostingEnvironment.ContentRootPath, Path.Combine(siteMapping.PagePath));
+            string filePath = Path.Join(hostingEnvironment.ContentRootPath, Path.Join(siteMapping.PagePath));
             HtmlDocument doc = new();
             doc.Load(filePath);
             string headHtml = doc.DocumentNode.Element("html").Element("head").InnerHtml;
@@ -74,7 +74,7 @@ public IActionResult Home()
     public IActionResult Guidelines()
     {
         ViewBag.PageTitle = "Coding Guidelines";
-        FileInfo fileInfo = new(Path.Combine(hostingEnvironment.ContentRootPath, "Guidelines", "guidelines.json"));
+        FileInfo fileInfo = new(Path.Join(hostingEnvironment.ContentRootPath, "Guidelines", "guidelines.json"));
         if (!fileInfo.Exists)
         {
             return RedirectToAction(nameof(Error), new { errorMessage = "Guidelines could not be found", statusCode = 404 });

EssentialCSharp.Web/Extensions/SiteMappingListExtensions.cs

@@ -16,14 +16,9 @@ public static class SiteMappingListExtensions
         {
             return siteMappings.FirstOrDefault();
         }
-        foreach (string? potentialMatch in key.GetPotentialMatches())
-        {
-            if (siteMappings.FirstOrDefault(x => x.Keys.Any(x => x == potentialMatch)) is { } siteMap)
-            {
-                return siteMap;
-            }
-        }
-        return null;
+        return key.GetPotentialMatches()
+            .Select(potentialMatch => siteMappings.FirstOrDefault(x => x.Keys.Any(k => k == potentialMatch)))
+            .FirstOrDefault(siteMap => siteMap != null);
     }
     /// <summary>
     /// Finds percent complete based on a key.

EssentialCSharp.Web/Helpers/SitemapXmlHelpers.cs

@@ -23,7 +23,7 @@ public static void GenerateAndSerializeSitemapXml(DirectoryInfo wwwrootDirectory
     {
         GenerateSitemapXml(wwwrootDirectory, siteMappings, routeConfigurationService, baseUrl, out List<SitemapNode> nodes);
         XmlSerializer sitemapProvider = new();
-        var xmlPath = Path.Combine(wwwrootDirectory.FullName, "sitemap.xml");
+        var xmlPath = Path.Join(wwwrootDirectory.FullName, "sitemap.xml");
         sitemapProvider.Serialize(new SitemapModel(nodes), xmlPath, true);
         logger.LogInformation("sitemap.xml successfully written to {XmlPath}", xmlPath);
     }

EssentialCSharp.Web/Services/RouteConfigurationService.cs

@@ -47,14 +47,13 @@ private HashSet<string> ExtractStaticRoutes()
 
             // For actions without attribute routes, use conventional routing
             if (actionDescriptor.AttributeRouteInfo?.Template == null &&
-                actionDescriptor.RouteValues.TryGetValue("action", out var actionName) && 
-                actionDescriptor.RouteValues.TryGetValue("controller", out var controllerName))
+                actionDescriptor.RouteValues.TryGetValue("action", out var actionName) &&
+                actionDescriptor.RouteValues.TryGetValue("controller", out var controllerName) &&
+                controllerName?.Equals("Home", StringComparison.OrdinalIgnoreCase) == true &&
+                actionName != null)
             {
-                if (controllerName?.Equals("Home", StringComparison.OrdinalIgnoreCase) == true && actionName != null)
-                {
-                    // Use the action name directly as the route
-                    routes.Add(actionName.ToLowerInvariant());
-                }
+                // Use the action name directly as the route
+                routes.Add(actionName.ToLowerInvariant());
             }
         }