Skip to content
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.

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

Add Absolute url matcher #254

Merged
merged 8 commits into from
Jun 12, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# OHHTTPStubs — CHANGELOG

## Master
Added absoulte url matcher.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Small typo here ✏️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

[@victorg1991](https://github.com/victorg1991
Copy link
Collaborator

Choose a reason for hiding this comment

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

Typo here, missing closing parenthesis ✏️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dish! I'll fix tha in a minute : D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done 👍

[#252](https://github.com/AliSoftware/OHHTTPStubs/pull/252)
Copy link
Collaborator

Choose a reason for hiding this comment

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

The number of this PR is 254 😉

* Fixed up empty lines with whitespace inside test case classes.
[@mikelupo](https://github.com/mikelupo
[#251](https://github.com/AliSoftware/OHHTTPStubs/pull/251)
Expand Down
14 changes: 14 additions & 0 deletions OHHTTPStubs/Sources/Swift/OHHTTPStubsSwift.swift
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,20 @@ public func isMethodDELETE() -> OHHTTPStubsTestBlock {
return { $0.httpMethod == "DELETE" }
}

/**
* Matcher for testing an `NSURLRequest`'s **absolute url**.
*
* e.g. the absolute url is `https://api.example.com/signin` in `https://api.example.com/signin`
*
* - Parameter scheme: The absolute url to match
*
Copy link
Owner

Choose a reason for hiding this comment

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

Parameter url:

* - Returns: a matcher (OHHTTPStubsTestBlock) that succeeds only if the request
* has the given absolute url
*/
public func isAbsoluteUrl(_ url: String) -> OHHTTPStubsTestBlock {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am wondering if this should not be called isAbsoluteString to match the URL member we call underneath, because there is a URL.absoluteURL
🤔

Copy link
Owner

Choose a reason for hiding this comment

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

Totally. We tried to name most if not all our matchers from the name of the method we call underneath to make the relationship clear, use common vocabulary and avoid confusion so let's try to continue that way 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that isAbsoluteUrl has more meaning than the other option, but its up to you.
Do I have to change to isAbsoluteString? I could also do something like URL.absoluteURL.absoluteString ¯_(ツ)_/¯ haha
What do you think?

Copy link
Owner

Choose a reason for hiding this comment

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

The problem with isAbsoluteUrl is also that it doesn't follow the Swift naming convention, letting us believe that the expected parameter is an URL and not a String.
Otoh just "isAbsoluteString" without context (as it's a free function, not a method on a tour) is also ambiguous… maybe isAbsoluteURLString? But might be too long. Tbh I honestly don't know what's best suited (especially at 0:30am 😅)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I prefer isAbsoluteURLString over isAbsoluteString, it doesn't sound too bad :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So I rename to isAbsoluteURLString? @AliSoftware

Copy link
Owner

Choose a reason for hiding this comment

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

yeah seems like a good compromise 👍

return { req in req.url?.absoluteString == url }
}

/**
* Matcher for testing an `NSURLRequest`'s **scheme**.
*
Expand Down
22 changes: 22 additions & 0 deletions OHHTTPStubs/UnitTests/Test Suites/SwiftHelpersTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,28 @@ class SwiftHelpersTests : XCTestCase {
}
}

func testIsAbsoluteUrl() {
let matcher = isAbsoluteUrl("foo://foo/bar")

let urls = [
"foo:": false,
"foo://foo/bar/baz": false,
"foo://foo/bar": true,
"bar://foo/bar": false,
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe add one or two more complex examples, I'm especially thinking about URLs with query parameters and anchors etc

"bar://foo/ba": false,
"foobar://": false
]

for (url, result) in urls {
#if swift(>=3.0)
let req = URLRequest(url: URL(string: url)!)
#else
let req = NSURLRequest(URL: NSURL(string: url)!)
Copy link
Owner

Choose a reason for hiding this comment

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

Unrelated to this PR directly, but I see we have that pattern on multiple tests: maybe we should add a func request(from string: String) -> URLRequest helper function for our tests, responsible for handling Swift 2/3 compatibility, and use that in our test cases to avoid repeating those #if Swift(>=3.0) everywhere? (Might be a separate PR though)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I agree. But I think this should be in another PR.

#endif
XCTAssert(matcher(req) == result, "isAbsoluteUrl(\"foo://foo/bar\") matcher failed when testing url \(url)")
}
}

func testIsScheme() {
let matcher = isScheme("foo")

Expand Down