implemented groupings in CodeInspections, ToDoItems and UnitTests (each needed their own MenuItemGroup.GroupName); simplified ToDoItems VM code and tweaked UI layout to work with collapsing/hidden controls.

retailcoder · retailcoder · commit c596563d8f9a · 2016-02-17T01:36:45.000-05:00
diff --git a/RetailCoder.VBE/ToDoItems/ToDoItem.cs b/RetailCoder.VBE/ToDoItems/ToDoItem.cs
@@ -15,33 +15,16 @@ public class ToDoItem : INavigateSource
         private readonly string _description;
         public string Description { get { return _description; } }
 
-        private readonly string _projectName;
-        public string ProjectName { get { return _projectName; } }
-
-        private readonly string _moduleName;
-        public string ModuleName { get { return _moduleName; } }
-
-        private readonly int _lineNumber;
-        public int LineNumber { get { return _lineNumber; } }
-
         private readonly string _type;
         public string Type { get { return _type; } }
 
         private readonly QualifiedSelection _selection;
-        public QualifiedSelection GetSelection() { return _selection; }
+        public QualifiedSelection Selection { get { return _selection; } }
 
         public ToDoItem(string markerText, CommentNode comment)
-            : this(markerText, comment.CommentText, comment.QualifiedSelection)
-        {
-        }
-
-        public ToDoItem(string markerText, string description, QualifiedSelection qualifiedSelection)
         {
-            _description = description;
-            _selection = qualifiedSelection;
-            _projectName = qualifiedSelection.QualifiedName.ProjectName;
-            _moduleName = qualifiedSelection.QualifiedName.ComponentName;
-            _lineNumber = qualifiedSelection.Selection.StartLine;
+            _description = comment.CommentText;
+            _selection = comment.QualifiedSelection;
             _type = markerText;
         }
 
diff --git a/RetailCoder.VBE/UI/CodeInspections/InspectionResultsControl.xaml b/RetailCoder.VBE/UI/CodeInspections/InspectionResultsControl.xaml
@@ -304,7 +304,7 @@
 
         <CollectionViewSource x:Key="ResultsByModule" Source="{Binding Results}">
             <CollectionViewSource.SortDescriptions>
-                <componentModel:SortDescription PropertyName="QualifiedSelection.QualifiedName.ComponentName"/>
+                <componentModel:SortDescription PropertyName="QualifiedSelection.QualifiedName.Name"/>
             </CollectionViewSource.SortDescriptions>
             <CollectionViewSource.GroupDescriptions>
                 <PropertyGroupDescription PropertyName="QualifiedSelection.QualifiedName" />
@@ -355,10 +355,10 @@
                     
                     <MenuItem x:Name="GroupByInspectionType" Style="{DynamicResource MenuItemStyle}" VerticalAlignment="Center" 
                               Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GroupingStyle_ByInspectionType}" IsChecked="True" 
-                              IsCheckable="True" controls:MenuItemGroup.GroupName="GroupingStyle" />
+                              IsCheckable="True" controls:MenuItemGroup.GroupName="InspectionsResults_GroupingStyle" />
                     <MenuItem x:Name="GroupByModule" Style="{DynamicResource MenuItemStyle}" VerticalAlignment="Center" 
                               Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GroupingStyle_ByLocation}" 
-                              IsCheckable="True" controls:MenuItemGroup.GroupName="GroupingStyle" />
+                              IsCheckable="True" controls:MenuItemGroup.GroupName="InspectionsResults_GroupingStyle" />
                 </MenuItem>
             </Menu>
 
diff --git a/RetailCoder.VBE/UI/CodeInspections/InspectionResultsControl.xaml.cs b/RetailCoder.VBE/UI/CodeInspections/InspectionResultsControl.xaml.cs
@@ -1,8 +1,5 @@
 ﻿using System.Windows;
 using System.Windows.Controls;
