Handle array declarations in move closer to usage. Closes #3258

Author: comintern

Rubberduck.Refactorings/MoveCloserToUsage/MoveCloserToUsageRefactoring.cs

@@ -5,6 +5,7 @@
 using Antlr4.Runtime.Misc;
 using Rubberduck.Common;
 using Rubberduck.Interaction;
+using Rubberduck.Parsing;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Rewriter;
 using Rubberduck.Parsing.Symbols;
@@ -152,7 +153,11 @@ private void UpdateOtherModules()
 
         private void InsertNewDeclaration()
         {
-            var newVariable = $"Dim {_target.IdentifierName} As {_target.AsTypeName}{Environment.NewLine}";
+            var subscripts = _target.Context.GetDescendent<VBAParser.SubscriptsContext>()?.GetText() ?? string.Empty;
+            var identifier = _target.IsArray ? $"{_target.IdentifierName}({subscripts})" : _target.IdentifierName;
+            var newVariable = _target.AsTypeContext is null
+                ? $"{Tokens.Dim} {identifier} {Tokens.As} {Tokens.Variant}{Environment.NewLine}"
+                : $"{Tokens.Dim} {identifier} {Tokens.As} {_target.AsTypeNameWithoutArrayDesignator}{Environment.NewLine}";
 
             var firstReference = _target.References.OrderBy(r => r.Selection.StartLine).First();
 

RubberduckTests/Refactoring/MoveCloserToUsageTests.cs

@@ -308,7 +308,7 @@ Private Sub Foo()
     Dim bat As Boolean
     bat = True
 End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -428,7 +428,7 @@ Private Sub Foo()
     Dim bay As Date
     bay = #1/13/2004#
 End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -470,7 +470,7 @@ bay As Date
     Dim bar As Integer
     bar = 3
 End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -687,7 +687,7 @@ End Sub
 Sub Baz(ByVal bat As Boolean)
 End Sub";
             var selection = new Selection(1, 1);
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -728,8 +728,8 @@ End Sub
 Sub Baz(ByVal bat As Boolean, ByVal bas As Boolean, ByVal bac As Boolean)
 End Sub";
             var selection = new Selection(1, 1);
-            
-            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var  component, selection);
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
 
@@ -761,7 +761,7 @@ Private Sub Foo(): Baz True, True, bar: End Sub
                 @"Private Sub Foo(): Dim bar As Boolean
 Baz True, True, bar: End Sub
 Private Sub Baz(ByVal bat As Boolean, ByVal bas As Boolean, ByVal bac As Boolean): End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -806,7 +806,7 @@ End Sub
 Public Sub SomeSub(ByVal someParam As Long)
     Debug.Print someParam
 End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -845,7 +845,7 @@ Public Sub Test(): Dim foo As Long
 Public Sub SomeSub(ByVal someParam As Long)
     Debug.Print someParam
 End Sub";
-            
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -871,7 +871,7 @@ public void IntroduceFieldRefactoring_PassInTarget_Nonvariable()
 Private Sub Foo()
     bar = True
 End Sub";
-           
+
             var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
             using (var state = MockParser.CreateAndParse(vbe.Object))
             {
@@ -1044,5 +1044,143 @@ Dim foo As Class1
                 Assert.AreEqual(expected, actual);
             }
         }
+
+        [Test]
+        [Category("Refactorings")]
+        [Category("Move Closer")]
+        public void MoveCloserToUsageRefactoring_DynamicArray()
+        {
+            //Input
+            const string inputCode =
+                @"Private bar() As Boolean
+Private Sub Foo()
+    ReDim bar(0)
+    bar(0) = True
+End Sub";
+            var selection = new Selection(1, 1);
+
+            //Expectation
+            const string expectedCode =
+                @"Private Sub Foo()
+    Dim bar() As Boolean
+    ReDim bar(0)
+    bar(0) = True
+End Sub";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+
+                var qualifiedSelection = new QualifiedSelection(new QualifiedModuleName(component), selection);
+
+                var refactoring = new MoveCloserToUsageRefactoring(vbe.Object, state, null);
+                refactoring.Refactor(qualifiedSelection);
+
+                var rewriter = state.GetRewriter(component);
+                Assert.AreEqual(expectedCode, rewriter.GetText());
+            }
+        }
+
+        [Test]
+        [Category("Refactorings")]
+        [Category("Move Closer")]
+        public void MoveCloserToUsageRefactoring_FixedArray()
+        {
+            //Input
+            const string inputCode =
+                @"Private bar(0) As Boolean
+Private Sub Foo()
+    bar(0) = True
+End Sub";
+            var selection = new Selection(1, 1);
+
+            //Expectation
+            const string expectedCode =
+                @"Private Sub Foo()
+    Dim bar(0) As Boolean
+    bar(0) = True
+End Sub";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+
+                var qualifiedSelection = new QualifiedSelection(new QualifiedModuleName(component), selection);
+
+                var refactoring = new MoveCloserToUsageRefactoring(vbe.Object, state, null);
+                refactoring.Refactor(qualifiedSelection);
+
+                var rewriter = state.GetRewriter(component);
+                Assert.AreEqual(expectedCode, rewriter.GetText());
+            }
+        }
+
+        [Test]
+        [Category("Refactorings")]
+        [Category("Move Closer")]
+        public void MoveCloserToUsageRefactoring_FixedArrayBounded()
+        {
+            //Input
+            const string inputCode =
+                @"Private bar(1 To 42) As Boolean
+Private Sub Foo()
+    bar(1) = True
+End Sub";
+            var selection = new Selection(1, 1);
+
+            //Expectation
+            const string expectedCode =
+                @"Private Sub Foo()
+    Dim bar(1 To 42) As Boolean
+    bar(1) = True
+End Sub";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+
+                var qualifiedSelection = new QualifiedSelection(new QualifiedModuleName(component), selection);
+
+                var refactoring = new MoveCloserToUsageRefactoring(vbe.Object, state, null);
+                refactoring.Refactor(qualifiedSelection);
+
+                var rewriter = state.GetRewriter(component);
+                Assert.AreEqual(expectedCode, rewriter.GetText());
+            }
+        }
+
+        [Test]
+        [Category("Refactorings")]
+        [Category("Move Closer")]
+        public void MoveCloserToUsageRefactoring_MultiDimensionalArray()
+        {
+            //Input
+            const string inputCode =
+                @"Private bar(1, 1) As Boolean
+Private Sub Foo()
+    bar(0, 0) = True
+End Sub";
+            var selection = new Selection(1, 1);
+
+            //Expectation
+            const string expectedCode =
+                @"Private Sub Foo()
+    Dim bar(1, 1) As Boolean
+    bar(0, 0) = True
+End Sub";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component, selection);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+
+                var qualifiedSelection = new QualifiedSelection(new QualifiedModuleName(component), selection);
+
+                var refactoring = new MoveCloserToUsageRefactoring(vbe.Object, state, null);
+                refactoring.Refactor(qualifiedSelection);
+
+                var rewriter = state.GetRewriter(component);
+                Assert.AreEqual(expectedCode, rewriter.GetText());
+            }
+        }
     }
 }