feat: derive clip name from FileMaker metadata on paste

fuzzzerd · fuzzzerd · commit 624f62cbddb0 · 2026-05-17T13:03:04.000-05:00
diff --git a/src/SharpFM.Model/ClipTypes/IClipTypeStrategy.cs b/src/SharpFM.Model/ClipTypes/IClipTypeStrategy.cs
@@ -29,4 +29,13 @@ public interface IClipTypeStrategy
     /// "new clip" flows in the host and by plugins.
     /// </summary>
     string DefaultXml(string clipName);
+
+    /// <summary>
+    /// Pull a clip-display-name hint out of <paramref name="xml"/> when the
+    /// wire format carries one (e.g. <c>&lt;Script name="…"&gt;</c> for
+    /// <c>Mac-XMSC</c>, <c>&lt;BaseTable name="…"&gt;</c> for <c>Mac-XMTB</c>).
+    /// Returns <c>null</c> for formats with no embedded name or when the
+    /// element is absent. Must not throw on malformed input.
+    /// </summary>
+    string? TryGetSourceName(string xml);
 }
diff --git a/src/SharpFM.Model/ClipTypes/LayoutClipStrategy.cs b/src/SharpFM.Model/ClipTypes/LayoutClipStrategy.cs
@@ -29,4 +29,6 @@ public ClipParseResult Parse(string xml)
 
     public string DefaultXml(string clipName) =>
         "<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";
+
+    public string? TryGetSourceName(string xml) => null;
 }
diff --git a/src/SharpFM.Model/ClipTypes/OpaqueClipStrategy.cs b/src/SharpFM.Model/ClipTypes/OpaqueClipStrategy.cs
@@ -44,4 +44,6 @@ public ClipParseResult Parse(string xml)
 
     public string DefaultXml(string clipName) =>
         "<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";
+
+    public string? TryGetSourceName(string xml) => null;
 }
diff --git a/src/SharpFM.Model/ClipTypes/ScriptClipStrategy.cs b/src/SharpFM.Model/ClipTypes/ScriptClipStrategy.cs
@@ -1,5 +1,8 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
+using System.Xml;
+using System.Xml.Linq;
 using SharpFM.Model.Parsing;
 using SharpFM.Model.Scripting;
 
@@ -63,4 +66,17 @@ public ClipParseResult Parse(string xml)
 
     public string DefaultXml(string clipName) =>
         "<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";
+
+    public string? TryGetSourceName(string xml)
+    {
+        try
+        {
+            var name = XDocument.Parse(xml).Descendants("Script").FirstOrDefault()?.Attribute("name")?.Value;
+            return string.IsNullOrEmpty(name) ? null : name;
+        }
+        catch (XmlException)
+        {
+            return null;
+        }
+    }
 }
diff --git a/src/SharpFM.Model/ClipTypes/TableClipStrategy.cs b/src/SharpFM.Model/ClipTypes/TableClipStrategy.cs
@@ -1,5 +1,8 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
+using System.Xml;
+using System.Xml.Linq;
 using SharpFM.Model.Parsing;
 using SharpFM.Model.Schema;
 using SharpFM.Model.Scripting;
@@ -66,4 +69,17 @@ public string DefaultXml(string clipName) =>
         _wrapsBaseTable
             ? $"<fmxmlsnippet type=\"FMObjectList\"><BaseTable name=\"{XmlHelpers.XmlEscape(clipName)}\"></BaseTable></fmxmlsnippet>"
             : "<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";
+
+    public string? TryGetSourceName(string xml)
+    {
+        try
+        {
+            var name = XDocument.Parse(xml).Descendants("BaseTable").FirstOrDefault()?.Attribute("name")?.Value;
+            return string.IsNullOrEmpty(name) ? null : name;
+        }
+        catch (XmlException)
+        {
+            return null;
+        }
+    }
 }
diff --git a/src/SharpFM/ViewModels/MainWindowViewModel.cs b/src/SharpFM/ViewModels/MainWindowViewModel.cs
@@ -334,6 +334,19 @@ public async Task CopyAsClass()
         }
     }
 
+    // Pick a clip name that doesn't collide with anything already loaded.
+    // Returns the input when it's free, otherwise appends "(2)", "(3)", … until
+    // a free slot is found.
+    private string UniqueClipName(string desired)
+    {
+        if (FileMakerClips.All(c => c.Clip.Name != desired)) return desired;
+        for (var n = 2; ; n++)
+        {
+            var candidate = $"{desired} ({n})";
+            if (FileMakerClips.All(c => c.Clip.Name != candidate)) return candidate;
+        }
+    }
+
     public async Task PasteFileMakerClipData()
     {
         try
@@ -355,6 +368,10 @@ public async Task PasteFileMakerClipData()
                 // don't add duplicates
                 if (FileMakerClips.Any(k => k.Clip.Xml == clip.Xml)) continue;
 
+                var sourceName = ClipTypeRegistry.For(format).TryGetSourceName(clip.Xml);
+                var desired = string.IsNullOrWhiteSpace(sourceName) ? "new-clip" : sourceName;
+                clip = clip.Rename(UniqueClipName(desired));
+
                 lastAdded = new ClipViewModel(clip);
                 FileMakerClips.Add(lastAdded);
                 count++;
diff --git a/tests/SharpFM.Tests/ClipTypes/LayoutClipStrategyTests.cs b/tests/SharpFM.Tests/ClipTypes/LayoutClipStrategyTests.cs
@@ -12,6 +12,15 @@ public void Identity_IsLayout()
         Assert.Equal("Layout", LayoutClipStrategy.Instance.DisplayName);
     }
 
