Clean up all the conditional compilation blocks and convert into conditional methods for types outside the TypeLib API

Author: bclothier

Rubberduck.CodeAnalysis/Inspections/Abstract/QuickFixBase.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using NLog;
 using Rubberduck.Parsing.Inspections.Abstract;
@@ -24,17 +25,28 @@ public void RegisterInspections(params Type[] inspections)
         {
             if (!inspections.All(s => s.GetInterfaces().Any(a => a == typeof(IInspection))))
             {
-#if DEBUG
-                throw new ArgumentException($"Parameters must implement {nameof(IInspection)}", nameof(inspections));
-#else
+                var dieNow = false;
+                MustThrowException(ref dieNow);
+                if (dieNow)
+                {
+                    throw new ArgumentException($"Parameters must implement {nameof(IInspection)}",
+                        nameof(inspections));
+                }
+
                 inspections.Where(s => s.GetInterfaces().All(i => i != typeof(IInspection))).ToList()
                     .ForEach(i => Logger.Error($"Type {i.Name} does not implement {nameof(IInspection)}"));
-#endif
             }
 
             _supportedInspections = inspections.ToHashSet();
         }
 
+        // ReSharper disable once RedundantAssignment : conditional must be void but we can use ref
+        [Conditional("DEBUG")] 
+        private static void MustThrowException(ref bool dieNow)
+        {
+            dieNow = true;
+        }
+
         public void RemoveInspections(params Type[] inspections)
         {
             _supportedInspections = _supportedInspections.Except(inspections).ToHashSet();

Rubberduck.Core/UI/Command/MenuItems/CommandBars/SerializeProjectsCommandMenuItem.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using Rubberduck.Parsing.ComReflection;
@@ -77,7 +78,12 @@ protected override void OnExecute(object parameter)
                 _serializationProvider.SerializeProject(library);
             }
 
-#if TRACE_COM_SAFE
+            SerializeComSafe();
+        }
+
+        [Conditional("TRACE_COM_SAFE")]
+        private void SerializeComSafe()
+        {
             //This block must be inside a conditional compilation block because the Serialize method 
             //called is conditionally compiled and available only if the compilation constant TRACE_COM_SAFE is set.
             var path = !string.IsNullOrWhiteSpace(_serializationProvider.Target)
@@ -88,8 +94,8 @@ protected override void OnExecute(object parameter)
             {
                 Directory.CreateDirectory(traceDirectory);
             }
+
             Rubberduck.VBEditor.ComManagement.ComSafeManager.GetCurrentComSafe().Serialize(traceDirectory);
-#endif
         }
     }
 }

Rubberduck.Core/UI/Command/MenuItems/RefactorExtractMethodCommandMenuItem.cs

@@ -1,13 +1,12 @@
 using System.Drawing;
