Introduce AnnotateDeclarationRefactoringAction

Author: MDoerner

Rubberduck.Refactorings/AnnotateDeclaration/AnnotateDeclarationModel.cs

@@ -0,0 +1,36 @@
+using System.Collections.Generic;
+using Rubberduck.Parsing.Annotations;
+using Rubberduck.Parsing.Symbols;
+
+namespace Rubberduck.Refactorings.AnnotateDeclaration
+{
+    //This is introduced in favor of a value tuple in order to ba able to bind to the components in XAML.
+    public struct TypedAnnotationArgument
+    {
+        public AnnotationArgumentType ArgumentType { get; set; }
+        public string Argument { get; set; }
+
+        public TypedAnnotationArgument(AnnotationArgumentType type, string argument)
+        {
+            ArgumentType = type;
+            Argument = argument;
+        }
+    }
+
+    public class AnnotateDeclarationModel : IRefactoringModel
+    {
+        public Declaration Target { get; }
+        public IAnnotation Annotation { get; set; }
+        public IList<TypedAnnotationArgument> Arguments { get; }
+
+        public AnnotateDeclarationModel(
+            Declaration target, 
+            IAnnotation annotation = null,
+            IList<TypedAnnotationArgument> arguments = null)
+        {
+            Target = target;
+            Annotation = annotation;
+            Arguments = arguments ?? new List<TypedAnnotationArgument>();
+        }
+    }
+}

Rubberduck.Refactorings/AnnotateDeclaration/AnnotateDeclarationRefactoring.cs

@@ -0,0 +1,46 @@
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Refactorings.Exceptions;
+using Rubberduck.VBEditor;
+using Rubberduck.VBEditor.Utility;
+
+namespace Rubberduck.Refactorings.AnnotateDeclaration
+{
+    public class AnnotateDeclarationRefactoring : InteractiveRefactoringBase<AnnotateDeclarationModel>
+    {
+        private readonly IRefactoringAction<AnnotateDeclarationModel> _annotateDeclarationAction;
+        private readonly ISelectedDeclarationProvider _selectedDeclarationProvider;
+
+        public AnnotateDeclarationRefactoring(
+            AnnotateDeclarationRefactoringAction annotateDeclarationAction,
+            ISelectedDeclarationProvider selectedDeclarationProvider,
+            ISelectionProvider selectionProvider,
+            RefactoringUserInteraction<IAnnotateDeclarationPresenter, AnnotateDeclarationModel> userInteraction)
+            : base(selectionProvider, userInteraction)
+        {
+            _annotateDeclarationAction = annotateDeclarationAction;
+            _selectedDeclarationProvider = selectedDeclarationProvider;
+        }
+        
+        protected override Declaration FindTargetDeclaration(QualifiedSelection targetSelection)
+        {
+            return _selectedDeclarationProvider.SelectedModule(targetSelection);
+        }
+
+        protected override AnnotateDeclarationModel InitializeModel(Declaration target)
+        {
+            if (target == null)
+            {
+                throw new TargetDeclarationIsNullException();
+            }
+
+            return new AnnotateDeclarationModel(target);
+        }
+
+        protected override void RefactorImpl(AnnotateDeclarationModel model)
+        {
+            _annotateDeclarationAction.Refactor(model);
+        }
+    }
+}
+

Rubberduck.Refactorings/AnnotateDeclaration/AnnotateFolderRefactoringAction.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Linq;
+using Rubberduck.Common;
+using Rubberduck.Parsing.Annotations;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Rewriter;
+using Rubberduck.Parsing.VBA;
+
+namespace Rubberduck.Refactorings.AnnotateDeclaration
+{
+    public class AnnotateDeclarationRefactoringAction : CodeOnlyRefactoringActionBase<AnnotateDeclarationModel>
+    {
+        private readonly IAnnotationUpdater _annotationUpdater;
+
+        public AnnotateDeclarationRefactoringAction(
+            IRewritingManager rewritingManager,
+            IAnnotationUpdater annotationUpdater) 
+            : base(rewritingManager)
+        {
+            _annotationUpdater = annotationUpdater;
+        }
+
+        public override void Refactor(AnnotateDeclarationModel model, IRewriteSession rewriteSession)
+        {
+            var arguments = model.Arguments.Select(ToCode).ToList();
+            _annotationUpdater.AddAnnotation(rewriteSession, model.Target, model.Annotation, arguments);
+        }
+
+        private string ToCode(TypedAnnotationArgument annotationArgument)
+        {
+            switch (annotationArgument.ArgumentType)
+            {
+                case AnnotationArgumentType.Text:
+                    return annotationArgument.Argument.ToVbaStringLiteral();
+                case AnnotationArgumentType.Boolean:
+                    return ToBooleanLiteral(annotationArgument.Argument);
+                default:
+                    return annotationArgument.Argument;
+            }
+        }
+
+        private const string NotABoolean = "NOT_A_BOOLEAN";
+        private string ToBooleanLiteral(string booleanText)
+        {
+            if (!bool.TryParse(booleanText, out var booleanValue))
+            {
+                return NotABoolean;
+            }
+
+            return booleanValue
+                ? Tokens.True
+                : Tokens.False;
+        }
+    }
+}

Rubberduck.Refactorings/AnnotateDeclaration/IAnnotateDeclarationPresenter.cs

@@ -0,0 +1,5 @@
+namespace Rubberduck.Refactorings.AnnotateDeclaration
+{
+    public interface IAnnotateDeclarationPresenter : IRefactoringPresenter<AnnotateDeclarationModel>
+    {}
+}

Rubberduck.Refactorings/MoveToFolder/MoveToFolderRefactoringAction.cs

@@ -47,9 +47,7 @@ private void UpdateFolderAnnotation(MoveToFolderModel model, IParseTreeAnnotatio
 
         private static (IAnnotation annotation, IReadOnlyList<string> annotationArguments) NewAnnotation(string targetFolder)
         {
-            var targetFolderLiteral = targetFolder
-                .Replace("\"", "\"\"")
-                .EnQuote();
+            var targetFolderLiteral = targetFolder.ToVbaStringLiteral();
 
             var annotation = new FolderAnnotation();
             var annotationValues = new List<string> { targetFolderLiteral };