Return IVBComponents in various Import methods

MDoerner · MDoerner · commit 2ff180d14da8 · 2019-04-07T21:40:14.000+02:00
This allows the calling method to continue work with the imported component. However, it also shifts the responsibility for disposal to the the caller.
diff --git a/Rubberduck.Main/Root/RubberduckIoCInstaller.cs b/Rubberduck.Main/Root/RubberduckIoCInstaller.cs
@@ -130,8 +130,8 @@ public void Install(IWindsorContainer container, IConfigurationStore store)
                 .LifestyleSingleton());
             container.Register(Component.For<IAddComponentService>()
                 .ImplementedBy<AddComponentService>()
-                .DependsOn(Dependency.OnComponent("codePaneSourceCodeProvider", typeof(CodeModuleComponentSourceCodeHandler)),
-                    Dependency.OnComponent("attributesSourceCodeProvider", typeof(SourceFileHandlerComponentSourceCodeHandlerAdapter)))
+                .DependsOn(Dependency.OnComponent("codePaneComponentSourceCodeProvider", typeof(CodeModuleComponentSourceCodeHandler)),
+                    Dependency.OnComponent("attributesComponentSourceCodeProvider", typeof(SourceFileHandlerComponentSourceCodeHandlerAdapter)))
                 .LifestyleSingleton());
 
             container.Register(Component.For<TestExplorerModel>()
diff --git a/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponents.cs b/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponents.cs
@@ -20,7 +20,7 @@ public interface IVBComponents : ISafeEventedComWrapper, IComCollection<IVBCompo
         IVBComponent Add(ComponentType type);
         IVBComponent Import(string path);
         IVBComponent AddCustom(string progId);
-        void ImportSourceFile(string path);
+        IVBComponent ImportSourceFile(string path);
 
         /// <summary>
         /// Safely removes the specified VbComponent from the collection.
diff --git a/Rubberduck.VBEEditor/SourceCodeHandling/CodeModuleComponentSourceCodeHandler.cs b/Rubberduck.VBEEditor/SourceCodeHandling/CodeModuleComponentSourceCodeHandler.cs
@@ -12,13 +12,15 @@ public string SourceCode(IVBComponent module)
             }
         }
 
-        public void SubstituteCode(IVBComponent module, string newCode)
+        public IVBComponent SubstituteCode(IVBComponent module, string newCode)
         {
             using (var codeModule = module.CodeModule)
             {
                 codeModule.Clear();
                 codeModule.InsertLines(1, newCode);
             }
+
+            return module;
         }
     }
 }
diff --git a/Rubberduck.VBEEditor/SourceCodeHandling/ComponentSourceCodeHandlerSourceCodeHandlerAdapter.cs b/Rubberduck.VBEEditor/SourceCodeHandling/ComponentSourceCodeHandlerSourceCodeHandlerAdapter.cs
@@ -32,7 +32,7 @@ public void SubstituteCode(QualifiedModuleName module, string newCode)
                 return;
             }
 
-            _componentSourceCodeHandler.SubstituteCode(component, newCode);
+            using (_componentSourceCodeHandler.SubstituteCode(component, newCode)){} //We do nothing; we just need to guarantee that the returned SCW gets disposed.
         }
     }
 }
diff --git a/Rubberduck.VBEEditor/SourceCodeHandling/IComponentSourceCodeHandler.cs b/Rubberduck.VBEEditor/SourceCodeHandling/IComponentSourceCodeHandler.cs
@@ -5,6 +5,6 @@ namespace Rubberduck.VBEditor.SourceCodeHandling
     public interface IComponentSourceCodeHandler
     {
         string SourceCode(IVBComponent module);
-        void SubstituteCode(IVBComponent module, string newCode);
+        IVBComponent SubstituteCode(IVBComponent module, string newCode);
     }
 }
diff --git a/Rubberduck.VBEEditor/SourceCodeHandling/ITempSourceFileHandler.cs b/Rubberduck.VBEEditor/SourceCodeHandling/ITempSourceFileHandler.cs
@@ -5,7 +5,7 @@ namespace Rubberduck.VBEditor.SourceCodeHandling
     public interface ITempSourceFileHandler
     {
         string Export(IVBComponent component);
-        void ImportAndCleanUp(IVBComponent component, string fileName);
+        IVBComponent ImportAndCleanUp(IVBComponent component, string fileName);
 
         string Read(IVBComponent component);
     }
diff --git a/Rubberduck.VBEEditor/SourceCodeHandling/SourceFileHandlerComponentSourceCodeHandlerAdapter.cs b/Rubberduck.VBEEditor/SourceCodeHandling/SourceFileHandlerComponentSourceCodeHandlerAdapter.cs
@@ -18,21 +18,21 @@ public string SourceCode(IVBComponent module)
             return _tempSourceFileHandler.Read(module) ?? string.Empty;
         }
 
