Merge pull request #4248 from mansellan/4008

retailcoder · web-flow · commit 22561bfd613d · 2018-08-07T13:18:33.000-04:00
Split VBA/VB6 menu locations/IDs.
diff --git a/Rubberduck.Main/Root/RubberduckIoCInstaller.cs b/Rubberduck.Main/Root/RubberduckIoCInstaller.cs
@@ -50,6 +50,7 @@
 using Rubberduck.VBEditor.Utility;
 using Rubberduck.AutoComplete;
 using Rubberduck.CodeAnalysis.CodeMetrics;
+using Rubberduck.VBEditor;
 
 namespace Rubberduck.Root
 {
@@ -59,12 +60,6 @@ public class RubberduckIoCInstaller : IWindsorInstaller
         private readonly IAddIn _addin;
         private readonly GeneralSettings _initialSettings;
 
-        private const int MenuBar = 1;
-        private const int CodeWindow = 9;
-        private const int ProjectWindow = 14;
-        private const int MsForms = 17;
-        private const int MsFormsControl = 18;
-
         public RubberduckIoCInstaller(IVBE vbe, IAddIn addin, GeneralSettings initialSettings)
         {
             _vbe = vbe;
@@ -319,9 +314,9 @@ private void RegisterParseTreeInspections(IWindsorContainer container, Assembly[
 
         private void RegisterRubberduckMenu(IWindsorContainer container)
         {
-            const int windowMenuId = 30009;
-            var controls = MainCommandBarControls(MenuBar);
-            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, windowMenuId);
+            var location = _addin.CommandBarLocations[CommandBarSite.MenuBar];
+            var controls = MainCommandBarControls(location.ParentId);
+            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, location.BeforeControlId);
             var menuItemTypes = RubberduckMenuItems();
             RegisterMenu<RubberduckParentMenu>(container, controls, beforeIndex, menuItemTypes);
         }
@@ -385,9 +380,9 @@ private ICommandBarControls MainCommandBarControls(int commandBarIndex)
 
         private void RegisterCodePaneContextMenu(IWindsorContainer container)
         {
-            const int listMembersMenuId = 2529;
-            var controls = MainCommandBarControls(CodeWindow);
-            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, listMembersMenuId);
+            var location = _addin.CommandBarLocations[CommandBarSite.CodeWindow];
+            var controls = MainCommandBarControls(location.ParentId);
+            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, location.BeforeControlId);
             var menuItemTypes = CodePaneContextMenuItems();
             RegisterMenu<CodePaneContextParentMenu>(container, controls, beforeIndex, menuItemTypes);
         }
@@ -406,9 +401,9 @@ private Type[] CodePaneContextMenuItems()
 
         private void RegisterFormDesignerContextMenu(IWindsorContainer container)
         {
-            const int viewCodeMenuId = 2558;
-            var controls = MainCommandBarControls(MsForms);
-            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, viewCodeMenuId);
+            var location = _addin.CommandBarLocations[CommandBarSite.MsForm];
+            var controls = MainCommandBarControls(location.ParentId);
+            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, location.BeforeControlId);
             var menuItemTypes = FormDesignerContextMenuItems();
             RegisterMenu<FormDesignerContextParentMenu>(container, controls, beforeIndex, menuItemTypes);
         }
@@ -424,18 +419,18 @@ private Type[] FormDesignerContextMenuItems()
 
         private void RegisterFormDesignerControlContextMenu(IWindsorContainer container)
         {
-            const int viewCodeMenuId = 2558;
-            var controls = MainCommandBarControls(MsFormsControl);
-            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, viewCodeMenuId);
+            var location = _addin.CommandBarLocations[CommandBarSite.MsFormControl];
+            var controls = MainCommandBarControls(location.ParentId);
+            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, location.BeforeControlId);
             var menuItemTypes = FormDesignerContextMenuItems();
             RegisterMenu<FormDesignerControlContextParentMenu>(container, controls, beforeIndex, menuItemTypes);
         }
 
         private void RegisterProjectExplorerContextMenu(IWindsorContainer container)
         {
-            const int projectPropertiesMenuId = 2578;
-            var controls = MainCommandBarControls(ProjectWindow);
-            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, projectPropertiesMenuId);
+            var location = _addin.CommandBarLocations[CommandBarSite.ProjectExplorer];
+            var controls = MainCommandBarControls(location.ParentId);
+            var beforeIndex = FindRubberduckMenuInsertionIndex(controls, location.BeforeControlId);
             var menuItemTypes = ProjectWindowContextMenuItems();
             RegisterMenu<ProjectWindowContextParentMenu>(container, controls, beforeIndex, menuItemTypes);
         }
