Merge pull request #5360 from MDoerner/EnhanceAddComponentToProvideTheName

Let AddComponentService optionally take a component name

Author: retailcoder

Rubberduck.VBEEditor/Utility/AddComponentService.cs

@@ -1,4 +1,6 @@
-using Rubberduck.VBEditor.ComManagement;
+using System.Runtime.InteropServices;
+using NLog;
+using Rubberduck.VBEditor.ComManagement;
 using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VBEditor.SourceCodeHandling;
@@ -11,6 +13,8 @@ public class AddComponentService : IAddComponentService
         private readonly IComponentSourceCodeHandler _codePaneSourceCodeHandler;
         private readonly IComponentSourceCodeHandler _attributeSourceCodeHandler;
 
+        private static ILogger _logger = LogManager.GetCurrentClassLogger();
+
         public AddComponentService(
             IProjectsProvider projectsProvider,
             IComponentSourceCodeHandler codePaneComponentSourceCodeProvider,
@@ -21,17 +25,17 @@ public AddComponentService(
             _attributeSourceCodeHandler = attributesComponentSourceCodeProvider;
         }
 
-        public void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null)
+        public void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null, string componentName = null)
         {
-            AddComponent(_codePaneSourceCodeHandler, projectId, componentType, code, additionalPrefixInModule);
+            AddComponent(_codePaneSourceCodeHandler, projectId, componentType, code, additionalPrefixInModule, componentName);
         }
 
-        public void AddComponentWithAttributes(string projectId, ComponentType componentType, string code, string prefixInModule = null)
+        public void AddComponentWithAttributes(string projectId, ComponentType componentType, string code, string prefixInModule = null, string componentName = null)
         {
-            AddComponent(_attributeSourceCodeHandler, projectId, componentType, code, prefixInModule);
+            AddComponent(_attributeSourceCodeHandler, projectId, componentType, code, prefixInModule, componentName);
         }
 
-        public void AddComponent(IComponentSourceCodeHandler sourceCodeHandler, string projectId, ComponentType componentType, string code = null, string prefixInModule = null)
+        public void AddComponent(IComponentSourceCodeHandler sourceCodeHandler, string projectId, ComponentType componentType, string code = null, string prefixInModule = null, string componentName = null)
         {
             using (var newComponent = CreateComponent(projectId, componentType))
             {
@@ -45,17 +49,36 @@ public void AddComponent(IComponentSourceCodeHandler sourceCodeHandler, string p
                     using (var loadedComponent = sourceCodeHandler.SubstituteCode(newComponent, code))
                     {
                         AddPrefix(loadedComponent, prefixInModule);
+                        RenameComponent(loadedComponent, componentName);
                         ShowComponent(loadedComponent);
                     }
                 }
                 else
                 {
                     AddPrefix(newComponent, prefixInModule);
+                    RenameComponent(newComponent, componentName);
                     ShowComponent(newComponent);
                 }
             }
         }
 
+        private static void RenameComponent(IVBComponent newComponent, string componentName)
+        {
+            if (componentName == null)
+            {
+                return;
+            }
+
+            try
+            {
+                newComponent.Name = componentName;
+            }
+            catch (COMException ex)
+            {
+                _logger.Debug(ex, $"Unable to rename component to {componentName}.");
+            }
+        }
+
         private static void ShowComponent(IVBComponent component)
         {
             if (component == null)

Rubberduck.VBEEditor/Utility/IAddComponentService.cs

@@ -4,7 +4,7 @@ namespace Rubberduck.VBEditor.Utility
 {
     public interface IAddComponentService
     {
-        void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null);
-        void AddComponentWithAttributes(string projectId, ComponentType componentType, string code, string prefixInModule = null);
+        void AddComponent(string projectId, ComponentType componentType, string code = null, string additionalPrefixInModule = null, string componentName = null);
+        void AddComponentWithAttributes(string projectId, ComponentType componentType, string code, string prefixInModule = null, string componentName = null);
     }
 }