Add UseOfRecursiveBangNotationInspection

Author: MDoerner

Rubberduck.CodeAnalysis/Inspections/Concrete/UseOfRecursiveBangNotationInspection.cs

@@ -0,0 +1,86 @@
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Resources.Inspections;
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Inspections.Inspections.Extensions;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Inspections;
+
+namespace Rubberduck.Inspections.Concrete
+{
+    /// <summary>
+    /// Identifies the use of bang notation, formally known as dictionary access expression, for which a recursive default member resolution is necessary.
+    /// </summary>
+    /// <why>
+    /// A dictionary access expression looks like a strongly typed call, but it actually is a stringly typed access to the parameterized default member of the object.
+    /// This is especially misleading if the parameterized default member is not on the object itself and can only be reached by calling the parameterless default member first.  
+    /// </why>
+    /// <example hasResult="true">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     MyName = rst!Name.Value
+    /// End Function
+    /// ]]>
+    /// </example>
+    /// <example hasResult="true">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     With rst
+    ///         !Name.Value
+    ///     End With
+    /// End Function
+    /// ]]>
+    /// </example>
+    /// <example hasResult="false">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     MyName = rst.Fields.Item("Name").Value
+    /// End Function
+    /// ]]>
+    /// </example>
+    /// <example hasResult="false">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     MyName = rst("Name").Value
+    /// End Function
+    /// ]]>
+    /// </example>
+    /// <example hasResult="false">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     MyName = rst.Fields!Name.Value
+    /// End Function
+    /// ]]>
+    /// </example>
+    /// <example hasResult="false">
+    /// <![CDATA[
+    /// Public Function MyName(ByVal rst As ADODB.Recordset) As Variant
+    ///     With rst
+    ///         MyName = .Fields.Item("Name").Value
+    ///     End With
+    /// End Function
+    /// ]]>
+    /// </example>
+    public sealed class UseOfRecursiveBangNotationInspection : IdentifierReferenceInspectionBase
+    {
+        public UseOfRecursiveBangNotationInspection(RubberduckParserState state)
+            : base(state)
+        {
+            Severity = CodeInspectionSeverity.Suggestion;
+        }
+
+        protected override bool IsResultReference(IdentifierReference reference)
+        {
+            return reference.IsIndexedDefaultMemberAccess
+                   && reference.DefaultMemberRecursionDepth > 1
+                   && reference.Context is VBAParser.DictionaryAccessContext
+                   && !reference.IsIgnoringInspectionResultFor(AnnotationName);
+        }
+
+        protected override string ResultDescription(IdentifierReference reference)
+        {
+            var expression = reference.IdentifierName;
+            return string.Format(InspectionResults.UseOfRecursiveBangNotationInspection, expression);
+        }
+    }
+}

Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs

@@ -404,6 +404,9 @@ Falls der Parameter 'null' sein kann, bitte dieses Auftreten ignorieren. 'null'
     <value>Der VBA-Compiler gibt keinen Fehler aus, wenn ein Standardmemberzugriff nötig ist, aber der der deklarierte Type des Objekts keinen passenden Standardmember hat. In fast allen Fällen führt dies zu einem Laufzeitfehler91 'Objektvariable oder With-Blockvariable nicht festgelegt' oder 438 'Objekt unterstützt diese Eigenschaft oder Methode nicht' abhängig davon, ob die Variable den Wert 'Nothing' hat oder nicht, der schwerer zu entdecken ist und auf einen Programmierfehler hinweist.</value>
   </data>
   <data name="UseOfBangNotationInspection" xml:space="preserve">
-    <value>Die Ausrufezeichennotation erweckt den Eindruck, dass es sich um einen Zugriff handelt, der Typchecks unterliegt. Allerdings handelt es sich lediglich um einen Zugriff auf den Standardmember des Objekts, auf das sie angewendent wird, bei dem das Argument als Zeichenkette übergeben wird.</value>
+    <value>Die Ausrufezeichennotation erweckt den Eindruck, dass es sich um einen Zugriff handelt, der Typchecks unterliegt. Allerdings handelt es sich lediglich um einen Zugriff auf den Standardmember des Objekts, auf das sie angewendet wird, bei dem das Argument als Zeichenkette übergeben wird.</value>
+  </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>Die Ausrufezeichennotation erweckt den Eindruck, dass es sich um einen Zugriff handelt, der Typchecks unterliegt. Allerdings handelt es sich lediglich um einen Zugriff auf den Standardmember des Objekts, auf das sie angewendet wird, bei dem das Argument als Zeichenkette übergeben wird. Dies ist besonders verwirrend, wenn der Standardmember des Objekts selber keine Zeichenkette akzeptiert und deshalb ein rekursiver Zugriff auf den parameterlosen Standardmember erfolgen muss.</value>
   </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.de.resx

@@ -406,4 +406,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="UseOfBangNotationInspection" xml:space="preserve">
     <value>Bang notation, formally known as dictionary access expression, looks like it is strongly typed. However, it is actually a stringly  typed access to the paramterized default member of the object it is used on.</value>
   </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>Bang notation, formally known as dictionary access expression, looks like it is strongly typed. However, it is actually a stringly  typed access to the paramterized default member of the object it is used on. This is especially misleading if the parameterized default member is not on the object itself and can only be reached by calling the parameterless default member first. </value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.resx

@@ -390,4 +390,7 @@
   <data name="UseOfBangNotationInspection" xml:space="preserve">
     <value>Verwendung der Ausrufezeichennotation</value>
   </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>Verwendung rekursiver Ausrufezeichennotation</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.Designer.cs

@@ -410,4 +410,7 @@
   <data name="UseOfBangNotationInspection" xml:space="preserve">
     <value>Use of bang notation</value>
   </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>Use of recursive bang notation</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.de.resx

@@ -431,4 +431,7 @@ In Memoriam, 1972-2018</value>
   <data name="UseOfBangNotationInspection" xml:space="preserve">
     <value>Der Ausdruck '{0}' verwendet Ausrufezeichennotation.</value>
   </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>Der Ausdruck '{0}' verwendet rekursive Ausrufezeichennotation.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionNames.resx

@@ -462,4 +462,8 @@ In memoriam, 1972-2018</value>
     <value>The expression '{0}' contains a use of bang notation.</value>
     <comment>{0} expression</comment>
   </data>
+  <data name="UseOfRecursiveBangNotationInspection" xml:space="preserve">
+    <value>The expression '{0}' contains a use of recursive bang notation.</value>
+    <comment>{0} expression</comment>
+  </data>
 </root>