Merge pull request #142 from retailcoder/config

Configuration and Settings Dialog Cleanup

Author: rubberduck203

RetailCoder.VBE/App.cs

@@ -16,27 +16,30 @@ public class App : IDisposable
         private readonly RubberduckMenu _menu;
         private readonly CodeInspectionsToolbar _codeInspectionsToolbar;
         private readonly IList<IInspection> _inspections;
+        private readonly IConfigurationService _configService;
 
         public App(VBE vbe, AddIn addIn)
         {
-            var config = ConfigurationLoader.LoadConfiguration();
+            _configService = new ConfigurationLoader();
 
-            var grammar = ConfigurationLoader.GetImplementedSyntax();
+            var grammar = _configService.GetImplementedSyntax();
 
-            _inspections = ConfigurationLoader.GetImplementedCodeInspections();
+            _inspections = _configService.GetImplementedCodeInspections();
 
+            var config = _configService.LoadConfiguration();
             EnableCodeInspections(config);
+
             var parser = new Parser(grammar);
 
-            _menu = new RubberduckMenu(vbe, addIn, config, parser, _inspections);
+            _menu = new RubberduckMenu(vbe, addIn, _configService, parser, _inspections);
             _codeInspectionsToolbar = new CodeInspectionsToolbar(vbe, parser, _inspections);
         }
 
         private void EnableCodeInspections(Configuration config)
         {
             foreach (var inspection in _inspections)
             {           
-                foreach (var setting in config.UserSettings.CodeInspectinSettings.CodeInspections)
+                foreach (var setting in config.UserSettings.CodeInspectionSettings.CodeInspections)
                 {
                     if (inspection.Name == setting.Name)
                     {

RetailCoder.VBE/Config/ConfigurationLoader.cs

@@ -12,12 +12,12 @@
 namespace Rubberduck.Config
 {
     [ComVisible(false)]
-    public static class ConfigurationLoader
+    public class ConfigurationLoader : IConfigurationService
     {
-        private static string configFile = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) + @"\Rubberduck\rubberduck.config";
+        private static string configFile = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Rubberduck", "rubberduck.config");
 
         /// <summary>   Saves a Configuration to Rubberduck.config XML file via Serialization.</summary>
-        public static void SaveConfiguration<T>(T toSerialize)
+        public void SaveConfiguration<T>(T toSerialize)
         {
             XmlSerializer xmlSerializer = new XmlSerializer(toSerialize.GetType());
             using (TextWriter textWriter = new StreamWriter(configFile))
@@ -28,14 +28,30 @@ public static void SaveConfiguration<T>(T toSerialize)
 
         /// <summary>   Loads the configuration from Rubberduck.config xml file. </summary>
         /// <remarks> If an IOException occurs returns a default configuration.</remarks>
-        public static Configuration LoadConfiguration()
+        public Configuration LoadConfiguration()
         {
             try
             {
                 using (StreamReader reader = new StreamReader(configFile))
                 {
                     var deserializer = new XmlSerializer(typeof(Configuration));
-                    return (Configuration)deserializer.Deserialize(reader);
+                    var config = (Configuration)deserializer.Deserialize(reader);
+
+                    //deserialization can silently fail for just parts of the config, 
+                    //  so we null check and return defaults if necessary.
+                    if (config.UserSettings.ToDoListSettings == null)
+                    {
+                        config.UserSettings.ToDoListSettings = new ToDoListSettings(GetDefaultTodoMarkers());
+                    }
+
+                    if (config.UserSettings.CodeInspectionSettings == null)
+                    {
+                        config.UserSettings.CodeInspectionSettings = new CodeInspectionSettings(GetDefaultCodeInspections());
+                    }
+
+                    //todo: check for implemented inspections that aren't in config file
+
+                    return config;
                 }
             }
             catch (IOException)
@@ -64,7 +80,7 @@ public static Configuration LoadConfiguration()
             }
         }
 
-        public static Configuration GetDefaultConfiguration()
+        public Configuration GetDefaultConfiguration()
         {
             var userSettings = new UserSettings(
                                     new ToDoListSettings(GetDefaultTodoMarkers()),
@@ -74,7 +90,7 @@ public static Configuration GetDefaultConfiguration()
             return new Configuration(userSettings);
         }
 
-        public static ToDoMarker[] GetDefaultTodoMarkers()
+        public ToDoMarker[] GetDefaultTodoMarkers()
         {
             var note = new ToDoMarker("NOTE:", TodoPriority.Low);
             var todo = new ToDoMarker("TODO:", TodoPriority.Normal);
@@ -85,7 +101,7 @@ public static ToDoMarker[] GetDefaultTodoMarkers()
 
         /// <summary>   Converts implemented code inspections into array of Config.CodeInspection objects. </summary>
         /// <returns>   An array of Config.CodeInspection. </returns>
-        public static CodeInspection[] GetDefaultCodeInspections()
+        public CodeInspection[] GetDefaultCodeInspections()
         {
             var configInspections = new List<CodeInspection>();
             foreach (var inspection in GetImplementedCodeInspections())
@@ -97,7 +113,7 @@ public static CodeInspection[] GetDefaultCodeInspections()
         }
 
         /// <summary>   Gets all implemented code inspections via reflection </summary>
-        public static IList<IInspection> GetImplementedCodeInspections()
+        public IList<IInspection> GetImplementedCodeInspections()
         {
             var inspections = Assembly.GetExecutingAssembly()
                                   .GetTypes()
@@ -115,7 +131,7 @@ public static IList<IInspection> GetImplementedCodeInspections()
         }
 
         /// <summary>   Gets all implemented syntax via reflection. </summary>
-        public static List<ISyntax> GetImplementedSyntax()
+        public List<ISyntax> GetImplementedSyntax()
         {
             var grammar = Assembly.GetExecutingAssembly()
                                   .GetTypes()

RetailCoder.VBE/Config/IConfigurationService.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Runtime.InteropServices;
+
+namespace Rubberduck.Config
+{
+    [ComVisible(false)]
+    public interface IConfigurationService
+    {
+        CodeInspection[] GetDefaultCodeInspections();
+        Configuration GetDefaultConfiguration();
+        ToDoMarker[] GetDefaultTodoMarkers();
+        System.Collections.Generic.IList<Rubberduck.Inspections.IInspection> GetImplementedCodeInspections();
+        System.Collections.Generic.List<Rubberduck.VBA.Parser.Grammar.ISyntax> GetImplementedSyntax();
+        Configuration LoadConfiguration();
+        void SaveConfiguration<T>(T toSerialize);
+    }
+}

RetailCoder.VBE/Config/UserSettings.cs

@@ -13,7 +13,7 @@ namespace Rubberduck.Config
     public class UserSettings
     {
         public ToDoListSettings ToDoListSettings { get; set; }
-        public CodeInspectionSettings CodeInspectinSettings { get; set; }
+        public CodeInspectionSettings CodeInspectionSettings { get; set; }
 
         public UserSettings()
         {
@@ -23,7 +23,7 @@ public UserSettings()
         public UserSettings(ToDoListSettings todoSettings, CodeInspectionSettings codeInspectionSettings)
         {
             this.ToDoListSettings = todoSettings;
-            this.CodeInspectinSettings = codeInspectionSettings;
+            this.CodeInspectionSettings = codeInspectionSettings;
         }
     }
 }

RetailCoder.VBE/Rubberduck.csproj

@@ -22,6 +22,7 @@
     <WarningLevel>4</WarningLevel>
     <RegisterForComInterop>true</RegisterForComInterop>
     <DocumentationFile>bin\Debug\Rubberduck.XML</DocumentationFile>
+    <NoWarn>1591</NoWarn>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -65,6 +66,8 @@
     <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Config\IConfigurationService.cs" />
+    <Compile Include="UI\Settings\ITodoSettingsView.cs" />
     <Compile Include="VBEHost\AccessApp.cs" />
     <Compile Include="Config\ConfigurationLoader.cs" />
     <Compile Include="Config\UserSettings.cs" />
@@ -170,13 +173,13 @@
     <Compile Include="UI\Settings\SettingsDialog.Designer.cs">
       <DependentUpon>SettingsDialog.cs</DependentUpon>
     </Compile>
-    <Compile Include="UI\Settings\TodoListSettingsControl.cs">
+    <Compile Include="UI\Settings\TodoListSettingsUserControl.cs">
       <SubType>UserControl</SubType>
     </Compile>
-    <Compile Include="UI\Settings\TodoListSettingsControl.Designer.cs">
-      <DependentUpon>TodoListSettingsControl.cs</DependentUpon>
+    <Compile Include="UI\Settings\TodoListSettingsUserControl.Designer.cs">
+      <DependentUpon>TodoListSettingsUserControl.cs</DependentUpon>
     </Compile>
-    <Compile Include="UI\Settings\TodoSettingModel.cs" />
+    <Compile Include="UI\Settings\TodoSettingPresenter.cs" />
     <Compile Include="UI\ToDoItems\ToDoExplorerDockablePresenter.cs" />
     <Compile Include="UI\ToDoItems\ToDoItemClickEventArgs.cs" />
     <Compile Include="UI\WindowExtensions.cs" />
@@ -386,8 +389,8 @@
     <EmbeddedResource Include="UI\Settings\SettingsDialog.resx">
       <DependentUpon>SettingsDialog.cs</DependentUpon>
     </EmbeddedResource>
-    <EmbeddedResource Include="UI\Settings\TodoListSettingsControl.resx">
-      <DependentUpon>TodoListSettingsControl.cs</DependentUpon>
+    <EmbeddedResource Include="UI\Settings\TodoListSettingsUserControl.resx">
+      <DependentUpon>TodoListSettingsUserControl.cs</DependentUpon>
     </EmbeddedResource>
     <EmbeddedResource Include="VBA\Grammar\ReservedKeywords.resx">
       <Generator>PublicResXFileCodeGenerator</Generator>

RetailCoder.VBE/UI/RubberduckMenu.cs

@@ -25,13 +25,19 @@ public class RubberduckMenu : IDisposable
         private readonly CodeExplorerMenu _codeExplorerMenu;
         private readonly CodeInspectionsMenu _codeInspectionsMenu;
         //private readonly RefactorMenu _refactorMenu; // todo: implement refactoring
+        private readonly IConfigurationService _configService;
 
-        public RubberduckMenu(VBE vbe, AddIn addIn, Configuration config, Parser parser, IEnumerable<IInspection> inspections)
+        public RubberduckMenu(VBE vbe, AddIn addIn, IConfigurationService configService, Parser parser, IEnumerable<IInspection> inspections)
         {
             _vbe = vbe;
+            _configService = configService;
+
             _testMenu = new TestMenu(_vbe, addIn);
             _codeExplorerMenu = new CodeExplorerMenu(_vbe, addIn, parser);
-            _todoItemsMenu = new ToDoItemsMenu(_vbe, addIn, config.UserSettings.ToDoListSettings, parser);
+
+            var todoSettings = configService.LoadConfiguration().UserSettings.ToDoListSettings;
+            _todoItemsMenu = new ToDoItemsMenu(_vbe, addIn, todoSettings, parser);
+
             _codeInspectionsMenu = new CodeInspectionsMenu(_vbe, addIn, parser, inspections);
             //_refactorMenu = new RefactorMenu(_vbe, addIn);
 
@@ -78,7 +84,7 @@ private CommandBarButton AddButton(CommandBarPopup parentMenu, string caption, b
 
         private void OnOptionsClick(CommandBarButton Ctrl, ref bool CancelDefault)
         {
-            using (var window = new Settings.SettingsDialog())
+            using (var window = new Settings.SettingsDialog(_configService))
             {
                 window.ShowDialog();
             }

RetailCoder.VBE/UI/Settings/CodeInspectionControl.cs

@@ -24,7 +24,12 @@ public CodeInspectionControl()
         public CodeInspectionControl(List<CodeInspection> inspections)
             : this()
         {
-            _inspections = new BindingList<CodeInspection>(inspections);
+            _inspections = new BindingList<CodeInspection>(inspections
+                                                            .OrderBy(c => c.InspectionType.ToString())
+                                                            .ThenBy(c => c.Name)
+                                                            .ToList()
+                                                            );
+            
             this.dataGridView1.AutoGenerateColumns = false;
             this.dataGridView1.DataSource = _inspections;
 

RetailCoder.VBE/UI/Settings/ITodoSettingsView.cs

@@ -0,0 +1,70 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Rubberduck.Config;
+using System.ComponentModel;
+using System.Windows.Forms;
+
+namespace Rubberduck.UI.Settings
+{
+    public interface ITodoSettingsView
+    {
+        /// <summary>
+        /// The TodoPriority level of the marker currently being edited.
+        /// </summary>
+        TodoPriority ActiveMarkerPriority { get; set; }
+
+        /// <summary>
+        /// The Text (or Name) of the marker currently being edited.
+        /// </summary>
+        string ActiveMarkerText { get; set; }
+
+        /// <summary>
+        /// List of all TodoMarkers to be displayed.
+        /// </summary>
+        BindingList<ToDoMarker> TodoMarkers { get; set; }
+
+        /// <summary>
+        /// Zero based index of the currently selected TodoMarker.
+        /// </summary>
+        int SelectedIndex { get; set; }
+
+        /// <summary>
+        /// Boolean value representing the enables/disabled state of the UI element the user needs to interact with to save the currently active marker.
+        /// </summary>
+        bool SaveEnabled { get; set; }
+
+        /// <summary>
+        /// Request to remove the marker at the SelectedIndex.
+        /// </summary>
+        event EventHandler RemoveMarker;
+
+        /// <summary>
+        /// Request to add the currently active marker to BindingList{TodoMarker}.
+        /// </summary>
+        event EventHandler AddMarker;
+
+        /// <summary>
+        /// Request to save changes made to the currently active marker back to the marker at the SelectedIndex.
+        /// </summary>
+        event EventHandler SaveMarker;
+
+        /// <summary>
+        /// Raised whenever SelectedIndex is changed.
+        /// </summary>
+        event EventHandler SelectionChanged;
+
+        /// <summary>
+        /// Raised whenever ActiveMarkerText is changed.
+        /// </summary>
+        event EventHandler TextChanged;
+
+        /// <summary>
+        /// Raised whenver ActiveMarkerPriority is changed.
+        /// </summary>
+        event EventHandler PriorityChanged;
+
+    }
+}