-        public void SubstituteCode(IVBComponent module, string newCode)
+        public IVBComponent SubstituteCode(IVBComponent module, string newCode)
         {
             if (module.Type == ComponentType.Document)
             {
                 //We cannot substitute the code of a document module via the file.
-                return;
+                return module;
             }
 
             var fileName = _tempSourceFileHandler.Export(module);
             if (fileName == null || !File.Exists(fileName))
             {
-                return;
+                return module;
             }
             File.WriteAllText(fileName, newCode);
-            _tempSourceFileHandler.ImportAndCleanUp(module, fileName);
+            return _tempSourceFileHandler.ImportAndCleanUp(module, fileName);
         }
     }
 }
diff --git a/Rubberduck.VBEEditor/Utility/AddComponentService.cs b/Rubberduck.VBEEditor/Utility/AddComponentService.cs
@@ -13,12 +13,12 @@ public class AddComponentService : IAddComponentService
 
         public AddComponentService(
             IProjectsProvider projectsProvider,
-            IComponentSourceCodeHandler codePaneSourceCodeHandler,
-            IComponentSourceCodeHandler attributeSourceCodeHandler)
+            IComponentSourceCodeHandler codePaneComponentSourceCodeProvider,
+            IComponentSourceCodeHandler attributesComponentSourceCodeProvider)
         {
             _projectsProvider = projectsProvider;
-            _codePaneSourceCodeHandler = codePaneSourceCodeHandler;
-            _attributeSourceCodeHandler = attributeSourceCodeHandler;
+            _codePaneSourceCodeHandler = codePaneComponentSourceCodeProvider;
+            _attributeSourceCodeHandler = attributesComponentSourceCodeProvider;
         }
 
         public void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null)
@@ -39,19 +39,31 @@ public void AddComponent(IComponentSourceCodeHandler sourceCodeHandler, string p
                 {
                     return;
                 }
-                
-                if (code != null)
-                {
-                    sourceCodeHandler.SubstituteCode(newComponent, code);
-                }
 
-                if (prefixInModule != null)
+                if (code != null)
                 {
-                    using (var codeModule = newComponent.CodeModule)
+                    using (var loadedComponent = sourceCodeHandler.SubstituteCode(newComponent, code))
                     {
-                        codeModule.InsertLines(1, prefixInModule);
+                        AddPrefix(loadedComponent, prefixInModule);
                     }
                 }
+                else
+                {
+                    AddPrefix(newComponent, prefixInModule);
+                }
+            }
+        }
+
+        private static void AddPrefix(IVBComponent module, string prefix)
+        {
+            if (prefix == null || module == null)
+            {
+                return;
+            }
+
+            using (var codeModule = module.CodeModule)
+            {
+                codeModule.InsertLines(1, prefix);
             }
         }
 
diff --git a/Rubberduck.VBEditor.VB6/ExternalFileTempSourceFileHandlerEmulator.cs b/Rubberduck.VBEditor.VB6/ExternalFileTempSourceFileHandlerEmulator.cs
@@ -13,9 +13,10 @@ public string Export(IVBComponent component)
             return component.GetFileName(1);            
         }
 
-        public void ImportAndCleanUp(IVBComponent component, string fileName)
+        public IVBComponent ImportAndCleanUp(IVBComponent component, string fileName)
         {
             // VB6 source code can be written directly in-place, without needing to import it, hence no-op.
+            return component;
         }
 
         public string Read(IVBComponent component)
diff --git a/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/VBComponents.cs b/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/VBComponents.cs
@@ -70,7 +70,7 @@ public override int GetHashCode()
             return IsWrappingNullReference ? 0 : HashCode.Compute(Target);
         }
 
-        public void ImportSourceFile(string path)
+        public IVBComponent ImportSourceFile(string path)
         {
             throw new NotSupportedException("ImportSourceFile not supported in VB6");
         }
diff --git a/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/VBComponents.cs b/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/VBComponents.cs
@@ -74,21 +74,27 @@ public override int GetHashCode()
             return IsWrappingNullReference ? 0 : HashCode.Compute(Target);
         }
 
