Merge pull request #4399 from Hosch250/issue753

Hosch250 · web-flow · commit b99aa13fe70a · 2018-10-08T11:49:55.000-05:00
Module without folder annotation
diff --git a/Rubberduck.CodeAnalysis/Inspections/Concrete/ModuleWithoutFolderInspection.cs b/Rubberduck.CodeAnalysis/Inspections/Concrete/ModuleWithoutFolderInspection.cs
@@ -0,0 +1,29 @@
+﻿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;
+using Rubberduck.Parsing.Annotations;
+
+namespace Rubberduck.Inspections.Concrete
+{
+    public sealed class ModuleWithoutFolderInspection : InspectionBase
+    {
+        public ModuleWithoutFolderInspection(RubberduckParserState state)
+            : base(state)
+        {
+        }
+
+        protected override IEnumerable<IInspectionResult> DoGetInspectionResults()
+        {
+            var modulesWithoutFolderAnnotation = State.DeclarationFinder.UserDeclarations(Parsing.Symbols.DeclarationType.Module)
+                .Where(w => w.Annotations.All(a => a.AnnotationType != AnnotationType.Folder))
+                .ToList();
+
+            return modulesWithoutFolderAnnotation.Select(declaration =>
+                new DeclarationInspectionResult(this, string.Format(InspectionResults.ModuleWithoutFolderInspection, declaration.IdentifierName), declaration));
+        }
+    }
+}
diff --git a/Rubberduck.CodeAnalysis/Rubberduck.CodeAnalysis.csproj b/Rubberduck.CodeAnalysis/Rubberduck.CodeAnalysis.csproj
@@ -81,6 +81,7 @@
     <Compile Include="Inspections\Concrete\EmptyForEachBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\EmptyForLoopBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\BooleanAssignedInIfElseInspection.cs" />
+    <Compile Include="Inspections\Concrete\ModuleWithoutFolderInspection.cs" />
     <Compile Include="Inspections\Concrete\EmptyWhileWendBlockInspection.cs" />
     <Compile Include="Inspections\Concrete\ObsoleteCallingConventionInspection.cs" />
     <Compile Include="Inspections\Concrete\ObsoleteErrorSyntaxInspection.cs" />
diff --git a/Rubberduck.Core/Properties/Settings.Designer.cs b/Rubberduck.Core/Properties/Settings.Designer.cs
diff --git a/Rubberduck.Core/Properties/Settings.settings b/Rubberduck.Core/Properties/Settings.settings
@@ -279,6 +279,7 @@
     &lt;CodeInspection Name="ObsoleteMemberUsageInspection" Severity="Warning" InspectionType="MaintainabilityAndReadabilityIssues" /&gt;
     &lt;CodeInspection Name="ObsoleteCallingConventionInspection" Severity="Warning" InspectionType="CodeQualityIssues" /&gt;
     &lt;CodeInspection Name="DuplicatedAnnotationInspection" Severity="Error" InspectionType="RubberduckOpportunities" /&gt;
+    &lt;CodeInspection Name="ModuleWithoutFolderInspection" Severity="Suggestion" InspectionType="RubberduckOpportunities" /&gt;
   &lt;/CodeInspections&gt;
   &lt;WhitelistedIdentifiers /&gt;
   &lt;RunInspectionsOnSuccessfulParse&gt;true&lt;/RunInspectionsOnSuccessfulParse&gt;
diff --git a/Rubberduck.Core/app.config b/Rubberduck.Core/app.config
@@ -402,6 +402,8 @@
                 InspectionType="CodeQualityIssues" />
               <CodeInspection Name="DuplicatedAnnotationInspection" Severity="Error"
                 InspectionType="RubberduckOpportunities" />
+              <CodeInspection Name="ModuleWithoutFolderInspection" Severity="Suggestion"
+                InspectionType="RubberduckOpportunities" />
             </CodeInspections>
             <WhitelistedIdentifiers />
             <RunInspectionsOnSuccessfulParse>true</RunInspectionsOnSuccessfulParse>
diff --git a/Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs b/Rubberduck.Resources/Inspections/InspectionInfo.Designer.cs
diff --git a/Rubberduck.Resources/Inspections/InspectionInfo.resx b/Rubberduck.Resources/Inspections/InspectionInfo.resx
@@ -334,4 +334,7 @@ If the parameter can be null, ignore this inspection result; passing a null valu
   <data name="DuplicatedAnnotationInspection" xml:space="preserve">
     <value>An annotation is specified multiple times, but is intended to be specified only once.</value>
   </data>
