Skip to content

Allow passing an array of values to stub #551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jdanthinne wants to merge 2 commits into from
Closed

Allow passing an array of values to stub #551

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc16c0a
Allow passing an array of values to stub
jdanthinne Apr 14, 2025
96a91ea
When passing an array of values, add inOrder argument name
jdanthinne May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Source/Stubbing/StubFunction/Trait/StubFunctionThenReturnTrait.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,12 @@ public extension StubFunctionThenReturnTrait {
}
return self
}

@discardableResult
func thenReturn(_ output: [OutputType]) -> Self {
output.forEach { output in
stub.appendAction(.returnValue(output))
}
return self
}
}
12 changes: 12 additions & 0 deletions Tests/Swift/Stubbing/StubbingTest.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ final class StubbingTest: XCTestCase {
XCTAssertEqual(mock.readOnlyProperty, "c")
}

func testReturningArray() {
let mock = MockTestedClass()
stub(mock) { mock in
when(mock.readOnlyProperty.get).thenReturn(["a", "b", "c"])
Copy link
Collaborator

@MatyasKriz MatyasKriz May 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this be ambiguous when the property is an array?

Copy link
Contributor Author

@jdanthinne jdanthinne May 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ambiguous for the compiler?
If readOnlyProperty is an array, the to generic method will translate to func thenReturn(_ output: [T], _ outputs: [T]...) -> Self and func thenReturn(_ output: [[T]]) -> Self.

So, if you give it a "simple" array (one dimension), it will known that it is the first method. I you give it an array of arrays (two dimensions), it will know that it is the second one.

Would you prefer to add a name to the argument for the new method, to be clearer for users?

Copy link
Collaborator

@MatyasKriz MatyasKriz May 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'd add something like inOrder: to the new method to disambiguate passing array of individually returned values from passing array as a singular one. I can imagine a scenario where some complex tests only tell the developer the classic "The compiler is unable to type-check this expression in reasonable time." because they might not know about the second method which returns the values one by one.

Copy link
Contributor Author

@jdanthinne jdanthinne May 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added the inOrder: parameter name.

}

XCTAssertEqual(mock.readOnlyProperty, "a")
XCTAssertEqual(mock.readOnlyProperty, "b")
XCTAssertEqual(mock.readOnlyProperty, "c")
XCTAssertEqual(mock.readOnlyProperty, "c")
}

func testOverrideStubWithMoreGeneralParameterMatcher() {
let mock = MockTestedClass()
stub(mock) { mock in
Expand Down
Loading