Moved window settings to .settings file

rkapka · rkapka · commit a1a74831b822 · 2018-01-13T23:01:29.000+01:00
diff --git a/RetailCoder.VBE/Properties/Settings.Designer.cs b/RetailCoder.VBE/Properties/Settings.Designer.cs
diff --git a/RetailCoder.VBE/Properties/Settings.settings b/RetailCoder.VBE/Properties/Settings.settings
@@ -157,5 +157,18 @@
       <Value Profile="(Default)">&lt;?xml version="1.0" encoding="utf-16"?&gt;
 &lt;ToDoMarker xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Text="BUG" /&gt;</Value>
     </Setting>
+    <Setting Name="WindowSettings" Type="Rubberduck.Settings.WindowSettings" Scope="Application">
+      <Value Profile="(Default)">&lt;?xml version="1.0" encoding="utf-16"?&gt;
+&lt;WindowSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"&gt;
+  &lt;CodeExplorerVisibleOnStartup&gt;false&lt;/CodeExplorerVisibleOnStartup&gt;
+  &lt;CodeInspectionsVisibleOnStartup&gt;false&lt;/CodeInspectionsVisibleOnStartup&gt;
+  &lt;SourceControlVisibleOnStartup&gt;false&lt;/SourceControlVisibleOnStartup&gt;
+  &lt;TestExplorerVisibleOnStartup&gt;false&lt;/TestExplorerVisibleOnStartup&gt;
+  &lt;TodoExplorerVisibleOnStartup&gt;false&lt;/TodoExplorerVisibleOnStartup&gt;
+  &lt;CodeExplorer_SortByName&gt;true&lt;/CodeExplorer_SortByName&gt;
+  &lt;CodeExplorer_SortByCodeOrder&gt;false&lt;/CodeExplorer_SortByCodeOrder&gt;
+  &lt;CodeExplorer_GroupByType&gt;false&lt;/CodeExplorer_GroupByType&gt;
+&lt;/WindowSettings&gt;</Value>
+    </Setting>
   </Settings>
