Merge pull request #2575 from retailcoder/next

retailcoder · web-flow · commit 693b349fdcb2 · 2017-01-24T00:05:06.000-05:00
use meaningful names tweaks
diff --git a/RetailCoder.VBE/Inspections/UseMeaningfulNameInspection.cs b/RetailCoder.VBE/Inspections/UseMeaningfulNameInspection.cs
@@ -1,6 +1,7 @@
 ﻿using System;
 using System.Collections.Generic;
 using System.Linq;
+using Rubberduck.Common;
 using Rubberduck.Inspections.Abstract;
 using Rubberduck.Inspections.Resources;
 using Rubberduck.Inspections.Results;
@@ -27,22 +28,47 @@ public UseMeaningfulNameInspection(IMessageBox messageBox, RubberduckParserState
         public override string Description { get { return InspectionsUI.UseMeaningfulNameInspectionName; } }
         public override CodeInspectionType InspectionType { get { return CodeInspectionType.MaintainabilityAndReadabilityIssues; } }
 
+        private static readonly DeclarationType[] IgnoreDeclarationTypes = 
+        {
+            DeclarationType.ModuleOption,
+            DeclarationType.BracketedExpression, 
+            DeclarationType.LibraryFunction,
+            DeclarationType.LibraryProcedure, 
+        };
+
         public override IEnumerable<InspectionResultBase> GetInspectionResults()
         {
             var settings = _settings.Load(new CodeInspectionSettings()) ?? new CodeInspectionSettings();
-            var whitelistedNames = settings.WhitelistedIdentifiers.Select(s => s.Identifier).ToList();
+            var whitelistedNames = settings.WhitelistedIdentifiers.Select(s => s.Identifier).ToArray();
+
+            var handlers = Declarations.FindBuiltInEventHandlers();
 
             var issues = UserDeclarations
-                            .Where(declaration => declaration.DeclarationType != DeclarationType.ModuleOption &&
-                                                  !whitelistedNames.Contains(declaration.IdentifierName) &&
-                                                  (declaration.IdentifierName.Length < 3 ||
-                                                  char.IsDigit(declaration.IdentifierName.Last()) ||
-                                                  !declaration.IdentifierName.Any(c => 
-                                                      "aeiouy".Any(a => string.Compare(a.ToString(), c.ToString(), StringComparison.OrdinalIgnoreCase) == 0))))
+                            .Where(declaration => 
+                                !IgnoreDeclarationTypes.Contains(declaration.DeclarationType) &&
+                                (declaration.ParentDeclaration == null || 
+                                    !IgnoreDeclarationTypes.Contains(declaration.ParentDeclaration.DeclarationType) &&
+                                    !handlers.Contains(declaration.ParentDeclaration)) &&
+                                !whitelistedNames.Contains(declaration.IdentifierName) &&
+                                IsBadIdentifier(declaration.IdentifierName))
                             .Select(issue => new IdentifierNameInspectionResult(this, issue, State, _messageBox, _settings))
                             .ToList();
 
             return issues;
         }
+
+        private static bool IsBadIdentifier(string identifier)
+        {
+            return identifier.Length < 3 ||
+                   char.IsDigit(identifier.Last()) ||
+                   !HasVowels(identifier);
+        }
+
+        private static bool HasVowels(string identifier)
+        {
+            const string vowels = "aeiouyàâäéèêëïîöôùûü";
+            return  identifier.Any(character => vowels.Any(vowel => 
+                    string.Compare(vowel.ToString(), character.ToString(), StringComparison.OrdinalIgnoreCase) == 0));
+        }
     }
 }