-        public void ImportSourceFile(string path)
+        public IVBComponent ImportSourceFile(string path)
         {
-            if (IsWrappingNullReference) { return; }
+            if (IsWrappingNullReference)
+            {
+                return null;
+            }
 
             var ext = Path.GetExtension(path);
             var name = Path.GetFileNameWithoutExtension(path);
             if (!File.Exists(path))
             {
-                return;
+                return null;
             }
 
-            if (ext == ComponentTypeExtensions.DocClassExtension)
+            switch (ext)
             {
-                IVBComponent component = null;
-                try {
+                case ComponentTypeExtensions.FormBinaryExtension:
+                    return null;
+                case ComponentTypeExtensions.DocClassExtension:
+                {
+                    IVBComponent component = null;
                     try
                     {
                         component = this[name];
@@ -104,17 +110,13 @@ public void ImportSourceFile(string path)
                         codeModule.Clear();
                         codeModule.AddFromString(codeString);
                     }
+
+                    return component;
+
                 }
-                finally
+                case ComponentTypeExtensions.FormExtension:
                 {
-                    component?.Dispose();
-                }
-            }
-            else if (ext == ComponentTypeExtensions.FormExtension)
-            {
-                IVBComponent component = null;
-                try
-                {   
+                    IVBComponent component = null;
                     try
                     {
                         component = this[name];
@@ -142,15 +144,11 @@ public void ImportSourceFile(string path)
                         codeModule.Clear();
                         codeModule.AddFromString(correctCodeString);
                     }
+                    
+                    return component;
                 }
-                finally
-                {
-                    component?.Dispose();
-                }
-            }
-            else if (ext != ComponentTypeExtensions.FormBinaryExtension)
-            {
-                using(Import(path)){} //Nothing to do here, except properly disposing the wrapper returned from Import.
+                default:
+                    return Import(path);
             }
         }
 
diff --git a/Rubberduck.VBEditor.VBA/TempSourceFileHandler.cs b/Rubberduck.VBEditor.VBA/TempSourceFileHandler.cs
@@ -21,17 +21,18 @@ public string Export(IVBComponent component)
                 : null;         
         }
 
-        public void ImportAndCleanUp(IVBComponent component, string fileName)
+        public IVBComponent ImportAndCleanUp(IVBComponent component, string fileName)
         {
             if (fileName == null || !File.Exists(fileName))
             {
-                return;
+                return component;
             }
 
+            IVBComponent newComponent = null;
             using (var components = component.Collection)
             {
                 components.Remove(component);
-                components.ImportSourceFile(fileName);
+                newComponent = components.ImportSourceFile(fileName);
             }
 
             try
@@ -42,6 +43,8 @@ public void ImportAndCleanUp(IVBComponent component, string fileName)
             {
                 // Meh.
             }
+
+            return newComponent;
         }
 
         public string Read(IVBComponent component)

Original file line number	Diff line number	Diff line change
`@@ -12,13 +12,15 @@ public string SourceCode(IVBComponent module)`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`- public void SubstituteCode(IVBComponent module, string newCode)`
	`15`	`+ public IVBComponent SubstituteCode(IVBComponent module, string newCode)`
`16`	`16`	`{`
`17`	`17`	`using (var codeModule = module.CodeModule)`
`18`	`18`	`{`
`19`	`19`	`codeModule.Clear();`
`20`	`20`	`codeModule.InsertLines(1, newCode);`
`21`	`21`	`}`
	`22`	`+`
	`23`	`+ return module;`
`22`	`24`	`}`
`23`	`25`	`}`
`24`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public void SubstituteCode(QualifiedModuleName module, string newCode)`
`32`	`32`	`return;`
`33`	`33`	`}`
`34`	`34`
`35`		`- _componentSourceCodeHandler.SubstituteCode(component, newCode);`
	`35`	`+ using (_componentSourceCodeHandler.SubstituteCode(component, newCode)){} //We do nothing; we just need to guarantee that the returned SCW gets disposed.`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@ namespace Rubberduck.VBEditor.SourceCodeHandling`