-using System.Windows.Data;
-using System.Windows.Input;
-using Rubberduck.Inspections;
 
 namespace Rubberduck.UI.CodeInspections
 {
@@ -21,7 +18,7 @@ public InspectionResultsControl()
 
         private void InspectionResultsControl_Loaded(object sender, RoutedEventArgs e)
         {
-            if (ViewModel.CanRefresh)
+            if (ViewModel != null && ViewModel.CanRefresh)
             {
                 ViewModel.RefreshCommand.Execute(null);
             }
diff --git a/RetailCoder.VBE/UI/CodeInspections/InspectionResultsViewModel.cs b/RetailCoder.VBE/UI/CodeInspections/InspectionResultsViewModel.cs
@@ -42,19 +42,6 @@ public InspectionResultsViewModel(RubberduckParserState state, IInspector inspec
             _quickFixInModuleCommand = new DelegateCommand(ExecuteQuickFixInModuleCommand);
             _quickFixInProjectCommand = new DelegateCommand(ExecuteQuickFixInProjectCommand);
             _copyResultsCommand = new DelegateCommand(ExecuteCopyResultsCommand, CanExecuteCopyResultsCommand);
-
-            _inspectionResults = new ListCollectionView(_results);
-            if (_inspectionResults.GroupDescriptions != null)
-            {
-                _inspectionResults.GroupDescriptions.Add(new PropertyGroupDescription("Inspection", new InspectionTypeConverter()));
-            }
-        }
-
-        private readonly ListCollectionView _inspectionResults;
-
-        public ListCollectionView InspectionResults
-        {
-            get { return _inspectionResults; }
         }
 
         private readonly ObservableCollection<ICodeInspectionResult> _results = new ObservableCollection<ICodeInspectionResult>();
@@ -80,29 +67,13 @@ public INavigateSource SelectedItem
                 CanExecuteQuickFixInProject = false;
 
                 var inspectionResult = _selectedItem as InspectionResultBase;
-
                 if (inspectionResult != null)
                 {
                     SelectedInspection = inspectionResult.Inspection;
                     CanQuickFix = inspectionResult.HasQuickFixes;
                     _defaultFix = inspectionResult.DefaultQuickFix;
                     CanExecuteQuickFixInModule = _defaultFix != null && _defaultFix.CanFixInModule;
                 }
-                else
-                {
-                    var viewGroup = _selectedItem as CollectionViewGroup;
-                    if (viewGroup != null)
-                    {
-                        var grouping = viewGroup;
-                        var inspection = grouping.Name as IInspection;
-                        if (inspection != null)
-                        {
-                            SelectedInspection = inspection;
-                            var result = _results.FirstOrDefault(item => item.Inspection == inspection);
-                            _defaultFix = result == null ? null : result.DefaultQuickFix;
-                        }
-                    }
-                }
 
                 CanDisableInspection = SelectedInspection != null;
                 CanExecuteQuickFixInProject = _defaultFix != null && _defaultFix.CanFixInProject;
diff --git a/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerControl.xaml b/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerControl.xaml
@@ -6,6 +6,7 @@
     xmlns:toDoItems="clr-namespace:Rubberduck.UI.ToDoItems"
     xmlns:themes="clr-namespace:Microsoft.Windows.Themes;assembly=PresentationFramework.Aero"
     xmlns:controls="clr-namespace:Rubberduck.UI.Controls"
+    xmlns:componentModel="clr-namespace:System.ComponentModel;assembly=WindowsBase"
     x:Class="Rubberduck.UI.ToDoItems.ToDoExplorerControl"
              Language="{UICulture}"
              mc:Ignorable="d" 
@@ -210,9 +211,35 @@
                 </DataTrigger>
             </Style.Triggers>
         </Style>
+
+        <CollectionViewSource x:Key="ItemsByMarker" Source="{Binding Items}">
+            <CollectionViewSource.SortDescriptions>
+                <componentModel:SortDescription PropertyName="Type" />
+            </CollectionViewSource.SortDescriptions>
+            <CollectionViewSource.GroupDescriptions>
+                <PropertyGroupDescription PropertyName="Type" />
+            </CollectionViewSource.GroupDescriptions>
+        </CollectionViewSource>
+
+        <CollectionViewSource x:Key="ItemsByLocation" Source="{Binding Items}">
+            <CollectionViewSource.SortDescriptions>
+                <componentModel:SortDescription PropertyName="Selection.QualifiedName.Name" />
+            </CollectionViewSource.SortDescriptions>
+            <CollectionViewSource.GroupDescriptions>
+                <PropertyGroupDescription PropertyName="Selection.QualifiedName" />
+            </CollectionViewSource.GroupDescriptions>
+        </CollectionViewSource>
+
     </UserControl.Resources>
-    <DockPanel LastChildFill="True">
-        <ToolBarTray DockPanel.Dock="Top" IsLocked="True">
+    
+    <Grid>
+        
+        <Grid.RowDefinitions>
+            <RowDefinition Height="30"/>
+            <RowDefinition Height="*" />
+        </Grid.RowDefinitions>
+        
+        <ToolBarTray Grid.Row="0" IsLocked="True">
             <ToolBar Style="{DynamicResource ToolBarWithOverflowOnlyShowingWhenNeededStyle}">
                 <Button ToolTip="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=Refresh}" Command="{Binding RefreshCommand, Mode=OneWay}" BorderThickness="0" Background="Transparent">
                     <Image Source="{StaticResource RefreshImage}" />
@@ -221,16 +248,45 @@
                 <Button ToolTip="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=Remove}" Command="{Binding Remove}" BorderThickness="0" Background="Transparent">
                     <Image Source="{StaticResource DeleteImage}" />
                 </Button>
+                <Menu>
+                    <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GroupingGrid_GroupingStyle}">
+                        <MenuItem.Icon>
+                            <Image Height="16" Source="../../Resources/Microsoft/PNG/GroupBy_284_32.png" />
+                        </MenuItem.Icon>
+
+                        <MenuItem x:Name="GroupByMarker" Style="{DynamicResource MenuItemStyle}" VerticalAlignment="Center" 
+                              Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GroupingStyle_ByMarker}" IsChecked="True" 
+                              IsCheckable="True" controls:MenuItemGroup.GroupName="ToDoExplorer_GroupingStyle" />
+                        <MenuItem x:Name="GroupByLocation" Style="{DynamicResource MenuItemStyle}" VerticalAlignment="Center" 
+                              Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GroupingStyle_ByLocation}" 
+                              IsCheckable="True" controls:MenuItemGroup.GroupName="ToDoExplorer_GroupingStyle" />
+                    </MenuItem>
+                </Menu>
             </ToolBar>
         </ToolBarTray>
