Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'next' into ExcludedProjectsSelection
- Loading branch information
Showing
31 changed files
with
1,173 additions
and
205 deletions.
There are no files selected for viewing
46 changes: 46 additions & 0 deletions
46
Rubberduck.CodeAnalysis/Inspections/Abstract/ImplicitSheetReferenceInspectionBase.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using Rubberduck.Parsing.Symbols; | ||
| using Rubberduck.Parsing.VBA; | ||
| using Rubberduck.Parsing.VBA.DeclarationCaching; | ||
|
|
||
| namespace Rubberduck.CodeAnalysis.Inspections.Abstract | ||
| { | ||
| internal abstract class ImplicitSheetReferenceInspectionBase : IdentifierReferenceInspectionFromDeclarationsBase | ||
| { | ||
| public ImplicitSheetReferenceInspectionBase(IDeclarationFinderProvider declarationFinderProvider) | ||
| : base(declarationFinderProvider) | ||
| { } | ||
|
|
||
| protected override IEnumerable<Declaration> ObjectionableDeclarations(DeclarationFinder finder) | ||
| { | ||
| var excel = finder.Projects | ||
| .SingleOrDefault(item => !item.IsUserDefined | ||
| && item.IdentifierName == "Excel"); | ||
| if (excel == null) | ||
| { | ||
| return Enumerable.Empty<Declaration>(); | ||
| } | ||
|
|
||
| var globalModules = GlobalObjectClassNames | ||
| .Select(className => finder.FindClassModule(className, excel, true)) | ||
| .OfType<ModuleDeclaration>(); | ||
|
|
||
| return globalModules | ||
| .SelectMany(moduleClass => moduleClass.Members) | ||
| .Where(declaration => TargetMemberNames.Contains(declaration.IdentifierName) | ||
| && declaration.DeclarationType.HasFlag(DeclarationType.Member) | ||
| && declaration.AsTypeName == "Range"); | ||
| } | ||
|
|
||
| private static readonly string[] GlobalObjectClassNames = | ||
| { | ||
| "Global", "_Global" | ||
| }; | ||
|
|
||
| private static readonly string[] TargetMemberNames = | ||
| { | ||
| "Cells", "Range", "Columns", "Rows" | ||
| }; | ||
| } | ||
| } |
46 changes: 46 additions & 0 deletions
46
Rubberduck.CodeAnalysis/Inspections/Abstract/ImplicitWorkbookReferenceInspectionBase.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using Rubberduck.Parsing.Symbols; | ||
| using Rubberduck.Parsing.VBA; | ||
| using Rubberduck.Parsing.VBA.DeclarationCaching; | ||
|
|
||
| namespace Rubberduck.CodeAnalysis.Inspections.Abstract | ||
| { | ||
| internal abstract class ImplicitWorkbookReferenceInspectionBase : IdentifierReferenceInspectionFromDeclarationsBase | ||
| { | ||
| internal ImplicitWorkbookReferenceInspectionBase(IDeclarationFinderProvider declarationFinderProvider) | ||
| : base(declarationFinderProvider) | ||
| { } | ||
|
|
||
| private static readonly string[] InterestingMembers = | ||
| { | ||
| "Worksheets", "Sheets", "Names" | ||
| }; | ||
|
|
||
| private static readonly string[] InterestingClasses = | ||
| { | ||
| "_Global", "_Application", "Global", "Application" | ||
| }; | ||
|
|
||
| protected override IEnumerable<Declaration> ObjectionableDeclarations(DeclarationFinder finder) | ||
| { | ||
| var excel = finder.Projects | ||
| .SingleOrDefault(project => project.IdentifierName == "Excel" && !project.IsUserDefined); | ||
| if (excel == null) | ||
| { | ||
| return Enumerable.Empty<Declaration>(); | ||
| } | ||
|
|
||
| var relevantClasses = InterestingClasses | ||
| .Select(className => finder.FindClassModule(className, excel, true)) | ||
| .OfType<ModuleDeclaration>(); | ||
|
|
||
| var relevantProperties = relevantClasses | ||
| .SelectMany(classDeclaration => classDeclaration.Members) | ||
| .OfType<PropertyGetDeclaration>() | ||
| .Where(member => InterestingMembers.Contains(member.IdentifierName)); | ||
|
|
||
| return relevantProperties; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
...erduck.CodeAnalysis/Inspections/Concrete/ImplicitContainingWorkbookReferenceInspection.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using Rubberduck.CodeAnalysis.Inspections.Abstract; | ||
| using Rubberduck.CodeAnalysis.Inspections.Attributes; | ||
| using Rubberduck.Parsing.Symbols; | ||
| using Rubberduck.Parsing.VBA; | ||
| using Rubberduck.Parsing.VBA.DeclarationCaching; | ||
| using Rubberduck.Resources.Inspections; | ||
|
|
||
| namespace Rubberduck.CodeAnalysis.Inspections.Concrete | ||
| { | ||
| /// <summary> | ||
| /// Locates unqualified Workbook.Worksheets/Sheets/Names member calls inside workbook document modules that implicitly refer to the containing workbook. | ||
| /// </summary> | ||
| /// <reference name="Excel" /> | ||
| /// <why> | ||
| /// Implicit references inside a workbook document module can be mistakes for implicit references to the active workbook, which is the behavior in all other modules | ||
| /// By explicitly qualifying these member calls with Me, the ambiguity can be resolved. | ||
| /// </why> | ||
| /// <example hasResult="true"> | ||
| /// <module name="ThisWorkbook" type="Document Module"> | ||
| /// <![CDATA[ | ||
| /// Private Sub Example() | ||
| /// Dim summarySheet As Worksheet | ||
| /// Set summarySheet = Worksheets("Summary") ' unqualified Worksheets is implicitly querying the containing workbook's Worksheets collection. | ||
| /// End Sub | ||
| /// ]]> | ||
| /// </module> | ||
| /// </example> | ||
| /// <example hasResult="false"> | ||
| /// <module name="ThisWorkbook" type="Document Module"> | ||
| /// <![CDATA[ | ||
| /// Private Sub Example() | ||
| /// Dim summarySheet As Worksheet | ||
| /// Set summarySheet = Me.Worksheets("Summary") | ||
| /// End Sub | ||
| /// ]]> | ||
| /// </module> | ||
| /// </example> | ||
| [RequiredLibrary("Excel")] | ||
| internal sealed class ImplicitContainingWorkbookReferenceInspection : ImplicitWorkbookReferenceInspectionBase | ||
| { | ||
| public ImplicitContainingWorkbookReferenceInspection(IDeclarationFinderProvider declarationFinderProvider) | ||
| : base(declarationFinderProvider) | ||
| { } | ||
|
|
||
| private static readonly List<string> _alwaysActiveWorkbookReferenceParents = new List<string> | ||
| { | ||
| "_Application", "Application" | ||
| }; | ||
|
|
||
| protected override IEnumerable<Declaration> ObjectionableDeclarations(DeclarationFinder finder) | ||
| { | ||
| return base.ObjectionableDeclarations(finder) | ||
| .Where(declaration => !_alwaysActiveWorkbookReferenceParents.Contains(declaration.ParentDeclaration.IdentifierName)); | ||
| } | ||
|
|
||
| protected override bool IsResultReference(IdentifierReference reference, DeclarationFinder finder) | ||
| { | ||
| return Declaration.GetModuleParent(reference.ParentNonScoping) is DocumentModuleDeclaration document | ||
| && document.SupertypeNames.Contains("Workbook"); | ||
| } | ||
|
|
||
| protected override string ResultDescription(IdentifierReference reference) | ||
| { | ||
| var referenceText = reference.Context.GetText(); | ||
| return string.Format( | ||
| InspectionResults.ImplicitContainingWorkbookReferenceInspection, | ||
| referenceText); | ||
| } | ||
| } | ||
| } |
59 changes: 59 additions & 0 deletions
59
...rduck.CodeAnalysis/Inspections/Concrete/ImplicitContainingWorksheetReferenceInspection.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| using System.Linq; | ||
| using Rubberduck.CodeAnalysis.Inspections.Abstract; | ||
| using Rubberduck.CodeAnalysis.Inspections.Attributes; | ||
| using Rubberduck.Parsing.Symbols; | ||
| using Rubberduck.Parsing.VBA; | ||
| using Rubberduck.Parsing.VBA.DeclarationCaching; | ||
| using Rubberduck.Resources.Inspections; | ||
|
|
||
| namespace Rubberduck.CodeAnalysis.Inspections.Concrete | ||
| { | ||
| /// <summary> | ||
| /// Locates unqualified Worksheet.Range/Cells/Columns/Rows member calls inside worksheet modules that implicitly refer to the containing sheet. | ||
| /// </summary> | ||
| /// <reference name="Excel" /> | ||
| /// <why> | ||
| /// Implicit references inside a worksheet document module can be mistakes for implicit references to the active worksheet, which is the behavior in all other places. | ||
| /// By explicitly qualifying these member calls with Me, the ambiguity can be resolved. | ||
| /// </why> | ||
| /// <example hasResult="true"> | ||
| /// <module name="Sheet1" type="Document Module"> | ||
| /// <![CDATA[ | ||
| /// Private Sub Example() | ||
| /// Dim foo As Range | ||
| /// Set foo = Range("A1") ' Worksheet.Range implicitly from containing worksheet | ||
| /// End Sub | ||
| /// ]]> | ||
| /// </module> | ||
| /// </example> | ||
| /// <example hasResult="false"> | ||
| /// <module name="Sheet1" type="Document Module"> | ||
| /// <![CDATA[ | ||
| /// Private Sub Example() | ||
| /// Dim foo As Range | ||
| /// Set foo = Me.Range("A1") | ||
| /// End Sub | ||
| /// ]]> | ||
| /// </module> | ||
| /// </example> | ||
| [RequiredLibrary("Excel")] | ||
| internal sealed class ImplicitContainingWorksheetReferenceInspection : ImplicitSheetReferenceInspectionBase | ||
| { | ||
| public ImplicitContainingWorksheetReferenceInspection(IDeclarationFinderProvider declarationFinderProvider) | ||
| : base(declarationFinderProvider) | ||
| {} | ||
|
|
||
| protected override bool IsResultReference(IdentifierReference reference, DeclarationFinder finder) | ||
| { | ||
| return Declaration.GetModuleParent(reference.ParentNonScoping) is DocumentModuleDeclaration document | ||
| && document.SupertypeNames.Contains("Worksheet"); | ||
| } | ||
|
|
||
| protected override string ResultDescription(IdentifierReference reference) | ||
| { | ||
| return string.Format( | ||
| InspectionResults.ImplicitContainingWorksheetReferenceInspection, | ||
| reference.Declaration.IdentifierName); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.