diff --git a/Rubberduck.Parsing/Symbols/DeclarationSymbolsListener.cs b/Rubberduck.Parsing/Symbols/DeclarationSymbolsListener.cs
@@ -69,7 +69,7 @@ public DeclarationSymbolsListener(
                     {
                         try
                         {
-                            if (coclass.Key.Count != _qualifiedName.Component.Properties.Count)
+                            if (_qualifiedName.Component == null || coclass.Key.Count != _qualifiedName.Component.Properties.Count)
                             {
                                 continue;
                             }
diff --git a/RubberduckTests/Inspections/ImplicitActiveSheetReferenceInspectionTests.cs b/RubberduckTests/Inspections/ImplicitActiveSheetReferenceInspectionTests.cs
@@ -53,6 +53,7 @@ End Sub
         }
 
         [TestMethod]
+        [DeploymentItem(@"TestFiles\")]
         [TestCategory("Inspections")]
         public void ImplicitActiveSheetReference_Ignored_DoesNotReportRange()
         {
@@ -87,8 +88,8 @@ End Sub
             Assert.AreEqual(0, inspectionResults.Count());
         }
 
-        [DeploymentItem(@"TestFiles\")]
         [TestMethod]
+        [DeploymentItem(@"TestFiles\")]
         public void ImplicitActiveSheetReference_IgnoreQuickFixWorks()
         {
             const string inputCode =
diff --git a/RubberduckTests/Inspections/ImplicitActiveWorkbookReferenceInspectionTests.cs b/RubberduckTests/Inspections/ImplicitActiveWorkbookReferenceInspectionTests.cs
@@ -17,6 +17,7 @@ namespace RubberduckTests.Inspections
     public class ImplicitActiveWorkbookReferenceInspectionTests
     {
         [TestMethod]
+        [DeploymentItem(@"TestFiles\")]
         [TestCategory("Inspections")]
         public void ImplicitActiveWorkbookReference_ReportsWorksheets()
         {
@@ -51,6 +52,7 @@ Dim sheet As Worksheet
         }
 
         [TestMethod]
+        [DeploymentItem(@"TestFiles\")]
         [TestCategory("Inspections")]
         public void ImplicitActiveWorkbookReference_Ignored_DoesNotReportRange()
         {
@@ -75,6 +77,7 @@ Dim sheet As Worksheet
             mockHost.SetupAllProperties();
 
             var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock<ISinks>().Object));
+            parser.State.AddTestLibrary("Excel.1.8.xml");
 
             parser.Parse(new CancellationTokenSource());
             if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }
diff --git a/RubberduckTests/RubberduckTests.csproj b/RubberduckTests/RubberduckTests.csproj
@@ -185,7 +185,6 @@
     <Compile Include="Settings\InspectionSettingsTests.cs" />
     <Compile Include="Settings\GeneralSettingsTests.cs" />
     <Compile Include="Settings\IndenterSettingsTests.cs" />
-    <Compile Include="Settings\SettingsControlTests.cs" />
     <Compile Include="Settings\TodoSettingsTests.cs" />
     <Compile Include="Settings\UnitTestSettingsTests.cs" />
     <Compile Include="SmartIndenter\EndOfLineCommentTests.cs" />
@@ -197,7 +196,6 @@
     <Compile Include="SourceControl\BranchesViewModelTests.cs" />
     <Compile Include="SourceControl\ChangesViewModelTests.cs" />
     <Compile Include="SourceControl\SettingsViewModelTests.cs" />
-    <Compile Include="SourceControl\SourceControlTests.cs" />
     <Compile Include="SourceControl\SourceControlViewModelTests.cs" />
     <Compile Include="SourceControl\UnsyncedCommitsViewModelTests.cs" />
     <Compile Include="StringExtensionsTests.cs" />
diff --git a/RubberduckTests/Settings/SettingsControlTests.cs b/RubberduckTests/Settings/SettingsControlTests.cs
diff --git a/RubberduckTests/SourceControl/SourceControlTests.cs b/RubberduckTests/SourceControl/SourceControlTests.cs

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public DeclarationSymbolsListener(`
`69`	`69`	`{`
`70`	`70`	`try`
`71`	`71`	`{`
`72`		`- if (coclass.Key.Count != _qualifiedName.Component.Properties.Count)`
	`72`	`+ if (_qualifiedName.Component == null \|\| coclass.Key.Count != _qualifiedName.Component.Properties.Count)`
`73`	`73`	`{`
`74`	`74`	`continue;`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ End Sub`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`[TestMethod]`
	`56`	`+ [DeploymentItem(@"TestFiles\")]`
`56`	`57`	`[TestCategory("Inspections")]`
`57`	`58`	`public void ImplicitActiveSheetReference_Ignored_DoesNotReportRange()`
`58`	`59`	`{`
`@@ -87,8 +88,8 @@ End Sub`
`87`	`88`	`Assert.AreEqual(0, inspectionResults.Count());`
`88`	`89`	`}`
`89`	`90`
`90`		`- [DeploymentItem(@"TestFiles\")]`
`91`	`91`	`[TestMethod]`
	`92`	`+ [DeploymentItem(@"TestFiles\")]`
`92`	`93`	`public void ImplicitActiveSheetReference_IgnoreQuickFixWorks()`
`93`	`94`	`{`
`94`	`95`	`const string inputCode =`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ namespace RubberduckTests.Inspections`
`17`	`17`	`public class ImplicitActiveWorkbookReferenceInspectionTests`
`18`	`18`	`{`
`19`	`19`	`[TestMethod]`
	`20`	`+ [DeploymentItem(@"TestFiles\")]`
`20`	`21`	`[TestCategory("Inspections")]`
`21`	`22`	`public void ImplicitActiveWorkbookReference_ReportsWorksheets()`
`22`	`23`	`{`
`@@ -51,6 +52,7 @@ Dim sheet As Worksheet`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`[TestMethod]`
	`55`	`+ [DeploymentItem(@"TestFiles\")]`
`54`	`56`	`[TestCategory("Inspections")]`
`55`	`57`	`public void ImplicitActiveWorkbookReference_Ignored_DoesNotReportRange()`
`56`	`58`	`{`
`@@ -75,6 +77,7 @@ Dim sheet As Worksheet`
`75`	`77`	`mockHost.SetupAllProperties();`
`76`	`78`
`77`	`79`	`var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock<ISinks>().Object));`
	`80`	`+ parser.State.AddTestLibrary("Excel.1.8.xml");`
`78`	`81`
`79`	`82`	`parser.Parse(new CancellationTokenSource());`
`80`	`83`	`if (parser.State.Status >= ParserState.Error) { Assert.Inconclusive("Parser Error"); }`