-        <controls:GroupingGrid ItemsSource="{Binding ToDos}"
-			                   SelectedItem="{Binding SelectedToDo}">
+
+        <controls:GroupingGrid Grid.Row="1" ShowGroupingItemCount="True"
+                               ItemsSource="{Binding Source={StaticResource ItemsByMarker}}"
+			                   SelectedItem="{Binding SelectedItem}"
+                               Visibility="{Binding Path=IsChecked, ElementName=GroupByMarker, Converter={StaticResource BoolToVisibility}}">
+            <controls:GroupingGrid.Columns>
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=TodoExplorer_Description}" Binding="{Binding Description}" Width="*"/>
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ProjectName}" Binding="{Binding Selection.QualifiedName.ProjectName}" />
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ModuleName}" Binding="{Binding Selection.QualifiedName.ComponentName}" />
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=TodoExplorer_LineNumber}" Binding="{Binding Selection.Selection.StartLine}" />
+            </controls:GroupingGrid.Columns>
+        </controls:GroupingGrid>
+        
+        <controls:GroupingGrid Grid.Row="1" ShowGroupingItemCount="True"
+                               ItemsSource="{Binding Source={StaticResource ItemsByLocation}}"
+			                   SelectedItem="{Binding SelectedItem}"
+                               Visibility="{Binding Path=IsChecked, ElementName=GroupByLocation, Converter={StaticResource BoolToVisibility}}">
             <controls:GroupingGrid.Columns>
                 <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=TodoExplorer_Description}" Binding="{Binding Description}" Width="*"/>
-                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ProjectName}" Binding="{Binding ProjectName}" />
-                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ModuleName}" Binding="{Binding ModuleName}" />
-                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=TodoExplorer_LineNumber}" Binding="{Binding LineNumber}" />
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ProjectName}" Binding="{Binding Selection.QualifiedName.ProjectName}" />
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ModuleName}" Binding="{Binding Selection.QualifiedName.ComponentName}" />
+                <DataGridTextColumn Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=TodoExplorer_LineNumber}" Binding="{Binding Selection.Selection.StartLine}" />
             </controls:GroupingGrid.Columns>
         </controls:GroupingGrid>
-    </DockPanel>
+    </Grid>
 </UserControl>
diff --git a/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerControl.xaml.cs b/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerControl.xaml.cs
@@ -1,15 +1,25 @@
-﻿using System.Windows.Input;
-
+﻿
 namespace Rubberduck.UI.ToDoItems
 {
     /// <summary>
     /// Interaction logic for ToDoExplorerControl.xaml
     /// </summary>
     public partial class ToDoExplorerControl
     {
+        private ToDoExplorerViewModel ViewModel { get { return DataContext as ToDoExplorerViewModel; } }
+
         public ToDoExplorerControl()
         {
             InitializeComponent();
+            Loaded += ToDoExplorerControl_Loaded;
+        }
+
+        void ToDoExplorerControl_Loaded(object sender, System.Windows.RoutedEventArgs e)
+        {
+            if (ViewModel != null && ViewModel.RefreshCommand.CanExecute(null))
+            {
+                ViewModel.RefreshCommand.Execute(null);
+            }
         }
     }
 }