+  <data name="ModuleWithoutFolderInspection" xml:space="preserve">
+    <value>Modules without the '@Folder' annotation cannot receive custom groupings in the Code Explorer. </value>
+  </data>
 </root>
diff --git a/Rubberduck.Resources/Inspections/InspectionNames.Designer.cs b/Rubberduck.Resources/Inspections/InspectionNames.Designer.cs
diff --git a/Rubberduck.Resources/Inspections/InspectionNames.resx b/Rubberduck.Resources/Inspections/InspectionNames.resx
@@ -333,4 +333,7 @@
   <data name="DuplicatedAnnotationInspection" xml:space="preserve">
     <value>Annotation is duplicated</value>
   </data>
+  <data name="ModuleWithoutFolderInspection" xml:space="preserve">
+    <value>Module without '@Folder' annotation</value>
+  </data>
 </root>
diff --git a/Rubberduck.Resources/Inspections/InspectionResults.Designer.cs b/Rubberduck.Resources/Inspections/InspectionResults.Designer.cs
diff --git a/Rubberduck.Resources/Inspections/InspectionResults.resx b/Rubberduck.Resources/Inspections/InspectionResults.resx
@@ -363,4 +363,7 @@
   <data name="DuplicatedAnnotationInspection" xml:space="preserve">
     <value>Annotation '{0}' is duplicated.</value>
   </data>
+  <data name="ModuleWithoutFolderInspection" xml:space="preserve">
+    <value>Module '{0}' has no '@Folder' annotation</value>
+  </data>
 </root>
diff --git a/RubberduckTests/Inspections/ModuleWithoutFolderInspectionTests.cs b/RubberduckTests/Inspections/ModuleWithoutFolderInspectionTests.cs
@@ -0,0 +1,62 @@
+﻿using NUnit.Framework;
+using Rubberduck.Inspections.Concrete;
+using RubberduckTests.Mocks;
+using System.Linq;
+using System.Threading;
+
+namespace RubberduckTests.Inspections
+{
+    [TestFixture]
+    public class ModuleWithoutFolderInspectionTests
+    {
+        [Test]
+        [Category("Inspections")]
+        public void Module_NoFolderAnnotation()
+        {
+            const string inputCode = "Option Explicit";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+                var inspection = new ModuleWithoutFolderInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                Assert.AreEqual(1, inspectionResults.Count());
+            }
+        }
+
+        [Test]
+        [Category("Inspections")]
+        public void Module_FolderAnnotation()
+        {
+            const string inputCode = @"'@Folder Foo.Bar
+Option Explicit";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+                var inspection = new ModuleWithoutFolderInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                Assert.AreEqual(0, inspectionResults.Count());
+            }
+        }
+
+        [Test]
+        [Category("Inspections")]
+        public void Module_NonFolderAnnotation()
+        {
+            const string inputCode = @"'@IgnoreModule
+Option Explicit";
+
+            var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
+            using (var state = MockParser.CreateAndParse(vbe.Object))
+            {
+                var inspection = new ModuleWithoutFolderInspection(state);
+                var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
+
+                Assert.AreEqual(1, inspectionResults.Count());
+            }
+        }
+    }
+}
diff --git a/RubberduckTests/RubberduckTests.csproj b/RubberduckTests/RubberduckTests.csproj
@@ -110,6 +110,7 @@
     <Compile Include="CodeAnalysis\CodeMetrics\LineCountTests.cs" />
     <Compile Include="CodeExplorer\CodeExplorerTests.cs" />
     <Compile Include="Inspections\ImplicitDefaultMemberAssignmentInspectionTests.cs" />
+    <Compile Include="Inspections\ModuleWithoutFolderInspectionTests.cs" />
     <Compile Include="Inspections\UnreachableCase\ExpressionFilterUnitTests.cs" />
     <Compile Include="Inspections\UnreachableCase\ParseTreeExpressionEvaluatorUnitTests.cs" />
     <Compile Include="Inspections\UnreachableCase\ParseTreeValueUnitTests.cs" />
