Merge pull request #334 from atc-net/feature/improve-String-and-StringBuilder-Extensions

Improve SetStringFormatParameterTemplatePlaceholders and FormatWith method with overload for StringComparison to support model-properties mapping

Author: davidkallesen

docs/CodeDoc/Atc/IndexExtended.md

@@ -5179,7 +5179,7 @@
      - EnsureFirstCharacterToUpperAndSingular(this string value)
      - EnsurePlural(this string value)
      - EnsureSingular(this string value)
-     - FormatWith(this string template, string arg0, string arg1 = null, string arg2 = null, string arg3 = null, string arg4 = null, string arg5 = null, string arg6 = null, string arg7 = null, string arg8 = null, string arg9 = null, string arg0Name = null, string arg1Name = null, string arg2Name = null, string arg3Name = null, string arg4Name = null, string arg5Name = null, string arg6Name = null, string arg7Name = null, string arg8Name = null, string arg9Name = null)
+     - FormatWith(this string template, string arg0, string arg1 = null, string arg2 = null, string arg3 = null, string arg4 = null, string arg5 = null, string arg6 = null, string arg7 = null, string arg8 = null, string arg9 = null, StringComparison comparison = OrdinalIgnoreCase, string arg0Name = null, string arg1Name = null, string arg2Name = null, string arg3Name = null, string arg4Name = null, string arg5Name = null, string arg6Name = null, string arg7Name = null, string arg8Name = null, string arg9Name = null)
      - GetStringFormatParameterLiteralCount(this string value)
      - GetStringFormatParameterNumericCount(this string value)
      - GetStringFormatParameterTemplatePlaceholders(this string value, bool useDoubleBracket = True)
@@ -5208,7 +5208,7 @@
      - ReplaceNewLines(this string value, string newValue)
      - ReplaceTemplateKeyWithValue(this string value, string templateKey, string templateValue, TemplatePatternType templatePatternType = HardBrackets)
      - ReplaceTemplateKeysWithValues(this string value, IDictionary<string, string> templateKeyValues, TemplatePatternType templatePatternType = HardBrackets)
-     - SetStringFormatParameterTemplatePlaceholders(this string value, IDictionary<string, string> replacements, bool useDoubleBracket = True)
+     - SetStringFormatParameterTemplatePlaceholders(this string value, IDictionary<string, string> replacements, bool useDoubleBracket = True, StringComparison comparison = Ordinal)
      - ToLines(this string value)
      - ToStream(this string value)
      - ToStreamFromBase64(this string base64Data)
@@ -5482,6 +5482,8 @@
   -  Static Methods
      - Append(this StringBuilder sb, int indentSpaces, string value)
      - Append(this StringBuilder sb, string format, object[] args)
+     - AppendLine(this StringBuilder sb, char value)
+     - AppendLine(this StringBuilder sb, int indentSpaces, char value)
      - AppendLine(this StringBuilder sb, int indentSpaces, string value)
      - AppendLine(this StringBuilder sb, string format, object[] args)
 

docs/CodeDoc/Atc/System.Text.md

@@ -56,4 +56,24 @@ Extensions for the `System.Text.StringBuilder` class.
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`sb`&nbsp;&nbsp;-&nbsp;&nbsp;The .<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`format`&nbsp;&nbsp;-&nbsp;&nbsp;A composite format string.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`args`&nbsp;&nbsp;-&nbsp;&nbsp;An object array that contains zero or more objects to format.<br />
+#### AppendLine
+>```csharp
+>void AppendLine(this StringBuilder sb, char value)
+>```
+><b>Summary:</b> Appends a new line with formatting options to the string builder.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`sb`&nbsp;&nbsp;-&nbsp;&nbsp;The .<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`format`&nbsp;&nbsp;-&nbsp;&nbsp;A composite format string.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`args`&nbsp;&nbsp;-&nbsp;&nbsp;An object array that contains zero or more objects to format.<br />
+#### AppendLine
+>```csharp
+>void AppendLine(this StringBuilder sb, int indentSpaces, char value)
+>```
+><b>Summary:</b> Appends a new line with formatting options to the string builder.
+>
+><b>Parameters:</b><br>
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`sb`&nbsp;&nbsp;-&nbsp;&nbsp;The .<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`format`&nbsp;&nbsp;-&nbsp;&nbsp;A composite format string.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`args`&nbsp;&nbsp;-&nbsp;&nbsp;An object array that contains zero or more objects to format.<br />
 <hr /><div style='text-align: right'><i>Generated by MarkdownCodeDoc version 1.2</i></div>

docs/CodeDoc/Atc/System.md

