Clean up SymbolReference constructors

Author: andyleejordan

src/PowerShellEditorServices/Services/CodeLens/PesterCodeLensProvider.cs

@@ -46,7 +46,7 @@ public PesterCodeLensProvider(ConfigurationService configurationService)
         private static CodeLens[] GetPesterLens(PesterSymbolReference pesterSymbol, ScriptFile scriptFile)
         {
             string word = pesterSymbol.Command == PesterCommandType.It ? "test" : "tests";
-            CodeLens[] codeLensResults = new CodeLens[]
+            return new CodeLens[]
             {
                 new CodeLens()
                 {
@@ -91,8 +91,6 @@ private static CodeLens[] GetPesterLens(PesterSymbolReference pesterSymbol, Scri
                     }
                 }
             };
-
-            return codeLensResults;
         }
 
         /// <summary>

src/PowerShellEditorServices/Services/Symbols/PesterDocumentSymbolProvider.cs

@@ -75,6 +75,8 @@ private static bool IsPesterCommand(CommandAst commandAst)
             return true;
         }
 
+        private static readonly char[] DefinitionTrimChars = new char[] { ' ', '{' };
+
         /// <summary>
         /// Convert a CommandAst known to represent a Pester command and a reference to the scriptfile
         /// it is in into symbol representing a Pester call for code lens
