Merge pull request #6260 from tommy9/encapsulate-field-annotations

Encapsulate Field keeps annotations with existing properties

Author: retailcoder

Rubberduck.Refactorings/EncapsulateField/EncapsulateFieldInsertNewCode/EncapsulateFieldInsertNewCodeRefactoringAction.cs

@@ -9,6 +9,9 @@
 using Rubberduck.Refactorings.EncapsulateField;
 using System.Collections.Generic;
 using Rubberduck.SmartIndenter;
+using Antlr4.Runtime;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing;
 
 namespace Rubberduck.Refactorings.EncapsulateFieldInsertNewCode
 {
@@ -106,17 +109,33 @@ private void InsertBlocks(EncapsulateFieldInsertNewCodeModel model, IRewriteSess
 
             var rewriter = rewriteSession.CheckOutModuleRewriter(model.QualifiedModuleName);
 
-            var codeSectionStartIndex = _declarationFinderProvider.DeclarationFinder
-                .Members(model.QualifiedModuleName).Where(m => m.IsMember())
+            var firstMember = _declarationFinderProvider.DeclarationFinder
+                .Members(model.QualifiedModuleName)
+                .Where(m => m.IsMember())
                 .OrderBy(c => c.Selection)
-                .FirstOrDefault()?.Context.Start.TokenIndex;
+                .FirstOrDefault();
 
-            if (codeSectionStartIndex.HasValue)
+            var codeSectionStartIndex = firstMember?.Context.Start.TokenIndex;
+
+            var firstAnnotationContext = firstMember?.Annotations?
+                .OrderBy(c => c.QualifiedSelection)
+                .FirstOrDefault()?.Context;
+
+            if (firstAnnotationContext != null)
+            {
+                codeSectionStartIndex = firstAnnotationContext
+                    .GetAncestor<VBAParser.CommentOrAnnotationContext>().start.TokenIndex;
+            }
+
+            if (codeSectionStartIndex != null)
             {
                 rewriter.InsertBefore(codeSectionStartIndex.Value, $"{formattedContent}{NewLines.DOUBLE_SPACE}");
-                return;
             }
-            rewriter.InsertBefore(rewriter.TokenStream.Size - 1, $"{NewLines.DOUBLE_SPACE}{formattedContent}");
+            else
+            {
+                var insertIndex = rewriter.TokenStream.Size - 1;
+                rewriter.InsertBefore(insertIndex, $"{NewLines.DOUBLE_SPACE}{formattedContent}");
+            }
         }
     }
 }

RubberduckTests/Refactoring/EncapsulateField/EncapsulateFieldUseBackingField/EncapsulateFieldTests.cs

@@ -236,6 +236,34 @@ Property Set Foo(ByVal vall As Variant)
             Assert.Less(actualCode.IndexOf($"fizz = {Support.RHSIdentifier}"), actualCode.IndexOf("Get Foo"));
         }
 
+        [Test]
+        [Category("Refactorings")]
+        [Category("Encapsulate Field")]
+        public void EncapsulatePublicField_AnnotatedPropertiesInClass()
+        {
+            var inputCode =
+                @"|Public fizz As Integer
+
+'@Description (""Description of Foo"")
+Property Get Foo() As Variant
+    Foo = True
+End Property
+
+Property Let Foo(ByVal vall As Variant)
+End Property
+
+Property Set Foo(ByVal vall As Variant)
+End Property";
+
+            var presenterAction = Support.SetParametersForSingleTarget("fizz", "Name");
+
+            var actualCode = Support.RefactoredCode(inputCode.ToCodeString(), presenterAction);
+
+            var lineOfAnnotation = actualCode.Substring(0, actualCode.IndexOf("Description of Foo")).Split(new[] { Environment.NewLine }, StringSplitOptions.None);
+            var lineOfProperty = actualCode.Substring(0, actualCode.IndexOf("Property Get Foo()")).Split(new[] { Environment.NewLine }, StringSplitOptions.None);
+            Assert.AreEqual(lineOfAnnotation.Length, lineOfProperty.Length - 1);
+        }
+
         [TestCase("|Public fizz As Integer\r\nPublic buzz As Boolean", "Private fizz As Integer\r\nPublic buzz As Boolean")]
         [TestCase("Public buzz As Boolean\r\n|Public fizz As Integer", "Public buzz As Boolean\r\nPrivate fizz As Integer")]
         [Category("Refactorings")]