-</SettingsFile>
+</SettingsFile>
diff --git a/RetailCoder.VBE/Settings/DefaultSettings.cs b/RetailCoder.VBE/Settings/DefaultSettings.cs
@@ -6,6 +6,7 @@ namespace Rubberduck.Settings
     public class DefaultSettings<T>
     {
         public IEnumerable<T> Defaults { get; }
+        public T Default => Defaults.First();
 
         public DefaultSettings()
         {
diff --git a/RetailCoder.VBE/Settings/WindowConfigProvider.cs b/RetailCoder.VBE/Settings/WindowConfigProvider.cs
@@ -5,21 +5,22 @@ namespace Rubberduck.Settings
     public class WindowConfigProvider : IConfigProvider<WindowSettings>
     {
         private readonly IPersistanceService<WindowSettings> _persister;
+        private readonly WindowSettings _defaultSettings;
 
         public WindowConfigProvider(IPersistanceService<WindowSettings> persister)
         {
             _persister = persister;
+            _defaultSettings = new DefaultSettings<WindowSettings>().Default;
         }
 
         public WindowSettings Create()
         {
-            var prototype = new WindowSettings();
-            return _persister.Load(prototype) ?? prototype;
+            return _persister.Load(_defaultSettings) ?? _defaultSettings;
         }
 
         public WindowSettings CreateDefaults()
         {
-            return new WindowSettings();
+            return _defaultSettings;
         }
 
         public void Save(WindowSettings settings)
diff --git a/RetailCoder.VBE/Settings/WindowSettings.cs b/RetailCoder.VBE/Settings/WindowSettings.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Configuration;
 using System.Xml.Serialization;
 using Rubberduck.UI;
 using Rubberduck.UI.CodeExplorer;
@@ -24,14 +25,15 @@ public interface IWindowSettings
         bool IsWindowVisible(DockableToolwindowPresenter candidate);
     }
 
+    [SettingsSerializeAs(SettingsSerializeAs.Xml)]
     [XmlType(AnonymousType = true)]
     public class WindowSettings : IWindowSettings, IEquatable<WindowSettings>
     {
+        /// <Summary>
+        /// Default constructor required for XML serialization. Initializes all settings to false.
+        /// </Summary>
         public WindowSettings()
-            : this(false, false, false, false, false, true, false, false)
-            // SortByName and SortByLocation are opposites; SortByName should start as True.
         {
-            //empty constructor needed for serialization
         }
 
         public WindowSettings(bool codeExplorerVisibleOnStartup, bool codeInspectionsVisibleOnStartup, 
@@ -63,28 +65,22 @@ public bool IsWindowVisible(DockableToolwindowPresenter candidate)
         {
             //I'm sure there's a better way to do this, because this is a lazy-ass way to do it.
             //We're injecting into the base class, so check the derived class:
-            if (candidate is CodeExplorerDockablePresenter)
+            switch (candidate)
             {
-                return CodeExplorerVisibleOnStartup;
+                case CodeExplorerDockablePresenter _:
+                    return CodeExplorerVisibleOnStartup;
+                case InspectionResultsDockablePresenter _:
+                    return CodeInspectionsVisibleOnStartup;
+                case SourceControlDockablePresenter _:
+                    return SourceControlVisibleOnStartup;
+                case TestExplorerDockablePresenter _:
+                    return TestExplorerVisibleOnStartup;
+                case ToDoExplorerDockablePresenter _:
+                    return TodoExplorerVisibleOnStartup;
+                default:
+                    //Oh. Hello. I have no clue who you are...
+                    return false;
             }
-            if (candidate is InspectionResultsDockablePresenter)
-            {
-                return CodeInspectionsVisibleOnStartup;
-            }
-            if (candidate is SourceControlDockablePresenter)
-            {
-                return SourceControlVisibleOnStartup;
-            }
-            if (candidate is TestExplorerDockablePresenter)
-            {
-                return TestExplorerVisibleOnStartup;
-            }
-            if (candidate is ToDoExplorerDockablePresenter)
-            {
-                return TodoExplorerVisibleOnStartup;
-            }
-            //Oh. Hello. I have no clue who you are...
-            return false;
         }
 
         public bool Equals(WindowSettings other)
diff --git a/RetailCoder.VBE/app.config b/RetailCoder.VBE/app.config
@@ -204,6 +204,21 @@
             xmlns:xsd="http://www.w3.org/2001/XMLSchema" Text="BUG" />
         </value>
       </setting>
+      <setting name="WindowSettings" serializeAs="Xml">
+        <value>
+          <WindowSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+            <CodeExplorerVisibleOnStartup>false</CodeExplorerVisibleOnStartup>
+            <CodeInspectionsVisibleOnStartup>false</CodeInspectionsVisibleOnStartup>
+            <SourceControlVisibleOnStartup>false</SourceControlVisibleOnStartup>
+            <TestExplorerVisibleOnStartup>false</TestExplorerVisibleOnStartup>
+            <TodoExplorerVisibleOnStartup>false</TodoExplorerVisibleOnStartup>
+            <CodeExplorer_SortByName>true</CodeExplorer_SortByName>
+            <CodeExplorer_SortByCodeOrder>false</CodeExplorer_SortByCodeOrder>
+            <CodeExplorer_GroupByType>false</CodeExplorer_GroupByType>
+          </WindowSettings>
+        </value>
+      </setting>
     </Rubberduck.Properties.Settings>
   </applicationSettings>
 </configuration>

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace Rubberduck.Settings`
`6`	`6`	`public class DefaultSettings<T>`
`7`	`7`	`{`
`8`	`8`	`public IEnumerable<T> Defaults { get; }`
	`9`	`+ public T Default => Defaults.First();`
`9`	`10`
`10`	`11`	`public DefaultSettings()`
`11`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,21 +5,22 @@ namespace Rubberduck.Settings`
`5`	`5`	`public class WindowConfigProvider : IConfigProvider<WindowSettings>`
`6`	`6`	`{`
`7`	`7`	`private readonly IPersistanceService<WindowSettings> _persister;`
	`8`	`+ private readonly WindowSettings _defaultSettings;`
`8`	`9`
`9`	`10`	`public WindowConfigProvider(IPersistanceService<WindowSettings> persister)`
`10`	`11`	`{`
`11`	`12`	`_persister = persister;`
	`13`	`+ _defaultSettings = new DefaultSettings<WindowSettings>().Default;`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`public WindowSettings Create()`
`15`	`17`	`{`
`16`		`- var prototype = new WindowSettings();`
`17`		`- return _persister.Load(prototype) ?? prototype;`
	`18`	`+ return _persister.Load(_defaultSettings) ?? _defaultSettings;`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`public WindowSettings CreateDefaults()`
`21`	`22`	`{`
`22`		`- return new WindowSettings();`
	`23`	`+ return _defaultSettings;`
`23`	`24`	`}`
`24`	`25`
`25`	`26`	`public void Save(WindowSettings settings)`