Remove ProjectDisplayName from ProjectDeclaration

MDoerner · MDoerner · commit c7ac2da07a88 · 2020-02-18T00:18:35.000+01:00
This also removes the IVbProject ctor parameter.
diff --git a/Rubberduck.Core/Formatters/InspectionResultFormatter.cs b/Rubberduck.Core/Formatters/InspectionResultFormatter.cs
@@ -8,10 +8,12 @@ namespace Rubberduck.Formatters
     public class InspectionResultFormatter : IExportable
     {
         private readonly IInspectionResult _inspectionResult;
+        private readonly string _documentName;
 
-        public InspectionResultFormatter(IInspectionResult inspectionResult)
+        public InspectionResultFormatter(IInspectionResult inspectionResult, string documentName)
         {
             _inspectionResult = inspectionResult;
+            _documentName = documentName;
         }
 
         public object[] ToArray()
@@ -28,30 +30,10 @@ public object[] ToArray()
             };
         }
 
-        /// <summary>
-        /// WARNING: This property can have side effects. It can change the ActiveVBProject if the result has a null Declaration, 
-        /// which causes a flicker in the VBE. This should only be called if it is *absolutely* necessary.
-        /// </summary>
         public string ToClipboardString()
         {
             var module = _inspectionResult.QualifiedSelection.QualifiedName;
-            var documentName = _inspectionResult.Target != null
-                ? _inspectionResult.Target.ProjectDisplayName
-                : string.Empty;
-
-            //todo: Find a sane way to reimplement this.
-            //if (string.IsNullOrEmpty(documentName))
-            //{
-            //    var component = module.Component;
-            //    documentName = component != null 
-            //        ? component.ParentProject.ProjectDisplayName 
-            //        : string.Empty;
-            //}
-
-            if (string.IsNullOrEmpty(documentName))
-            {
-                documentName = Path.GetFileName(module.ProjectPath);
-            }
+            var documentName = _documentName;
 
             return string.Format(
                 InspectionsUI.QualifiedSelectionInspection,
diff --git a/Rubberduck.Parsing/Symbols/ProjectDeclaration.cs b/Rubberduck.Parsing/Symbols/ProjectDeclaration.cs
@@ -3,20 +3,17 @@
 using Rubberduck.VBEditor;
 using System.Collections.Generic;
 using System.Linq;
-using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.Parsing.Symbols
 {
     public sealed class ProjectDeclaration : Declaration, IDisposable
     {
         private readonly List<ProjectReference> _projectReferences;
-        private readonly IVBProject _project;
 
         public ProjectDeclaration(
             QualifiedMemberName qualifiedName,
             string name,
-            bool isUserDefined,
-            IVBProject project)
+            bool isUserDefined)
             : base(
                   qualifiedName,
                   null,
@@ -34,12 +31,11 @@ public ProjectDeclaration(
                   null,
                   isUserDefined)
         {
-            _project = project;
             _projectReferences = new List<ProjectReference>();
         }
 
         public ProjectDeclaration(ComProject project, QualifiedModuleName module)
-            : this(module.QualifyMemberName(project.Name), project.Name, false, null)
+            : this(module.QualifyMemberName(project.Name), project.Name, false)
         {
             Guid = project.Guid;
             MajorVersion = project.MajorVersion;
@@ -72,24 +68,6 @@ public void ClearProjectReferences()
             _projectReferences.Clear();
         }
 
-        private string _displayName;
-        /// <summary>
-        /// WARNING: This property has side effects. It changes the ActiveVBProject, which causes a flicker in the VBE.
-        /// This should only be called if it is *absolutely* necessary.
-        /// </summary>
-        public override string ProjectDisplayName
-        {
-            get
-            {
-                if (_displayName != null)
-                {
-                    return _displayName;
-                }
-                _displayName = !IsDisposed && _project != null ? _project.ProjectDisplayName : string.Empty;
-                return _displayName;
-            }
-        }
-
         public bool IsDisposed { get; private set; }
 
         public void Dispose()
diff --git a/Rubberduck.Parsing/VBA/DeclarationResolving/DeclarationResolveRunnerBase.cs b/Rubberduck.Parsing/VBA/DeclarationResolving/DeclarationResolveRunnerBase.cs
@@ -80,7 +80,7 @@ private Declaration CreateProjectDeclaration(string projectId)
 
             var qualifiedModuleName = new QualifiedModuleName(project);
             var qualifiedName = qualifiedModuleName.QualifyMemberName(project.Name);
-            var projectDeclaration = new ProjectDeclaration(qualifiedName, qualifiedName.MemberName, true, project);
+            var projectDeclaration = new ProjectDeclaration(qualifiedName, qualifiedName.MemberName, true);
 
             return projectDeclaration;
         }
diff --git a/RubberduckTests/Symbols/AccessibilityCheckTests.cs b/RubberduckTests/Symbols/AccessibilityCheckTests.cs
@@ -23,7 +23,7 @@ public void ProjectsAreAlwaysAccessible()
             private static ProjectDeclaration GetTestProject(string name)
             {
                 var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);
-                return new ProjectDeclaration(qualifiedProjectName, name, true, null);
+                return new ProjectDeclaration(qualifiedProjectName, name, true);
             }
 
                 private static QualifiedModuleName StubQualifiedModuleName()
diff --git a/RubberduckTests/Symbols/ClassModuleDeclarationTests.cs b/RubberduckTests/Symbols/ClassModuleDeclarationTests.cs
@@ -22,7 +22,7 @@ public void ClassModulesHaveDeclarationTypeClassModule()
             private static ProjectDeclaration GetTestProject(string name)
             {
                 var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);
-                return new ProjectDeclaration(qualifiedProjectName, name, true, null);
+                return new ProjectDeclaration(qualifiedProjectName, name, true);
             }
 
                 private static QualifiedModuleName StubQualifiedModuleName()
diff --git a/RubberduckTests/Symbols/DeclarationFinderTests.cs b/RubberduckTests/Symbols/DeclarationFinderTests.cs
@@ -1583,7 +1583,7 @@ private static ClassModuleDeclaration GetTestClassModule(Declaration projectDecl
         private static ProjectDeclaration GetTestProject(string name)
         {
             var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName("proj"), name);
-            return new ProjectDeclaration(qualifiedProjectName, name, true, null);
+            return new ProjectDeclaration(qualifiedProjectName, name, true);
         }
 
         private static QualifiedModuleName StubQualifiedModuleName(string name)
diff --git a/RubberduckTests/Symbols/ProceduralModuleDeclarationTests.cs b/RubberduckTests/Symbols/ProceduralModuleDeclarationTests.cs
@@ -21,7 +21,7 @@ public void ProceduralModulesHaveDeclarationTypeProceduralModule()
             private static ProjectDeclaration GetTestProject(string name)
             {
                 var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);
-                return new ProjectDeclaration(qualifiedProjectName, name, true, null);
+                return new ProjectDeclaration(qualifiedProjectName, name, true);
             }
 
                 private static QualifiedModuleName StubQualifiedModuleName()