diff --git a/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerViewModel.cs b/RetailCoder.VBE/UI/ToDoItems/ToDoExplorerViewModel.cs
@@ -1,7 +1,6 @@
 ﻿using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Linq;
-using System.Threading.Tasks;
-using System.Windows.Data;
 using System.Windows.Input;
 using System.Windows.Threading;
 using Rubberduck.Parsing.Nodes;
@@ -15,28 +14,19 @@ namespace Rubberduck.UI.ToDoItems
 {
     public class ToDoExplorerViewModel : ViewModelBase, INavigateSelection
     {
+        private readonly Dispatcher _dispatcher;
         private readonly RubberduckParserState _state;
-        private readonly IEnumerable<ToDoMarker> _markers;
-        private ListCollectionView _toDos; 
+        private readonly IGeneralConfigService _configService;
+
         public ToDoExplorerViewModel(RubberduckParserState state, IGeneralConfigService configService)
         {
+            _dispatcher = Dispatcher.CurrentDispatcher;
             _state = state;
-            _markers = configService.LoadConfiguration().UserSettings.ToDoListSettings.ToDoMarkers;
-
-            _uiDispatcher = Dispatcher.CurrentDispatcher;
+            _configService = configService;
         }
 
-        public ListCollectionView ToDos {
-            get
-            {
-                return _toDos;
-            }
-            set
-            {
-                _toDos = value;
-                OnPropertyChanged();
-            }
-        } 
+        private readonly ObservableCollection<ToDoItem> _items = new ObservableCollection<ToDoItem>();
+        public ObservableCollection<ToDoItem> Items { get { return _items; } } 
 
         private ICommand _refreshCommand;
         public ICommand RefreshCommand
@@ -61,20 +51,27 @@ private async void _state_StateChanged(object sender, ParserStateEventArgs e)
             {
                 return;
             }
-            var results = await GetItems();
-            
-            _uiDispatcher.Invoke(() =>
+            _dispatcher.Invoke(() =>
             {
-                ToDos = new ListCollectionView(results.ToList());
-                if (ToDos.GroupDescriptions != null)
+                Items.Clear();
+                foreach (var item in GetItems())
                 {
-                    ToDos.GroupDescriptions.Add(new PropertyGroupDescription("Type"));
+                    Items.Add(item);
                 }
             });
         }
 
-        public INavigateSource SelectedItem { get { return SelectedToDo; } set { SelectedToDo = value as ToDoItem; } }
-        public ToDoItem SelectedToDo { get; set; }
+        private ToDoItem _selectedItem;
+
+        public INavigateSource SelectedItem
+        {
+            get { return _selectedItem; }
+            set
+            {
+                _selectedItem = value as ToDoItem; 
+                OnPropertyChanged();
+            }
+        }
 
         private ICommand _clear;
         public ICommand Remove
@@ -87,25 +84,23 @@ public ICommand Remove
                 }
                 return _clear = new DelegateCommand(_ =>
                 {
-                    if (SelectedToDo == null)
+                    if (_selectedItem == null)
                     {
                         return;
                     }
-                    var module = SelectedToDo.GetSelection().QualifiedName.Component.CodeModule;
+                    var module = _selectedItem.Selection.QualifiedName.Component.CodeModule;
 
-                    var oldContent = module.Lines[SelectedToDo.LineNumber, 1];
-                    var newContent =
-                        oldContent.Remove(SelectedToDo.GetSelection().Selection.StartColumn - 1);
+                    var oldContent = module.Lines[_selectedItem.Selection.Selection.StartLine, 1];
+                    var newContent = oldContent.Remove(_selectedItem.Selection.Selection.StartColumn - 1);
 
-                    module.ReplaceLine(SelectedToDo.LineNumber, newContent);
+                    module.ReplaceLine(_selectedItem.Selection.Selection.StartLine, newContent);
 
                     RefreshCommand.Execute(null);
                 });
             }
         }
 
         private NavigateCommand _navigateCommand;
