Inspection for public members with underscores in names in class modules

Author: Hosch250

Rubberduck.CodeAnalysis/Inspections/Concrete/UnderscoreInPublicClassModuleMemberInspection.cs

@@ -0,0 +1,28 @@
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Results;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Resources.Inspections;
+using Rubberduck.Parsing.VBA;
+
+namespace Rubberduck.Inspections.Concrete
+{
+    public sealed class UnderscoreInPublicClassModuleMemberInspection : InspectionBase
+    {
+        public UnderscoreInPublicClassModuleMemberInspection(RubberduckParserState state)
+            : base(state) { }
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            var names = State.DeclarationFinder.UserDeclarations(Parsing.Symbols.DeclarationType.Member)
+                .Where(w => w.ParentDeclaration.DeclarationType == Parsing.Symbols.DeclarationType.ClassModule)
+                .Where(w => w.Accessibility == Parsing.Symbols.Accessibility.Public)
+                .Where(w => w.IdentifierName.Contains('_'))
+                .ToList();
+
+            return names.Select(issue =>
+                new DeclarationInspectionResult(this, string.Format(InspectionResults.UnderscoreInPublicClassModuleMemberInspection, issue.IdentifierName), issue));
+        }
+    }
+}

Rubberduck.Core/Properties/Settings.Designer.cs

@@ -284,6 +284,7 @@
     <CodeInspection Name="IsMissingOnInappropriateArgumentInspection" Severity="Warning" InspectionType="CodeQualityIssues" />
     <CodeInspection Name="IsMissingWithNonArgumentParameterInspection" Severity="Warning" InspectionType="CodeQualityIssues" />
     <CodeInspection Name="AssignmentNotUsedInspection" Severity="Suggestion" InspectionType="CodeQualityIssues" />
+    <CodeInspection Name="UnderscoreInPublicClassModuleMemberInspection" Severity="Warning" InspectionType="CodeQualityIssues" />
   </CodeInspections>
   <WhitelistedIdentifiers />
   <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/Properties/Settings.settings

@@ -412,6 +412,8 @@
                 Severity="Warning" InspectionType="CodeQualityIssues" />
               <CodeInspection Name="AssignmentNotUsedInspection" Severity="Suggestion"
                 InspectionType="CodeQualityIssues" />
+              <CodeInspection Name="UnderscoreInPublicClassModuleMemberInspection" Severity="Warning"
+                InspectionType="CodeQualityIssues" />
             </CodeInspections>
             <WhitelistedIdentifiers />
             <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>

Rubberduck.Core/app.config

@@ -349,4 +349,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="AssignmentNotUsedInspection" xml:space="preserve">
     <value>An assignment is immediately overridden by another assignment or is never referenced.</value>
   </data>
+  <data name="UnderscoreInPublicClassModuleMemberInspection" xml:space="preserve">
+    <value>A class module with public members with underscores cannot implement interfaces that do not expose said member.</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs

@@ -348,4 +348,7 @@
   <data name="AssignmentNotUsedInspection" xml:space="preserve">
     <value>Assignment is not used</value>
   </data>
+  <data name="UnderscoreInPublicClassModuleMemberInspection" xml:space="preserve">
+    <value>Underscore in public class module member</value>
+  </data>
 </root>

Rubberduck.Resources/Inspections/InspectionInfo.resx

@@ -378,4 +378,7 @@
   <data name="AssignmentNotUsedInspection" xml:space="preserve">
     <value>An assignment is immediately overridden by another assignment or is never referenced.</value>
   </data>
+  <data name="UnderscoreInPublicClassModuleMemberInspection" xml:space="preserve">
+    <value>Public member '{0}' has underscore in name.</value>
+  </data>
 </root>