Provide IRewriteSessions to quickfixes in QuickFixProvider

This change ensures that whenever a fix is used for multiple results, the same IRewriteSession is used.

Author: MDoerner

Rubberduck.CodeAnalysis/Inspections/Abstract/QuickFixBase.cs

@@ -4,8 +4,8 @@
 using NLog;
 using Rubberduck.Parsing.Inspections.Abstract;
 using Rubberduck.Parsing.Rewriter;
-using Rubberduck.Parsing.VBA;
 using Rubberduck.Parsing.VBA.Extensions;
+using Rubberduck.Parsing.VBA.Parsing;
 
 namespace Rubberduck.Inspections.Abstract
 {
@@ -40,6 +40,8 @@ public void RemoveInspections(params Type[] inspections)
             _supportedInspections = _supportedInspections.Except(inspections).ToHashSet();
         }
 
+        public virtual CodeKind TargetCodeKind => CodeKind.CodePaneCode;
+
         public abstract void Fix(IInspectionResult result, IRewriteSession rewriteSession = null);
         public abstract string Description(IInspectionResult result);
 

Rubberduck.CodeAnalysis/QuickFixes/QuickFixProvider.cs

@@ -4,7 +4,9 @@
 using System.Linq;
 using Microsoft.CSharp.RuntimeBinder;
 using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Parsing.Rewriter;
 using Rubberduck.Parsing.VBA;
+using Rubberduck.Parsing.VBA.Parsing;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Inspections.QuickFixes
@@ -74,17 +76,39 @@ public void Fix(IQuickFix fix, IInspectionResult result)
                 return;
             }
 
-            fix.Fix(result);
+            var rewriteSession = RewriteSession(fix.TargetCodeKind);
+            fix.Fix(result, rewriteSession);
+            rewriteSession.Rewrite();
+
             _state.RewriteAllModules();
             _state.OnParseRequested(this);
         }
 
+        private IRewriteSession RewriteSession(CodeKind targetCodeKind)
+        {
+            switch (targetCodeKind)
+            {
+                case CodeKind.CodePaneCode:
+                    return _state.RewritingManager.CheckOutCodePaneSession();
+                case CodeKind.AttributesCode:
+                    return _state.RewritingManager.CheckOutAttributesSession();
+                default:
+                    throw new NotSupportedException(nameof(targetCodeKind));
+            }
+        }
+
         public void FixInProcedure(IQuickFix fix, QualifiedMemberName? qualifiedMember, Type inspectionType, IEnumerable<IInspectionResult> results)
         {
             Debug.Assert(qualifiedMember.HasValue, "Null qualified member.");
 
             var filteredResults = results.Where(result => result.Inspection.GetType() == inspectionType && result.QualifiedMemberName == qualifiedMember).ToList();
 
+            if (!filteredResults.Any())
+            {
+                return;
+            }
+
+            var rewriteSession = RewriteSession(fix.TargetCodeKind);
             foreach (var result in filteredResults)
             {
                 if (!CanFix(fix, result))
@@ -94,18 +118,22 @@ public void FixInProcedure(IQuickFix fix, QualifiedMemberName? qualifiedMember,
 
                 fix.Fix(result);
             }
+            rewriteSession.Rewrite();
 
-            if (filteredResults.Any())
-            {
-                _state.RewriteAllModules();
-                _state.OnParseRequested(this);
-            }
+            _state.RewriteAllModules();
+            _state.OnParseRequested(this);
         }
 
         public void FixInModule(IQuickFix fix, QualifiedSelection selection, Type inspectionType, IEnumerable<IInspectionResult> results)
         {
             var filteredResults = results.Where(result => result.Inspection.GetType() == inspectionType && result.QualifiedSelection.QualifiedName == selection.QualifiedName).ToList();
 
+            if (!filteredResults.Any())
+            {
+                return;
+            }
+
+            var rewriteSession = RewriteSession(fix.TargetCodeKind);
             foreach (var result in filteredResults)
             {
                 if (!CanFix(fix, result))
@@ -115,18 +143,22 @@ public void FixInModule(IQuickFix fix, QualifiedSelection selection, Type inspec
 
                 fix.Fix(result);
             }
+            rewriteSession.Rewrite();
 
-            if (filteredResults.Any())
-            {
-                _state.RewriteAllModules();
-                _state.OnParseRequested(this);
-            }
+            _state.RewriteAllModules();
+            _state.OnParseRequested(this);
         }
 
         public void FixInProject(IQuickFix fix, QualifiedSelection selection, Type inspectionType, IEnumerable<IInspectionResult> results)
         {
             var filteredResults = results.Where(result => result.Inspection.GetType() == inspectionType && result.QualifiedSelection.QualifiedName.ProjectId == selection.QualifiedName.ProjectId).ToList();
 
+            if (!filteredResults.Any())
+            {
+                return;
+            }
+
+            var rewriteSession = RewriteSession(fix.TargetCodeKind);
             foreach (var result in filteredResults)
             {
                 if (!CanFix(fix, result))
@@ -136,18 +168,22 @@ public void FixInProject(IQuickFix fix, QualifiedSelection selection, Type inspe
 
                 fix.Fix(result);
             }
+            rewriteSession.Rewrite();
 
-            if (filteredResults.Any())
-            {
-                _state.RewriteAllModules();
-                _state.OnParseRequested(this);
-            }
+            _state.RewriteAllModules();
+            _state.OnParseRequested(this);
         }
 
         public void FixAll(IQuickFix fix, Type inspectionType, IEnumerable<IInspectionResult> results)
         {
             var filteredResults = results.Where(result => result.Inspection.GetType() == inspectionType).ToArray();
 
+            if (!filteredResults.Any())
+            {
+                return;
+            }
+
+            var rewriteSession = RewriteSession(fix.TargetCodeKind);
             foreach (var result in filteredResults)
             {
                 if (!CanFix(fix, result))
@@ -157,12 +193,10 @@ public void FixAll(IQuickFix fix, Type inspectionType, IEnumerable<IInspectionRe
 
                 fix.Fix(result);
             }
+            rewriteSession.Rewrite();
 
-            if (filteredResults.Any())
-            {
-                _state.RewriteAllModules();
-                _state.OnParseRequested(this);
-            }
+            _state.RewriteAllModules();
+            _state.OnParseRequested(this);
         }
 
         public bool HasQuickFixes(IInspectionResult inspectionResult)

Rubberduck.Parsing/Inspections/Abstract/IQuickFix.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using Rubberduck.Parsing.Rewriter;
+using Rubberduck.Parsing.VBA.Parsing;
 
 namespace Rubberduck.Parsing.Inspections.Abstract
 {
@@ -14,6 +15,7 @@ public interface IQuickFix
         bool CanFixInProject { get; }
 
         IReadOnlyCollection<Type> SupportedInspections { get; }
+        CodeKind TargetCodeKind { get; }
 
         void RegisterInspections(params Type[] inspections);
         void RemoveInspections(params Type[] inspections);

Rubberduck.Parsing/Rewriter/RewriteSessionBase.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using NLog;
 using Rubberduck.VBEditor;
 
@@ -39,6 +40,11 @@ public IModuleRewriter CheckOutModuleRewriter(QualifiedModuleName module)
 
         public void Rewrite()
         {
+            if (!CheckedOutModuleRewriters.Any())
+            {
+                return;
+            }
+
             lock (_invalidationLockObject)
             {
                 if (_isInvalidated)