`5`	`5`	`public interface IComponentSourceCodeHandler`
`6`	`6`	`{`
`7`	`7`	`string SourceCode(IVBComponent module);`
`8`		`- void SubstituteCode(IVBComponent module, string newCode);`
	`8`	`+ IVBComponent SubstituteCode(IVBComponent module, string newCode);`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace Rubberduck.VBEditor.SourceCodeHandling`
`5`	`5`	`public interface ITempSourceFileHandler`
`6`	`6`	`{`
`7`	`7`	`string Export(IVBComponent component);`
`8`		`- void ImportAndCleanUp(IVBComponent component, string fileName);`
	`8`	`+ IVBComponent ImportAndCleanUp(IVBComponent component, string fileName);`
`9`	`9`
`10`	`10`	`string Read(IVBComponent component);`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,21 +18,21 @@ public string SourceCode(IVBComponent module)`
`18`	`18`	`return _tempSourceFileHandler.Read(module) ?? string.Empty;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public void SubstituteCode(IVBComponent module, string newCode)`
	`21`	`+ public IVBComponent SubstituteCode(IVBComponent module, string newCode)`
`22`	`22`	`{`
`23`	`23`	`if (module.Type == ComponentType.Document)`
`24`	`24`	`{`
`25`	`25`	`//We cannot substitute the code of a document module via the file.`
`26`		`- return;`
	`26`	`+ return module;`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`var fileName = _tempSourceFileHandler.Export(module);`
`30`	`30`	`if (fileName == null \|\| !File.Exists(fileName))`
`31`	`31`	`{`
`32`		`- return;`
	`32`	`+ return module;`
`33`	`33`	`}`
`34`	`34`	`File.WriteAllText(fileName, newCode);`
`35`		`- _tempSourceFileHandler.ImportAndCleanUp(module, fileName);`
	`35`	`+ return _tempSourceFileHandler.ImportAndCleanUp(module, fileName);`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,12 @@ public class AddComponentService : IAddComponentService`
`13`	`13`
`14`	`14`	`public AddComponentService(`
`15`	`15`	`IProjectsProvider projectsProvider,`
`16`		`- IComponentSourceCodeHandler codePaneSourceCodeHandler,`
`17`		`- IComponentSourceCodeHandler attributeSourceCodeHandler)`
	`16`	`+ IComponentSourceCodeHandler codePaneComponentSourceCodeProvider,`
	`17`	`+ IComponentSourceCodeHandler attributesComponentSourceCodeProvider)`
`18`	`18`	`{`
`19`	`19`	`_projectsProvider = projectsProvider;`
`20`		`- _codePaneSourceCodeHandler = codePaneSourceCodeHandler;`
`21`		`- _attributeSourceCodeHandler = attributeSourceCodeHandler;`
	`20`	`+ _codePaneSourceCodeHandler = codePaneComponentSourceCodeProvider;`
	`21`	`+ _attributeSourceCodeHandler = attributesComponentSourceCodeProvider;`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`public void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null)`
`@@ -39,19 +39,31 @@ public void AddComponent(IComponentSourceCodeHandler sourceCodeHandler, string p`
`39`	`39`	`{`
`40`	`40`	`return;`
`41`	`41`	`}`
`42`		`-`
`43`		`- if (code != null)`
`44`		`- {`
`45`		`- sourceCodeHandler.SubstituteCode(newComponent, code);`
`46`		`- }`
`47`	`42`
`48`		`- if (prefixInModule != null)`
	`43`	`+ if (code != null)`
`49`	`44`	`{`
`50`		`- using (var codeModule = newComponent.CodeModule)`
	`45`	`+ using (var loadedComponent = sourceCodeHandler.SubstituteCode(newComponent, code))`
`51`	`46`	`{`
`52`		`- codeModule.InsertLines(1, prefixInModule);`
	`47`	`+ AddPrefix(loadedComponent, prefixInModule);`
`53`	`48`	`}`
`54`	`49`	`}`
	`50`	`+ else`
	`51`	`+ {`
	`52`	`+ AddPrefix(newComponent, prefixInModule);`
	`53`	`+ }`
	`54`	`+ }`
	`55`	`+ }`
	`56`	`+`
	`57`	`+ private static void AddPrefix(IVBComponent module, string prefix)`
	`58`	`+ {`
	`59`	`+ if (prefix == null \|\| module == null)`
	`60`	`+ {`
	`61`	`+ return;`
	`62`	`+ }`
	`63`	`+`
	`64`	`+ using (var codeModule = module.CodeModule)`
	`65`	`+ {`
	`66`	`+ codeModule.InsertLines(1, prefix);`
`55`	`67`	`}`
`56`	`68`	`}`
`57`	`69`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,10 @@ public string Export(IVBComponent component)`
`13`	`13`	`return component.GetFileName(1);`
`14`	`14`	`}`
`15`	`15`
`16`		`- public void ImportAndCleanUp(IVBComponent component, string fileName)`
	`16`	`+ public IVBComponent ImportAndCleanUp(IVBComponent component, string fileName)`
`17`	`17`	`{`
`18`	`18`	`// VB6 source code can be written directly in-place, without needing to import it, hence no-op.`
	`19`	`+ return component;`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`public string Read(IVBComponent component)`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public override int GetHashCode()`
`70`	`70`	`return IsWrappingNullReference ? 0 : HashCode.Compute(Target);`
`71`	`71`	`}`
`72`	`72`
`73`		`- public void ImportSourceFile(string path)`
	`73`	`+ public IVBComponent ImportSourceFile(string path)`
`74`	`74`	`{`
`75`	`75`	`throw new NotSupportedException("ImportSourceFile not supported in VB6");`
`76`	`76`	`}`