Merge pull request #631 from ckuhn203/ScTestRefactor

Added doc comments to the MockFactory closes #630.

Author: rubberduck203

RubberduckTests/Mocks/MockFactory.cs

@@ -1,16 +1,19 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using Microsoft.Vbe.Interop;
 using Moq;
 
 namespace RubberduckTests.Mocks
 {
     static class MockFactory
     {
+        /// <summary>
+        /// Creates a mock <see cref="Window"/> that is particularly useful for passing into <see cref="MockWindowsCollection"/>'s ctor.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="Mock{Window}"/>that has all the properties needed for <see cref="Rubberduck.UI.DockablePresenterBase"/> pre-setup.
+        /// </returns>
         internal static Mock<Window> CreateWindowMock()
         {
             var window = new Mock<Window>();
@@ -22,6 +25,14 @@ internal static Mock<Window> CreateWindowMock()
             return window;
         }
 
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBE}"/> that returns the <see cref="Windows"/> collection argument out of the Windows property.
+        /// </summary>
+        /// <param name="windows">
+        /// A <see cref="MockWindowsCollection"/> is expected. 
+        /// Other objects implementing the<see cref="Windows"/> interface could cause issues.
+        /// </param>
+        /// <returns></returns>
         internal static Mock<VBE> CreateVbeMock(Windows windows)
         {
             var vbe = new Mock<VBE>();
@@ -30,6 +41,15 @@ internal static Mock<VBE> CreateVbeMock(Windows windows)
             return vbe;
         }
 
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBE}"/> with the <see cref="VBE.Windows"/> and <see cref="VBE.VBProjects"/> properties setup.
+        /// </summary>
+        /// <param name="windows">
+        /// A <see cref="MockWindowsCollection"/> is expected. 
+        /// Other objects implementing the<see cref="Windows"/> interface could cause issues.
+        /// </param>
+        /// <param name="projects"><see cref="VBProjects"/> collecction.</param>
+        /// <returns></returns>
         internal static Mock<VBE> CreateVbeMock(Windows windows, VBProjects projects)
         {
             var vbe = CreateVbeMock(windows);
@@ -38,16 +58,37 @@ internal static Mock<VBE> CreateVbeMock(Windows windows, VBProjects projects)
             return vbe;
         }
 
