Merge pull request #4686 from MDoerner/RecoveringMemberAttributes

Recovering member attributes

Author: retailcoder

Rubberduck.Core/UI/Notifiers/MemberAttributeRecoveryFailureNotifier.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Collections.Generic;
+using Rubberduck.Interaction;
+using Rubberduck.Parsing.Rewriter;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.UI.Notifiers
+{
+    public class MemberAttributeRecoveryFailureNotifier : IMemberAttributeRecoveryFailureNotifier
+    {
+        private readonly IMessageBox _messageBox;
+
+        public MemberAttributeRecoveryFailureNotifier(IMessageBox messageBox)
+        {
+            _messageBox = messageBox;
+        }
+
+        public void NotifyRewriteFailed(RewriteSessionState sessionState)
+        {
+            var message = RewriteFailureMessage(sessionState);
+            var caption = Resources.RubberduckUI.MemberAttributeRecoveryFailureCaption;
+
+            _messageBox.NotifyWarn(message, caption);
+        }
+
+        private static string RewriteFailureMessage(RewriteSessionState sessionState)
+        {
+            var baseFailureMessage = Resources.RubberduckUI.MemberAttributeRecoveryRewriteFailedMessage;
+            var failureReasonMessage = RewriteFailureReasonMessage(sessionState);
+            var message = string.IsNullOrEmpty(failureReasonMessage)
+                ? baseFailureMessage
+                : $"{baseFailureMessage}{Environment.NewLine}{Environment.NewLine}{failureReasonMessage}";
+            return message;
+        }
+
+        private static string RewriteFailureReasonMessage(RewriteSessionState sessionState)
+        {
+            switch (sessionState)
+            {
+                case RewriteSessionState.StaleParseTree:
+                    return Resources.Inspections.QuickFixes.StaleModuleFailureReason;
+                default:
+                    return string.Empty;
+            }
+        }
+
+        public void NotifyMembersForRecoveryNotFound(IEnumerable<QualifiedMemberName> membersNotFound)
+        {
+            var message = MembersNotFoundMessage(membersNotFound);
+            var caption = Resources.RubberduckUI.MemberAttributeRecoveryFailureCaption;
+
+            _messageBox.NotifyWarn(message, caption);
+        }
+
+        private string MembersNotFoundMessage(IEnumerable<QualifiedMemberName> membersNotFound)
+        {
+            var missingMemberList = $"{Environment.NewLine}{string.Join(Environment.NewLine, membersNotFound)}";
+            return string.Format(Resources.RubberduckUI.MemberAttributeRecoveryMembersNotFoundMessage, missingMemberList); ;
+        }
+    }
+}

Rubberduck.Deployment.Build/RubberduckPreBuildTask.cs

@@ -55,7 +55,7 @@ private void VerifyFileLocks()
 
         private void UpdateLicenseFile()
         {
-            var sourceFile = WorkingDir + @"\Licenses\license.rtf";
+            var sourceFile = WorkingDir + @"\Licenses\License.rtf";
             var license = WorkingDir + @"\InnoSetup\Includes\license.rtf";
             var endYear = new DateTime().Year;
 

Rubberduck.Main/Root/RubberduckIoCInstaller.cs

@@ -116,6 +116,9 @@ public void Install(IWindsorContainer container, IConfigurationStore store)
             container.Register(Component.For<IRewritingManager>()
                 .ImplementedBy<RewritingManager>()
                 .LifestyleSingleton());
+            container.Register(Component.For<IMemberAttributeRecovererWithSettableRewritingManager>()
+                .ImplementedBy<MemberAttributeRecoverer>()
+                .LifestyleSingleton());
 
             container.Register(Component.For<TestExplorerModel>()
                 .LifestyleSingleton());

Rubberduck.Parsing/Rewriter/AttributesRewriteSession.cs

@@ -24,9 +24,10 @@ protected override IExecutableModuleRewriter ModuleRewriter(QualifiedModuleName
         }
 
         protected override bool TryRewriteInternal()
-        {          
+        {
             //The suspension ensures that only one parse gets executed instead of two for each rewritten module.
-            var result = _parseManager.OnSuspendParser(this, new[] {ParserState.Ready}, ExecuteAllRewriters);
+            GuaranteeReparseAfterRewrite();
+            var result = _parseManager.OnSuspendParser(this, new[] {ParserState.Ready, ParserState.ResolvedDeclarations}, ExecuteAllRewriters);
             if(result != SuspensionResult.Completed)
             {
                 Logger.Warn($"Rewriting attribute modules did not succeed. suspension result = {result}");
@@ -36,6 +37,22 @@ protected override bool TryRewriteInternal()
             return true;
         }
 
+        private void GuaranteeReparseAfterRewrite()
+        {
+            _parseManager.StateChanged += ReparseOnSuspension;
+        }
+
+        private void ReparseOnSuspension(object requestor, ParserStateEventArgs e)
+        {
+            if (e.State != ParserState.Busy)
+            {
+                return;
+            }
+
+            _parseManager.StateChanged -= ReparseOnSuspension;
+            _parseManager.OnParseRequested(this);
+        }
+
         private void ExecuteAllRewriters()
         {
             foreach (var module in CheckedOutModuleRewriters.Keys)

Rubberduck.Parsing/Rewriter/IMemberAttributeRecoverer.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Parsing.Rewriter
+{
+    public interface IMemberAttributeRecoverer
+    {
+        void RecoverCurrentMemberAttributesAfterNextParse(IEnumerable<QualifiedMemberName> members);
+        void RecoverCurrentMemberAttributesAfterNextParse(IEnumerable<QualifiedModuleName> modules);
+    }
+}

Rubberduck.Parsing/Rewriter/IMemberAttributeRecovererWithSettableRewritingManager.cs

@@ -0,0 +1,7 @@
+namespace Rubberduck.Parsing.Rewriter
+{
+    public interface IMemberAttributeRecovererWithSettableRewritingManager : IMemberAttributeRecoverer
+    {
+        IRewritingManager RewritingManager { set; }
+    }
+}

Rubberduck.Parsing/Rewriter/IMemberAttributeRecoveryFailureNotifier.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+using Rubberduck.VBEditor;
+
+namespace Rubberduck.Parsing.Rewriter
+{
+    public interface IMemberAttributeRecoveryFailureNotifier
+    {
+        void NotifyRewriteFailed(RewriteSessionState rewriteSessionState);
+        void NotifyMembersForRecoveryNotFound(IEnumerable<QualifiedMemberName> membersNotFound);
+    }
+}

Rubberduck.Parsing/Rewriter/IRewriteSession.cs

@@ -1,4 +1,5 @@
-using Rubberduck.Parsing.VBA.Parsing;
+using System.Collections.Generic;
+using Rubberduck.Parsing.VBA.Parsing;
 using Rubberduck.VBEditor;
 
 namespace Rubberduck.Parsing.Rewriter
@@ -7,6 +8,7 @@ public interface IRewriteSession
     {
         IModuleRewriter CheckOutModuleRewriter(QualifiedModuleName module);
         bool TryRewrite();
+        IReadOnlyCollection<QualifiedModuleName> CheckedOutModules { get; }
         RewriteSessionState Status { get; set; }
         CodeKind TargetCodeKind { get; }
     }