diff --git a/Rubberduck.VBEEditor/CommandBarLocation.cs b/Rubberduck.VBEEditor/CommandBarLocation.cs
@@ -0,0 +1,14 @@
+﻿namespace Rubberduck.VBEditor
+{
+    public class CommandBarLocation
+    {
+        public CommandBarLocation(int parentId, int beforeControlId)
+        {
+            ParentId = parentId;
+            BeforeControlId = beforeControlId;
+        }
+
+        public int ParentId { get; }
+        public int BeforeControlId { get; }
+    }
+}
diff --git a/Rubberduck.VBEEditor/CommandBarSite.cs b/Rubberduck.VBEEditor/CommandBarSite.cs
@@ -0,0 +1,11 @@
+﻿namespace Rubberduck.VBEditor
+{
+    public enum CommandBarSite
+    {
+        MenuBar,
+        CodeWindow,
+        ProjectExplorer,
+        MsForm,
+        MsFormControl
+    }
+}
diff --git a/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj b/Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj
@@ -66,9 +66,11 @@
     <Compile Include="Factories\ISafeComWrapperProvider.cs" />
     <Compile Include="Factories\VBEFactory.cs" />
     <Compile Include="HashCode.cs" />
+    <Compile Include="CommandBarLocation.cs" />
     <Compile Include="ISourceCodeHandler.cs" />
     <Compile Include="SafeComWrappers\Abstract\HostApplicationBase.cs" />
     <Compile Include="SafeComWrappers\Abstract\ISafeComWrapper.cs" />
+    <Compile Include="CommandBarSite.cs" />
     <Compile Include="SafeComWrappers\SafeComWrapper.cs" />
     <Compile Include="SafeComWrappers\SafeRedirectedEventedComWrapper.cs" />
     <Compile Include="SafeComWrappers\VB\Abstract\IHostApplication.cs" />
diff --git a/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IAddIn.cs b/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IAddIn.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Collections.Generic;
 
 namespace Rubberduck.VBEditor.SafeComWrappers.Abstract
 {
@@ -12,5 +13,6 @@ public interface IAddIn : ISafeComWrapper, IEquatable<IAddIn>
 
         IVBE VBE { get; }
         IAddIns Collection { get; }
+        IReadOnlyDictionary<CommandBarSite, CommandBarLocation> CommandBarLocations { get; }
     }
 }
diff --git a/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBE.cs b/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBE.cs
@@ -20,7 +20,6 @@ public interface IVBE : ISafeComWrapper, IEquatable<IVBE>
         IWindows Windows { get; }
         IHostApplication HostApplication();
         IWindow ActiveMDIChild();
-
         QualifiedSelection? GetActiveSelection();
 
         bool IsInDesignMode { get; }
