Add a bunch of ignoreonce's to inspection quick fixes

Hosch250 · Hosch250 · commit 9ea89cc71d72 · 2016-07-13T12:50:08.000-05:00
diff --git a/RetailCoder.VBE/Inspections/AssignedByValParameterInspectionResult.cs b/RetailCoder.VBE/Inspections/AssignedByValParameterInspectionResult.cs
@@ -13,9 +13,10 @@ public class AssignedByValParameterInspectionResult : InspectionResultBase
         public AssignedByValParameterInspectionResult(IInspection inspection, Declaration target)
             : base(inspection, target)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
                 new PassParameterByReferenceQuickFix(target.Context, QualifiedSelection),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/EmptyStringLiteralInspection.cs b/RetailCoder.VBE/Inspections/EmptyStringLiteralInspection.cs
@@ -1,7 +1,9 @@
 ﻿using System.Collections.Generic;
 using System.Linq;
 using Antlr4.Runtime;
+using Microsoft.Vbe.Interop;
 using Rubberduck.Parsing;
+using Rubberduck.Parsing.Annotations;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Parsing.Grammar;
 
@@ -26,11 +28,34 @@ public override IEnumerable<InspectionResultBase> GetInspectionResults()
             {
                 return new InspectionResultBase[] { };
             }