@@ -2101,7 +2101,7 @@ Extensions for the string class.
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`value`&nbsp;&nbsp;-&nbsp;&nbsp;The value.<br />
 #### FormatWith
 >```csharp
->string FormatWith(this string template, string arg0, string arg1 = null, string arg2 = null, string arg3 = null, string arg4 = null, string arg5 = null, string arg6 = null, string arg7 = null, string arg8 = null, string arg9 = null, string arg0Name = null, string arg1Name = null, string arg2Name = null, string arg3Name = null, string arg4Name = null, string arg5Name = null, string arg6Name = null, string arg7Name = null, string arg8Name = null, string arg9Name = null)
+>string FormatWith(this string template, string arg0, string arg1 = null, string arg2 = null, string arg3 = null, string arg4 = null, string arg5 = null, string arg6 = null, string arg7 = null, string arg8 = null, string arg9 = null, StringComparison comparison = OrdinalIgnoreCase, string arg0Name = null, string arg1Name = null, string arg2Name = null, string arg3Name = null, string arg4Name = null, string arg5Name = null, string arg6Name = null, string arg7Name = null, string arg8Name = null, string arg9Name = null)
 >```
 ><b>Summary:</b> Formats a string template by replacing placeholders with corresponding argument values.
 >
@@ -2117,6 +2117,7 @@ Extensions for the string class.
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg7`&nbsp;&nbsp;-&nbsp;&nbsp;Optional argument for placeholder replacement.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg8`&nbsp;&nbsp;-&nbsp;&nbsp;Optional argument for placeholder replacement.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg9`&nbsp;&nbsp;-&nbsp;&nbsp;Optional argument for placeholder replacement.<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`comparison`&nbsp;&nbsp;-&nbsp;&nbsp;Use comparison with default  for key matching.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg0Name`&nbsp;&nbsp;-&nbsp;&nbsp;The name of , provided via .<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg1Name`&nbsp;&nbsp;-&nbsp;&nbsp;The name of  (if provided), automatically inferred.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`arg2Name`&nbsp;&nbsp;-&nbsp;&nbsp;The name of  (if provided), automatically inferred.<br />
@@ -2420,14 +2421,15 @@ Extensions for the string class.
 ><b>Returns:</b> The modified input string with template keys replaced by their corresponding template values.
 #### SetStringFormatParameterTemplatePlaceholders
 >```csharp
->string SetStringFormatParameterTemplatePlaceholders(this string value, IDictionary<string, string> replacements, bool useDoubleBracket = True)
+>string SetStringFormatParameterTemplatePlaceholders(this string value, IDictionary<string, string> replacements, bool useDoubleBracket = True, StringComparison comparison = Ordinal)
 >```
 ><b>Summary:</b> Sets the string format parameter template placeholders.
 >
 ><b>Parameters:</b><br>
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`value`&nbsp;&nbsp;-&nbsp;&nbsp;The value.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`replacements`&nbsp;&nbsp;-&nbsp;&nbsp;The replacements.<br />
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`useDoubleBracket`&nbsp;&nbsp;-&nbsp;&nbsp;Use double bracket if ;otherwise .<br />
+>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`comparison`&nbsp;&nbsp;-&nbsp;&nbsp;Use comparison with default  for key matching.<br />
 #### ToLines
 >```csharp
 >string[] ToLines(this string value)

src/Atc.XUnit/CodeComplianceTestHelper.cs

