Skip to content

Commit 9fd37a1

Browse files
MDoernerMDoerner
committed
Update ShadowedDeclarationInspection for the fact that Debug is a module now
1 parent 1cfa1a2 commit 9fd37a1

File tree

3 files changed

+159
-2
lines changed

3 files changed

+159
-2
lines changed

‎Rubberduck.CodeAnalysis/Inspections/Concrete/ShadowedDeclarationInspection.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using System.Collections.Generic;
1+
using System;
2+
using System.Collections.Generic;
23
using System.Globalization;
34
using System.Linq;
45
using Rubberduck.Inspections.Abstract;
@@ -200,6 +201,12 @@ private static bool DeclarationInReferencedProjectCanBeShadowed(Declaration orig
200201
return false;
201202
}
202203

204+
// We insert Debug.Assert as a member access on an artificial Debug standard module. Thus, Assert will also be seen as shadowing Debug.Assert, which is not true.
205+
if (originalDeclaration.IdentifierName.Equals("Assert", StringComparison.InvariantCultureIgnoreCase) && originalDeclaration.QualifiedModuleName.ComponentName.Equals("Debug", StringComparison.InvariantCultureIgnoreCase))
206+
{
207+
return false;
208+
}
209+
203210
return DeclarationAccessibilityCanBeShadowed(originalDeclaration);
204211
}
205212

‎RubberduckTests/Grammar/ResolverTests.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2238,7 +2238,6 @@ public void ObjectPrintExprsSeparatedByStatementSeparator_IsReferenceToLocalVari
22382238
{
22392239
var code = @"
22402240
Sub Test()
2241-
Dim obj As Object
22422241
Dim referenced As String
22432242
obj.Print referenced;referenced, referenced , referenced ; : obj.Print referenced; referenced , referenced ;
22442243
End Sub";

‎RubberduckTests/Inspections/ShadowedDeclarationInspectionTests.cs

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5109,6 +5109,157 @@ public void ShadowedDeclaration_DoesNotReturnResult_EventParameterWithSameNameAs
51095109
Assert.IsFalse(inspectionResults.Any());
51105110
}
51115111

