Restructure to make list handling more efficient, add tests.

Author: comintern

Rubberduck.Core/CodeAnalysis/CodeMetrics/CodeMetricsViewModel.cs

@@ -56,35 +56,35 @@ private void OnStateChanged(object sender, ParserStateEventArgs e)
 
             if (e.State == ParserState.ResolvedDeclarations)
             {
-                Synchronize(_state.DeclarationFinder.AllUserDeclarations.ToList());
+                Synchronize(_state.DeclarationFinder.AllUserDeclarations);
             }
         }
 
-        private void Synchronize(List<Declaration> declarations)
+        private void Synchronize(IEnumerable<Declaration> declarations)
         {
             var metricResults = _analyst.GetMetrics(_state);
             _resultsByDeclaration = metricResults.GroupBy(r => r.Declaration).ToDictionary(g => g.Key, g => g.ToList());
 
             _uiDispatcher.Invoke(() =>
             {
+                var updates = declarations.ToList();
                 var existing = Projects.OfType<CodeExplorerProjectViewModel>().ToList();
 
                 foreach (var project in existing)
                 {
-                    project.Synchronize(declarations);
+                    project.Synchronize(ref updates);
                     if (project.Declaration is null)
                     {
                         Projects.Remove(project);
                     }
                 }
 
-                var adding = declarations.OfType<ProjectDeclaration>().ToList();
+                var adding = updates.OfType<ProjectDeclaration>().ToList();
 
                 foreach (var project in adding)
                 {
-                    var model = new CodeExplorerProjectViewModel(project, declarations.Where(proj => proj.ProjectId.Equals(project.ProjectId)).ToList(), _state, _vbe, false);
+                    var model = new CodeExplorerProjectViewModel(project, ref updates, _state, _vbe, false);
                     Projects.Add(model);
-                    model.IsExpanded = true;
                 }
             });
         }

Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerComponentViewModel.cs

@@ -30,12 +30,12 @@ public sealed class CodeExplorerComponentViewModel : CodeExplorerItemViewModel
 
         private readonly IVBE _vbe;
 
-        public CodeExplorerComponentViewModel(ICodeExplorerNode parent, Declaration declaration, IEnumerable<Declaration> declarations, IVBE vbe) 
+        public CodeExplorerComponentViewModel(ICodeExplorerNode parent, Declaration declaration, ref List<Declaration> declarations, IVBE vbe) 
             : base(parent, declaration)
         {
             _vbe = vbe;
             SetName();    
-            AddNewChildren(declarations.ToList());
+            AddNewChildren(ref declarations);
         }
 
         private string _name;
