Introduce ProcedureRequiredInspection

This inspection reports all places in which an unparameterized procedure call is required but an object variable has been provided.

Author: MDoerner

Rubberduck.CodeAnalysis/Inspections/Concrete/ProcedureRequiredInspection.cs

@@ -0,0 +1,99 @@
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Inspections.Extensions;
+using Rubberduck.Inspections.Results;
+using Rubberduck.Parsing.Inspections;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Resources.Inspections;
+
+namespace Rubberduck.CodeAnalysis.Inspections.Concrete
+{
+    /// <summary>
+    /// Locates places in which a procedure needs to be called but an object variables has been provided that does not have a suitable default member. 
+    /// </summary>
+    /// <why>
+    /// The VBA compiler does not check whether the necessary default member is present. Instead there is a runtime error whenever the runtime type fails to have the default member.
+    /// </why>
+    /// <example hasResult="true">
+    /// <![CDATA[
+    /// Class1:
+    ///
+    /// Public Sub Foo()
+    /// 'No default member attribute
+    /// End Sub
+    ///
+    /// ------------------------------
+    /// Module1:
+    /// 
+    /// Public Sub DoIt()
+    ///     Dim cls As Class1
+    ///     Set cls = New Class1
+    ///     cls 
+    /// End Sub
+    /// ]]>
+    /// </example>
+    /// <example hasResult="false">
+    /// <![CDATA[
+    /// Class1:
+    ///
+    /// Public Sub Foo()
+    /// Attribute Foo.UserMemId = 0
+    /// End Sub
+    ///
+    /// ------------------------------
+    /// Module1:
+    /// 
+    /// Public Sub DoIt()
+    ///     Dim cls As Class1
+    ///     Set cls = New Class1
+    ///     cls 
+    /// End Sub
+    /// ]]>
+    /// </example>
+    public class ProcedureRequiredInspection : InspectionBase
+    {
+        private readonly IDeclarationFinderProvider _declarationFinderProvider;
+
+        public ProcedureRequiredInspection(RubberduckParserState state)
+            : base(state)
+        {
+            _declarationFinderProvider = state;
+
+            //This will most likely cause a runtime error. The exceptions are rare and should be refactored or made explicit with an @Ignore annotation.
+            Severity = CodeInspectionSeverity.Error;
+        }
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            var finder = _declarationFinderProvider.DeclarationFinder;
+
+            var failedProcedureCoercions = finder.FailedProcedureCoercions();
+            return failedProcedureCoercions
+                .Where(failedCoercion => !IsIgnored(failedCoercion))
+                .Select(failedCoercion => InspectionResult(failedCoercion, _declarationFinderProvider));
+        }
+
+        private bool IsIgnored(IdentifierReference assignment)
+        {
+            return assignment.IsIgnoringInspectionResultFor(AnnotationName);
+        }
+
+        private IInspectionResult InspectionResult(IdentifierReference failedCoercion, IDeclarationFinderProvider declarationFinderProvider)
+        {
+            return new IdentifierReferenceInspectionResult(this,
+                ResultDescription(failedCoercion),
+                declarationFinderProvider,
+                failedCoercion);
+        }
+
+        private string ResultDescription(IdentifierReference failedCoercion)
+        {
+            var expression = failedCoercion.IdentifierName;
+            var typeName = failedCoercion.Declaration?.FullAsTypeName;
+            return string.Format(InspectionResults.ProcedureRequiredInspection, expression, typeName);
+        }
+    }
+}

Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs

@@ -397,4 +397,7 @@ Falls der Parameter 'null' sein kann, bitte dieses Auftreten ignorieren. 'null'
   <data name="ValueRequiredInspection" xml:space="preserve">
     <value>Der VBA-Compiler gibt keinen Fehler aus, wenn ein Objekt an einer Stelle verwendet wird, die einen Wert verlangt, und der deklarierte Type des Objekts keinen passenden Standardmember hat. In fast allen Fällen führt dies zu einem Laufzeitfehler, der schwerer zu entdecken ist und auf einen Programmierfehler hinweist.</value>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>Der VBA-Compiler gibt keinen Fehler aus, wenn eine Objektvariable an einer Stelle verwendet wird, die eine Prozedur erfordert, und der deklarierte Type des Objekts keinen passenden Standardmember hat. In fast allen Fällen führt dies zu einem Laufzeitfehler, der schwerer zu entdecken ist und auf einen Programmierfehler hinweist.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.de.resx

@@ -397,4 +397,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="ValueRequiredInspection" xml:space="preserve">
     <value>The VBA compiler does not raise an error if an object is used in a place that requires a value type and the object's declared type does not have a suitable default member. Under almost all circumstances, this leads to a run-time error, which is harder to detect and indicates a bug.</value>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>The VBA compiler does not raise an error if an object variable is used in a place that requires a procedure and the object's declared type does not have a suitable default member. Under almost all circumstances, this leads to a run-time error, which is harder to detect and indicates a bug.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.resx

@@ -381,4 +381,7 @@
   <data name="ValueRequiredInspection" xml:space="preserve">
     <value>Objekt statt Wert verwendet</value>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>Objekt statt Prozedur verwendet</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.Designer.cs

@@ -401,4 +401,7 @@
   <data name="ValueRequiredInspection" xml:space="preserve">
     <value>Object used where a value is required</value>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>Object used where a procedure is required</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.de.resx

@@ -422,4 +422,7 @@ In Memoriam, 1972-2018</value>
   <data name="ValueRequiredInspection" xml:space="preserve">
     <value>An einer Stelle, die einen Wert verlangt, wird der Ausdruck '{0}' vom Objekttyp '{1}'  verwendet, der keinen passendes Standardmember hat.</value>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>An einer Stelle, die eine Prozedur erfordert, wird der Ausdruck '{0}' vom Objekttyp '{1}'  verwendet, der keinen passendes Standardmember hat.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.resx

@@ -450,4 +450,8 @@ In memoriam, 1972-2018</value>
     <value>In a context that requires a value type, the expression '{0}' of object type '{1}' is used that does not have a suitable default member.</value>
     <comment>{0} expression; {1} type</comment>
   </data>
+  <data name="ProcedureRequiredInspection" xml:space="preserve">
+    <value>In a context that requires a procedure, the expression '{0}' of object type '{1}' is used that does not have a suitable default member.</value>
+    <comment>{0} expression; {1} type</comment>
+  </data>
 </root>