Add Absolute url matcher #254
Conversation
There was a problem hiding this comment.
Hi @victorg1991
Thank you for your contribution following the guidelines and templates 🎉
I am wondering if we should add this new function as-is or if it should be renamed.
Let's summon @AliSoftware to see what he thinks about that 😁
CHANGELOG.md
Outdated
| @@ -1,6 +1,9 @@ | |||
| # OHHTTPStubs — CHANGELOG | |||
|
|
|||
| ## Master | |||
| Added absoulte url matcher. | |||
CHANGELOG.md
Outdated
| @@ -1,6 +1,9 @@ | |||
| # OHHTTPStubs — CHANGELOG | |||
|
|
|||
| ## Master | |||
| Added absoulte url matcher. | |||
| [@victorg1991](https://github.com/victorg1991 | |||
| [#252](https://github.com/AliSoftware/OHHTTPStubs/pull/252) | |||
There was a problem hiding this comment.
The number of this PR is 254 😉
| * - Returns: a matcher (OHHTTPStubsTestBlock) that succeeds only if the request | ||
| * has the given absolute url | ||
| */ | ||
| public func isAbsoluteUrl(_ url: String) -> OHHTTPStubsTestBlock { |
There was a problem hiding this comment.
I am wondering if this should not be called isAbsoluteString to match the URL member we call underneath, because there is a URL.absoluteURL
🤔
There was a problem hiding this comment.
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 😉
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 😅)
There was a problem hiding this comment.
I prefer isAbsoluteURLString over isAbsoluteString, it doesn't sound too bad :)
There was a problem hiding this comment.
So I rename to isAbsoluteURLString? @AliSoftware
There was a problem hiding this comment.
yeah seems like a good compromise 👍
CHANGELOG.md
Outdated
| @@ -1,6 +1,9 @@ | |||
| # OHHTTPStubs — CHANGELOG | |||
|
|
|||
| ## Master | |||
| Added absolute url matcher. | |||
There was a problem hiding this comment.
Don't forget the * to create a bullet point
| @@ -158,6 +158,20 @@ public func isMethodDELETE() -> OHHTTPStubsTestBlock { | |||
| } | |||
|
|
|||
| /** | |||
| * 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` | |||
There was a problem hiding this comment.
Maybe use a more contrived example like with x=1&y=2#anchor query + anchor?
| * e.g. the absolute url is `https://api.example.com/signin` in `https://api.example.com/signin` | ||
| * | ||
| * - Parameter scheme: The absolute url to match | ||
| * |
| * - Returns: a matcher (OHHTTPStubsTestBlock) that succeeds only if the request | ||
| * has the given absolute url | ||
| */ | ||
| public func isAbsoluteUrl(_ url: String) -> OHHTTPStubsTestBlock { |
There was a problem hiding this comment.
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 😉
| "foo:": false, | ||
| "foo://foo/bar/baz": false, | ||
| "foo://foo/bar": true, | ||
| "bar://foo/bar": false, |
There was a problem hiding this comment.
Maybe add one or two more complex examples, I'm especially thinking about URLs with query parameters and anchors etc
|
Done! |
CHANGELOG.md
Outdated
| @@ -1,6 +1,9 @@ | |||
| # OHHTTPStubs — CHANGELOG | |||
|
|
|||
| ## Master | |||
| * Added absolute url matcher. | |||
| [@victorg1991](https://github.com/victorg1991 | |||
There was a problem hiding this comment.
Typo here, missing closing parenthesis ✏️
There was a problem hiding this comment.
Dish! I'll fix tha in a minute : D
| #if swift(>=3.0) | ||
| let req = URLRequest(url: URL(string: url)!) | ||
| #else | ||
| let req = NSURLRequest(URL: NSURL(string: url)!) |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Yes, I agree. But I think this should be in another PR.
Checklist
Description
This PR adds a matcher for the url matcher
Motivation and Context
Sometimes it's useful to match urls by the absolute url
I've created a test to changes the changes and run all the test 100% success