@@ -54,9 +54,9 @@ public CodeExplorerComponentViewModel(ICodeExplorerNode parent, Declaration decl
         public bool IsTestModule => Declaration.DeclarationType == DeclarationType.ProceduralModule
                                     && Declaration.Annotations.Any(annotation => annotation.AnnotationType == AnnotationType.TestModule);
 
-        public override void Synchronize(List<Declaration> updated)
+        public override void Synchronize(ref List<Declaration> updated)
         {
-            base.Synchronize(updated);
+            base.Synchronize(ref updated);
             if (Declaration is null)
             {
                 return;
@@ -66,23 +66,22 @@ public override void Synchronize(List<Declaration> updated)
             SetName();
         }
 
-        protected override void AddNewChildren(List<Declaration> updated)
+        protected override void AddNewChildren(ref List<Declaration> updated)
         {
             if (updated is null)
             {
                 return;
             }
 
-            var children = updated
-                .Where(declaration => declaration.ParentDeclaration != null &&
-                    MemberTypes.Contains(declaration.DeclarationType) &&
-                    declaration.ParentScope.Equals(Declaration.Scope, StringComparison.OrdinalIgnoreCase))
-                .ToList();
+            var children = updated.Where(declaration =>
+                !ReferenceEquals(Declaration, declaration) &&
+                declaration.QualifiedModuleName.Equals(Declaration?.QualifiedModuleName)).ToList();
 
-            foreach (var member in children)
+            updated = updated.Except(children.Concat(new [] { Declaration })).ToList();
+
+            foreach (var member in children.Where(declaration => MemberTypes.Contains(declaration.DeclarationType)).ToList())
             {
-                AddChild(new CodeExplorerMemberViewModel(this, member, updated));
-                updated.Remove(member);
+                AddChild(new CodeExplorerMemberViewModel(this, member, ref children));
             }
         }
 

Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerCustomFolderViewModel.cs

@@ -8,7 +8,7 @@
 
 namespace Rubberduck.Navigation.CodeExplorer
 {
-    [DebuggerDisplay("{Name}")]
+    [DebuggerDisplay("{" + nameof(Name) + "}")]
     public sealed class CodeExplorerCustomFolderViewModel : CodeExplorerItemViewModel
     {
         private static readonly DeclarationType[] ComponentTypes =
@@ -26,14 +26,14 @@ public CodeExplorerCustomFolderViewModel(
             string name, 
             string fullPath, 
             IVBE vbe,
-            IEnumerable<Declaration> declarations) : base(parent, parent?.Declaration)
+            ref List<Declaration> declarations) : base(parent, parent?.Declaration)
         {
             _vbe = vbe;
             FolderDepth = parent is CodeExplorerCustomFolderViewModel folder ? folder.FolderDepth + 1 : 1;
             FullPath = fullPath?.Trim('"') ?? string.Empty;
             Name = name.Replace("\"", string.Empty);
 
-            AddNewChildren(declarations.ToList());
+            AddNewChildren(ref declarations);
         }
 
         public override string Name { get; }
@@ -63,84 +63,77 @@ public override bool IsErrorState
 
         public override bool Filtered => false;
 
-        protected override void AddNewChildren(List<Declaration> declarations)
+        protected override void AddNewChildren(ref List<Declaration> declarations)
         {
-            var children = declarations.Where(declaration => declaration.IsInSubFolder(FullPath)).ToList();
+            var children = declarations.Where(declaration => declaration.IsInFolderOrSubFolder(FullPath)).ToList();
+            declarations = declarations.Except(children).ToList();
 
-            foreach (var folder in children.GroupBy(declaration => declaration.CustomFolder.SubFolderRoot(FullPath)))
+            var subFolders = children.Where(declaration => declaration.IsInSubFolder(FullPath)).ToList();
+
+            foreach (var folder in subFolders.GroupBy(declaration => declaration.CustomFolder.SubFolderRoot(FullPath)))
             {
-                AddChild(new CodeExplorerCustomFolderViewModel(this, folder.Key, $"{FullPath}.{folder.Key}", _vbe, folder));
-                foreach (var declaration in folder)
-                {
-                    declarations.Remove(declaration);
-                }
+                var contents = folder.ToList();
+                AddChild(new CodeExplorerCustomFolderViewModel(this, folder.Key, $"{FullPath}.{folder.Key}", _vbe, ref contents));
             }
 
-            foreach (var declaration in declarations.Where(child => child.IsInFolder(FullPath)).GroupBy(item => item.ComponentName))
+            children = children.Except(subFolders).ToList();
+
+            foreach (var declaration in children.Where(child => child.IsInFolder(FullPath)).GroupBy(item => item.ComponentName))
             {
                 var moduleName = declaration.Key;
-                var parent = declarations.SingleOrDefault(item => 
+                var parent = children.SingleOrDefault(item => 
                     ComponentTypes.Contains(item.DeclarationType) && item.ComponentName == moduleName);
 
                 if (parent is null)
                 {
                     continue;
                 }
 
-                var members = declarations.Where(item =>
-                    !ComponentTypes.Contains(item.DeclarationType) && item.ComponentName == moduleName);
+                var members = children.Where(item =>
+                    !ComponentTypes.Contains(item.DeclarationType) && item.ComponentName == moduleName).ToList();
 
-                AddChild(new CodeExplorerComponentViewModel(this, parent, members, _vbe));
-                declarations.Remove(parent);
+                AddChild(new CodeExplorerComponentViewModel(this, parent, ref members, _vbe));
             }
         }
 
-        public override void Synchronize(List<Declaration> updated)
+        public override void Synchronize(ref List<Declaration> updated)
         {
-            SynchronizeChildren(updated);
+            SynchronizeChildren(ref updated);
         }
 
-        protected override void SynchronizeChildren(List<Declaration> updated)
+        protected override void SynchronizeChildren(ref List<Declaration> updated)
         {
-            var declarations = updated.Where(declaration => declaration.IsInFolderOrSubFolder(FullPath)).ToList();
+            var children = updated.Where(declaration => declaration.IsInFolderOrSubFolder(FullPath)).ToList();
+            updated = updated.Except(children).ToList();
 
-            if (!declarations.Any())
+            if (!children.Any())
             {
                 Declaration = null;
                 return;
             }
 
-            var synchronizing = declarations.ToList();
+            var subFolders = children.Where(declaration => declaration.IsInSubFolder(FullPath)).ToList();
+            children = children.Except(subFolders).ToList();
 
             foreach (var subfolder in Children.OfType<CodeExplorerCustomFolderViewModel>().ToList())
             {
-                subfolder.SynchronizeChildren(declarations);
+                subfolder.SynchronizeChildren(ref subFolders);
                 if (subfolder.Declaration is null)
                 {
                     RemoveChild(subfolder);
-                    continue;
-                }
-
-                var synchronized = synchronizing.Where(child => !declarations.Contains(child)).ToList();
-                foreach (var declaration in synchronized)
-                {
-                    updated.Remove(declaration);
                 }
             }
 
             foreach (var child in Children.OfType<CodeExplorerComponentViewModel>().ToList())
             {
-                child.Synchronize(updated);
+                child.Synchronize(ref children);
                 if (child.Declaration is null)
                 {
                     RemoveChild(child);
-                    continue;
                 }
-
-                updated.Remove(child.Declaration);
             }
 
-            AddNewChildren(updated);
+            AddNewChildren(ref children);
         }
     }
 }

Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerItemViewModel.cs

@@ -34,7 +34,7 @@ public override bool IsErrorState
             }
         }
 