+        /// <summary>
+        /// Creates a new <see cref="Mock{CodeModule}"/> with <see cref="CodeModule.get_Lines"/> and <see cref="CodeModule.CountOfLines"/> 
+        /// setup to appropriately mimic getting code out of the <see cref="CodeModule"/>.
+        /// </summary>
+        /// <param name="code">A block of VBA code.</param>
+        /// <returns></returns>
         internal static Mock<CodeModule> CreateCodeModuleMock(string code)
         {
-            var lineCount = code.Split(new string[] { Environment.NewLine }, StringSplitOptions.None).Length;
+            var lineCount = code.Split(new [] { Environment.NewLine }, StringSplitOptions.None).Length;
 
             var codeModule = new Mock<CodeModule>();
             codeModule.SetupGet(c => c.CountOfLines).Returns(lineCount);
+
+            // ReSharper disable once UseIndexedProperty
+            // No R#, the indexed property breaks the expression. I tried that first.
             codeModule.SetupGet(c => c.get_Lines(1, lineCount)).Returns(code);
             return codeModule;
         }
 
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBComponent}"/>.
+        /// </summary>
+        /// <param name="name">The name to return from the <see cref="VBComponent.Name"/> property.</param>
+        /// <param name="codeModule">The <see cref="CodeModule"/> to return from the CodeModule property.</param>
+        /// <param name="componentType">
+        /// The type of component to be simulated.
+        /// Use vbext_ct_StdModule for standard modules.
+        /// Use vbext_ct_ClassModule for classes.
+        /// vbext_ct_ActiveXDesigner is invalid for the VBE.
+        /// </param>
+        /// <returns></returns>
         internal static Mock<VBComponent> CreateComponentMock(string name, CodeModule codeModule, vbext_ComponentType componentType)
         {
             var component = new Mock<VBComponent>();
@@ -57,16 +98,44 @@ internal static Mock<VBComponent> CreateComponentMock(string name, CodeModule co
             return component;
         }
 
-        internal static Mock<VBComponents> CreateComponentsMock(List<VBComponent> componentList, VBProject project)
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBComponets}"/> that can be iterated over as an <see cref="IEnumerable"/>.
+        /// </summary>
+        /// <param name="componentList">The collection to be iterated over.</param>
+        /// <returns></returns>
+        internal static Mock<VBComponents> CreateComponentsMock(List<VBComponent> componentList)
         {
             var components = new Mock<VBComponents>();
             components.Setup(c => c.GetEnumerator()).Returns(componentList.GetEnumerator());
             components.As<IEnumerable>().Setup(c => c.GetEnumerator()).Returns(componentList.GetEnumerator());
+
+            return components;
+        }
+
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBComponets}"/> that can be iterated over as an <see cref="IEnumerable"/>.
+        /// </summary>
+        /// <param name="componentList">The collection to be iterated over.</param>
+        /// <param name="project">The <see cref="VBComponents.Parent"/> property.</param>
+        /// <returns></returns>
+        internal static Mock<VBComponents> CreateComponentsMock(List<VBComponent> componentList, VBProject project)
+        {
+            var components = CreateComponentsMock(componentList);
             components.SetupGet(c => c.Parent).Returns(project);
 
             return components;
         }
 
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBProject}"/>.
+        /// </summary>
+        /// <param name="name">The <see cref="VBProject.Name"/> property.</param>
+        /// <param name="protectionLevel">
+        /// The <see cref="VBProject.Protection"/> property.
+        /// Use vbext_pp_none to simulate a normal project.
+        /// Use vbext_pp_locked to simulate a password protected, or otherwise unavailable, project.
+        /// </param>
+        /// <returns></returns>
         internal static Mock<VBProject> CreateProjectMock(string name, vbext_ProjectProtection protectionLevel)
         {
             var project = new Mock<VBProject>();
@@ -75,20 +144,18 @@ internal static Mock<VBProject> CreateProjectMock(string name, vbext_ProjectProt
             return project;
         }
 
-        internal static Mock<VBProjects> CreateProjectsMock(List<VBProject> projectList, VBProject project)
+        /// <summary>
+        /// Creates a new <see cref="Mock{VBProjects}"/> that can be iterated over as an <see cref="IEnumerable"/>.
+        /// </summary>
+        /// <param name="projectList">The collection to be iterated over.</param>
+        /// <returns></returns>
+        internal static Mock<VBProjects> CreateProjectsMock(List<VBProject> projectList)
         {
             var projects = new Mock<VBProjects>();
             projects.Setup(p => p.GetEnumerator()).Returns(projectList.GetEnumerator());
             projects.As<IEnumerable>().Setup(p => p.GetEnumerator()).Returns(projectList.GetEnumerator());
 
             return projects;
         }
-
-        //internal static Mock<VBProjects> CreateProjectsMock(List<VBProject> projectList, VBProject project, VBComponents components)
-        //{
-        //    CreateProjectsMock(projectList, project);
-        //    project.SetupGet(p => p.VBComponents).Returns(components.Object);
-        //    return projects;
-        //}
     }
 }

RubberduckTests/Mocks/MockWindowsCollection.cs

@@ -9,8 +9,15 @@ namespace RubberduckTests.Mocks
     /// <summary>
     /// Fake Windows collection to get around Moq's inability to deal with ref params.
     /// </summary>
+    /// <remarks>
+    /// The <see cref="Window"/> passed into MockWindowCollection's ctor will be returned from <see cref="CreateToolWindow"/>.
+    /// </remarks>
     class MockWindowsCollection : Windows
     {
+        /// <param name="window">
+        /// Expects a window created by <see cref="MockFactory.CreateWindowMock"/>.
+        /// This argument will be returned from <see cref="CreateToolWindow"/>.
+        /// </param>
         internal MockWindowsCollection(Window window)
         {
             _window = window;

RubberduckTests/TodoExplorerTests.cs

@@ -38,7 +38,6 @@ public void Intialize()
             _markers = _loader.GetDefaultTodoMarkers();
 
             _gridViewSorter = new GridViewSort<ToDoItem>("Priority", false);
-
         }
 
         [TestMethod]
@@ -62,7 +61,7 @@ Public Sub Bazzer()
 
             var projectList = new List<VBProject>() {project.Object};
 
-            var projects = RdMockFacotry.CreateProjectsMock(projectList, project.Object);
+            var projects = RdMockFacotry.CreateProjectsMock(projectList);
             project.SetupGet(p => p.VBComponents).Returns(components.Object);
 
             _vbe = RdMockFacotry.CreateVbeMock(_windows, projects.Object);