Merge branch 'next' of https://github.com/rubberduck-vba/Rubberduck into next

Author: SonGokussj4

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Rubberduck does not work as expected
+title: ''
+labels: bug
+assignees: ''
+
+---
+**Rubberduck version information**
+The info below can be copy-paste-completed from the first lines of Rubberduck's Log or the About box:
+
+    Rubberduck version [...]
+    Operating System: [...]
+    Host Product: [...]
+    Host Version: [...]
+    Host Executable: [...]
+
+
+**Description**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Logfile**
+Rubberduck generates extensive logging in TRACE-Level. If no log was created at `%APP_DATA%\Rubberduck\Logs`, check your settings. Include this Log for bugreports about the behavior of Rubbberduck
+
+**Additional context**
+Add any other context about the problem here.

Rubberduck.CodeAnalysis/Inspections/Concrete/NonReturningFunctionInspection.cs

@@ -51,7 +51,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
         private bool IsAssignedByRefArgument(Declaration enclosingProcedure, IdentifierReference reference)
         {
             var argExpression = reference.Context.GetAncestor<VBAParser.ArgumentExpressionContext>();
-            var parameter = State.DeclarationFinder.FindParameterFromArgument(argExpression, enclosingProcedure);
+            var parameter = State.DeclarationFinder.FindParameterOfNonDefaultMemberFromSimpleArgumentNotPassedByValExplicitly(argExpression, enclosingProcedure);
 
             // note: not recursive, by design.
             return parameter != null

Rubberduck.CodeAnalysis/Inspections/Concrete/ParameterCanBeByValInspection.cs

@@ -54,7 +54,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
         private bool IsAssignedByRefArgument(Declaration enclosingProcedure, IdentifierReference reference)
         {
             var argExpression = reference.Context.GetAncestor<VBAParser.ArgumentExpressionContext>();
-            var parameter = State.DeclarationFinder.FindParameterFromArgument(argExpression, enclosingProcedure);
+            var parameter = State.DeclarationFinder.FindParameterOfNonDefaultMemberFromSimpleArgumentNotPassedByValExplicitly(argExpression, enclosingProcedure);
 
             // note: not recursive, by design.
             return parameter != null

Rubberduck.CodeAnalysis/Inspections/Concrete/UnassignedVariableUsageInspection.cs

@@ -37,7 +37,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
         private bool IsAssignedByRefArgument(Declaration enclosingProcedure, IdentifierReference reference)
         {
             var argExpression = reference.Context.GetAncestor<VBAParser.ArgumentExpressionContext>();
-            var parameter = State.DeclarationFinder.FindParameterFromArgument(argExpression, enclosingProcedure);
+            var parameter = State.DeclarationFinder.FindParameterOfNonDefaultMemberFromSimpleArgumentNotPassedByValExplicitly(argExpression, enclosingProcedure);
 
             // note: not recursive, by design.
             return parameter != null

Rubberduck.CodeAnalysis/Inspections/Concrete/VariableNotAssignedInspection.cs

@@ -183,7 +183,7 @@ public bool Matches(ReferenceInfo info)
                    FullPath.Equals(info.FullPath, StringComparison.OrdinalIgnoreCase) ||
                    FullPath32.Equals(info.FullPath, StringComparison.OrdinalIgnoreCase) ||
                    FullPath64.Equals(info.FullPath, StringComparison.OrdinalIgnoreCase) ||
-                   Guid.Equals(info.Guid);
+                   !Guid.Equals(Guid.Empty) && Guid.Equals(info.Guid);
         }
 
         private void NotifyPropertyChanged([CallerMemberName] string propertyName = "")

Rubberduck.Core/AddRemoveReferences/ReferenceModel.cs

@@ -6,136 +6,91 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using Rubberduck.Navigation.CodeExplorer;
-using System.Windows;
-using Rubberduck.Navigation.Folders;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
 namespace Rubberduck.CodeAnalysis.CodeMetrics
 {
-    public class CodeMetricsViewModel : ViewModelBase, IDisposable
+    public sealed class CodeMetricsViewModel : ViewModelBase, IDisposable
     {
         private readonly RubberduckParserState _state;
         private readonly ICodeMetricsAnalyst _analyst;
-        private readonly FolderHelper _folderHelper;
         private readonly IVBE _vbe;
+        private readonly IUiDispatcher _uiDispatcher;
 
-        public CodeMetricsViewModel(RubberduckParserState state, ICodeMetricsAnalyst analyst, FolderHelper folderHelper, IVBE vbe)
+        public CodeMetricsViewModel(
+            RubberduckParserState state, 
+            ICodeMetricsAnalyst analyst, 
+            IVBE vbe,
+            IUiDispatcher uiDispatcher)
         {
             _state = state;
-            _analyst = analyst;
-            _folderHelper = folderHelper;
             _state.StateChanged += OnStateChanged;
+
+            _analyst = analyst;
             _vbe = vbe;
-        }
-        
-        private void OnStateChanged(object sender, ParserStateEventArgs e)
-        {
-            if (e.State != ParserState.Ready && e.State != ParserState.Error && e.State != ParserState.ResolverError && e.State != ParserState.UnexpectedError)
-            {
-                IsBusy = true;
-            }
+            _uiDispatcher = uiDispatcher;
 
-            if (e.State == ParserState.Ready)
-            {
-                UpdateData();
-                IsBusy = false;
-            }
+            OnPropertyChanged(nameof(Projects));
+        }
 
-            if (e.State == ParserState.Error || e.State == ParserState.ResolverError || e.State == ParserState.UnexpectedError)
+        private bool _unparsed = true;
+        public bool Unparsed
+        {
+            get => _unparsed;
+            set
             {
-                IsBusy = false;
+                if (_unparsed == value)
+                {
+                    return;
+                }
+                _unparsed = value;
+                OnPropertyChanged();
             }
         }
 
-        private void UpdateData()
+        private void OnStateChanged(object sender, ParserStateEventArgs e)
         {
-            IsBusy = true;
-
-            var metricResults = _analyst.GetMetrics(_state);
-            resultsByDeclaration = metricResults.GroupBy(r => r.Declaration).ToDictionary(g => g.Key, g => g.ToList());
+            Unparsed = false;
+            IsBusy = _state.Status != ParserState.Pending && _state.Status <= ParserState.ResolvedDeclarations;
 
-            if (Projects == null)
+            if (e.State == ParserState.ResolvedDeclarations)
             {
-                Projects = new ObservableCollection<CodeExplorerItemViewModel>();
+                Synchronize(_state.DeclarationFinder.AllUserDeclarations);
             }
-
-            IsBusy = _state.Status != ParserState.Pending && _state.Status <= ParserState.ResolvedDeclarations;
-
-            var userDeclarations = _state.DeclarationFinder.AllUserDeclarations
-                .GroupBy(declaration => declaration.ProjectId)
-                .ToList();
-
-            var newProjects = userDeclarations
-                .Where(grouping => grouping.Any(declaration => declaration.DeclarationType == DeclarationType.Project))
-                .Select(grouping =>
-                new CodeExplorerProjectViewModel(_folderHelper,
-                    grouping.SingleOrDefault(declaration => declaration.DeclarationType == DeclarationType.Project),
-                    grouping,
-                    _vbe)).ToList();
-
-            UpdateNodes(Projects, newProjects);
-
-            Projects = new ObservableCollection<CodeExplorerItemViewModel>(newProjects);
-
-            IsBusy = false;
         }
 
-        private void UpdateNodes(IEnumerable<CodeExplorerItemViewModel> oldList, IEnumerable<CodeExplorerItemViewModel> newList)
+        private void Synchronize(IEnumerable<Declaration> declarations)
         {
-            foreach (var item in newList)
-            {
-                CodeExplorerItemViewModel oldItem;
+            var metricResults = _analyst.GetMetrics(_state);
+            _resultsByDeclaration = metricResults.GroupBy(r => r.Declaration).ToDictionary(g => g.Key, g => g.ToList());
 
-                if (item is CodeExplorerCustomFolderViewModel)
-                {
-                    oldItem = oldList.FirstOrDefault(i => i.Name == item.Name);
-                }
-                else
-                {
-                    oldItem = oldList.FirstOrDefault(i =>
-                        item.QualifiedSelection != null && i.QualifiedSelection != null &&
-                        i.QualifiedSelection.Value.QualifiedName.ProjectId ==
-                        item.QualifiedSelection.Value.QualifiedName.ProjectId &&
-                        i.QualifiedSelection.Value.QualifiedName.ComponentName ==
-                        item.QualifiedSelection.Value.QualifiedName.ComponentName &&
-                        i.QualifiedSelection.Value.Selection == item.QualifiedSelection.Value.Selection);
-                }
+            _uiDispatcher.Invoke(() =>
+            {
+                var updates = declarations.ToList();
+                var existing = Projects.OfType<CodeExplorerProjectViewModel>().ToList();
 
-                if (oldItem != null)
+                foreach (var project in existing)
                 {
-                    item.IsExpanded = oldItem.IsExpanded;
-                    item.IsSelected = oldItem.IsSelected;
-
-                    if (oldItem.Items.Any() && item.Items.Any())
+                    project.Synchronize(ref updates);
+                    if (project.Declaration is null)
                     {
-                        UpdateNodes(oldItem.Items, item.Items);
+                        Projects.Remove(project);
                     }
                 }
-            }
-        }
-
-        public void Dispose()
-        {
-            Dispose(true);
-            GC.SuppressFinalize(this);
-        }
 
-        private bool _isDisposed;
-        protected virtual void Dispose(bool disposing)
-        {
-            if (_isDisposed || !disposing)
-            {
-                return;
-            }
-            _isDisposed = true;
+                var adding = updates.OfType<ProjectDeclaration>().ToList();
 
-            _state.StateChanged -= OnStateChanged;
+                foreach (var project in adding)
+                {
+                    var model = new CodeExplorerProjectViewModel(project, ref updates, _state, _vbe, false);
+                    Projects.Add(model);
+                }
+            });
         }
 
-        private Dictionary<Declaration, List<ICodeMetricResult>> resultsByDeclaration;
-
-        private CodeExplorerItemViewModel _selectedItem;
-        public CodeExplorerItemViewModel SelectedItem
+        private ICodeExplorerNode _selectedItem;
+        public ICodeExplorerNode SelectedItem
         {
             get => _selectedItem;
             set
@@ -150,27 +105,15 @@ public CodeExplorerItemViewModel SelectedItem
             }
         }
 
-        private ObservableCollection<CodeExplorerItemViewModel> _projects;
-        public ObservableCollection<CodeExplorerItemViewModel> Projects
-        {
-            get => _projects;
-            set
-            {
-                _projects = new ObservableCollection<CodeExplorerItemViewModel>(value.OrderBy(o => o.NameWithSignature));
+        public ObservableCollection<ICodeExplorerNode> Projects { get; } = new ObservableCollection<ICodeExplorerNode>();
 
-                OnPropertyChanged();
-                OnPropertyChanged(nameof(TreeViewVisibility));
-            }
-        }
-
-        public Visibility TreeViewVisibility => Projects == null || Projects.Count == 0 ? Visibility.Collapsed : Visibility.Visible;
-        
+        private Dictionary<Declaration, List<ICodeMetricResult>> _resultsByDeclaration;
         public ObservableCollection<ICodeMetricResult> Metrics
         {
             get
             {
-                var results = resultsByDeclaration?.FirstOrDefault(f => f.Key == SelectedItem.GetSelectedDeclaration());
-                return !results.HasValue || results.Value.Value == null ? new ObservableCollection<ICodeMetricResult>() : new ObservableCollection<ICodeMetricResult>(results.Value.Value);
+                var results = _resultsByDeclaration?.FirstOrDefault(f => ReferenceEquals(f.Key, SelectedItem.Declaration));
+                return results?.Value == null ? new ObservableCollection<ICodeMetricResult>() : new ObservableCollection<ICodeMetricResult>(results.Value.Value);
             }
         }
 
@@ -181,23 +124,27 @@ public bool IsBusy
             set
             {
                 _isBusy = value;
-                EmptyUIRefreshMessageVisibility = false;
                 OnPropertyChanged();
             }
         }
 
-        private bool _emptyUIRefreshMessageVisibility = true;
-        public bool EmptyUIRefreshMessageVisibility
+        public void Dispose()
         {
-            get => _emptyUIRefreshMessageVisibility;
-            set
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        private bool _isDisposed;
+
+        private void Dispose(bool disposing)
+        {
+            if (_isDisposed || !disposing)
             {
-                if (_emptyUIRefreshMessageVisibility != value)
-                {
-                    _emptyUIRefreshMessageVisibility = value;
-                    OnPropertyChanged();
-                }
+                return;
             }
+            _isDisposed = true;
+
+            _state.StateChanged -= OnStateChanged;
         }
     }
 }