Make it possible to run inspections for single modules

MDoerner · MDoerner · commit b24cfcb3edee · 2020-02-27T20:09:40.000+01:00
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/DeclarationInspectionBaseBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/DeclarationInspectionBaseBase.cs
@@ -40,7 +40,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .ToList();
         }
 
-        protected virtual IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/DeclarationInspectionUsingGlobalInformationBaseBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/DeclarationInspectionUsingGlobalInformationBaseBase.cs
@@ -50,7 +50,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .ToList();
         }
 
-        protected virtual IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             var globalInformation = GlobalInformation(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/IdentifierReferenceInspectionBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/IdentifierReferenceInspectionBase.cs
@@ -40,7 +40,7 @@ protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleN
                 .ToList();
         }
 
-        protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
@@ -102,7 +102,7 @@ protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleN
                 : ((IdentifierReference reference, T properties)?)null;
         }
 
-        protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/IdentifierReferenceInspectionFromDeclarationsBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/IdentifierReferenceInspectionFromDeclarationsBase.cs
@@ -45,7 +45,7 @@ protected virtual IEnumerable<IdentifierReference> ObjectionableReferences(Decla
 
         protected virtual bool IsResultReference(IdentifierReference reference, DeclarationFinder finder) => true;
 
-        protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             var objectionableReferences = ObjectionableReferences(finder)
@@ -112,7 +112,7 @@ protected virtual IEnumerable<IdentifierReference> ObjectionableReferences(Decla
                 .SelectMany(declaration => declaration.References);
         }
 
-        protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             var objectionableReferences = ObjectionableReferences(finder)
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/InspectionBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/InspectionBase.cs
@@ -68,6 +68,7 @@ protected InspectionBase(IDeclarationFinderProvider declarationFinderProvider)
         public int CompareTo(object obj) => CompareTo(obj as IInspection);
 
         protected abstract IEnumerable<IInspectionResult> DoGetInspectionResults();
+        protected abstract IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module);
 
         /// <summary>
         /// A method that inspects the parser state and returns all issues it can find.
@@ -88,6 +89,26 @@ public IEnumerable<IInspectionResult> GetInspectionResults(CancellationToken tok
             return result;
         }
 
+        /// <summary>
+        /// A method that inspects the parser state and returns all issues in it can find in a module.
+        /// </summary>
+        /// <param name="module">The module for which to get inspection results</param>
+        /// <param name="token"></param>
+        /// <returns></returns>
+        public IEnumerable<IInspectionResult> GetInspectionResults(QualifiedModuleName module, CancellationToken token)
+        {
+            var stopwatch = new Stopwatch();
+            stopwatch.Start();
+            var declarationFinder = DeclarationFinderProvider.DeclarationFinder;
+            var result = DoGetInspectionResults(module)
+                .Where(ir => !ir.IsIgnoringInspectionResult(declarationFinder))
+                .ToList();
+            stopwatch.Stop();
+            Logger.Trace("Intercepted invocation of '{0}.{1}' returned {2} objects.", GetType().Name, nameof(DoGetInspectionResults), result.Count);
+            Logger.Trace("Intercepted invocation of '{0}.{1}' ran for {2}ms", GetType().Name, nameof(DoGetInspectionResults), stopwatch.ElapsedMilliseconds);
+            return result;
+        }
+
         public virtual bool ChangesInvalidateResult(IInspectionResult result, ICollection<QualifiedModuleName> modifiedModules)
         {
             return true;
diff --git a/Rubberduck.CodeAnalysis/Inspections/Abstract/ParseTreeInspectionBase.cs b/Rubberduck.CodeAnalysis/Inspections/Abstract/ParseTreeInspectionBase.cs
@@ -28,7 +28,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
             return DoGetInspectionResults(Listener.Contexts());
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             return DoGetInspectionResults(Listener.Contexts(module));
         }
@@ -72,7 +72,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
             return DoGetInspectionResults(Listener.Contexts());
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             return DoGetInspectionResults(Listener.Contexts(module));
         }
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/IllegalAnnotationInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/IllegalAnnotationInspection.cs
@@ -60,7 +60,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/ObjectWhereProcedureIsRequiredInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/ObjectWhereProcedureIsRequiredInspection.cs
@@ -70,7 +70,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName));
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/ObsoleteTypeHintInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/ObsoleteTypeHintInspection.cs
@@ -48,7 +48,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));
         }
 
-        private  IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/SuspiciousLetAssignmentInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/SuspiciousLetAssignmentInspection.cs
@@ -60,7 +60,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/UnreachableCaseInspection/UnreachableCaseInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/UnreachableCaseInspection/UnreachableCaseInspection.cs
@@ -156,7 +156,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
                 .ToList();
         }
 