@@ -165,7 +165,7 @@ public static string CollectExportedTypesWithMissingTestsAndGenerateText(
 
         var sb = new StringBuilder();
         sb.AppendLine(12, "var excludeTypes = new List<Type>");
-        sb.AppendLine(12, "{");
+        sb.AppendLine(12, '{');
         sb.AppendLine(12, "{    // TODO: Implement tests on the following types, and then remove the type from the exclude list.");
         for (var i = 0; i < typesWithMissingTests.Length; i++)
         {

src/Atc/Extensions/StringBuilderExtensions.cs

@@ -121,4 +121,33 @@ public static void AppendLine(
 
         sb.AppendLine(value.PadLeft(value.Length + indentSpaces));
     }
+
+    /// <summary>
+    /// Appends a new line with indented spaces to the string builder.
+    /// </summary>
+    /// <param name="sb">The <see cref="StringBuilder"/>.</param>
+    /// <param name="value">The value.</param>
+    public static void AppendLine(
+        this StringBuilder sb,
+        char value)
+    {
+        if (sb is null)
+        {
+            throw new ArgumentNullException(nameof(sb));
+        }
+
+        sb.AppendLine(value.ToString());
+    }
+
+    /// <summary>
+    /// Appends a new line with indented spaces to the string builder.
+    /// </summary>
+    /// <param name="sb">The <see cref="StringBuilder"/>.</param>
+    /// <param name="indentSpaces">The indent spaces.</param>
+    /// <param name="value">The value.</param>
+    public static void AppendLine(
+        this StringBuilder sb,
+        int indentSpaces,
+        char value)
+        => AppendLine(sb, indentSpaces, value.ToString());
 }

src/Atc/Extensions/StringExtensions.cs

@@ -257,6 +257,7 @@ in matches
     /// <param name="value">The value.</param>
     /// <param name="replacements">The replacements.</param>
     /// <param name="useDoubleBracket">Use double bracket if <see langword="true" />;otherwise <see langword="false" />.</param>
+    /// <param name="comparison">Use comparison with default <see langword="StringComparison.Ordinal" /> for key matching.</param>
     /// <exception cref="ArgumentNullException">
     /// value
     /// or
@@ -265,7 +266,8 @@ in matches
     public static string SetStringFormatParameterTemplatePlaceholders(
         this string value,
         IDictionary<string, string> replacements,
-        bool useDoubleBracket = true)
+        bool useDoubleBracket = true,
+        StringComparison comparison = StringComparison.Ordinal)
     {
         if (value is null)
         {
@@ -284,8 +286,8 @@ public static string SetStringFormatParameterTemplatePlaceholders(
             {
                 var s = (pair.Key.StartsWith("{{", StringComparison.Ordinal) &&
                          pair.Key.EndsWith("}}", StringComparison.Ordinal)
-                    ? placeholders.Find(x => string.Equals(x, pair.Key, StringComparison.Ordinal))
-                    : placeholders.Find(x => string.Equals(x, "{{" + pair.Key + "}}", StringComparison.Ordinal)))!;
+                    ? placeholders.Find(x => string.Equals(x, pair.Key, comparison))
+                    : placeholders.Find(x => string.Equals(x, "{{" + pair.Key + "}}", comparison)))!;
 
                 if (!string.IsNullOrEmpty(s))
                 {
@@ -297,10 +299,10 @@ public static string SetStringFormatParameterTemplatePlaceholders(
         {
             foreach (var pair in replacements)
             {
-                var s = (pair.Key.StartsWith("{", StringComparison.Ordinal) &&
-                         pair.Key.EndsWith("}", StringComparison.Ordinal)
-                    ? placeholders.Find(x => string.Equals(x, pair.Key, StringComparison.Ordinal))
-                    : placeholders.Find(x => string.Equals(x, "{" + pair.Key + "}", StringComparison.Ordinal)))!;
+                var s = (pair.Key.StartsWith('{') &&
+                         pair.Key.EndsWith('}')
+                    ? placeholders.Find(x => string.Equals(x, pair.Key, comparison))
+                    : placeholders.Find(x => string.Equals(x, '{' + pair.Key + '}', comparison)))!;
 
                 if (!string.IsNullOrEmpty(s))
                 {
@@ -2022,6 +2024,7 @@ public static bool TryParseToHttpStatusCode(
     /// <param name="arg7">Optional argument for placeholder replacement.</param>
     /// <param name="arg8">Optional argument for placeholder replacement.</param>
     /// <param name="arg9">Optional argument for placeholder replacement.</param>
+    /// <param name="comparison">Use comparison with default <see langword="StringComparison.OrdinalIgnoreCase" /> for key matching.</param>
     /// <param name="arg0Name">The name of <paramref name="arg0"/>, provided via <see cref="CallerArgumentExpressionAttribute"/>.</param>
     /// <param name="arg1Name">The name of <paramref name="arg1"/> (if provided), automatically inferred.</param>
     /// <param name="arg2Name">The name of <paramref name="arg2"/> (if provided), automatically inferred.</param>
@@ -2047,6 +2050,8 @@ public static bool TryParseToHttpStatusCode(
     /// - Named placeholders (e.g., '{argName}') and indexed placeholders (e.g., '{0}') are supported.<br/>
     /// - Argument names are inferred using the <see cref="CallerArgumentExpressionAttribute"/> for better debugging.
     /// </remarks>
+    [SuppressMessage("Critical Code Smell", "S3776:Cognitive Complexity of methods should not be too high", Justification = "OK.")]
+    [SuppressMessage("Design", "MA0051:Method is too long", Justification = "OK.")]
     public static string FormatWith(
         this string template,
         string arg0,
@@ -2059,6 +2064,7 @@ public static string FormatWith(
         string? arg7 = null,
         string? arg8 = null,
         string? arg9 = null,
+        StringComparison comparison = StringComparison.OrdinalIgnoreCase,
         [CallerArgumentExpression("arg0")] string arg0Name = null!,
         [CallerArgumentExpression("arg1")] string? arg1Name = null,
         [CallerArgumentExpression("arg2")] string? arg2Name = null,
@@ -2092,6 +2098,23 @@ public static string FormatWith(
             var key = placeholder.Trim('{', '}');
 
             var index = Array.IndexOf(argNames, key);
+            if (index == -1)
+            {
+                for (var i = 0; i < argNames.Length; i++)
+                {
+                    if (argNames[i] == null)
+                    {
+                        break;
+                    }
+
+                    if (argNames[i]!.Contains('.', StringComparison.Ordinal) &&
+                        argNames[i]!.EndsWith(key, comparison))
+                    {
+                        index = i;
+                    }
+                }
+            }
+
             if (index != -1 && index < usedArgsCount)
             {
                 dictionary.Add(key, argValues[index]!);
@@ -2111,7 +2134,10 @@ public static string FormatWith(
             }
         }
 
-        return template.SetStringFormatParameterTemplatePlaceholders(dictionary, useDoubleBracket: false);
+        return template.SetStringFormatParameterTemplatePlaceholders(
+            dictionary,
+            useDoubleBracket: false,
+            comparison: StringComparison.OrdinalIgnoreCase);
     }
 #endif
 

test/Atc.Console.Spectre.Tests/SampleIntegrationTests/SampleIntegrationTestBase.cs

@@ -32,9 +32,9 @@ public static void PrepareCliAppSettings(ConsoleLoggerConfiguration config)
         var jsonPart = json.Replace(Environment.NewLine, $"{Environment.NewLine}  ", StringComparison.Ordinal);
 
         var sbJson = new StringBuilder();
-        sbJson.AppendLine("{");
+        sbJson.AppendLine('{');
         sbJson.AppendLine("  \"ConsoleLogger\": " + jsonPart);
-        sbJson.AppendLine("}");
+        sbJson.AppendLine('}');
 
         var jsonOutput = sbJson.ToString();
         File.WriteAllText(appSettingsFile.FullName, jsonOutput);

test/Atc.DotNet.Tests/DotnetBuildHelperTests.cs

@@ -73,15 +73,15 @@ private static Task CreateProgramFile(DirectoryInfo workingDirectory, bool withE
         sb.AppendLine("using System;");
         sb.AppendLine();
         sb.AppendLine("namespace Test");
-        sb.AppendLine("{");
+        sb.AppendLine('{');
         sb.AppendLine(4, "class Program");
-        sb.AppendLine(4, "{");
+        sb.AppendLine(4, '{');
         sb.AppendLine(8, "static void Main(string[] args)");
-        sb.AppendLine(8, "{");
+        sb.AppendLine(8, '{');
         sb.AppendLine(12, withError ? "QQConsole.WriteLine(\"Hello World!\");" : "Console.WriteLine(\"Hello World!\");");
-        sb.AppendLine(8, "}");
-        sb.AppendLine(4, "}");
-        sb.AppendLine("}");
+        sb.AppendLine(8, '}');
+        sb.AppendLine(4, '}');
+        sb.AppendLine('}');
 
         return File.WriteAllTextAsync(file.FullName, sb.ToString(), Encoding.UTF8);
     }

test/Atc.DotNet.Tests/DotnetCsProjFileHelperTests.cs

@@ -710,10 +710,10 @@ private static void CreateProgramCsFileBlazorServerApp(
         sb.AppendLine();
         sb.AppendLine("var app = builder.Build();");
         sb.AppendLine("if (!app.Environment.IsDevelopment())");
-        sb.AppendLine("{");
+        sb.AppendLine('{');
         sb.AppendLine("    app.UseExceptionHandler(\"/Error\");");
         sb.AppendLine("    app.UseHsts();");
-        sb.AppendLine("}");
+        sb.AppendLine('}');
         sb.AppendLine();
         sb.AppendLine("app.UseHttpsRedirection();");
         sb.AppendLine("app.UseStaticFiles();");

test/Atc.Tests/ConsoleEmojiConstantsTests.cs

@@ -70,7 +70,7 @@ private static string GenerateContent(IList<(string Group, string SubGroup, stri
         sb.AppendLine($"/// Generated from: {SourceUrl}");
         sb.AppendLine("/// </Remarks>");
         sb.AppendLine("public static partial class EmojiConstants");
-        sb.AppendLine("{");
+        sb.AppendLine('{');
         var isFirst = true;
         foreach (var groupName in groupNames)
         {