Clean up the persistence services and make it use PersistancePathProvider. Update the registration.

Author: bclothier

Rubberduck.Main/Extension.cs

@@ -145,7 +145,7 @@ private void InitializeAddIn()
                     return;
                 }
 
-                var configLoader = new XmlPersistanceService<GeneralSettings>
+                var configLoader = new XmlPersistanceService<GeneralSettings>()
                 {
                     FilePath =
                         Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),

Rubberduck.Main/Root/RubberduckIoCInstaller.cs

@@ -84,7 +84,7 @@ public void Install(IWindsorContainer container, IConfigurationStore store)
             ActivateAutoMagicFactories(container);
             OverridePropertyInjection(container);
 
-            RegisterConstantVbeAndAddIn(container);
+            RegisterInstances(container);
             RegisterAppWithSpecialDependencies(container);
             RegisterUnitTestingComSide(container);
 
@@ -850,15 +850,16 @@ private void RegisterAppWithSpecialDependencies(IWindsorContainer container)
                 .LifestyleSingleton());
         }
 
-        private void RegisterConstantVbeAndAddIn(IWindsorContainer container)
+        private void RegisterInstances(IWindsorContainer container)
         {
             container.Register(Component.For<IVBE>().Instance(_vbe));
             container.Register(Component.For<IAddIn>().Instance(_addin));
             //note: This registration makes Castle Windsor inject _vbe_CommandBars in all ICommandBars Parent properties.
             container.Register(Component.For<ICommandBars>().Instance(_vbe.CommandBars));
             container.Register(Component.For<IUiContextProvider>().Instance(UiContextProvider.Instance()).LifestyleSingleton());
             container.Register(Component.For<IVBEEvents>().Instance(VBEEvents.Initialize(_vbe)).LifestyleSingleton());
-            container.Register(Component.For<ITempSourceFileHandler>().Instance(_vbe.TempSourceFileHandler));
+            container.Register(Component.For<ITempSourceFileHandler>().Instance(_vbe.TempSourceFileHandler).LifestyleSingleton());
+            container.Register(Component.For<IPersistancePathProvider>().Instance(PersistancePathProvider.Instance).LifestyleSingleton());
         }
     }
 }

Rubberduck.SettingsProvider/PersistancePathProvider.cs

@@ -5,6 +5,13 @@ namespace Rubberduck.SettingsProvider
 {
     public class PersistancePathProvider : IPersistancePathProvider
     {
+        private static readonly Lazy<IPersistancePathProvider> LazyInstance;
+
+        static PersistancePathProvider()
+        {
+            LazyInstance = new Lazy<IPersistancePathProvider>(() => new PersistancePathProvider());
+        }
+
         public string DataRootPath => Path.Combine(
             Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
             "Rubberduck");
@@ -13,5 +20,7 @@ public string DataFolderPath(string folderName)
         {
             return Path.Combine(DataRootPath, folderName);
         }
+
+        public static IPersistancePathProvider Instance => LazyInstance.Value;
     }
 }

Rubberduck.SettingsProvider/XmlContractPersistanceService.cs

@@ -24,12 +24,11 @@ public override string FilePath
 
         public override T Load(T toDeserialize)
         {
-            var defaultOutput = CachedOrNotFound();
-            if (defaultOutput != null)
+            if (!File.Exists(FilePath))
             {
-                return defaultOutput;
+                return Cached;
             }
-
+            
             try
             {
                 using (var stream = new FileStream(FilePath, FileMode.Open, FileAccess.Read))

Rubberduck.SettingsProvider/XmlPersistanceService.cs

@@ -7,29 +7,24 @@
 
 namespace Rubberduck.SettingsProvider
 {
-    public class XmlPersistanceService<T> : XmlPersistanceServiceBase<T> where T : class, IEquatable<T>, new()
+    public class XmlPersistanceService<T> : XmlPersistanceServiceBase<T> 
+        where T : class, IEquatable<T>, new()
     {
         public override T Load(T toDeserialize)
         {
-            var defaultOutput = CachedOrNotFound();
-            if (defaultOutput != null)
-            {
-                return defaultOutput;
-            }
-
             var doc = GetConfigurationDoc(FilePath);
             var node = GetNodeByName(doc, typeof(T).Name);
             if (node == null)
             {
-                return FailedLoadReturnValue();
+                return Cached;
             }
 
             using (var reader = node.CreateReader())
             {
                 var deserializer = new XmlSerializer(typeof(T));
                 try
                 {
-                    Cached = (T)Convert.ChangeType(deserializer.Deserialize(reader), typeof(T));
+                    Cached = (T)deserializer.Deserialize(reader);
                     return Cached;
                 }
                 catch

Rubberduck.SettingsProvider/XmlPersistanceServiceBase.cs

@@ -13,7 +13,7 @@ namespace Rubberduck.SettingsProvider
     {
         private const string DefaultConfigFile = "rubberduck.config";
 
-        protected readonly string RootPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Rubberduck");
+        protected readonly string RootPath;
         protected static readonly UTF8Encoding OutputEncoding = new UTF8Encoding(false);        
         protected const string RootElement = "Configuration";
 
@@ -28,6 +28,12 @@ namespace Rubberduck.SettingsProvider
 
         protected T Cached { get; set; }
 
+        protected XmlPersistanceServiceBase()
+        {
+            var pathProvider = PersistancePathProvider.Instance;
+            RootPath = pathProvider.DataRootPath;
+        }
+
         private string _filePath;
         public virtual string FilePath
         {
@@ -41,11 +47,16 @@ public virtual string FilePath
 
         protected static T FailedLoadReturnValue()
         {
-            return (T)Convert.ChangeType(null, typeof(T));
+            return new T();
         }
 
         protected static XDocument GetConfigurationDoc(string file)
         {
+            if (!File.Exists(file))
+            {
+                return new XDocument();
+            }
+
             XDocument output;
             try
             {
@@ -78,10 +89,5 @@ protected void EnsurePathExists()
                 Directory.CreateDirectory(folder);
             }
         }
-
-        protected T CachedOrNotFound()
-        {
-            return !File.Exists(FilePath) ? FailedLoadReturnValue() : Cached;
-        }
     }
 }