Merge pull request #711 from rubberduck-vba/GrammarIsFun

Mock UserForm

Author: retailcoder

RubberduckTests/Mocks/MockProjectBuilder.cs

@@ -7,15 +7,18 @@
 
 namespace RubberduckTests.Mocks
 {
+    /// <summary>
+    /// Builds a mock <see cref="VBProject"/>.
+    /// </summary>
     public class MockProjectBuilder
     {
         private readonly Func<VBE> _getVbe;
         private readonly Mock<VBProject> _project;
         private readonly Mock<VBComponents> _vbComponents;
         private readonly Mock<References> _vbReferences;
 
-        private readonly List<Mock<VBComponent>> _components = new List<Mock<VBComponent>>();
-        private readonly List<Mock<Reference>> _references = new List<Mock<Reference>>(); 
+        private readonly ICollection<Mock<VBComponent>> _components = new List<Mock<VBComponent>>();
+        private readonly ICollection<Mock<Reference>> _references = new List<Mock<Reference>>(); 
 
         public MockProjectBuilder(string name, vbext_ProjectProtection protection, Func<VBE> getVbe)
         {
@@ -30,20 +33,58 @@ public MockProjectBuilder(string name, vbext_ProjectProtection protection, Func<
             _project.SetupGet(m => m.References).Returns(_vbReferences.Object);
         }
 
+        /// <summary>
+        /// Adds a new component to the project.
+        /// </summary>
+        /// <param name="name">The name of the new component.</param>
+        /// <param name="type">The type of component to create.</param>
+        /// <param name="content">The VBA code associated to the component.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
         public MockProjectBuilder AddComponent(string name, vbext_ComponentType type, string content)
         {
             var component = CreateComponentMock(name, type, content);
-            _components.Add(component);
+            return AddComponent(component);
+        }
 
-            return this;
+        /// <summary>
+        /// Adds a new mock component to the project.
+        /// Use the <see cref="AddComponent(string,vbext_ComponentType,string)"/> overload to add module components.
+        /// Use this overload to add user forms created with a <see cref="MockUserFormBuilder"/> instance.
+        /// </summary>
+        /// <param name="component">The component to add.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
+        public MockProjectBuilder AddComponent(Mock<VBComponent> component)
+        {
+            _components.Add(component);
+            return this;            
         }
 
+        /// <summary>
+        /// Adds a mock reference to the project.
+        /// </summary>
+        /// <param name="name">The name of the referenced library.</param>
+        /// <param name="filePath">The path to the referenced library.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
         public MockProjectBuilder AddReference(string name, string filePath)
         {
             _references.Add(CreateReferenceMock(name, filePath));
             return this;
         }
 
+        /// <summary>
+        /// Creates a <see cref="MockUserFormBuilder"/> to build a new form component.
+        /// </summary>
+        /// <param name="name">The name of the component.</param>
+        /// <param name="content">The VBA code associated to the component.</param>
+        public MockUserFormBuilder UserFormBuilder(string name, string content)
+        {
+            var component = CreateComponentMock(name, vbext_ComponentType.vbext_ct_MSForm, content);
+            return new MockUserFormBuilder(component);
+        }
+
+        /// <summary>
+        /// Gets the mock <see cref="VBProject"/> instance.
+        /// </summary>
         public Mock<VBProject> Build()
         {
             return _project;
@@ -70,8 +111,9 @@ private Mock<VBComponents> CreateComponentsMock()
             result.Setup(c => c.GetEnumerator()).Returns(() => _components.GetEnumerator());
             result.As<IEnumerable>().Setup(c => c.GetEnumerator()).Returns(() => _components.GetEnumerator());
 
-            result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(index => _components[index].Object);
+            result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(index => _components.ElementAt(index).Object);
             result.Setup(m => m.Item(It.IsAny<string>())).Returns<string>(name => _components.Single(item => item.Object.Name == name).Object);
+            result.SetupGet(m => m.Count).Returns(_components.Count);
 
             return result;
         }
@@ -86,7 +128,8 @@ private Mock<References> CreateReferencesMock()
             result.Setup(m => m.GetEnumerator()).Returns(() => _references.GetEnumerator());
             result.As<IEnumerable>().Setup(m => m.GetEnumerator()).Returns(() => _references.GetEnumerator());
 
-            result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(index => _references[index].Object);
+            result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(index => _references.ElementAt(index).Object);
+            result.SetupGet(m => m.Count).Returns(_references.Count);
 
             return result;
         }

RubberduckTests/Mocks/MockUserFormBuilder.cs

@@ -0,0 +1,76 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.Vbe.Interop;
+using Microsoft.Vbe.Interop.Forms;
+using Moq;
+
+namespace RubberduckTests.Mocks
+{
+    /// <summary>
+    /// Builds a mock <see cref="UserForm"/> component.
+    /// </summary>
+    public class MockUserFormBuilder
+    {
+        private readonly Mock<VBComponent> _component;
+        private readonly Mock<Controls> _vbControls;
+        private readonly ICollection<Mock<Control>> _controls = new List<Mock<Control>>();
+
+        public MockUserFormBuilder(Mock<VBComponent> component)
+        {
+            if (component.Object.Type != vbext_ComponentType.vbext_ct_MSForm)
+            {
+                throw new InvalidOperationException("Component type must be 'vbext_ComponentType.vbext_ct_MSForm'.");
+            }
+
+            _component = component;
+            _vbControls = CreateControlsMock();
+        }
+
+        /// <summary>
+        /// Adds a <see cref="Control"/> to the form.
+        /// </summary>
+        /// <param name="name">The name of the control to add.</param>
+        /// <returns></returns>
+        public MockUserFormBuilder AddControl(string name)
+        {
+            var control = new Mock<Control>();
+            control.SetupProperty(m => m.Name, name);
+
+            _controls.Add(control);
+            return this;
+        }
+
+        /// <summary>
+        /// Gets the mock <see cref="UserForm"/> component.
+        /// </summary>
+        /// <returns></returns>
+        public Mock<VBComponent> Build()
+        {
+            var designer = CreateMockDesigner();
+            _component.SetupGet(m => m.Designer).Returns(() => designer);
+
+            return _component;
+        }
+
+        private Mock<UserForm> CreateMockDesigner()
+        {
+            var result = new Mock<UserForm>();
+            result.SetupGet(m => m.Controls).Returns(() => _vbControls.Object);
+
+            return result;
+        }
+
+        private Mock<Controls> CreateControlsMock()
+        {
+            var result = new Mock<Controls>();
+            result.Setup(m => m.GetEnumerator()).Returns(() => _controls.GetEnumerator());
+            result.As<IEnumerable>().Setup(m => m.GetEnumerator()).Returns(() => _controls.GetEnumerator());
+
+            result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(index => _controls.ElementAt(index).Object);
+            result.SetupGet(m => m.Count).Returns(_controls.Count);
+            return result;
+        }
+    }
+}

RubberduckTests/Mocks/MockVbeBuilder.cs

@@ -6,6 +6,9 @@
 
 namespace RubberduckTests.Mocks
 {
+    /// <summary>
+    /// Builds a mock <see cref="VBE"/>.
+    /// </summary>
     public class MockVbeBuilder
     {
         private readonly Mock<VBE> _vbe;
@@ -21,6 +24,12 @@ public MockVbeBuilder()
             _vbe = CreateVbeMock();
         }
 
+        /// <summary>
+        /// Adds a project to the mock VBE.
+        /// Use a <see cref="MockProjectBuilder"/> to build the <see cref="project"/>.
+        /// </summary>
+        /// <param name="project">A mock <see cref="VBProject"/>.</param>
+        /// <returns>Returns the <see cref="MockVbeBuilder"/> instance.</returns>
         public MockVbeBuilder AddProject(Mock<VBProject> project)
         {
             project.SetupGet(m => m.VBE).Returns(_vbe.Object);
@@ -34,12 +43,20 @@ public MockVbeBuilder AddProject(Mock<VBProject> project)
             return this;
         }
 
+        /// <summary>
+        /// Creates a <see cref="MockProjectBuilder"/> to build a new project.
+        /// </summary>
+        /// <param name="name">The name of the project to build.</param>
+        /// <param name="protection">A value that indicates whether the project is protected.</param>
         public MockProjectBuilder ProjectBuilder(string name, vbext_ProjectProtection protection)
         {
             var result = new MockProjectBuilder(name, protection, () => _vbe.Object);
             return result;
         }
 
+        /// <summary>
+        /// Gets the mock <see cref="VBE"/> instance.
+        /// </summary>
         public Mock<VBE> Build()
         {
             return _vbe;
@@ -73,19 +90,26 @@ private Mock<VBE> CreateVbeMock()
         private Mock<VBProjects> CreateProjectsMock()
         {
             var result = new Mock<VBProjects>();
+
             result.Setup(m => m.GetEnumerator()).Returns(_projects.GetEnumerator());
             result.As<IEnumerable>().Setup(m => m.GetEnumerator()).Returns(_projects.GetEnumerator());
+            
             result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(value => _projects.ElementAt(value));
+            result.SetupGet(m => m.Count).Returns(_projects.Count);
+
 
             return result;
         }
 
         private Mock<CodePanes> CreateCodePanesMock()
         {
             var result = new Mock<CodePanes>();
+
             result.Setup(m => m.GetEnumerator()).Returns(_codePanes.GetEnumerator());
             result.As<IEnumerable>().Setup(m => m.GetEnumerator()).Returns(_codePanes.GetEnumerator());
+            
             result.Setup(m => m.Item(It.IsAny<int>())).Returns<int>(value => _codePanes.ElementAt(value));
+            result.SetupGet(m => m.Count).Returns(_codePanes.Count);
 
             return result;
         }

RubberduckTests/RubberduckTests.csproj

@@ -143,6 +143,9 @@
       <EmbedInteropTypes>True</EmbedInteropTypes>
       <HintPath>..\libs\Microsoft.Vbe.Interop.dll</HintPath>
     </Reference>
+    <Reference Include="Microsoft.Vbe.Interop.Forms, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c">
+      <EmbedInteropTypes>True</EmbedInteropTypes>
+    </Reference>
     <Reference Include="Moq">
       <HintPath>..\packages\Moq.4.2.1409.1722\lib\net40\Moq.dll</HintPath>
     </Reference>
@@ -179,6 +182,7 @@
   <ItemGroup>
     <Compile Include="Mocks\MockProjectBuilder.cs" />
     <Compile Include="Mocks\MockFactory.cs" />
+    <Compile Include="Mocks\MockUserFormBuilder.cs" />
     <Compile Include="Mocks\MockWindowsCollection.cs" />
     <Compile Include="Mocks\MockVbeBuilder.cs" />
     <Compile Include="VbeTestBase.cs" />