refactor: build clip XML via XElement instead of string interpolation

Author: fuzzzerd

src/SharpFM.Model/ClipTypes/IClipTypeStrategy.cs

@@ -26,7 +26,9 @@ public interface IClipTypeStrategy
 
     /// <summary>
     /// Produce a starter XML body for a fresh clip with the given name. Used by
-    /// "new clip" flows in the host and by plugins.
+    /// "new clip" flows in the host and by plugins. Build with
+    /// <see cref="System.Xml.Linq.XElement"/> rather than string concatenation so
+    /// XML metacharacters in <paramref name="clipName"/> are escaped by the framework.
     /// </summary>
     string DefaultXml(string clipName);
 

src/SharpFM.Model/ClipTypes/TableClipStrategy.cs

@@ -5,7 +5,6 @@
 using System.Xml.Linq;
 using SharpFM.Model.Parsing;
 using SharpFM.Model.Schema;
-using SharpFM.Model.Scripting;
 
 namespace SharpFM.Model.ClipTypes;
 
@@ -65,10 +64,15 @@ public ClipParseResult Parse(string xml)
         return new ParseSuccess(new TableClipModel(table), report);
     }
 
-    public string DefaultXml(string clipName) =>
-        _wrapsBaseTable
-            ? $"<fmxmlsnippet type=\"FMObjectList\"><BaseTable name=\"{XmlHelpers.XmlEscape(clipName)}\"></BaseTable></fmxmlsnippet>"
-            : "<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";
+    public string DefaultXml(string clipName)
+    {
+        var snippet = new XElement("fmxmlsnippet", new XAttribute("type", "FMObjectList"));
+        if (_wrapsBaseTable)
+        {
+            snippet.Add(new XElement("BaseTable", new XAttribute("name", clipName)));
+        }
+        return snippet.ToString(SaveOptions.DisableFormatting);
+    }
 
     public string? TryGetSourceName(string xml)
     {

src/SharpFM.Model/Schema/FmField.cs

@@ -189,7 +189,7 @@ public XElement ToXml()
         // Calculation
         if (!string.IsNullOrEmpty(Calculation))
         {
-            var calcEl = XElement.Parse($"<Calculation><![CDATA[{Calculation}]]></Calculation>");
+            var calcEl = new XElement("Calculation", new XCData(Calculation));
             if (AlwaysEvaluate)
                 calcEl.Add(new XAttribute("alwaysEvaluate", "True"));
             if (!string.IsNullOrEmpty(CalculationContext))
@@ -222,10 +222,10 @@ public XElement ToXml()
                         new XAttribute("nextSerialNumber", AutoEnterValue ?? "1")));
                     break;
                 case AutoEnterType.ConstantData:
-                    autoEl.Add(XElement.Parse($"<ConstantData><![CDATA[{AutoEnterValue ?? ""}]]></ConstantData>"));
+                    autoEl.Add(new XElement("ConstantData", new XCData(AutoEnterValue ?? "")));
                     break;
                 case AutoEnterType.Calculation:
-                    autoEl.Add(XElement.Parse($"<Calculation><![CDATA[{AutoEnterValue ?? ""}]]></Calculation>"));
+                    autoEl.Add(new XElement("Calculation", new XCData(AutoEnterValue ?? "")));
                     break;
             }
 
@@ -249,16 +249,16 @@ public XElement ToXml()
             {
                 var rangeEl = new XElement("Range");
                 if (RangeMin != null)
-                    rangeEl.Add(XElement.Parse($"<MinimumValue><![CDATA[{RangeMin}]]></MinimumValue>"));
+                    rangeEl.Add(new XElement("MinimumValue", new XCData(RangeMin)));
                 if (RangeMax != null)
-                    rangeEl.Add(XElement.Parse($"<MaximumValue><![CDATA[{RangeMax}]]></MaximumValue>"));
+                    rangeEl.Add(new XElement("MaximumValue", new XCData(RangeMax)));
                 valEl.Add(rangeEl);
             }
 
             if (ValidationCalculation != null)
-                valEl.Add(XElement.Parse($"<StrictValidation><![CDATA[{ValidationCalculation}]]></StrictValidation>"));
+                valEl.Add(new XElement("StrictValidation", new XCData(ValidationCalculation)));
             if (ErrorMessage != null)
-                valEl.Add(XElement.Parse($"<ErrorMessage><![CDATA[{ErrorMessage}]]></ErrorMessage>"));
+                valEl.Add(new XElement("ErrorMessage", new XCData(ErrorMessage)));
 
             el.Add(valEl);
         }

src/SharpFM.Model/Scripting/Values/Calculation.cs

@@ -16,7 +16,7 @@ public sealed record Calculation(string Text)
     /// common case in FileMaker script XML.
     /// </summary>
     public XElement ToXml(string elementName = "Calculation") =>
-        XElement.Parse($"<{elementName}><![CDATA[{Text}]]></{elementName}>");
+        new(elementName, new XCData(Text));
 
     /// <summary>
     /// Parse the text body of the element (CDATA is transparent to

src/SharpFM.Model/Scripting/XmlHelpers.cs

@@ -6,14 +6,6 @@ namespace SharpFM.Model.Scripting;
 
 public static class XmlHelpers
 {
-    public static string XmlEscape(string s)
-    {
-        return s.Replace("&", "&")
-                .Replace("<", "&lt;")
-                .Replace(">", "&gt;")
-                .Replace("\"", "&quot;");
-    }
-
     public static string Unquote(string s)
     {
         if (s.Length >= 2 && s[0] == '"' && s[^1] == '"')

tests/SharpFM.Tests/ClipTypes/TableClipStrategyTests.cs

@@ -100,6 +100,7 @@ public void DefaultXml_ProducesParseableSnippet()
     [InlineData("My \"favorite\" stuff")]
     [InlineData("A & B")]
     [InlineData("<Angle>")]
+    [InlineData("O'Brien")]
     public void Table_DefaultXml_EscapesPunctuationInName(string clipName)
     {
         var seed = TableClipStrategy.Table.DefaultXml(clipName);

tests/SharpFM.Tests/Scripting/Values/CalculationTests.cs

@@ -55,4 +55,17 @@ public void RoundTrip_PreservesComplexExpression()
 
         Assert.Equal(expr, roundTripped.Value);
     }
+
+    [Theory]
+    [InlineData("a < b & c > d")]
+    [InlineData("Quote(\"hello\")")]
+    [InlineData("If ( name = \"O'Brien\" ; 1 ; 0 )")]
+    public void RoundTrip_PreservesXmlMetacharacters(string expr)
+    {
+        var emitted = new Calculation(expr).ToXml();
+        var serialized = emitted.ToString();
+        var reparsed = Calculation.FromXml(XElement.Parse(serialized));
+
+        Assert.Equal(expr, reparsed.Text);
+    }
 }