Convert VBETypeLibsAPI from static class into a regular instance class

bclothier · bclothier · commit 10d0ce20b41c · 2018-02-22T23:34:12.000-06:00
Introduce IVBETypeLibsAPI interface to make it mockable
Make ReparseCommand testable.
diff --git a/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs b/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs
@@ -45,6 +45,7 @@
 using Rubberduck.UI.CodeMetrics;
 using Rubberduck.VBEditor.ComManagement;
 using Rubberduck.Parsing.Common;
+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 
 
 namespace Rubberduck.Root
@@ -104,6 +105,7 @@ public void Install(IWindsorContainer container, IConfigurationStore store)
 
             RegisterSmartIndenter(container);
             RegisterParsingEngine(container);
+            RegisterTypeLibApi(container);
 
             container.Register(Component.For<TestExplorerModel>()
                 .LifestyleSingleton());
@@ -716,6 +718,13 @@ private void RegisterParsingEngine(IWindsorContainer container)
                 .Instance(() => new VBAPreprocessor(double.Parse(_vbe.Version, CultureInfo.InvariantCulture))));
         }
 
+        private void RegisterTypeLibApi(IWindsorContainer container)
+        {
+            container.Register(Component.For<IVBETypeLibsAPI>()
+                .ImplementedBy<VBETypeLibsAPI>()
+                .LifestyleSingleton());
+        }
+
         private void RegisterCustomDeclarationLoadersToParser(IWindsorContainer container)
         {
             container.Register(Classes.FromAssemblyContaining<ICustomDeclarationLoader>()
diff --git a/RetailCoder.VBE/UI/Command/ReparseCommand.cs b/RetailCoder.VBE/UI/Command/ReparseCommand.cs
@@ -19,14 +19,18 @@ namespace Rubberduck.UI.Command
     public class ReparseCommand : CommandBase
     {
         private readonly IVBE _vbe;
+        private readonly IVBETypeLibsAPI _typeLibApi;
+        private readonly IMessageBox _messageBox;
         private readonly RubberduckParserState _state;
         private readonly GeneralSettings _settings;
 
-        public ReparseCommand(IVBE vbe, IConfigProvider<GeneralSettings> settingsProvider, RubberduckParserState state) : base(LogManager.GetCurrentClassLogger())
+        public ReparseCommand(IVBE vbe, IConfigProvider<GeneralSettings> settingsProvider, RubberduckParserState state, IVBETypeLibsAPI typeLibApi, IMessageBox messageBox) : base(LogManager.GetCurrentClassLogger())
         {
             _vbe = vbe;
+            _typeLibApi = typeLibApi;
             _state = state;
             _settings = settingsProvider.Create();
+            _messageBox = messageBox;
         }
 
         protected override bool EvaluateCanExecute(object parameter)
@@ -66,7 +70,7 @@ private bool CompileAllProjects(out List<string> failedNames)
                             continue;
                         }
 
-                        if (!VBETypeLibsAPI.CompileProject(project))
+                        if (!_typeLibApi.CompileProject(project))
                         {
                             failedNames.Add(project.Name);
                         }
@@ -81,8 +85,7 @@ private bool PromptUserToContinue(List<string> failedNames)
         {
             var formattedList = string.Concat(Environment.NewLine, Environment.NewLine,
                 string.Join(Environment.NewLine, failedNames));
-            var msgbox = new MessageBox();
-            var result = msgbox.Show(
+            var result = _messageBox.Show(
                 string.Format(RubberduckUI.Command_Reparse_CannotCompile,
                     formattedList),
                 RubberduckUI.Command_Reparse_CannotCompile_Caption, MessageBoxButtons.YesNo,
diff --git a/RetailCoder.VBE/UnitTesting/TestEngine.cs b/RetailCoder.VBE/UnitTesting/TestEngine.cs
@@ -21,16 +21,18 @@ public class TestEngine : ITestEngine
         private readonly IVBE _vbe;
         private readonly RubberduckParserState _state;
         private readonly IFakesProviderFactory _fakesFactory;
+        private readonly IVBETypeLibsAPI _typeLibApi;
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
-        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory)
+        public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory, IVBETypeLibsAPI typeLibApi)
         {
             Debug.WriteLine("TestEngine created.");
             Model = model;
             _vbe = vbe;
             _state = state;
             _fakesFactory = fakesFactory;
+            _typeLibApi = typeLibApi;
         }
 
         public TestExplorerModel Model { get; }
@@ -126,7 +128,7 @@ private void Run(IEnumerable<Declaration> members)
                 {
                     foreach (var member in group)
                     {
-                        VBETypeLibsAPI.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,
+                        _typeLibApi.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,
                             member.QualifiedName.MemberName);
                     }
                 }
diff --git a/RetailCoder.VBE/UnitTesting/TestMethod.cs b/RetailCoder.VBE/UnitTesting/TestMethod.cs
@@ -19,11 +19,13 @@ public class TestMethod : ViewModelBase, IEquatable<TestMethod>, INavigateSource
     {
         private readonly ICollection<AssertCompletedEventArgs> _assertResults = new List<AssertCompletedEventArgs>();
         private readonly IVBE _vbe;
+        private readonly IVBETypeLibsAPI _typeLibApi;
 
-        public TestMethod(Declaration declaration, IVBE vbe)
+        public TestMethod(Declaration declaration, IVBE vbe, IVBETypeLibsAPI typeLibApi)
         {
             _declaration = declaration;
             _vbe = vbe;
+            _typeLibApi = typeLibApi;
         }
 
         private Declaration _declaration;
@@ -45,7 +47,7 @@ public void Run()
             try
             {
                 AssertHandler.OnAssertCompleted += HandleAssertCompleted;
-                VBETypeLibsAPI.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,
+                _typeLibApi.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,
                     Declaration.QualifiedName.MemberName);
                 AssertHandler.OnAssertCompleted -= HandleAssertCompleted;
                 
diff --git a/RetailCoder.VBE/UnitTesting/UnitTestUtils.cs b/RetailCoder.VBE/UnitTesting/UnitTestUtils.cs
@@ -5,6 +5,7 @@
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor;
+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;
 using Rubberduck.VBEditor.Extensions;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 
@@ -16,7 +17,7 @@ public static IEnumerable<TestMethod> GetAllTests(IVBE vbe, RubberduckParserStat
         {
             return GetTestModuleProcedures(state)
                     .Where(item => IsTestMethod(state, item))
-                    .Select(item => new TestMethod(item, vbe));
+                    .Select(item => new TestMethod(item, vbe, new VBETypeLibsAPI()));
         }
 
         public static IEnumerable<TestMethod> GetTests(this IVBComponent component, IVBE vbe, RubberduckParserState state)
diff --git a/Rubberduck.VBEEditor/ComManagement/TypeLibs/TypeLibsAPI.cs b/Rubberduck.VBEEditor/ComManagement/TypeLibs/TypeLibsAPI.cs
diff --git a/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj b/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

Original file line number	Diff line number	Diff line change
`@@ -19,14 +19,18 @@ namespace Rubberduck.UI.Command`
`19`	`19`	`public class ReparseCommand : CommandBase`
`20`	`20`	`{`
`21`	`21`	`private readonly IVBE _vbe;`
	`22`	`+ private readonly IVBETypeLibsAPI _typeLibApi;`
	`23`	`+ private readonly IMessageBox _messageBox;`
`22`	`24`	`private readonly RubberduckParserState _state;`
`23`	`25`	`private readonly GeneralSettings _settings;`
`24`	`26`
`25`		`- public ReparseCommand(IVBE vbe, IConfigProvider<GeneralSettings> settingsProvider, RubberduckParserState state) : base(LogManager.GetCurrentClassLogger())`
	`27`	`+ public ReparseCommand(IVBE vbe, IConfigProvider<GeneralSettings> settingsProvider, RubberduckParserState state, IVBETypeLibsAPI typeLibApi, IMessageBox messageBox) : base(LogManager.GetCurrentClassLogger())`
`26`	`28`	`{`
`27`	`29`	`_vbe = vbe;`
	`30`	`+ _typeLibApi = typeLibApi;`
`28`	`31`	`_state = state;`
`29`	`32`	`_settings = settingsProvider.Create();`
	`33`	`+ _messageBox = messageBox;`
`30`	`34`	`}`
`31`	`35`
`32`	`36`	`protected override bool EvaluateCanExecute(object parameter)`
`@@ -66,7 +70,7 @@ private bool CompileAllProjects(out List<string> failedNames)`
`66`	`70`	`continue;`
`67`	`71`	`}`
`68`	`72`
`69`		`- if (!VBETypeLibsAPI.CompileProject(project))`
	`73`	`+ if (!_typeLibApi.CompileProject(project))`
`70`	`74`	`{`
`71`	`75`	`failedNames.Add(project.Name);`
`72`	`76`	`}`
`@@ -81,8 +85,7 @@ private bool PromptUserToContinue(List<string> failedNames)`
`81`	`85`	`{`
`82`	`86`	`var formattedList = string.Concat(Environment.NewLine, Environment.NewLine,`
`83`	`87`	`string.Join(Environment.NewLine, failedNames));`
`84`		`- var msgbox = new MessageBox();`
`85`		`- var result = msgbox.Show(`
	`88`	`+ var result = _messageBox.Show(`
`86`	`89`	`string.Format(RubberduckUI.Command_Reparse_CannotCompile,`
`87`	`90`	`formattedList),`
`88`	`91`	`RubberduckUI.Command_Reparse_CannotCompile_Caption, MessageBoxButtons.YesNo,`
Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,18 @@ public class TestEngine : ITestEngine`
`21`	`21`	`private readonly IVBE _vbe;`
`22`	`22`	`private readonly RubberduckParserState _state;`
`23`	`23`	`private readonly IFakesProviderFactory _fakesFactory;`
	`24`	`+ private readonly IVBETypeLibsAPI _typeLibApi;`
`24`	`25`
`25`	`26`	`private static readonly Logger Logger = LogManager.GetCurrentClassLogger();`
`26`	`27`
`27`		`- public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory)`
	`28`	`+ public TestEngine(TestExplorerModel model, IVBE vbe, RubberduckParserState state, IFakesProviderFactory fakesFactory, IVBETypeLibsAPI typeLibApi)`
`28`	`29`	`{`
`29`	`30`	`Debug.WriteLine("TestEngine created.");`
`30`	`31`	`Model = model;`
`31`	`32`	`_vbe = vbe;`
`32`	`33`	`_state = state;`
`33`	`34`	`_fakesFactory = fakesFactory;`
	`35`	`+ _typeLibApi = typeLibApi;`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`public TestExplorerModel Model { get; }`
`@@ -126,7 +128,7 @@ private void Run(IEnumerable<Declaration> members)`
`126`	`128`	`{`
`127`	`129`	`foreach (var member in group)`
`128`	`130`	`{`
`129`		`- VBETypeLibsAPI.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,`
	`131`	`+ _typeLibApi.ExecuteCode(typeLib, member.QualifiedModuleName.ComponentName,`
`130`	`132`	`member.QualifiedName.MemberName);`
`131`	`133`	`}`
`132`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,13 @@ public class TestMethod : ViewModelBase, IEquatable<TestMethod>, INavigateSource`
`19`	`19`	`{`
`20`	`20`	`private readonly ICollection<AssertCompletedEventArgs> _assertResults = new List<AssertCompletedEventArgs>();`
`21`	`21`	`private readonly IVBE _vbe;`
	`22`	`+ private readonly IVBETypeLibsAPI _typeLibApi;`
`22`	`23`
`23`		`- public TestMethod(Declaration declaration, IVBE vbe)`
	`24`	`+ public TestMethod(Declaration declaration, IVBE vbe, IVBETypeLibsAPI typeLibApi)`
`24`	`25`	`{`
`25`	`26`	`_declaration = declaration;`
`26`	`27`	`_vbe = vbe;`
	`28`	`+ _typeLibApi = typeLibApi;`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`private Declaration _declaration;`
`@@ -45,7 +47,7 @@ public void Run()`
`45`	`47`	`try`
`46`	`48`	`{`
`47`	`49`	`AssertHandler.OnAssertCompleted += HandleAssertCompleted;`
`48`		`- VBETypeLibsAPI.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,`
	`50`	`+ _typeLibApi.ExecuteCode(_vbe, Declaration.ProjectName, Declaration.QualifiedModuleName.ComponentName,`
`49`	`51`	`Declaration.QualifiedName.MemberName);`
`50`	`52`	`AssertHandler.OnAssertCompleted -= HandleAssertCompleted;`
`51`	`53`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using Rubberduck.Parsing.Symbols;`
`6`	`6`	`using Rubberduck.Parsing.VBA;`
`7`	`7`	`using Rubberduck.VBEditor;`
	`8`	`+using Rubberduck.VBEditor.ComManagement.TypeLibsAPI;`
`8`	`9`	`using Rubberduck.VBEditor.Extensions;`
`9`	`10`	`using Rubberduck.VBEditor.SafeComWrappers.Abstract;`
`10`	`11`
`@@ -16,7 +17,7 @@ public static IEnumerable<TestMethod> GetAllTests(IVBE vbe, RubberduckParserStat`
`16`	`17`	`{`
`17`	`18`	`return GetTestModuleProcedures(state)`
`18`	`19`	`.Where(item => IsTestMethod(state, item))`
`19`		`- .Select(item => new TestMethod(item, vbe));`
	`20`	`+ .Select(item => new TestMethod(item, vbe, new VBETypeLibsAPI()));`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public static IEnumerable<TestMethod> GetTests(this IVBComponent component, IVBE vbe, RubberduckParserState state)`