-        private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)
         {
             var finder = DeclarationFinderProvider.DeclarationFinder;
             return DoGetInspectionResults(module, finder);
diff --git a/Rubberduck.Parsing/Inspections/Abstract/IInspection.cs b/Rubberduck.Parsing/Inspections/Abstract/IInspection.cs
@@ -17,6 +17,14 @@ public interface IInspection : IInspectionModel, IComparable<IInspection>, IComp
         /// <returns>Returns inspection results, if any.</returns>
         IEnumerable<IInspectionResult> GetInspectionResults(CancellationToken token);
 
+        /// <summary>
+        /// Runs code inspection for a module and returns inspection results.
+        /// </summary>
+        /// <param name="module">The module for which to get inspection results</param>
+        /// <param name="token"></param>
+        /// <returns></returns>
+        IEnumerable<IInspectionResult> GetInspectionResults(QualifiedModuleName module, CancellationToken token);
+
         /// <summary>
         /// Specifies whether an inspection result is deemed invalid after the specified modules have changed.
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`40`	`40`	`.ToList();`
`41`	`41`	`}`
`42`	`42`
`43`		`- protected virtual IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`43`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`44`	`44`	`{`
`45`	`45`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`46`	`46`	`return DoGetInspectionResults(module, finder);`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`50`	`50`	`.ToList();`
`51`	`51`	`}`
`52`	`52`
`53`		`- protected virtual IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`53`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`54`	`54`	`{`
`55`	`55`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`56`	`56`	`var globalInformation = GlobalInformation(module, finder);`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleN`
`40`	`40`	`.ToList();`
`41`	`41`	`}`
`42`	`42`
`43`		`- protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`43`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`44`	`44`	`{`
`45`	`45`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`46`	`46`	`return DoGetInspectionResults(module, finder);`
`@@ -102,7 +102,7 @@ protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleN`
`102`	`102`	`: ((IdentifierReference reference, T properties)?)null;`
`103`	`103`	`}`
`104`	`104`
`105`		`- protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`105`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`106`	`106`	`{`
`107`	`107`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`108`	`108`	`return DoGetInspectionResults(module, finder);`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ protected virtual IEnumerable<IdentifierReference> ObjectionableReferences(Decla`
`45`	`45`
`46`	`46`	`protected virtual bool IsResultReference(IdentifierReference reference, DeclarationFinder finder) => true;`
`47`	`47`
`48`		`- protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`48`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`49`	`49`	`{`
`50`	`50`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`51`	`51`	`var objectionableReferences = ObjectionableReferences(finder)`
`@@ -112,7 +112,7 @@ protected virtual IEnumerable<IdentifierReference> ObjectionableReferences(Decla`
`112`	`112`	`.SelectMany(declaration => declaration.References);`
`113`	`113`	`}`
`114`	`114`
`115`		`- protected IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`115`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`116`	`116`	`{`
`117`	`117`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`118`	`118`	`var objectionableReferences = ObjectionableReferences(finder)`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`28`	`28`	`return DoGetInspectionResults(Listener.Contexts());`
`29`	`29`	`}`
`30`	`30`
`31`		`- private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`31`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`32`	`32`	`{`
`33`	`33`	`return DoGetInspectionResults(Listener.Contexts(module));`
`34`	`34`	`}`
`@@ -72,7 +72,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`72`	`72`	`return DoGetInspectionResults(Listener.Contexts());`
`73`	`73`	`}`
`74`	`74`
`75`		`- private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`75`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`76`	`76`	`{`
`77`	`77`	`return DoGetInspectionResults(Listener.Contexts(module));`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`60`	`60`	`.SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));`
`61`	`61`	`}`
`62`	`62`
`63`		`- private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`63`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`64`	`64`	`{`
`65`	`65`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`66`	`66`	`return DoGetInspectionResults(module, finder);`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`70`	`70`	`.SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName));`
`71`	`71`	`}`
`72`	`72`
`73`		`- private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`73`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`74`	`74`	`{`
`75`	`75`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`76`	`76`	`return DoGetInspectionResults(module, finder);`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ protected override IEnumerable<IInspectionResult> DoGetInspectionResults()`
`48`	`48`	`.SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));`
`49`	`49`	`}`
`50`	`50`
`51`		`- private IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
	`51`	`+ protected override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module)`
`52`	`52`	`{`
`53`	`53`	`var finder = DeclarationFinderProvider.DeclarationFinder;`
`54`	`54`	`return DoGetInspectionResults(module, finder);`