+using Rubberduck.Parsing.Common;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems.ParentMenus;
 using Rubberduck.UI.Command.Refactorings;
 
 namespace Rubberduck.UI.Command.MenuItems
 {
-#if !DEBUG
-    [Parsing.Common.Disabled]
-#endif 
+    [Disabled]
     public class RefactorExtractMethodCommandMenuItem : CommandMenuItemBase
     {
         public RefactorExtractMethodCommandMenuItem(RefactorExtractMethodCommand command) 

Rubberduck.Core/UI/Command/MenuItems/RegexSearchReplaceCommandMenuItem.cs

@@ -1,10 +1,9 @@
+using Rubberduck.Parsing.Common;
 using Rubberduck.UI.Command.MenuItems.ParentMenus;
 
 namespace Rubberduck.UI.Command.MenuItems
 {
-#if !DEBUG
-    [Parsing.Common.Disabled]
-#endif
+    [Disabled]
     public class RegexSearchReplaceCommandMenuItem : CommandMenuItemBase
     {
         public RegexSearchReplaceCommandMenuItem(RegexSearchReplaceCommand command)

Rubberduck.Core/UI/Command/Refactorings/RefactorExtractMethodCommand.cs

@@ -12,9 +12,7 @@
 
 namespace Rubberduck.UI.Command.Refactorings
 {
-#if !DEBUG
     [Disabled]
-#endif
     [ComVisible(false)]
     public class RefactorExtractMethodCommand : CommandBase
     {

Rubberduck.Core/UI/Command/RegexSearchReplaceCommand.cs

@@ -4,9 +4,7 @@
 
 namespace Rubberduck.UI.Command
 {
-#if !DEBUG
     [Disabled]
-#endif
     [ComVisible(false)]
     public class RegexSearchReplaceCommand : CommandBase
     {

Rubberduck.Main/Extension.cs

@@ -70,10 +70,7 @@ public void OnConnection(object Application, ext_ConnectMode ConnectMode, object
                 VbeProvider.Initialize(_vbe, _vbeNativeApi, _beepInterceptor);
                 VbeNativeServices.HookEvents(_vbe);
 
-#if DEBUG
-                // FOR DEBUGGING/DEVELOPMENT PURPOSES, ALLOW ACCESS TO SOME VBETypeLibsAPI FEATURES FROM VBA
-                _addin.Object = new VBETypeLibsAPI_Object(_vbe);
-#endif
+                SetAddInObject();
 
                 switch (ConnectMode)
                 {
@@ -92,6 +89,13 @@ public void OnConnection(object Application, ext_ConnectMode ConnectMode, object
             }
         }
 
+        [Conditional("DEBUG")]
+        private void SetAddInObject()
+        {
+            // FOR DEBUGGING/DEVELOPMENT PURPOSES, ALLOW ACCESS TO SOME VBETypeLibsAPI FEATURES FROM VBA
+            _addin.Object = new VBETypeLibsAPI_Object(_vbe);
+        }
+
         private Assembly LoadFromSameFolder(object sender, ResolveEventArgs args)
         {
             var folderPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) ?? string.Empty;
@@ -239,11 +243,7 @@ private void Startup()
             catch (Exception e)
             {
                 _logger.Log(LogLevel.Fatal, e, "Startup sequence threw an unexpected exception.");
-#if DEBUG
-                throw;
-#else
-                throw new Exception("Rubberduck's startup sequence threw an unexpected exception. Please check the Rubberduck logs for more information and report an issue if necessary");
-#endif
+                throw new Exception("Rubberduck's startup sequence threw an unexpected exception. Please check the Rubberduck logs for more information and report an issue if necessary", e);
             }
         }
 

Rubberduck.Main/Root/RubberduckIoCInstaller.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
 using System.Reflection;
@@ -575,17 +576,24 @@ private void RegisterRubberduckCommandBar(IWindsorContainer container)
 
         private Type[] RubberduckCommandBarItems()
         {
-            return new[]
+            var types = new List<Type>
             {
                 typeof(ReparseCommandMenuItem),
                 typeof(ShowParserErrorsCommandMenuItem),
                 typeof(ContextSelectionLabelMenuItem),
                 typeof(ContextDescriptionLabelMenuItem),
-                typeof(ReferenceCounterLabelMenuItem),
-#if DEBUG
-                typeof(SerializeProjectsCommandMenuItem)
-#endif
+                typeof(ReferenceCounterLabelMenuItem)
             };
+
+            AttachRubberduckDebugCommandBarItems(ref types);
+
+            return types.ToArray();
+        }
+
+        [Conditional("DEBUG")]
+        private static void AttachRubberduckDebugCommandBarItems(ref List<Type> types)
+        {
+            types.Add(typeof(SerializeProjectsCommandMenuItem));
         }
 
         private void RegisterParentMenus(IWindsorContainer container)

Rubberduck.Parsing/ComReflection/ComMember.cs

@@ -27,9 +27,7 @@ internal enum DispId
 
     [DataContract]
     [KnownType(typeof(ComBase))]
-#if DEBUG
     [DebuggerDisplay("{" + nameof(MemberDeclaration) + "}")]
-#endif
     public class ComMember : ComBase
     {
         [DataMember(IsRequired = true)]
@@ -143,8 +141,7 @@ private void LoadParameters(FUNCDESC funcDesc, ITypeInfo info)
                 Parameters.Last().IsParamArray = true;
             }
         }
-#if DEBUG
-        // ReSharper disable once UnusedMember.Local
+
         private string MemberDeclaration
         {
             get
@@ -174,6 +171,5 @@ private string MemberDeclaration
                 return $"{(IsHidden || IsRestricted ? "Private" : "Public")} {type} {Name}{(AsTypeName == null ? string.Empty : $" As {AsTypeName.TypeName}")}";
             }
         }
-#endif
     }
 }

Rubberduck.Parsing/ComReflection/ComParameter.cs

@@ -16,28 +16,15 @@ namespace Rubberduck.Parsing.ComReflection
 {
     [DataContract]
     [KnownType(typeof(ComTypeName))]
-#if DEBUG
     [DebuggerDisplay("{" + nameof(DeclarationName) + "}")]
-#endif
     public class ComParameter
     {
         public static ComParameter Void = new ComParameter { _typeName = new ComTypeName(null, string.Empty) };
 
         [DataMember(IsRequired = true)]
         public string Name { get; private set; }
 
-#if DEBUG
-        // ReSharper disable once UseStringInterpolation
-        public string DeclarationName => string.Format("{0}{1} {2} As {3}{4}{5}",
-            IsOptional ? "Optional " : string.Empty,
-            IsByRef ? "ByRef" : "ByVal",
-            Name,
-            TypeName,
-            IsOptional && DefaultValue != null ? " = " : string.Empty,
-            IsOptional && DefaultValue != null ?
-                _typeName.IsEnumMember ? DefaultAsEnum : DefaultValue
-                : string.Empty);
-#endif
+        public string DeclarationName => $"{(IsOptional ? "Optional " : string.Empty)}{(IsByRef ? "ByRef" : "ByVal")} {Name} As {TypeName}{(IsOptional && DefaultValue != null ? " = " : string.Empty)}{(IsOptional && DefaultValue != null ? _typeName.IsEnumMember ? DefaultAsEnum : DefaultValue : string.Empty)}";
 
         [DataMember(IsRequired = true)]
         public bool IsArray { get; private set; }