Sort inspections by localized name in AnnotateDeclaration UI

The way it is set up, the ordering will not react to a change in UI culture, but that is OK since the dialog is modal; no possibility to get to the settings dialog during its lifetime.

Author: MDoerner

Rubberduck.Core/UI/Refactorings/AnnotateDeclaration/AnnotateDeclarationView.xaml

@@ -75,12 +75,7 @@
             <converters:SpecificValueToVisibilityConverter SpecialValue="{x:Static annotations:AnnotationArgumentType.Inspection}" CollapseSpecialValue="False" x:Key="InspectionArgumentVisibilityConverter"/>
             <DataTemplate DataType="{x:Type local:IAnnotationArgumentViewModel}" x:Key="ArgumentValueTemplate">
                 <DataTemplate.Resources>
-                    <CollectionViewSource Source="{Binding InspectionNames}" x:Key="InspectionNamesView">
-                        <CollectionViewSource.SortDescriptions>
-                            <scm:SortDescription PropertyName="." />
-                            <!-- This is not really the sort we want. We want a converter here, which is impossible. -->
-                        </CollectionViewSource.SortDescriptions>
-                    </CollectionViewSource>
+                    <CollectionViewSource Source="{Binding InspectionNames}" x:Key="InspectionNamesView" />
                 </DataTemplate.Resources>
                 <StackPanel>
                     <TextBox Text="{Binding ArgumentValue, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged, ValidatesOnNotifyDataErrors=True}"

Rubberduck.Core/UI/Refactorings/AnnotateDeclaration/AnnotationArgumentViewModel.cs

@@ -1,10 +1,14 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Globalization;
 using System.Linq;
+using System.Windows.Controls;
+using System.Windows.Data;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Refactorings.AnnotateDeclaration;
 using Rubberduck.Resources;
+using Rubberduck.UI.Converters;
 
 namespace Rubberduck.UI.Refactorings.AnnotateDeclaration
 {
@@ -24,13 +28,16 @@ internal class AnnotationArgumentViewModel : ViewModelBase, IAnnotationArgumentV
         private const int MaxAllowedCharacters = 511;
 
         private TypedAnnotationArgument _model;
+        private readonly IReadOnlyList<string> _inspectionNames;
+        private readonly IValueConverter _inspectionNameConverter;
 
-        public AnnotationArgumentViewModel(TypedAnnotationArgument model, IReadOnlyList<string> inspectionNames)
+        public AnnotationArgumentViewModel(TypedAnnotationArgument model, IReadOnlyList<string> inspectionNames, InspectionToLocalizedNameConverter inspectionNameConverter)
         {
             _model = model;
+            _inspectionNameConverter = inspectionNameConverter;
+            _inspectionNames = inspectionNames;
 
             ApplicableArgumentTypes = ApplicableTypes(_model.ArgumentType);
-            InspectionNames = inspectionNames;
             BooleanValues = new List<string> { "True", "False" };
 
             _model.ArgumentType = ApplicableArgumentTypes.FirstOrDefault();
@@ -53,9 +60,12 @@ private IReadOnlyList<AnnotationArgumentType> ApplicableTypes(AnnotationArgument
         public IReadOnlyList<AnnotationArgumentType> ApplicableArgumentTypes { get; }
 
         public bool CanEditArgumentType => ApplicableArgumentTypes.Count > 1;
-        public IReadOnlyList<string> InspectionNames { get; }
         public IReadOnlyList<string> BooleanValues { get; }
 
+        public IReadOnlyList<string> InspectionNames => _inspectionNames
+            .OrderBy(inspectionName => _inspectionNameConverter.Convert(inspectionName, typeof(TextBlock), null, CultureInfo.CurrentUICulture))
+            .ToList();
+
         public AnnotationArgumentType ArgumentType
         {
             get => _model.ArgumentType;

Rubberduck.Core/UI/Refactorings/AnnotateDeclaration/AnnotationArgumentViewModelFactory.cs

@@ -1,26 +1,30 @@
 using System.Collections.Generic;
 using System.Linq;
+using System.Windows.Data;
 using Rubberduck.CodeAnalysis.Inspections;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Refactorings.AnnotateDeclaration;
+using Rubberduck.UI.Converters;
 
 namespace Rubberduck.UI.Refactorings.AnnotateDeclaration
 {
     internal class AnnotationArgumentViewModelFactory : IAnnotationArgumentViewModelFactory
     {
-        private readonly IReadOnlyList<string> InspectionNames;
+        private readonly IReadOnlyList<string> _inspectionNames;
+        private readonly InspectionToLocalizedNameConverter _inspectionNameConverter;
 
-        public AnnotationArgumentViewModelFactory(IEnumerable<IInspection> inspections)
+        public AnnotationArgumentViewModelFactory(IEnumerable<IInspection> inspections, InspectionToLocalizedNameConverter inspectionNameConverter)
         {
-            InspectionNames = inspections
+            _inspectionNames = inspections
                 .Select(inspection => inspection.AnnotationName)
                 .ToList();
+            _inspectionNameConverter = inspectionNameConverter;
         }
 
         public IAnnotationArgumentViewModel Create(AnnotationArgumentType argumentType, string argument = null)
         {
             var model = new TypedAnnotationArgument(argumentType, argument ?? string.Empty);
-            return new AnnotationArgumentViewModel(model, InspectionNames);
+            return new AnnotationArgumentViewModel(model, _inspectionNames, _inspectionNameConverter);
         }
     }
 }

RubberduckTests/Refactoring/AnnotateDeclaration/AnnotationArgumentViewModelTests.cs

@@ -4,6 +4,7 @@
 using NUnit.Framework;
 using Rubberduck.Parsing.Annotations;
 using Rubberduck.Refactorings.AnnotateDeclaration;
+using Rubberduck.UI.Converters;
 using Rubberduck.UI.Refactorings.AnnotateDeclaration;
 
 namespace RubberduckTests.Refactoring.AnnotateDeclaration
@@ -217,7 +218,8 @@ private AnnotationArgumentViewModel TestViewModel(
             IReadOnlyList<string> inspectionNames = null)
         {
             var model = new TypedAnnotationArgument(argumentType, initialArgument ?? string.Empty);
-            return new AnnotationArgumentViewModel(model, inspectionNames ?? new List<string>());
+            var inspectionNameConverter = new InspectionToLocalizedNameConverter();
+            return new AnnotationArgumentViewModel(model, inspectionNames ?? new List<string>(), inspectionNameConverter);
         }
     }
 }