Enclose default members to expand with brackets if they are otherwise not legal

Author: MDoerner

Rubberduck.CodeAnalysis/QuickFixes/ExpandBangNotationQuickFix.cs

@@ -59,10 +59,24 @@ private void InsertDefaultMember(VBAParser.DictionaryAccessContext dictionaryAcc
         private string DefaultMemberAccessCode(QualifiedSelection selection, DeclarationFinder finder)
         {
             var defaultMemberAccesses = finder.IdentifierReferences(selection);
-            var defaultMemberNames = defaultMemberAccesses.Select(reference => reference.Declaration.IdentifierName);
+            var defaultMemberNames = defaultMemberAccesses
+                .Select(reference => reference.Declaration.IdentifierName)
+                .Select(declarationName => IsNotLegalIdentifierName(declarationName) 
+                                            ? $"[{declarationName}]" 
+                                            : declarationName);
             return $".{string.Join("().", defaultMemberNames)}";
         }
 
+        private bool IsNotLegalIdentifierName(string declarationName)
+        {
+            return string.IsNullOrEmpty(declarationName)
+                || NonIdentifierCharacters.Any(character => declarationName.Contains(character))
+                || AdditionalNonFirstIdentifierCharacters.Contains(declarationName[0]); ;
+        }
+
+        private string NonIdentifierCharacters = "[](){}\r\n\t.,'\"\\ |!@#$%^&*-+:=; ";
+        private string AdditionalNonFirstIdentifierCharacters = "0123456789_";
+
         public override string Description(IInspectionResult result)
         {
             return Resources.Inspections.QuickFixes.ExpandBangNotationQuickFix;

Rubberduck.CodeAnalysis/QuickFixes/ExpandDefaultMemberQuickFix.cs

@@ -54,10 +54,23 @@ private void InsertDefaultMember(ParserRuleContext lExpressionContext, Qualified
         private string DefaultMemberAccessCode(QualifiedSelection selection, DeclarationFinder finder)
         {
             var defaultMemberAccesses = finder.IdentifierReferences(selection).Where(reference => reference.DefaultMemberRecursionDepth > 0);
-            var defaultMemberNames = defaultMemberAccesses.Select(reference => reference.Declaration.IdentifierName);
+            var defaultMemberNames = defaultMemberAccesses.Select(reference => reference.Declaration.IdentifierName)
+                .Select(declarationName => IsNotLegalIdentifierName(declarationName)
+                                            ? $"[{declarationName}]"
+                                            : declarationName);
             return $".{string.Join("().", defaultMemberNames)}";
         }
 
+        private bool IsNotLegalIdentifierName(string declarationName)
+        {
+            return string.IsNullOrEmpty(declarationName)
+                || NonIdentifierCharacters.Any(character => declarationName.Contains(character))
+                || AdditionalNonFirstIdentifierCharacters.Contains(declarationName[0]);                ;
+        }
+
+        private string NonIdentifierCharacters = "[](){}\r\n\t.,'\"\\ |!@#$%^&*-+:=; ";
+        private string AdditionalNonFirstIdentifierCharacters = "0123456789_";
+
         public override string Description(IInspectionResult result)
         {
             return Resources.Inspections.QuickFixes.ExpandDefaultMemberQuickFix;

RubberduckTests/QuickFixes/ExpandBangNotationQuickFixTests.cs

@@ -170,6 +170,37 @@ End Function
             Assert.AreEqual(expectedModuleCode, actualModuleCode);
         }
 
+        [Test]
+        [Category("QuickFixes")]
+        public void OtherwiseIllegalDeclarationNamesAreEnclosedInBrackets()
+        {
+            var moduleCode = @"
+Private Sub Foo() 
+    Dim wkb As Excel.Workbook
+    Dim bar As Variant
+    bar = wkb.Sheets!MySheet.Range(""A1"").Value
+End Sub
+";
+
+            var expectedModuleCode = @"
+Private Sub Foo() 
+    Dim wkb As Excel.Workbook
+    Dim bar As Variant
+    bar = wkb.Sheets.[_Default](""MySheet"").Range(""A1"").Value
+End Sub
+";
+
+            var vbe = new MockVbeBuilder()
+                .ProjectBuilder("TestProject", ProjectProtection.Unprotected)
+                .AddComponent("Module1", ComponentType.StandardModule, moduleCode)
+                .AddReference("Excel", MockVbeBuilder.LibraryPathMsExcel, 1, 8, true)
+                .AddProjectToVbeBuilder()
+                .Build();
+
+            var actualModuleCode = ApplyQuickFixToFirstInspectionResult(vbe.Object, "Module1", state => new UseOfBangNotationInspection(state));
+            Assert.AreEqual(expectedModuleCode, actualModuleCode);
+        }
+
         protected override IQuickFix QuickFix(RubberduckParserState state)
         {
             return new ExpandBangNotationQuickFix(state);

RubberduckTests/QuickFixes/ExpandDefaultMemberQuickFixTests.cs

@@ -644,6 +644,37 @@ End Sub
             Assert.AreEqual(expectedModuleCode, actualModuleCode);
         }
 
+        [Test]
+        [Category("QuickFixes")]
+        public void OtherwiseIllegalDeclarationNamesAreEnclosedInBrackets()
+        {
+            var moduleCode = @"
+Private Sub Foo() 
+    Dim wkb As Excel.Workbook
+    Dim bar As Variant
+    bar = wkb.Sheets(""MySheet"").Range(""A1"").Value
+End Sub
+";
+
+            var expectedModuleCode = @"
+Private Sub Foo() 
+    Dim wkb As Excel.Workbook
+    Dim bar As Variant
+    bar = wkb.Sheets.[_Default](""MySheet"").Range(""A1"").Value
+End Sub
+";
+
+            var vbe = new MockVbeBuilder()
+                .ProjectBuilder("TestProject", ProjectProtection.Unprotected)
+                .AddComponent("Module1", ComponentType.StandardModule, moduleCode)
+                .AddReference("Excel", MockVbeBuilder.LibraryPathMsExcel, 1, 8, true)
+                .AddProjectToVbeBuilder()
+                .Build();
+
+            var actualModuleCode = ApplyQuickFixToFirstInspectionResult(vbe.Object, "Module1", state => new IndexedDefaultMemberAccessInspection(state));
+            Assert.AreEqual(expectedModuleCode, actualModuleCode);
+        }
+
         protected override IQuickFix QuickFix(RubberduckParserState state)
         {
             return new ExpandDefaultMemberQuickFix(state);