Improve handling of transient static sheet references. Closes #4329

Author: comintern

Rubberduck.CodeAnalysis/QuickFixes/AccessSheetUsingCodeNameQuickFix.cs

@@ -27,7 +27,8 @@ public override void Fix(IInspectionResult result)
             var rewriter = _state.GetRewriter(referenceResult.QualifiedName);
 
             var setStatement = referenceResult.Context.GetAncestor<VBAParser.SetStmtContext>();
-            if (setStatement == null)
+            var isArgument = referenceResult.Context.GetAncestor<VBAParser.ArgumentContext>() != null;
+            if (setStatement == null || isArgument)
             {
                 // Sheet accessed inline
 
@@ -49,20 +50,23 @@ public override void Fix(IInspectionResult result)
                         return moduleBodyElement != null && moduleBodyElement == referenceResult.Context.GetAncestor<VBAParser.ModuleBodyElementContext>();
                     });
 
-                var variableListContext = (VBAParser.VariableListStmtContext)sheetDeclaration.Context.Parent;
-                if (variableListContext.variableSubStmt().Length == 1)
+                if (!sheetDeclaration.IsUndeclared)
                 {
-                    rewriter.Remove(variableListContext.Parent as ParserRuleContext);
-                }
-                else if (sheetDeclaration.Context == variableListContext.variableSubStmt().Last())
-                {
-                    rewriter.Remove(variableListContext.COMMA().Last());
-                    rewriter.Remove(sheetDeclaration);
-                }
-                else
-                {
-                    rewriter.Remove(variableListContext.COMMA().First(comma => comma.Symbol.StartIndex > sheetDeclaration.Context.Start.StartIndex));
-                    rewriter.Remove(sheetDeclaration);
+                    var variableListContext = (VBAParser.VariableListStmtContext)sheetDeclaration.Context.Parent;
+                    if (variableListContext.variableSubStmt().Length == 1)
+                    {
+                        rewriter.Remove(variableListContext.Parent as ParserRuleContext);
+                    }
+                    else if (sheetDeclaration.Context == variableListContext.variableSubStmt().Last())
+                    {
+                        rewriter.Remove(variableListContext.COMMA().Last());
+                        rewriter.Remove(sheetDeclaration);
+                    }
+                    else
+                    {
+                        rewriter.Remove(variableListContext.COMMA().First(comma => comma.Symbol.StartIndex > sheetDeclaration.Context.Start.StartIndex));
+                        rewriter.Remove(sheetDeclaration);
+                    }
                 }
 
                 foreach (var reference in sheetDeclaration.References)

RubberduckTests/QuickFixes/AccessSheetUsingCodeNameQuickFixTests.cs

@@ -276,6 +276,87 @@ Dim ws As Worksheet
             }
         }
 
+        [Test]
+        [Category("QuickFixes")]
+        public void SheetAccessedUsingString_QuickFixWorks_TransientReferenceSetStatement()
+        {
+            const string inputCode = @"
+Sub Test()
+    Dim ws As Worksheet
+    Set ws = Worksheets.Add(Worksheets(""Sheet1""))
+    Debug.Print ws.Name
+End Sub";
+
+            const string expectedCode = @"
+Sub Test()
+    Dim ws As Worksheet
+    Set ws = Worksheets.Add(Sheet1)
+    Debug.Print ws.Name
+End Sub";
+
+            using (var state = ArrangeParserAndParse(inputCode, out var component))
+            {
+                var inspection = new SheetAccessedUsingStringInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                new AccessSheetUsingCodeNameQuickFix(state).Fix(inspectionResults.First());
+                Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
+            }
+        }
+
+        [Test]
+        [Category("QuickFixes")]
+        public void SheetAccessedUsingString_QuickFixWorks_TransientReferenceNoSetStatement()
+        {
+            const string inputCode = @"
+Sub Test()
+    If Not Worksheets.Add(Worksheets(""Sheet1"")) Is Nothing Then
+        Debug.Print ""Added""
+    End If
+End Sub";
+
+            const string expectedCode = @"
+Sub Test()
+    If Not Worksheets.Add(Sheet1) Is Nothing Then
+        Debug.Print ""Added""
+    End If
+End Sub";
+
+            using (var state = ArrangeParserAndParse(inputCode, out var component))
+            {
+                var inspection = new SheetAccessedUsingStringInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                new AccessSheetUsingCodeNameQuickFix(state).Fix(inspectionResults.First());
+                Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
+            }
+        }
+
+        [Test]
+        [Category("QuickFixes")]
+        public void SheetAccessedUsingString_QuickFixWorks_ImplicitVariableAssignment()
+        {
+            const string inputCode = @"
+Sub Test()
+    Set ws = Worksheets(""Sheet1"")
+    Debug.Print ws.Name
+End Sub";
+
+            const string expectedCode = @"
+Sub Test()
+    Sheet1.Name
+End Sub";
+
+            using (var state = ArrangeParserAndParse(inputCode, out var component))
+            {
+                var inspection = new SheetAccessedUsingStringInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                new AccessSheetUsingCodeNameQuickFix(state).Fix(inspectionResults.First());
+                Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
+            }
+        }
+
         private static RubberduckParserState ArrangeParserAndParse(string inputCode, out IVBComponent component)
         {
             var builder = new MockVbeBuilder();