diff --git a/RubberduckTests/Symbols/ProjectDeclarationTests.cs b/RubberduckTests/Symbols/ProjectDeclarationTests.cs
@@ -20,7 +20,7 @@ public void ProjectsHaveDeclarationTypeProject()
             private static ProjectDeclaration GetTestProject(string name)
             {
                 var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);
-                return new ProjectDeclaration(qualifiedProjectName, name, true, null);
+                return new ProjectDeclaration(qualifiedProjectName, name, true);
             }
 
                 private static QualifiedModuleName StubQualifiedModuleName()

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ private Declaration CreateProjectDeclaration(string projectId)`
`80`	`80`
`81`	`81`	`var qualifiedModuleName = new QualifiedModuleName(project);`
`82`	`82`	`var qualifiedName = qualifiedModuleName.QualifyMemberName(project.Name);`
`83`		`- var projectDeclaration = new ProjectDeclaration(qualifiedName, qualifiedName.MemberName, true, project);`
	`83`	`+ var projectDeclaration = new ProjectDeclaration(qualifiedName, qualifiedName.MemberName, true);`
`84`	`84`
`85`	`85`	`return projectDeclaration;`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public void ProjectsAreAlwaysAccessible()`
`23`	`23`	`private static ProjectDeclaration GetTestProject(string name)`
`24`	`24`	`{`
`25`	`25`	`var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);`
`26`		`- return new ProjectDeclaration(qualifiedProjectName, name, true, null);`
	`26`	`+ return new ProjectDeclaration(qualifiedProjectName, name, true);`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`private static QualifiedModuleName StubQualifiedModuleName()`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public void ClassModulesHaveDeclarationTypeClassModule()`
`22`	`22`	`private static ProjectDeclaration GetTestProject(string name)`
`23`	`23`	`{`
`24`	`24`	`var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);`
`25`		`- return new ProjectDeclaration(qualifiedProjectName, name, true, null);`
	`25`	`+ return new ProjectDeclaration(qualifiedProjectName, name, true);`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`private static QualifiedModuleName StubQualifiedModuleName()`
Original file line number	Diff line number	Diff line change
`@@ -1583,7 +1583,7 @@ private static ClassModuleDeclaration GetTestClassModule(Declaration projectDecl`
`1583`	`1583`	`private static ProjectDeclaration GetTestProject(string name)`
`1584`	`1584`	`{`
`1585`	`1585`	`var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName("proj"), name);`
`1586`		`- return new ProjectDeclaration(qualifiedProjectName, name, true, null);`
	`1586`	`+ return new ProjectDeclaration(qualifiedProjectName, name, true);`
`1587`	`1587`	`}`
`1588`	`1588`
`1589`	`1589`	`private static QualifiedModuleName StubQualifiedModuleName(string name)`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public void ProceduralModulesHaveDeclarationTypeProceduralModule()`
`21`	`21`	`private static ProjectDeclaration GetTestProject(string name)`
`22`	`22`	`{`
`23`	`23`	`var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);`
`24`		`- return new ProjectDeclaration(qualifiedProjectName, name, true, null);`
	`24`	`+ return new ProjectDeclaration(qualifiedProjectName, name, true);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`private static QualifiedModuleName StubQualifiedModuleName()`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public void ProjectsHaveDeclarationTypeProject()`
`20`	`20`	`private static ProjectDeclaration GetTestProject(string name)`
`21`	`21`	`{`
`22`	`22`	`var qualifiedProjectName = new QualifiedMemberName(StubQualifiedModuleName(), name);`
`23`		`- return new ProjectDeclaration(qualifiedProjectName, name, true, null);`
	`23`	`+ return new ProjectDeclaration(qualifiedProjectName, name, true);`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`private static QualifiedModuleName StubQualifiedModuleName()`