Simplify API abstraction to just the existing WorkspaceOpenDocument

Author: JustinGrote

src/PowerShellEditorServices/Extensions/EditorWorkspace.cs

@@ -5,57 +5,6 @@
 
 namespace Microsoft.PowerShell.EditorServices.Extensions
 {
-    /// <summary>
-    /// A document currently open in the editor workspace.
-    /// </summary>
-    public sealed class EditorWorkspaceDocument
-    {
-        private readonly EditorWorkspace _workspace;
-
-        internal EditorWorkspaceDocument(EditorWorkspace workspace, string path, bool saved)
-        {
-            _workspace = workspace;
-            Path = path;
-            Saved = saved;
-        }
-
-        /// <summary>
-        /// Gets the path of the document.
-        /// </summary>
-        public string Path { get; }
-
-        /// <summary>
-        /// Gets whether the document is backed by a saved file path (not in-memory).
-        /// </summary>
-        public bool Saved { get; }
-
-        /// <summary>
-        /// Opens this document in the editor.
-        /// </summary>
-        public void Open() => _workspace.OpenFile(Path);
-
-        /// <summary>
-        /// Saves this document in the editor.
-        /// </summary>
-        public void Save() => _workspace.SaveFile(Path);
-
-        /// <summary>
-        /// Closes this document in the editor.
-        /// </summary>
-        public void Close() => _workspace.CloseFile(Path);
-
-        /// <summary>
-        /// Gets the display name of this document and unsaved status.
-        /// </summary>
-        /// <returns>The display name of this document.</returns>
-        public override string ToString()
-        {
-            string documentPath = Path ?? string.Empty;
-            string fileName = System.IO.Path.GetFileName(documentPath);
-            return Saved ? fileName : fileName + " [Unsaved]";
-        }
-    }
-
     /// <summary>
     /// Provides a PowerShell-facing API which allows scripts to
     /// interact with the editor's workspace.
@@ -84,11 +33,7 @@ public sealed class EditorWorkspace
         /// <summary>
         /// Get all currently open documents in the workspace.
         /// </summary>
-        public EditorWorkspaceDocument[] Documents => [..
-            editorOperations
-            .GetWorkspaceOpenDocuments()
-            .Select(doc => new EditorWorkspaceDocument(this, doc.Path, doc.Saved))
-        ];
+        public WorkspaceOpenDocument[] Documents => [.. editorOperations.GetWorkspaceOpenDocuments()];
 
         #endregion
 
@@ -138,13 +83,15 @@ public sealed class EditorWorkspace
         /// <param name="filePath">The path to the file to be closed.</param>
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void CloseFile(string filePath) => editorOperations.CloseFileAsync(filePath).Wait();
+        public void CloseFile(WorkspaceOpenDocument document) => CloseFile(document.Path);
 
         /// <summary>
         /// Saves an open file in the workspace.
         /// </summary>
         /// <param name="filePath">The path to the file to be saved.</param>
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SaveFile(string filePath) => editorOperations.SaveFileAsync(filePath).Wait();
+        public void SaveFile(WorkspaceOpenDocument document) => SaveFile(document.Path);
 
         /// <summary>
         /// Saves a file with a new name AKA a copy.

src/PowerShellEditorServices/Extensions/IEditorOperations.cs

@@ -3,26 +3,32 @@
 
 using System.Threading.Tasks;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
+#nullable enable
 
 namespace Microsoft.PowerShell.EditorServices.Extensions
 {
-    internal readonly struct WorkspaceOpenDocument
+    public readonly struct WorkspaceOpenDocument(string path, bool saved)
     {
-        internal WorkspaceOpenDocument(string path, bool saved)
-        {
-            Path = path;
-            Saved = saved;
-        }
-
         /// <summary>
         /// Gets the path or URI of the open document.
         /// </summary>
-        public string Path { get; }
+        public string Path { get; } = path;
 
         /// <summary>
         /// Gets whether the document is backed by a saved file path (not in-memory).
         /// </summary>
-        public bool Saved { get; }
+        public bool Saved { get; } = saved;
+
+        /// <summary>
+        /// Gets the display name of this document and unsaved status.
+        /// </summary>
+        /// <returns>The display name of this document.</returns>
+        public override string ToString()
+        {
+            string documentPath = Path ?? string.Empty;
+            string fileName = System.IO.Path.GetFileName(documentPath);
+            return Saved ? fileName : fileName + " [Unsaved]";
+        }
     }
 
     /// <summary>

test/PowerShellEditorServices.Test/Extensions/EditorWorkspaceTests.cs

@@ -33,7 +33,7 @@ public void DocumentsReturnsOpenWorkspaceDocuments()
 
             EditorWorkspace workspace = new(editorOperations);
 
-            EditorWorkspaceDocument[] documents = workspace.Documents;
+            WorkspaceOpenDocument[] documents = workspace.Documents;
 
             Assert.Collection(
                 documents,
@@ -50,7 +50,7 @@ public void DocumentsReturnsOpenWorkspaceDocuments()
         }
 
         [Fact]
-        public void DocumentOpenSaveAndCloseUseWorkspaceOperations()
+        public void DocumentSaveAndCloseUseWorkspaceOperations()
         {
             string filePath = Path.Combine(WorkspacePath, "file.ps1");
             TestEditorOperations editorOperations = new()
@@ -59,15 +59,13 @@ public void DocumentOpenSaveAndCloseUseWorkspaceOperations()
             };
 
             EditorWorkspace workspace = new(editorOperations);
-            EditorWorkspaceDocument document = Assert.Single(workspace.Documents);
+            WorkspaceOpenDocument document = Assert.Single(workspace.Documents);
 
-            document.Open();
             document.Save();
             document.Close();
 
             Assert.Collection(
                 editorOperations.Calls,
-                call => Assert.Equal("OpenFile:" + filePath, call),
                 call => Assert.Equal("SaveFile:" + filePath, call),
                 call => Assert.Equal("CloseFile:" + filePath, call));
         }
@@ -86,7 +84,7 @@ public void DocumentToStringReturnsFileNameAndSavedStatus()
             };
 
             EditorWorkspace workspace = new(editorOperations);
-            IEnumerable<EditorWorkspaceDocument> documents = workspace.Documents;
+            IEnumerable<WorkspaceOpenDocument> documents = workspace.Documents;
 
             Assert.Collection(
                 documents,
@@ -106,7 +104,7 @@ public void DocumentSavedReturnsWorkspaceSavedState()
             };
 
             EditorWorkspace workspace = new(editorOperations);
-            IEnumerable<EditorWorkspaceDocument> documents = workspace.Documents;
+            IEnumerable<WorkspaceOpenDocument> documents = workspace.Documents;
 
             Assert.Collection(
                 documents,