-        public virtual void Synchronize(List<Declaration> updated)
+        public virtual void Synchronize(ref List<Declaration> updated)
         {
             if (Declaration is null)
             {
@@ -53,14 +53,14 @@ public virtual void Synchronize(List<Declaration> updated)
 
             Declaration = matching;
             updated.Remove(matching);
-            SynchronizeChildren(updated);
+            SynchronizeChildren(ref updated);
         }
 
-        protected virtual void SynchronizeChildren(List<Declaration> updated)
+        protected virtual void SynchronizeChildren(ref List<Declaration> updated)
         {
             foreach (var child in Children.OfType<CodeExplorerItemViewModel>().ToList())
             {
-                child.Synchronize(updated);
+                child.Synchronize(ref updated);
                 if (child.Declaration is null)
                 {
                     RemoveChild(child);
@@ -70,9 +70,9 @@ protected virtual void SynchronizeChildren(List<Declaration> updated)
                 updated.Remove(child.Declaration);
             }
 
-            AddNewChildren(updated);
+            AddNewChildren(ref updated);
         }
 
-        protected abstract void AddNewChildren(List<Declaration> updated);
+        protected abstract void AddNewChildren(ref List<Declaration> updated);
     }
 }

Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerMemberViewModel.cs

@@ -7,11 +7,11 @@
 
 namespace Rubberduck.Navigation.CodeExplorer
 {
-    public class CodeExplorerMemberViewModel : CodeExplorerItemViewModel
+    public sealed class CodeExplorerMemberViewModel : CodeExplorerItemViewModel
     {
-        public CodeExplorerMemberViewModel(ICodeExplorerNode parent, Declaration declaration, List<Declaration> declarations) : base(parent, declaration)
+        public CodeExplorerMemberViewModel(ICodeExplorerNode parent, Declaration declaration, ref List<Declaration> declarations) : base(parent, declaration)
         {
-            AddNewChildren(declarations);
+            AddNewChildren(ref declarations);
             Name = DetermineMemberName(declaration);
         }
 
@@ -59,9 +59,9 @@ public override string NameWithSignature
             DeclarationType.UserDefinedTypeMember
         };
 
-        public override void Synchronize(List<Declaration> updated)
+        public override void Synchronize(ref List<Declaration> updated)
         {
-            base.Synchronize(updated);
+            base.Synchronize(ref updated);
             if (Declaration is null)
             {
                 return;
@@ -72,21 +72,19 @@ public override void Synchronize(List<Declaration> updated)
             OnNameChanged();
         }
 
-        protected sealed override void AddNewChildren(List<Declaration> updated)
+        protected override void AddNewChildren(ref List<Declaration> updated)
         {
-            if (updated != null)
+            if (updated == null)
             {
-                var updates = updated.Where(item =>
-                        SubMemberTypes.Contains(item.DeclarationType) && item.ParentDeclaration.Equals(Declaration))
-                    .ToList();
+                return;
+            }
 
-                AddChildren(updates.Select(item => new CodeExplorerSubMemberViewModel(this, item)));
+            var updates = updated.Where(item =>
+                SubMemberTypes.Contains(item.DeclarationType) && item.ParentDeclaration.Equals(Declaration)).ToList();
 
-                foreach (var declaration in updates)
-                {
-                    updated.Remove(declaration);
-                }
-            }
+            updated = updated.Except(updates.Concat(new[] { Declaration })).ToList();
+
+            AddChildren(updates.Select(item => new CodeExplorerSubMemberViewModel(this, item)));
         }
 
         public override Comparer<ICodeExplorerNode> SortComparer