+    [Fact]
+    public void TryGetSourceName_ReturnsNull()
+    {
+        var name = LayoutClipStrategy.Instance.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><Layout/></fmxmlsnippet>");
+
+        Assert.Null(name);
+    }
+
     [Fact]
     public void Parse_ValidLayoutSnippet_ReturnsSuccess()
     {
diff --git a/tests/SharpFM.Tests/ClipTypes/OpaqueClipStrategyTests.cs b/tests/SharpFM.Tests/ClipTypes/OpaqueClipStrategyTests.cs
@@ -53,4 +53,12 @@ public void DefaultXml_ProducesParseableSnippet()
         var result = OpaqueClipStrategy.Instance.Parse(seed);
         Assert.IsType<ParseSuccess>(result);
     }
+
+    [Fact]
+    public void TryGetSourceName_ReturnsNull()
+    {
+        var name = OpaqueClipStrategy.Instance.TryGetSourceName("<root name=\"Whatever\"/>");
+
+        Assert.Null(name);
+    }
 }
diff --git a/tests/SharpFM.Tests/ClipTypes/ScriptClipStrategyTests.cs b/tests/SharpFM.Tests/ClipTypes/ScriptClipStrategyTests.cs
@@ -14,6 +14,41 @@ public void StepsAndScript_HaveDistinctIdentities()
         Assert.Equal("Script", ScriptClipStrategy.Script.DisplayName);
     }
 
+    [Fact]
+    public void TryGetSourceName_ReturnsScriptNameAttribute()
+    {
+        var name = ScriptClipStrategy.Script.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><Script name=\"FooBar\"></Script></fmxmlsnippet>");
+
+        Assert.Equal("FooBar", name);
+    }
+
+    [Fact]
+    public void TryGetSourceName_StepsClipWithoutScriptWrapper_ReturnsNull()
+    {
+        var name = ScriptClipStrategy.Steps.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><Step enable=\"True\" id=\"141\" name=\"Set Variable\"/></fmxmlsnippet>");
+
+        Assert.Null(name);
+    }
+
+    [Fact]
+    public void TryGetSourceName_MalformedXml_ReturnsNull()
+    {
+        var name = ScriptClipStrategy.Script.TryGetSourceName("<oops>");
+
+        Assert.Null(name);
+    }
+
+    [Fact]
+    public void TryGetSourceName_PreservesPunctuationInName()
+    {
+        var name = ScriptClipStrategy.Script.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><Script name=\"My &quot;favorite&quot; script\"></Script></fmxmlsnippet>");
+
+        Assert.Equal("My \"favorite\" script", name);
+    }
+
     [Fact]
     public void Parse_EmptyScriptSnippet_ReturnsLosslessSuccess()
     {
diff --git a/tests/SharpFM.Tests/ClipTypes/TableClipStrategyTests.cs b/tests/SharpFM.Tests/ClipTypes/TableClipStrategyTests.cs
@@ -12,6 +12,32 @@ public void TableAndField_HaveDistinctIdentities()
         Assert.Equal("Mac-XMFD", TableClipStrategy.Field.FormatId);
     }
 
+    [Fact]
+    public void TryGetSourceName_ReturnsBaseTableNameAttribute()
+    {
+        var name = TableClipStrategy.Table.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><BaseTable name=\"Customers\" id=\"1\"></BaseTable></fmxmlsnippet>");
+
+        Assert.Equal("Customers", name);
+    }
+
+    [Fact]
+    public void TryGetSourceName_FieldClipWithoutBaseTable_ReturnsNull()
+    {
+        var name = TableClipStrategy.Field.TryGetSourceName(
+            "<fmxmlsnippet type=\"FMObjectList\"><Field id=\"1\" name=\"ID\"/></fmxmlsnippet>");
+
+        Assert.Null(name);
+    }
+
+    [Fact]
+    public void TryGetSourceName_MalformedXml_ReturnsNull()
+    {
+        var name = TableClipStrategy.Table.TryGetSourceName("<oops>");
+
+        Assert.Null(name);
+    }
+
     [Fact]
     public void Parse_ValidTable_ReturnsSuccess()
     {
diff --git a/tests/SharpFM.Tests/ViewModels/MainWindowViewModelTests.cs b/tests/SharpFM.Tests/ViewModels/MainWindowViewModelTests.cs
@@ -7,6 +7,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using SharpFM.Dialogs;
+using SharpFM.Model;
 using SharpFM.Plugin;
 using SharpFM.Plugin.UI;
 using SharpFM.Services;
@@ -199,6 +200,77 @@ public async Task PasteFileMakerClipData_SelectsLastPastedClip()
         Assert.Contains("Pasted 2 clip(s)", vm.StatusMessage);
     }
 