5112+
[Test]
5113+
[Category("Inspections")]
5114+
[TestCase("", "As Object", "")] //Variable
5115+
[TestCase("Function", "As Object", "End Function")]
5116+
[TestCase("Sub", "", "End Sub")]
5117+
[TestCase("Property Get", "As Object", "End Property")]
5118+
[TestCase("Property Let", "", "End Property")]
5119+
[TestCase("Property Set", "", "End Property")]
5120+
public void ShadowedDeclaration_DoesNotReturnResult_AssertBecauseOfDebugAssert(string memberType, string asTypeClause, string endTag)
5121+
{
5122+
var code =
5123+
$@"Public {memberType} Assert() {asTypeClause}
5124+
{endTag}";
5125+
5126+
var vbe = new MockVbeBuilder()
5127+
.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
5128+
.AddComponent("TestClass", ComponentType.ClassModule, code)
5129+
.AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
5130+
.AddProjectToVbeBuilder()
5131+
.Build();
5132+
5133+
IEnumerable<IInspectionResult> inspectionResults;
5134+
using (var state = MockParser.CreateAndParse(vbe.Object))
5135+
{
5136+
var inspection = new ShadowedDeclarationInspection(state);
5137+
inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
5138+
}
5139+
5140+
Assert.IsFalse(inspectionResults.Any());
5141+
}
5142+
5143+
[Test]
5144+
[Category("Inspections")]
5145+
public void ShadowedDeclaration_DoesNotReturnResult_LocalAssertVariableAssertBecauseOfDebugAssert()
5146+
{
5147+
var code =
5148+
@"Public Sub Foo()
5149+
Dim Assert As Long
5150+
End Sub";
5151+
5152+
var vbe = new MockVbeBuilder()
5153+
.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
5154+
.AddComponent("TestClass", ComponentType.ClassModule, code)
5155+
.AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
5156+
.AddProjectToVbeBuilder()
5157+
.Build();
5158+
5159+
IEnumerable<IInspectionResult> inspectionResults;
5160+
using (var state = MockParser.CreateAndParse(vbe.Object))
5161+
{
5162+
var inspection = new ShadowedDeclarationInspection(state);
5163+
inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
5164+
}
5165+
5166+
Assert.IsFalse(inspectionResults.Any());
5167+
}
5168+
5169+
[Test]
5170+
[Category("Inspections")]
5171+
public void ShadowedDeclaration_DoesNotReturnResult_AssertParameterAssertBecauseOfDebugAssert()
5172+
{
5173+
var code =
5174+
@"Public Sub Foo(Assert As Boolean)
5175+
End Sub";
5176+
5177+
var vbe = new MockVbeBuilder()
5178+
.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
5179+
.AddComponent("TestClass", ComponentType.ClassModule, code)
5180+
.AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
5181+
.AddProjectToVbeBuilder()
5182+
.Build();
5183+
5184+
IEnumerable<IInspectionResult> inspectionResults;
5185+
using (var state = MockParser.CreateAndParse(vbe.Object))
5186+
{
5187+
var inspection = new ShadowedDeclarationInspection(state);
5188+
inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
5189+
}
5190+
5191+
Assert.IsFalse(inspectionResults.Any());
5192+
}
5193+
5194+
[Test]
5195+
[Category("Inspections")]
5196+
[TestCase("", "As Object", "")] //Variable
5197+
[TestCase("Function", "As Object", "End Function")]
5198+
[TestCase("Sub", "", "End Sub")]
5199+
[TestCase("Property Get", "As Object", "End Property")]
5200+
[TestCase("Property Let", "", "End Property")]
5201+
[TestCase("Property Set", "", "End Property")]
5202+
public void ShadowedDeclaration_ReturnResult_LocalAssertVariableAssertBecauseOfNonDebugAssert(string memberType, string asTypeClause, string endTag)
5203+
{
5204+
var code =
5205+
$@"Public {memberType} Assert() {asTypeClause}
5206+
{endTag}
5207+
5208+
Public Sub Foo()
5209+
Dim Assert As Long
5210+
End Sub";
5211+
5212+
var vbe = new MockVbeBuilder()
5213+
.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
5214+
.AddComponent("TestClass", ComponentType.ClassModule, code)
5215+
.AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
5216+
.AddProjectToVbeBuilder()
5217+
.Build();
5218+
5219+
IEnumerable<IInspectionResult> inspectionResults;
5220+
using (var state = MockParser.CreateAndParse(vbe.Object))
5221+
{
5222+
var inspection = new ShadowedDeclarationInspection(state);
5223+
inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
5224+
}
5225+
5226+
Assert.AreEqual(1,inspectionResults.Count());
5227+
}
5228+
5229+
[Test]
5230+
[Category("Inspections")]
5231+
[TestCase("", "As Object", "")] //Variable
5232+
[TestCase("Function", "As Object", "End Function")]
5233+
[TestCase("Sub", "", "End Sub")]
5234+
[TestCase("Property Get", "As Object", "End Property")]
5235+
[TestCase("Property Let", "", "End Property")]
5236+
[TestCase("Property Set", "", "End Property")]
5237+
public void ShadowedDeclaration_ReturnResult_AssertParameterAssertBecauseOfNonDebugAssert(string memberType, string asTypeClause, string endTag)
5238+
{
5239+
var code =
5240+
$@"Public {memberType} Assert() {asTypeClause}
5241+
{endTag}
5242+
5243+
Public Sub Foo(Assert As Boolean)
5244+
End Sub";
5245+
5246+
var vbe = new MockVbeBuilder()
5247+
.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
5248+
.AddComponent("TestClass", ComponentType.ClassModule, code)
5249+
.AddReference("VBA", MockVbeBuilder.LibraryPathVBA, 4, 2, true)
5250+
.AddProjectToVbeBuilder()
5251+
.Build();
5252+
5253+
IEnumerable<IInspectionResult> inspectionResults;
5254+
using (var state = MockParser.CreateAndParse(vbe.Object))
5255+
{
5256+
var inspection = new ShadowedDeclarationInspection(state);
5257+
inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
5258+
}
5259+
5260+
Assert.AreEqual(1, inspectionResults.Count());
5261+
}
5262+
51125263
[Test]
51135264
[Category("Inspections")]
51145265
public void ShadowedDeclaration_Ignored_DoesNotReturnResult()

0 commit comments

Comments
 (0)