diff --git a/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/AddIn.cs b/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/AddIn.cs
@@ -1,16 +1,42 @@
-﻿using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+﻿using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using VB = Microsoft.Vbe.Interop.VB6;
 
 // ReSharper disable once CheckNamespace - Special dispensation due to conflicting file vs namespace priorities
 namespace Rubberduck.VBEditor.SafeComWrappers.VB6
 {
     public class AddIn : SafeComWrapper<VB.AddIn>, IAddIn
     {
+
+        private const int MenuBar = 1;
+        private const int CodeWindow = 15;
+        private const int ProjectExplorer = 22;
+        private const int MsForm = 20;
+        private const int MsFormControl = 21;
+
+        private const int WindowMenu = 30009;
+        private const int ListProperties = 2529;
+        private const int ProjectProperties = 2578;
+        private const int UpdateUserControls = 746;
+        private const int ViewCode = 2558;
+
+
         public AddIn(VB.AddIn target, bool rewrapping = false) 
             : base(target, rewrapping)
-        {
+        {     
+            CommandBarLocations = new ReadOnlyDictionary<CommandBarSite, CommandBarLocation>(new Dictionary<CommandBarSite, CommandBarLocation>
+            {
+                {CommandBarSite.MenuBar, new CommandBarLocation(MenuBar, WindowMenu)},
+                {CommandBarSite.CodeWindow, new CommandBarLocation(CodeWindow, ListProperties)},
+                {CommandBarSite.ProjectExplorer, new CommandBarLocation(ProjectExplorer, ProjectProperties)},
+                {CommandBarSite.MsForm, new CommandBarLocation(MsForm, UpdateUserControls)},
+                {CommandBarSite.MsFormControl, new CommandBarLocation(MsFormControl, ViewCode)}
+            });
         }
 
+        public IReadOnlyDictionary<CommandBarSite, CommandBarLocation> CommandBarLocations { get; }
+
         public string ProgId => IsWrappingNullReference ? string.Empty : Target.ProgId;
 
         public string Guid => IsWrappingNullReference ? string.Empty : Target.Guid;
diff --git a/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/AddIn.cs b/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/AddIn.cs
@@ -1,16 +1,41 @@
-﻿using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+﻿using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using VB = Microsoft.Vbe.Interop;
 
 // ReSharper disable once CheckNamespace - Special dispensation due to conflicting file vs namespace priorities
 namespace Rubberduck.VBEditor.SafeComWrappers.VBA
 {
     public class AddIn : SafeComWrapper<VB.AddIn>, IAddIn
     {
+        private const int MenuBar = 1;
+        private const int CodeWindow = 9;
+        private const int ProjectExplorer = 14;
+        private const int MsForm = 17;
+        private const int MsFormControl = 18;
+
+        private const int WindowMenu = 30009;
+        private const int ListProperties = 2529;
+        private const int ProjectProperties = 2578;
+        private const int ViewCode = 2558;
+
         public AddIn(VB.AddIn target, bool rewrapping = false) 
             : base(target, rewrapping)
         {
+            CommandBarLocations = new ReadOnlyDictionary<CommandBarSite, CommandBarLocation>(new Dictionary<CommandBarSite, CommandBarLocation>
+            {
+                {CommandBarSite.MenuBar, new CommandBarLocation(MenuBar, WindowMenu)},
+                {CommandBarSite.CodeWindow, new CommandBarLocation(CodeWindow, ListProperties)},
+                {CommandBarSite.ProjectExplorer, new CommandBarLocation(ProjectExplorer, ProjectProperties)},
+                {CommandBarSite.MsForm, new CommandBarLocation(MsForm, ViewCode)},
+                {CommandBarSite.MsFormControl, new CommandBarLocation(MsFormControl, ViewCode)}
+            });
+
         }
 
+
+        public IReadOnlyDictionary<CommandBarSite, CommandBarLocation> CommandBarLocations { get; }
+
         public string ProgId => IsWrappingNullReference ? string.Empty : Target.ProgId;
 
         public string Guid => IsWrappingNullReference ? string.Empty : Target.Guid;
diff --git a/RubberduckTests/IoCContainer/IoCRegistrationTests.cs b/RubberduckTests/IoCContainer/IoCRegistrationTests.cs
@@ -1,11 +1,8 @@
 ﻿using System.Collections.Generic;
 using Castle.Windsor;
 using NUnit.Framework;
-using Moq;
 using Rubberduck.Settings;
-using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.Root;
-using Rubberduck.UI;
 using RubberduckTests.Mocks;
 
 namespace RubberduckTests.IoCContainer
@@ -18,8 +15,9 @@ public class IoCRegistrationTests
         public void RegistrationOfRubberduckIoCContainerWithSC_NoException()
         {
             var vbeBuilder = new MockVbeBuilder();
-            var ide = vbeBuilder.Build().Object;
-            var addin = new Mock<IAddIn>().Object;
+            var addInBuilder = new MockAddInBuilder();
+            var ide = vbeBuilder.Build().Object;            
+            var addin = addInBuilder.Build().Object;
             var initialSettings = new GeneralSettings
             {
                 EnableExperimentalFeatures = new List<ExperimentalFeatures>
@@ -41,8 +39,9 @@ public void RegistrationOfRubberduckIoCContainerWithSC_NoException()
         public void RegistrationOfRubberduckIoCContainerWithoutSC_NoException()
         {
             var vbeBuilder = new MockVbeBuilder();
+            var addInBuilder = new MockAddInBuilder();
             var ide = vbeBuilder.Build().Object;
-            var addin = new Mock<IAddIn>().Object;
+            var addin = addInBuilder.Build().Object;
             var initialSettings = new GeneralSettings {EnableExperimentalFeatures = new List<ExperimentalFeatures>()};
 
             using (var container =
diff --git a/RubberduckTests/Mocks/MockAddinBuilder.cs b/RubberduckTests/Mocks/MockAddinBuilder.cs
@@ -0,0 +1,39 @@
+﻿using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Moq;
+using Rubberduck.VBEditor;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+
+namespace RubberduckTests.Mocks
+{
+    public class MockAddInBuilder
+    {
+        private readonly Mock<IAddIn> _addIn;
+
+        public MockAddInBuilder()
+        {
+            _addIn = CreateAddInMock();
+        }
+
+        private Mock<IAddIn> CreateAddInMock()
+        {
+            var addIn = new Mock<IAddIn>();
+
+            addIn.Setup(a => a.CommandBarLocations).Returns(new ReadOnlyDictionary<CommandBarSite, CommandBarLocation>(new Dictionary<CommandBarSite, CommandBarLocation>
+            {
+                {CommandBarSite.MenuBar, new CommandBarLocation(1, 1)},
+                {CommandBarSite.CodeWindow, new CommandBarLocation(2, 2)},
+                {CommandBarSite.ProjectExplorer, new CommandBarLocation(3, 3)},
+                {CommandBarSite.MsForm, new CommandBarLocation(4, 4)},
+                {CommandBarSite.MsFormControl, new CommandBarLocation(5, 5)}
+            }));
+
+            return addIn;
+        }
+
+        public Mock<IAddIn> Build()
+        {
+            return _addIn;
+        }
+    }
+}
diff --git a/RubberduckTests/Mocks/MockVbeBuilder.cs b/RubberduckTests/Mocks/MockVbeBuilder.cs
@@ -60,12 +60,6 @@ public class MockVbeBuilder
         private Mock<ICodePanes> _vbCodePanes;
         private readonly ICollection<ICodePane> _codePanes = new List<ICodePane>();
 
-        private const int MenuBar = 1;
-        private const int CodeWindow = 9;
-        private const int ProjectWindow = 14;
-        private const int MsForms = 17;
-        private const int MsFormsControl = 18;
-
         public MockVbeBuilder()
         {
             _vbe = CreateVbeMock();
@@ -232,11 +226,7 @@ private static ICommandBars DummyCommandBars()
  
             var dummyCommandBar = DummyCommandBar();
 
-            commandBars.SetupGet(m => m[MenuBar]).Returns(dummyCommandBar);
-            commandBars.SetupGet(m => m[CodeWindow]).Returns(dummyCommandBar);
-            commandBars.SetupGet(m => m[ProjectWindow]).Returns(dummyCommandBar);
-            commandBars.SetupGet(m => m[MsForms]).Returns(dummyCommandBar);
-            commandBars.SetupGet(m => m[MsFormsControl]).Returns(dummyCommandBar);
+            commandBars.SetupGet(m => m[It.IsAny<int>()]).Returns(dummyCommandBar);
 
             return commandBars.Object;
         }
diff --git a/RubberduckTests/RubberduckTests.csproj b/RubberduckTests/RubberduckTests.csproj
@@ -105,6 +105,7 @@
     <Compile Include="CodeAnalysis\CodeMetrics\CyclomaticComplexityTests.cs" />
     <Compile Include="CodeAnalysis\CodeMetrics\LineCountTests.cs" />
     <Compile Include="CodeExplorer\CodeExplorerTests.cs" />
+    <Compile Include="Mocks\MockAddInBuilder.cs" />
     <Compile Include="Mocks\MockVbeEvents.cs" />
     <Compile Include="Inspections\SheetAccessedUsingStringInspectionTests.cs" />
     <Compile Include="Parsing\VBACodeStringParserTests.cs" />

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Collections.Generic;`
`2`	`3`
`3`	`4`	`namespace Rubberduck.VBEditor.SafeComWrappers.Abstract`
`4`	`5`	`{`
`@@ -12,5 +13,6 @@ public interface IAddIn : ISafeComWrapper, IEquatable<IAddIn>`
`12`	`13`
`13`	`14`	`IVBE VBE { get; }`
`14`	`15`	`IAddIns Collection { get; }`
	`16`	`+ IReadOnlyDictionary<CommandBarSite, CommandBarLocation> CommandBarLocations { get; }`
`15`	`17`	`}`
`16`	`18`	`}`