-        private readonly Dispatcher _uiDispatcher;
 
         public INavigateCommand NavigateCommand
         {
@@ -121,26 +116,15 @@ public INavigateCommand NavigateCommand
 
         private IEnumerable<ToDoItem> GetToDoMarkers(CommentNode comment)
         {
-            var c = _markers.Where(marker => !string.IsNullOrEmpty(marker.Text));
-            var t = _markers.Select(marker => marker.Text.ToLowerInvariant());
-            var v = comment.Comment.ToLowerInvariant();
-            var y = _markers.Where(marker => comment.Comment.ToLowerInvariant().Contains(marker.Text.ToLowerInvariant()));
-            var z = _markers.Select(marker => new ToDoItem(marker.Text, comment)).ToList();
-
-            return _markers.Where(marker => !string.IsNullOrEmpty(marker.Text)
-                && comment.Comment.ToLowerInvariant().Contains(marker.Text.ToLowerInvariant()))
-                .Select(marker => new ToDoItem(marker.Text, comment)).ToList();
+            var markers = _configService.LoadConfiguration().UserSettings.ToDoListSettings.ToDoMarkers;
+            return markers.Where(marker => !string.IsNullOrEmpty(marker.Text)
+                                         && comment.Comment.ToLowerInvariant().Contains(marker.Text.ToLowerInvariant()))
+                           .Select(marker => new ToDoItem(marker.Text, comment));
         }
 
-        private async Task<IOrderedEnumerable<ToDoItem>> GetItems()
+        private IEnumerable<ToDoItem> GetItems()
         {
-            var markers = _state.AllComments.SelectMany(GetToDoMarkers).ToList();
-            var sortedItems = markers.OrderByDescending(item => item.Type)
-                                   .ThenBy(item => item.ProjectName)
-                                   .ThenBy(item => item.ModuleName)
-                                   .ThenBy(item => item.LineNumber);
-
-            return sortedItems;
+            return _state.AllComments.SelectMany(GetToDoMarkers);
         }
     }
 }
diff --git a/RetailCoder.VBE/UI/UnitTesting/TestExplorerControl.xaml b/RetailCoder.VBE/UI/UnitTesting/TestExplorerControl.xaml

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,5 @@`
`1`	`1`	`using System.Windows;`
`2`	`2`	`using System.Windows.Controls;`
`3`		`-using System.Windows.Data;`
`4`		`-using System.Windows.Input;`
`5`		`-using Rubberduck.Inspections;`
`6`	`3`
`7`	`4`	`namespace Rubberduck.UI.CodeInspections`
`8`	`5`	`{`
`@@ -21,7 +18,7 @@ public InspectionResultsControl()`
`21`	`18`
`22`	`19`	`private void InspectionResultsControl_Loaded(object sender, RoutedEventArgs e)`
`23`	`20`	`{`
`24`		`- if (ViewModel.CanRefresh)`
	`21`	`+ if (ViewModel != null && ViewModel.CanRefresh)`
`25`	`22`	`{`
`26`	`23`	`ViewModel.RefreshCommand.Execute(null);`
`27`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,25 @@`
`1`		`-using System.Windows.Input;`
`2`		`-`
	`1`	`+`
`3`	`2`	`namespace Rubberduck.UI.ToDoItems`
`4`	`3`	`{`
`5`	`4`	`/// <summary>`
`6`	`5`	`/// Interaction logic for ToDoExplorerControl.xaml`
`7`	`6`	`/// </summary>`
`8`	`7`	`public partial class ToDoExplorerControl`
`9`	`8`	`{`
	`9`	`+ private ToDoExplorerViewModel ViewModel { get { return DataContext as ToDoExplorerViewModel; } }`
	`10`	`+`
`10`	`11`	`public ToDoExplorerControl()`
`11`	`12`	`{`
`12`	`13`	`InitializeComponent();`
	`14`	`+ Loaded += ToDoExplorerControl_Loaded;`
	`15`	`+ }`
	`16`	`+`
	`17`	`+ void ToDoExplorerControl_Loaded(object sender, System.Windows.RoutedEventArgs e)`
	`18`	`+ {`
	`19`	`+ if (ViewModel != null && ViewModel.RefreshCommand.CanExecute(null))`
	`20`	`+ {`
	`21`	`+ ViewModel.RefreshCommand.Execute(null);`
	`22`	`+ }`
`13`	`23`	`}`
`14`	`24`	`}`
`15`	`25`	`}`