Add MissingModuleAnnotationInspection

Also removes the last remnants of the MissingAnnotationInspection.

Author: MDoerner

Rubberduck.CodeAnalysis/Inspections/Concrete/MissingModuleAnnotationInspection.cs

@@ -0,0 +1,105 @@
+using System.Collections.Generic;
+using System.Linq;
+using Rubberduck.Inspections.Abstract;
+using Rubberduck.Inspections.Results;
+using Rubberduck.Parsing;
+using Rubberduck.Parsing.Annotations;
+using Rubberduck.Parsing.Grammar;
+using Rubberduck.Parsing.Inspections.Abstract;
+using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.VBA;
+using Rubberduck.Resources.Inspections;
+using Rubberduck.VBEditor.SafeComWrappers;
+
+namespace Rubberduck.Inspections.Inspections.Concrete
+{
+    public sealed class MissingModuleAnnotationInspection : InspectionBase
+    {
+        public MissingModuleAnnotationInspection(RubberduckParserState state) 
+        :base(state)
+        {}
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            var moduleDeclarationsWithAttributes = State.DeclarationFinder
+                .UserDeclarations(DeclarationType.Module)
+                .Where(decl => decl.Attributes.Any());
+
+            var declarationsToInspect = moduleDeclarationsWithAttributes
+                .Where(decl => decl.QualifiedModuleName.ComponentType != ComponentType.Document
+                               && !IsIgnoringInspectionResultFor(decl, AnnotationName));
+
+            var results = new List<DeclarationInspectionResult>();
+            foreach (var declaration in declarationsToInspect)
+            {
+                foreach (var attribute in declaration.Attributes)
+                {
+                    if (IsDefaultAttribute(declaration, attribute))
+                    {
+                        continue;
+                    }
+
+                    if (MissesCorrespondingModuleAnnotation(declaration, attribute))
+                    {
+                        var description = string.Format(InspectionResults.MissingMemberAnnotationInspection,
+                            declaration.IdentifierName,
+                            attribute.Name,
+                            attribute.Values);
+
+                        var result = new DeclarationInspectionResult(this, description, declaration,
+                            new QualifiedContext(declaration.QualifiedModuleName, declaration.Context));
+                        result.Properties.AttributeName = attribute.Name;
+                        result.Properties.AttributeValues = attribute.Values;
+
+                        results.Add(result);
+                    }
+                }
+            }
+
+            return results;
+        }
+
+        private static bool IsDefaultAttribute(Declaration declaration, AttributeNode attribute)
+        {
+            switch (attribute.Name)
+            {
+                case "VB_Name":
+                    return true;
+                case "VB_GlobalNameSpace":
+                    return declaration.DeclarationType.HasFlag(DeclarationType.ClassModule) 
+                        && attribute.Values[0].Equals(Tokens.False);
+                case "VB_Exposed":
+                    return declaration.DeclarationType.HasFlag(DeclarationType.ClassModule)
+                           && attribute.Values[0].Equals(Tokens.False);
+                case "VB_Creatable":
+                    return declaration.DeclarationType.HasFlag(DeclarationType.ClassModule)
+                           && attribute.Values[0].Equals(Tokens.False);
+                case "VB_PredeclaredId":
+                    return (declaration.QualifiedModuleName.ComponentType == ComponentType.ClassModule
+                                && attribute.Values[0].Equals(Tokens.False))
+                            || (declaration.QualifiedModuleName.ComponentType == ComponentType.UserForm
+                                && attribute.Values[0].Equals(Tokens.True));
+                default:
+                    return false;
+            }
+        }
+
+        private static bool MissesCorrespondingModuleAnnotation(Declaration declaration, AttributeNode attribute)
+        {
+            if (string.IsNullOrEmpty(attribute.Name) || !declaration.DeclarationType.HasFlag(DeclarationType.Module))
+            {
+                return false;
+            }
+
+            //VB_Ext_Key attributes are special in that identity also depends on the first value, the key.
+            if (attribute.Name == "VB_Ext_Key")
+            {
+                return !declaration.Annotations.OfType<IAttributeAnnotation>()
+                    .Any(annotation => annotation.Attribute.Equals("VB_Ext_Key") && attribute.Values[0].Equals(annotation.AttributeValues[0]));
+            }
+
+            return !declaration.Annotations.OfType<IAttributeAnnotation>()
+                .Any(annotation => annotation.Attribute.Equals(attribute.Name));
+        }
+    }
+}