@@ -84,7 +86,11 @@ private static bool IsPesterCommand(CommandAst commandAst)
         /// <returns>a symbol representing the Pester call containing metadata for CodeLens to use</returns>
         private static PesterSymbolReference ConvertPesterAstToSymbolReference(ScriptFile scriptFile, CommandAst pesterCommandAst)
         {
-            string testLine = scriptFile.GetLine(pesterCommandAst.Extent.StartLineNumber);
+            string symbolName = scriptFile
+                .GetLine(pesterCommandAst.Extent.StartLineNumber)
+                .TrimStart()
+                .TrimEnd(DefinitionTrimChars);
+
             PesterCommandType? commandName = PesterSymbolReference.GetCommandType(pesterCommandAst.GetCommandName());
             if (commandName == null)
             {
@@ -126,7 +132,7 @@ private static PesterSymbolReference ConvertPesterAstToSymbolReference(ScriptFil
             return new PesterSymbolReference(
                 scriptFile,
                 commandName.Value,
-                testLine,
+                symbolName,
                 testName,
                 pesterCommandAst.Extent
             );
@@ -206,8 +212,6 @@ internal record PesterSymbolReference : SymbolReference
                 .Cast<PesterCommandType>()
                 .ToDictionary(pct => pct.ToString(), pct => pct, StringComparer.OrdinalIgnoreCase);
 
-        private static readonly char[] DefinitionTrimChars = new char[] { ' ', '{' };
-
         /// <summary>
         /// Gets the name of the test
         /// </summary>
@@ -221,15 +225,15 @@ internal record PesterSymbolReference : SymbolReference
         internal PesterSymbolReference(
             ScriptFile scriptFile,
             PesterCommandType commandType,
-            string testLine,
+            string symbolName,
             string testName,
             IScriptExtent scriptExtent)
                 : base(
                     SymbolType.Function,
-                    testLine.TrimStart().TrimEnd(DefinitionTrimChars),
+                    symbolName,
+                    scriptExtent,
                     scriptExtent,
-                    scriptFile.FilePath,
-                    testLine,
+                    scriptFile,
                     isDeclaration: true)
         {
             Command = commandType;

src/PowerShellEditorServices/Services/Symbols/PsdDocumentSymbolProvider.cs

@@ -23,7 +23,7 @@ IEnumerable<SymbolReference> IDocumentSymbolProvider.ProvideDocumentSymbols(
             if ((scriptFile.FilePath?.EndsWith(".psd1", StringComparison.OrdinalIgnoreCase) == true) ||
                  IsPowerShellDataFileAst(scriptFile.ScriptAst))
             {
-                FindHashtableSymbolsVisitor findHashtableSymbolsVisitor = new();
+                FindHashtableSymbolsVisitor findHashtableSymbolsVisitor = new(scriptFile);
                 scriptFile.ScriptAst.Visit(findHashtableSymbolsVisitor);
                 return findHashtableSymbolsVisitor.SymbolReferences;
             }

src/PowerShellEditorServices/Services/Symbols/SymbolReference.cs

@@ -33,32 +33,13 @@ internal record SymbolReference
 
         /// <summary>
         /// Constructs and instance of a SymbolReference
-        /// TODO: Remove this when it becomes unused.
         /// </summary>
         /// <param name="symbolType">The higher level type of the symbol</param>
         /// <param name="symbolName">The name of the symbol</param>
+        /// <param name="nameExtent">The extent of the symbol's name</param>
         /// <param name="scriptExtent">The script extent of the symbol</param>
-        /// <param name="filePath">The file path of the symbol</param>
-        /// <param name="sourceLine">The line contents of the given symbol (defaults to empty string)</param>
+        /// <param name="file">The script file that has the symbol</param>
         /// <param name="isDeclaration">True if this reference is the definition of the symbol</param>
-        public SymbolReference(
-            SymbolType symbolType,
-            string symbolName,
-            IScriptExtent scriptExtent,
-            string filePath = "",
-            string sourceLine = "",
-            bool isDeclaration = false)
-        {
-            // TODO: Verify params
-            SymbolType = symbolType;
-            SymbolName = symbolName;
-            ScriptRegion = new(scriptExtent);
-            NameRegion = ScriptRegion;
-            FilePath = string.IsNullOrEmpty(filePath) ? scriptExtent.File : filePath;
-            SourceLine = sourceLine;
-            IsDeclaration = isDeclaration;
-        }
-
         public SymbolReference(
             SymbolType symbolType,
             string symbolName,
@@ -82,16 +63,5 @@ public SymbolReference(
             }
             IsDeclaration = isDeclaration;
         }
-
-        /// <summary>
-        /// Constructs an instance of a SymbolReference.
-        /// TODO: Remove this when it becomes unused.
-        /// </summary>
-        /// <param name="symbolType">The higher level type of the symbol</param>
-        /// <param name="scriptExtent">The script extent of the symbol</param>
-        public SymbolReference(SymbolType symbolType, IScriptExtent scriptExtent)
-            : this(symbolType, scriptExtent.Text, scriptExtent, scriptExtent.File)
-        {
-        }
     }
 }

src/PowerShellEditorServices/Services/Symbols/Vistors/FindSymbolsVisitor.cs

@@ -5,6 +5,7 @@
 
 using System.Collections.Generic;
 using System.Management.Automation.Language;
+using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 
 namespace Microsoft.PowerShell.EditorServices.Services.Symbols
 {
@@ -13,6 +14,8 @@ namespace Microsoft.PowerShell.EditorServices.Services.Symbols
     /// </summary>
     internal class FindHashtableSymbolsVisitor : AstVisitor
     {
+        private readonly ScriptFile _file;
+
         /// <summary>
         /// List of symbols (keys) found in the hashtable
         /// </summary>
@@ -21,7 +24,11 @@ internal class FindHashtableSymbolsVisitor : AstVisitor
         /// <summary>
         /// Initializes a new instance of FindHashtableSymbolsVisitor class
         /// </summary>
-        public FindHashtableSymbolsVisitor() => SymbolReferences = new List<SymbolReference>();
+        public FindHashtableSymbolsVisitor(ScriptFile file)
+        {
+            SymbolReferences = new List<SymbolReference>();
+            _file = file;
+        }
 
         /// <summary>
         /// Adds keys in the input hashtable to the symbol reference
@@ -49,12 +56,16 @@ public override AstVisitAction VisitHashtable(HashtableAst hashtableAst)
                         File = hashtableAst.Extent.File
                     };
 
-                    const SymbolType symbolType = SymbolType.HashtableKey;
-
                     SymbolReferences.Add(
                         new SymbolReference(
-                            symbolType,
-                            nameExtent));
+                            SymbolType.HashtableKey,
+                            nameExtent.Text,
+                            nameExtent,
+                            // TODO: Should this be more?
+                            nameExtent,
+                            _file,
+                            // TODO: Should this be true?
+                            isDeclaration: false));
                 }
             }