public void GivenImplicitVariantPropertyGetter_StillConvertsToSub()
{
const string inputCode =
@"Property Get Foo()
End Property";
const string expectedCode =
@"Sub Foo()
End Sub";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, module.Lines());
}
public void NonReturningFunction_ReturnsResult_InterfaceImplementation_OnlyIgnoreOnceQuickFix()
{
//Input
const string inputCode1 =
@"Function Foo() As Boolean
End Function";
const string inputCode2 =
@"Implements IClass1
Function IClass1_Foo() As Boolean
End Function";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
.AddComponent("IClass1", ComponentType.ClassModule, inputCode1)
.AddComponent("Class1", ComponentType.ClassModule, inputCode2)
.Build();
var vbe = builder.AddProject(project).Build();
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsTrue(inspectionResults.First().QuickFixes.Any() &&
inspectionResults.First().QuickFixes.All(quickfix => quickfix.Description == InspectionsUI.IgnoreOnce));
}
public void NonReturningPropertyGet_ReturnsResult()
{
const string inputCode =
@"Property Get Foo() As Boolean
End Property";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void NonReturningFunction_IgnoreQuickFixWorks()
{
const string inputCode =
@"Function Foo() As Boolean
End Function";
const string expectedCode =
@"'@Ignore NonReturningFunction
Function Foo() As Boolean
End Function";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.Single(s => s is IgnoreOnceQuickFix).Fix();
Assert.AreEqual(expectedCode, module.Lines());
}
public void GivenParameterizedPropertyGetter_QuickFixKeepsParameter()
{
const string inputCode =
@"Property Get Foo(ByVal b As Boolean) As String
End Property";
const string expectedCode =
@"Sub Foo(ByVal b As Boolean)
End Sub";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, module.Lines());
}
public void NonReturningFunction_ReturnsResult_MultipleFunctions()
{
const string inputCode =
@"Function Foo() As Boolean
End Function
Function Goo() As String
End Function";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(2, inspectionResults.Count());
}
public void NonReturningFunction_NoResult_GivenClassMemberCall()
{
const string code = @"
Public Function Foo() As Boolean
With New Class1
.ByRefAssign Foo
End With
End Function
";
const string classCode = @"
Public Sub ByRefAssign(ByRef b As Boolean)
End Sub
";
var builder = new MockVbeBuilder();
builder.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
.AddComponent("TestModule1", ComponentType.StandardModule, code)
.AddComponent("Class1", ComponentType.ClassModule, classCode);
var vbe = builder.Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void NonReturningFunction_ReturnsResult_InterfaceImplementation()
{
//Input
const string inputCode1 =
@"Function Foo() As Boolean
End Function";
const string inputCode2 =
@"Implements IClass1
Function IClass1_Foo() As Boolean
End Function";
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("TestProject1", ProjectProtection.Unprotected)
.AddComponent("IClass1", ComponentType.ClassModule, inputCode1)
.AddComponent("Class1", ComponentType.ClassModule, inputCode2)
.Build();
var vbe = builder.AddProject(project).Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
}
public void NonReturningPropertyGet_ReturnsResult()
{
const string inputCode =
@"Property Get Foo() As Boolean
End Property";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void NonReturningFunction_DoesNotReturnResult_Set()
{
const string inputCode =
@"Function Foo() As Collection
Set Foo = new Collection
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void NonReturningFunction_Ignored_DoesNotReturnResult()
{
const string inputCode =
@"'@Ignore NonReturningFunction
Function Foo() As Boolean
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsFalse(inspectionResults.Any());
}
public void NonReturningFunction_ReturnsResult()
{
const string inputCode =
@"Function Foo() As Boolean
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(1, inspectionResults.Count());
}
}
public void NonReturningFunction_DoesNotReturnResult()
{
const string inputCode =
@"Function Foo() As Boolean
Foo = True
End Function";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void NonReturningFunction_ReturnsResult_MultipleSubs_SomeReturning()
{
const string inputCode =
@"Function Foo() As Boolean
Foo = True
End Function
Function Goo() As String
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void GivenParameterizedPropertyGetter_QuickFixKeepsParameter()
{
const string inputCode =
@"Property Get Foo(ByVal b As Boolean) As String
End Property";
const string expectedCode =
@"Sub Foo(ByVal b As Boolean)
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
public void NonReturningFunction_QuickFixWorks_FunctionReturnsImplicitVariant()
{
const string inputCode =
@"Function Foo()
End Function";
const string expectedCode =
@"Sub Foo()
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
public void GivenNonReturningPropertyGetWithTypeHint_QuickFixDropsTypeHint()
{
const string inputCode =
@"Property Get Foo$()
End Property";
const string expectedCode =
@"Sub Foo()
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
public void NonReturningFunction_IgnoreQuickFixWorks()
{
const string inputCode =
@"Function Foo() As Boolean
End Function";
const string expectedCode =
@"'@Ignore NonReturningFunction
Function Foo() As Boolean
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
new IgnoreOnceQuickFix(state, new[] { inspection }).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
public void GivenFunctionNameWithTypeHint_SubNameHasNoTypeHint()
{
const string inputCode =
@"Function Foo$()
End Function";
const string expectedCode =
@"Sub Foo()
End Sub";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, component.CodeModule.Content());
}
public void NonReturningFunction_QuickFixWorks_FunctionHasVariable()
{
const string inputCode =
@"Function Foo(ByVal b As Boolean) As String
End Function";
const string expectedCode =
@"Sub Foo(ByVal b As Boolean)
End Sub";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, component.CodeModule.Content());
}
public void GivenImplicitVariantPropertyGetter_StillConvertsToSub()
{
const string inputCode =
@"Property Get Foo()
End Property";
const string expectedCode =
@"Sub Foo()
End Sub";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, component.CodeModule.Content());
}
public void GivenParameterizedPropertyGetter_QuickFixKeepsParameter()
{
const string inputCode =
@"Property Get Foo(ByVal b As Boolean) As String
End Property";
const string expectedCode =
@"Sub Foo(ByVal b As Boolean)
End Sub";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
Assert.AreEqual(expectedCode, component.CodeModule.Content());
}
public void NonReturningFunction_ReturnsResult_GivenParenthesizedByRefAssignment()
{
const string inputCode = @"
Public Function Foo() As Boolean
ByRefAssign (Foo)
End Function
Public Sub ByRefAssign(ByRef a As Boolean)
End Sub
";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(1, inspectionResults.Count());
}
}
public void NonReturningFunction_ReturnsResult_GivenUnassignedByRefAssignment_WithMemberAccess()
{
const string inputCode = @"
Public Function Foo() As Boolean
TestModule1.ByRefAssign False, Foo
End Function
Public Sub ByRefAssign(ByVal v As Boolean, ByRef a As Boolean)
'nope, not assigned
End Sub
";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(1, inspectionResults.Count());
}
}
public void NonReturningFunction_NoResult_GivenByRefAssignment_WithNamedArgument()
{
const string inputCode = @"
Public Function Foo() As Boolean
ByRefAssign b:=Foo
End Function
Public Sub ByRefAssign(Optional ByVal a As Long, Optional ByRef b As Boolean)
b = False
End Sub
";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void GivenImplicitVariantPropertyGetter_StillConvertsToSub()
{
const string inputCode =
@"Property Get Foo()
End Property";
const string expectedCode =
@"Sub Foo()
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
}
public void NonReturningFunction_QuickFixWorks_FunctionHasVariable()
{
const string inputCode =
@"Function Foo(ByVal b As Boolean) As String
End Function";
const string expectedCode =
@"Sub Foo(ByVal b As Boolean)
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
}
public void GivenFunctionNameWithTypeHint_SubNameHasNoTypeHint()
{
const string inputCode =
@"Function Foo$()
End Function";
const string expectedCode =
@"Sub Foo()
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out var component);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
Assert.AreEqual(expectedCode, state.GetRewriter(component).GetText());
}
}
public void NonReturningFunction_IgnoreQuickFixWorks()
{
const string inputCode =
@"Function Foo() As Boolean
End Function";
const string expectedCode =
@"'@Ignore NonReturningFunction
Function Foo() As Boolean
End Function";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new NonReturningFunctionInspection(state);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.Single(s => s is IgnoreOnceQuickFix).Fix();
Assert.AreEqual(expectedCode, component.CodeModule.Content());
}
public void NonReturningFunction_ReturnsResult_InterfaceImplementation_NoQuickFix()
{
//Input
const string inputCode1 =
@"Function Foo() As Boolean
End Function";
const string inputCode2 =
@"Implements IClass1
Function IClass1_Foo() As Boolean
End Function";
//Arrange
var builder = new MockVbeBuilder();
var project = builder.ProjectBuilder("TestProject1", vbext_ProjectProtection.vbext_pp_none)
.AddComponent("IClass1", vbext_ComponentType.vbext_ct_ClassModule, inputCode1)
.AddComponent("Class1", vbext_ComponentType.vbext_ct_ClassModule, inputCode2)
.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 NonReturningFunctionInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.First().QuickFixes.Count());
}