+    [Fact]
+    public async Task PasteFileMakerClipData_ScriptWithMetadataName_UsesMetadataAsClipName()
+    {
+        var clipboard = new MockClipboardService();
+        clipboard.ClipboardData["Mac-XMSC"] = BuildClipBytes(
+            "<fmxmlsnippet><Script name=\"OrderTotal\"></Script></fmxmlsnippet>");
+        var vm = CreateVm(clipboard);
+        vm.FileMakerClips.Clear();
+
+        await vm.PasteFileMakerClipData();
+
+        Assert.Equal("OrderTotal", vm.SelectedClip!.Clip.Name);
+    }
+
+    [Fact]
+    public async Task PasteFileMakerClipData_TableWithBaseTableName_UsesItAsClipName()
+    {
+        var clipboard = new MockClipboardService();
+        clipboard.ClipboardData["Mac-XMTB"] = BuildClipBytes(
+            "<fmxmlsnippet><BaseTable name=\"Customers\"></BaseTable></fmxmlsnippet>");
+        var vm = CreateVm(clipboard);
+        vm.FileMakerClips.Clear();
+
+        await vm.PasteFileMakerClipData();
+
+        Assert.Equal("Customers", vm.SelectedClip!.Clip.Name);
+    }
+
+    [Fact]
+    public async Task PasteFileMakerClipData_NoMetadataName_FallsBackToNewClip()
+    {
+        var clipboard = new MockClipboardService();
+        clipboard.ClipboardData["Mac-XMSS"] = BuildClipBytes(
+            "<fmxmlsnippet type=\"FMObjectList\"><Step enable=\"True\" id=\"141\" name=\"Set Variable\"/></fmxmlsnippet>");
+        var vm = CreateVm(clipboard);
+        vm.FileMakerClips.Clear();
+
+        await vm.PasteFileMakerClipData();
+
+        Assert.Equal("new-clip", vm.SelectedClip!.Clip.Name);
+    }
+
+    [Fact]
+    public async Task PasteFileMakerClipData_CollidingName_AppendsNumericSuffix()
+    {
+        var clipboard = new MockClipboardService();
+        clipboard.ClipboardData["Mac-XMSC"] = BuildClipBytes(
+            "<fmxmlsnippet><Script name=\"OrderTotal\"></Script></fmxmlsnippet>");
+        var vm = CreateVm(clipboard);
+        vm.FileMakerClips.Clear();
+        vm.FileMakerClips.Add(new ClipViewModel(Clip.FromXml("OrderTotal", "Mac-XMSC", "<fmxmlsnippet/>")));
+
+        await vm.PasteFileMakerClipData();
+
+        Assert.Equal("OrderTotal (2)", vm.SelectedClip!.Clip.Name);
+    }
+
+    [Fact]
+    public async Task PasteFileMakerClipData_PreservesPunctuationInName()
+    {
+        var clipboard = new MockClipboardService();
+        clipboard.ClipboardData["Mac-XMSC"] = BuildClipBytes(
+            "<fmxmlsnippet><Script name=\"My &quot;favorite&quot; script\"></Script></fmxmlsnippet>");
+        var vm = CreateVm(clipboard);
+        vm.FileMakerClips.Clear();
+
+        await vm.PasteFileMakerClipData();
+
+        Assert.Equal("My \"favorite\" script", vm.SelectedClip!.Clip.Name);
+    }
+
     private static byte[] BuildClipBytes(string xml)
     {
         var payload = Encoding.UTF8.GetBytes(xml);

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,6 @@ public ClipParseResult Parse(string xml)`
`29`	`29`
`30`	`30`	`public string DefaultXml(string clipName) =>`
`31`	`31`	`"<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";`
	`32`	`+`
	`33`	`+ public string? TryGetSourceName(string xml) => null;`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,4 +44,6 @@ public ClipParseResult Parse(string xml)`
`44`	`44`
`45`	`45`	`public string DefaultXml(string clipName) =>`
`46`	`46`	`"<fmxmlsnippet type=\"FMObjectList\"></fmxmlsnippet>";`
	`47`	`+`
	`48`	`+ public string? TryGetSourceName(string xml) => null;`
`47`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,4 +53,12 @@ public void DefaultXml_ProducesParseableSnippet()`
`53`	`53`	`var result = OpaqueClipStrategy.Instance.Parse(seed);`
`54`	`54`	`Assert.IsType<ParseSuccess>(result);`
`55`	`55`	`}`
	`56`	`+`
	`57`	`+ [Fact]`
	`58`	`+ public void TryGetSourceName_ReturnsNull()`
	`59`	`+ {`
	`60`	`+ var name = OpaqueClipStrategy.Instance.TryGetSourceName("<root name=\"Whatever\"/>");`
	`61`	`+`
	`62`	`+ Assert.Null(name);`
	`63`	`+ }`
`56`	`64`	`}`