public void UseMeaningfulName_ReturnsResult_NameEndsWithDigit()
{
const string inputCode =
@"Sub Foo1()
End Sub";
//Arrange
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", vbext_ProjectProtection.vbext_pp_none)
.AddComponent("MyClass", vbext_ComponentType.vbext_ct_ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock <ISinks>().Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(null, parser.State, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void UseMeaningfulName_IgnoreQuickFixWorks()
{
const string inputCode =
@"Sub Ffffff()
End Sub";
const string expectedCode =
@"'@Ignore UseMeaningfulName
Sub Ffffff()
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var component = project.Object.VBComponents[0];
var vbe = builder.AddProject(project).Build();
var parser = MockParser.Create(vbe.Object);
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(parser.State, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
new IgnoreOnceQuickFix(parser.State, new[] { inspection }).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, parser.State.GetRewriter(component).GetText());
}
public void InspectionName()
{
const string inspectionName = "UseMeaningfulNameInspection";
var inspection = new UseMeaningfulNameInspection(null, null, null);
Assert.AreEqual(inspectionName, inspection.Name);
}
public void UseMeaningfulName_IgnoreQuickFixWorks()
{
const string inputCode =
@"Sub Ffffff()
End Sub";
const string expectedCode =
@"'@Ignore UseMeaningfulName
Sub Ffffff()
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var component = project.Object.VBComponents[0];
var vbe = builder.AddProject(project).Build();
var(state, rewritingManager) = MockParser.CreateAndParseWithRewritingManager(vbe.Object);
using (state)
{
var inspection = new UseMeaningfulNameInspection(state, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
var rewriteSession = rewritingManager.CheckOutCodePaneSession();
new IgnoreOnceQuickFix(new AnnotationUpdater(), state, new[] { inspection }).Fix(inspectionResults.First(), rewriteSession);
var actualCode = rewriteSession.CheckOutModuleRewriter(component.QualifiedModuleName).GetText();
Assert.AreEqual(expectedCode, actualCode);
}
}
public void UseMeaningfulName_IgnoreQuickFixWorks()
{
const string inputCode =
@"Sub Ffffff()
End Sub";
const string expectedCode =
@"'@Ignore UseMeaningfulName
Sub Ffffff()
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var module = project.Object.VBComponents[0].CodeModule;
var vbe = builder.AddProject(project).Build();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(null, parser.State, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.Single(s => s is IgnoreOnceQuickFix).Fix();
Assert.AreEqual(expectedCode, module.Content());
}
public void UseMeaningfulName_DoesNotReturnsResult_OptionBase()
{
const string inputCode =
@"Option Base 1";
//Arrange
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", vbext_ProjectProtection.vbext_pp_none)
.AddComponent("MyClass", vbext_ComponentType.vbext_ct_ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState());
parser.Parse();
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(null, parser.State);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void UseMeaningfulName_IgnoreQuickFixWorks()
{
const string inputCode =
@"Sub Ffffff()
End Sub";
const string expectedCode =
@"'@Ignore UseMeaningfulName
Sub Ffffff()
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var component = project.Object.VBComponents[0];
var vbe = builder.AddProject(project).Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new UseMeaningfulNameInspection(state, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
new IgnoreOnceQuickFix(state, new[] { inspection }).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
}
public void HungarianNotation_DoesNotReturnResult_WhenWhitelisted()
{
const string inputCode =
@"Sub Feherlista()
Dim oRange As Object
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(null, parser.State, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsFalse(inspectionResults.Any());
}
public void HungarianNotation_DoesNotReturnResult_WhenIgnored()
{
const string inputCode =
@"Sub MagyarRendbenVan()
'@Ignore HungarianNotation
Dim strFoo As Variant
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
var parser = MockParser.Create(vbe.Object);
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(parser.State, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsFalse(inspectionResults.Any());
}
private void AssertVbaFragmentYieldsExpectedInspectionResultCount(string inputCode, int expectedCount)
{
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new UseMeaningfulNameInspection(state, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(expectedCount, inspectionResults.Count());
}
}
public void UseMeaningfulName_NoResultForLineNumberLabels()
{
const string inputCode = @"
Sub DoSomething()
10 Debug.Print 42
End Sub
";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new UseMeaningfulNameInspection(state, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults().Where(i => i.Target.DeclarationType == DeclarationType.LineLabel);
Assert.IsFalse(inspectionResults.Any());
}
}
public void HungarianNotation_DoesNotReturnResult_WhenWhitelisted()
{
const string inputCode =
@"Sub Feherlista()
Dim oRange As Object
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new UseMeaningfulNameInspection(state, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsFalse(inspectionResults.Any());
}
}
private void AssertVbaFragmentYieldsExpectedInspectionResultCount(string inputCode, int expectedCount)
{
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(vbe.Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(null, parser.State, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(expectedCount, inspectionResults.Count());
}
public void HungarianNotation_DoesNotReturnResult_WhenIgnored()
{
const string inputCode =
@"Sub MagyarRendbenVan()
'@Ignore HungarianNotation
Dim strFoo As Variant
End Sub";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("VBAProject", ProjectProtection.Unprotected)
.AddComponent("MyClass", ComponentType.ClassModule, inputCode)
.Build();
var vbe = builder.AddProject(project).Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new UseMeaningfulNameInspection(state, UseMeaningfulNameInspectionTests.GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.IsFalse(inspectionResults.Any());
}
}
public void UseMeaningfulName_NoResultForLineNumberLabels()
{
const string inputCode = @"
Sub DoSomething()
10 Debug.Print 42
End Sub
";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var parser = MockParser.Create(vbe.Object);
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new UseMeaningfulNameInspection(parser.State, GetInspectionSettings().Object);
var inspectionResults = inspection.GetInspectionResults().Where(i => i.Target.DeclarationType == DeclarationType.LineLabel);
Assert.IsFalse(inspectionResults.Any());
}
public void InspectionName()
{
var inspection = new UseMeaningfulNameInspection(null, null);
Assert.AreEqual(nameof(UseMeaningfulNameInspection), inspection.Name);
}
public void InspectionType()
{
var inspection = new UseMeaningfulNameInspection(null, null, null);
Assert.AreEqual(CodeInspectionType.MaintainabilityAndReadabilityIssues, inspection.InspectionType);
}
