Quote GitConfigItem values in output as needed

Co-authored-by: Jay Asbury <[email protected]>

Author: drewnoakes

GitExtUtils/GitArgumentBuilder.cs

@@ -175,14 +175,14 @@ public override string ToString()
         {
             var arguments = base.ToString();
 
-            var capacity = _command.Length + 1 + arguments.Length + 1 + _configItems.Sum(i => i.Key.Length + i.Value.Length + 5);
+            // 7 = "-c " + "=" + " " + 2 (for possible quotes of value)
+            var capacity = _configItems.Sum(i => i.Key.Length + i.Value.Length + 7) + _command.Length + 1 + arguments.Length;
 
             var str = new StringBuilder(capacity);
 
             foreach (var (key, value) in _configItems)
             {
-                str.Append("-c ").Append(key).Append('=').Append(value);
-                str.Append(' ');
+                str.Append("-c ").Append(key).Append('=').AppendQuoted(value).Append(' ');
             }
 
             str.Append(_command);

GitExtUtils/GitExtUtils.csproj

@@ -62,6 +62,7 @@
     <Compile Include="Linq\LinqExtensions.cs" />
     <Compile Include="MruCache.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="StringBuilderExtensions.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="app.config" />

GitExtUtils/StringBuilderExtensions.cs

@@ -0,0 +1,48 @@
+using System.Text;
+using JetBrains.Annotations;
+
+namespace GitCommands
+{
+    public static class StringBuilderExtensions
+    {
+        private static readonly char[] _whiteSpaceChars = { ' ', '\r', '\n', '\t' };
+
+        [NotNull]
+        public static StringBuilder AppendQuoted([NotNull] this StringBuilder builder, [NotNull] string s)
+        {
+            if (NeedsEscaping())
+            {
+                builder.Append('"').Append(s).Append('"');
+            }
+            else
+            {
+                builder.Append(s);
+            }
+
+            return builder;
+
+            bool NeedsEscaping()
+            {
+                if (string.IsNullOrWhiteSpace(s))
+                {
+                    // Quote empty or white space strings
+                    return true;
+                }
+
+                if (s.IndexOfAny(_whiteSpaceChars) == -1)
+                {
+                    // Doesn't contain any white space
+                    return false;
+                }
+
+                if (s.Length > 1 && s[0] == '"' && s[s.Length - 1] == '"')
+                {
+                    // String is already quoted
+                    return false;
+                }
+
+                return true;
+            }
+        }
+    }
+}

UnitTests/GitExtUtils/GitArgumentBuilderTests.cs

@@ -49,6 +49,32 @@ public void Command_with_custom_config_item()
                 args.ToString());
         }
 
+        [Test]
+        public void Command_with_custom_config_item_quoted()
+        {
+            var args = new GitArgumentBuilder("foo")
+            {
+                new GitConfigItem("bar", "baz bax")
+            };
+
+            Assert.AreEqual(
+                "-c bar=\"baz bax\" foo",
+                args.ToString());
+        }
+
+        [Test]
+        public void Command_with_custom_config_item_already_quoted()
+        {
+            var args = new GitArgumentBuilder("foo")
+            {
+                new GitConfigItem("bar", "\"baz bax\"")
+            };
+
+            Assert.AreEqual(
+                "-c bar=\"baz bax\" foo",
+                args.ToString());
+        }
+
         [Test]
         public void Command_with_custom_config_item_and_argument()
         {

UnitTests/GitUITests/GitUITests.csproj

@@ -72,6 +72,7 @@
     <Compile Include="LinqExtensionsTests.cs" />
     <Compile Include="SpellChecker\WordAtCursorExtractorTests.cs" />
     <Compile Include="SplitterManagerTest.cs" />
+    <Compile Include="StringBuilderExtensionsTests.cs" />
     <Compile Include="ThreadHelperTests.cs" />
     <Compile Include="TranslationTest.cs" />
     <Compile Include="UITest.cs" />

UnitTests/GitUITests/StringBuilderExtensionsTests.cs

@@ -0,0 +1,20 @@
+using System.Text;
+using GitCommands;
+using NUnit.Framework;
+
+namespace GitUITests
+{
+    public sealed class StringBuilderExtensionsTests
+    {
+        [TestCase("foo", "foo")]
+        [TestCase("\"foo bar\"", "foo bar")]
+        [TestCase("\"foo\tbar\"", "foo\tbar")]
+        [TestCase("\"foo bar\"", "\"foo bar\"")]
+        [TestCase("\"\"", "")]
+        [TestCase("\" \"", " ")]
+        public void AppendQuoted(string expected, string source)
+        {
+            Assert.AreEqual(expected, new StringBuilder().AppendQuoted(source).ToString());
+        }
+    }
+}