-            return ParseTreeResults.EmptyStringLiterals.Select(
-                    context => new EmptyStringLiteralInspectionResult(this,
+            return ParseTreeResults.EmptyStringLiterals
+                .Where(s => !HasIgnoreEmptyStringLiteralAnnotations(s.ModuleName.Component, s.Context.Start.Line))
+                .Select(context => new EmptyStringLiteralInspectionResult(this,
                             new QualifiedContext<ParserRuleContext>(context.ModuleName, context.Context)));
         }
 
+        private bool HasIgnoreEmptyStringLiteralAnnotations(VBComponent component, int line)
+        {
+            var annotations = State.GetModuleAnnotations(component).ToList();
+
+            if (State.GetModuleAnnotations(component) == null)
+            {
+                return false;
+            }
+            
+            // VBE 1-based indexing
+            for (var i = line - 1; i >= 1; i--)
+            {
+                var annotation = annotations.SingleOrDefault(a => a.QualifiedSelection.Selection.StartLine == i) as IgnoreAnnotation;
+                if (annotation != null && annotation.InspectionNames.Contains(AnnotationName))
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         public class EmptyStringLiteralListener : VBAParserBaseListener
         {
             private readonly IList<VBAParser.LiteralExpressionContext> _contexts = new List<VBAParser.LiteralExpressionContext>();
diff --git a/RetailCoder.VBE/Inspections/EmptyStringLiteralInspectionResult.cs b/RetailCoder.VBE/Inspections/EmptyStringLiteralInspectionResult.cs
@@ -13,9 +13,10 @@ public class EmptyStringLiteralInspectionResult : InspectionResultBase
         public EmptyStringLiteralInspectionResult(IInspection inspection, QualifiedContext<ParserRuleContext> qualifiedContext)
             : base(inspection, qualifiedContext.ModuleName, qualifiedContext.Context)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
-                new RepaceEmptyStringLiteralStatementQuickFix(Context, QualifiedSelection), 
+                new RepaceEmptyStringLiteralStatementQuickFix(Context, QualifiedSelection),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/EncapsulatePublicFieldInspectionResult.cs b/RetailCoder.VBE/Inspections/EncapsulatePublicFieldInspectionResult.cs
@@ -16,9 +16,10 @@ public class EncapsulatePublicFieldInspectionResult : InspectionResultBase
         public EncapsulatePublicFieldInspectionResult(IInspection inspection, Declaration target, RubberduckParserState state)
             : base(inspection, target)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
                 new EncapsulateFieldQuickFix(target.Context, target.QualifiedSelection, target, state),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/FunctionReturnValueNotUsedInspectionResult.cs b/RetailCoder.VBE/Inspections/FunctionReturnValueNotUsedInspectionResult.cs
@@ -34,9 +34,10 @@ public FunctionReturnValueNotUsedInspectionResult(
             var root = new ConvertToProcedureQuickFix(context, QualifiedSelection, returnStatements);
             var compositeFix = new CompositeCodeInspectionFix(root);
             children.ToList().ForEach(child => compositeFix.AddChild(new ConvertToProcedureQuickFix(child.Item1, child.Item2, child.Item3)));
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
-                compositeFix
+                compositeFix,
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/MoveFieldCloserToUsageInspectionResult.cs b/RetailCoder.VBE/Inspections/MoveFieldCloserToUsageInspectionResult.cs
@@ -15,9 +15,10 @@ public class MoveFieldCloserToUsageInspectionResult : InspectionResultBase
         public MoveFieldCloserToUsageInspectionResult(IInspection inspection, Declaration target, RubberduckParserState state, IMessageBox messageBox)
             : base(inspection, target)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
                 new MoveFieldCloserToUsageQuickFix(target.Context, target.QualifiedSelection, target, state, messageBox),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/MultilineParameterInspectionResult.cs b/RetailCoder.VBE/Inspections/MultilineParameterInspectionResult.cs
@@ -12,9 +12,10 @@ public class MultilineParameterInspectionResult : InspectionResultBase
         public MultilineParameterInspectionResult(IInspection inspection, Declaration target)
             : base(inspection, target)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
-                new MakeSingleLineParameterQuickFix(Context, QualifiedSelection), 
+                new MakeSingleLineParameterQuickFix(Context, QualifiedSelection),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName) 
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/OptionBaseInspectionResult.cs b/RetailCoder.VBE/Inspections/OptionBaseInspectionResult.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.VBEditor;
@@ -11,6 +12,17 @@ public OptionBaseInspectionResult(IInspection inspection, QualifiedModuleName qu
         {
         }
 
+        public override IEnumerable<CodeInspectionQuickFix> QuickFixes
+        {
+            get
+            {
+                return new CodeInspectionQuickFix[]
+                {
+                    new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
+                };
+            }
+        }
+
         public override string Description
         {
             get { return string.Format(Inspection.Description, QualifiedName.ComponentName); }
diff --git a/RetailCoder.VBE/Inspections/ParameterCanBeByValInspectionResult.cs b/RetailCoder.VBE/Inspections/ParameterCanBeByValInspectionResult.cs
@@ -13,9 +13,10 @@ public class ParameterCanBeByValInspectionResult : InspectionResultBase
         public ParameterCanBeByValInspectionResult(IInspection inspection, Declaration target, ParserRuleContext context, QualifiedMemberName qualifiedName)
             : base(inspection, qualifiedName.QualifiedModuleName, context, target)
         {
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
-                new PassParameterByValueQuickFix(Context, QualifiedSelection), 
+                new PassParameterByValueQuickFix(Context, QualifiedSelection),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/ProcedureShouldBeFunctionInspectionResult.cs b/RetailCoder.VBE/Inspections/ProcedureShouldBeFunctionInspectionResult.cs
@@ -22,9 +22,10 @@ public ProcedureShouldBeFunctionInspectionResult(IInspection inspection, Rubberd
                declaration.DeclarationType == DeclarationType.Procedure
                && declaration.Context == subStmtQualifiedContext.Context);
 
-            _quickFixes = new[]
+            _quickFixes = new CodeInspectionQuickFix[]
             {
-                new ChangeProcedureToFunction(state, argListQualifiedContext, subStmtQualifiedContext, QualifiedSelection), 
+                new ChangeProcedureToFunction(state, argListQualifiedContext, subStmtQualifiedContext, QualifiedSelection),
+                new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)
             };
         }
 
diff --git a/RetailCoder.VBE/Inspections/SelfAssignedDeclarationInspectionResult.cs b/RetailCoder.VBE/Inspections/SelfAssignedDeclarationInspectionResult.cs
@@ -1,4 +1,5 @@
-﻿using Rubberduck.Parsing.Symbols;
+﻿using System.Collections.Generic;
+using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.Inspections
 {
@@ -9,6 +10,17 @@ public SelfAssignedDeclarationInspectionResult(IInspection inspection, Declarati
         {
         }
 
+        public override IEnumerable<CodeInspectionQuickFix> QuickFixes
+        {
+            get
+            {
+                return new CodeInspectionQuickFix[]
+                {
+                    new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
+                };
+            }
+        }
+
         public override string Description
         {
             get
diff --git a/RetailCoder.VBE/Inspections/WriteOnlyPropertyInspection.cs b/RetailCoder.VBE/Inspections/WriteOnlyPropertyInspection.cs
@@ -48,7 +48,15 @@ public override string Description
             get { return string.Format(InspectionsUI.WriteOnlyPropertyInspectionResultFormat, Target.IdentifierName); }
         }
 
-        // todo: override quickfixes
-        //public override IEnumerable<CodeInspectionQuickFix> QuickFixes { get; private set; }
+        public override IEnumerable<CodeInspectionQuickFix> QuickFixes
+        {
+            get
+            {
+                return new CodeInspectionQuickFix[]
+                {
+                    new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
+                };
+            }
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,10 @@ public class AssignedByValParameterInspectionResult : InspectionResultBase`
`13`	`13`	`public AssignedByValParameterInspectionResult(IInspection inspection, Declaration target)`
`14`	`14`	`: base(inspection, target)`
`15`	`15`	`{`
`16`		`- _quickFixes = new[]`
	`16`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`17`	`17`	`{`
`18`	`18`	`new PassParameterByReferenceQuickFix(target.Context, QualifiedSelection),`
	`19`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)`
`19`	`20`	`};`
`20`	`21`	`}`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,10 @@ public class EmptyStringLiteralInspectionResult : InspectionResultBase`
`13`	`13`	`public EmptyStringLiteralInspectionResult(IInspection inspection, QualifiedContext<ParserRuleContext> qualifiedContext)`
`14`	`14`	`: base(inspection, qualifiedContext.ModuleName, qualifiedContext.Context)`
`15`	`15`	`{`
`16`		`- _quickFixes = new[]`
	`16`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`17`	`17`	`{`
`18`		`- new RepaceEmptyStringLiteralStatementQuickFix(Context, QualifiedSelection),`
	`18`	`+ new RepaceEmptyStringLiteralStatementQuickFix(Context, QualifiedSelection),`
	`19`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)`
`19`	`20`	`};`
`20`	`21`	`}`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,10 @@ public class EncapsulatePublicFieldInspectionResult : InspectionResultBase`
`16`	`16`	`public EncapsulatePublicFieldInspectionResult(IInspection inspection, Declaration target, RubberduckParserState state)`
`17`	`17`	`: base(inspection, target)`
`18`	`18`	`{`
`19`		`- _quickFixes = new[]`
	`19`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`20`	`20`	`{`
`21`	`21`	`new EncapsulateFieldQuickFix(target.Context, target.QualifiedSelection, target, state),`
	`22`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)`
`22`	`23`	`};`
`23`	`24`	`}`
`24`	`25`
Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,10 @@ public FunctionReturnValueNotUsedInspectionResult(`
`34`	`34`	`var root = new ConvertToProcedureQuickFix(context, QualifiedSelection, returnStatements);`
`35`	`35`	`var compositeFix = new CompositeCodeInspectionFix(root);`
`36`	`36`	`children.ToList().ForEach(child => compositeFix.AddChild(new ConvertToProcedureQuickFix(child.Item1, child.Item2, child.Item3)));`
`37`		`- _quickFixes = new[]`
	`37`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`38`	`38`	`{`
`39`		`- compositeFix`
	`39`	`+ compositeFix,`
	`40`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)`
`40`	`41`	`};`
`41`	`42`	`}`
`42`	`43`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,10 @@ public class MoveFieldCloserToUsageInspectionResult : InspectionResultBase`
`15`	`15`	`public MoveFieldCloserToUsageInspectionResult(IInspection inspection, Declaration target, RubberduckParserState state, IMessageBox messageBox)`
`16`	`16`	`: base(inspection, target)`
`17`	`17`	`{`
`18`		`- _quickFixes = new[]`
	`18`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`19`	`19`	`{`
`20`	`20`	`new MoveFieldCloserToUsageQuickFix(target.Context, target.QualifiedSelection, target, state, messageBox),`
	`21`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)`
`21`	`22`	`};`
`22`	`23`	`}`
`23`	`24`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,10 @@ public class MultilineParameterInspectionResult : InspectionResultBase`
`12`	`12`	`public MultilineParameterInspectionResult(IInspection inspection, Declaration target)`
`13`	`13`	`: base(inspection, target)`
`14`	`14`	`{`
`15`		`- _quickFixes = new[]`
	`15`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`16`	`16`	`{`
`17`		`- new MakeSingleLineParameterQuickFix(Context, QualifiedSelection),`
	`17`	`+ new MakeSingleLineParameterQuickFix(Context, QualifiedSelection),`
	`18`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)`
`18`	`19`	`};`
`19`	`20`	`}`
`20`	`21`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,10 @@ public class ParameterCanBeByValInspectionResult : InspectionResultBase`
`13`	`13`	`public ParameterCanBeByValInspectionResult(IInspection inspection, Declaration target, ParserRuleContext context, QualifiedMemberName qualifiedName)`
`14`	`14`	`: base(inspection, qualifiedName.QualifiedModuleName, context, target)`
`15`	`15`	`{`
`16`		`- _quickFixes = new[]`
	`16`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`17`	`17`	`{`
`18`		`- new PassParameterByValueQuickFix(Context, QualifiedSelection),`
	`18`	`+ new PassParameterByValueQuickFix(Context, QualifiedSelection),`
	`19`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)`
`19`	`20`	`};`
`20`	`21`	`}`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,10 @@ public ProcedureShouldBeFunctionInspectionResult(IInspection inspection, Rubberd`
`22`	`22`	`declaration.DeclarationType == DeclarationType.Procedure`
`23`	`23`	`&& declaration.Context == subStmtQualifiedContext.Context);`
`24`	`24`
`25`		`- _quickFixes = new[]`
	`25`	`+ _quickFixes = new CodeInspectionQuickFix[]`
`26`	`26`	`{`
`27`		`- new ChangeProcedureToFunction(state, argListQualifiedContext, subStmtQualifiedContext, QualifiedSelection),`
	`27`	`+ new ChangeProcedureToFunction(state, argListQualifiedContext, subStmtQualifiedContext, QualifiedSelection),`
	`28`	`+ new IgnoreOnceQuickFix(Context, QualifiedSelection, inspection.AnnotationName)`
`28`	`29`	`};`
`29`	`30`	`}`
`30`	`31`