Make RouteOptions available on route response #122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1ec5
approved these changes
Apr 13, 2017
MapboxDirections/MBRoute.swift
Outdated
| @@ -26,12 +26,12 @@ open class Route: NSObject, NSSecureCoding { | |||
| - parameter waypoints: An array of waypoints that the route visits in chronological order. | |||
| - parameter profileIdentifier: The profile identifier used to request the routes. | |||
There was a problem hiding this comment.
This parameter has been replaced by routeOptions.
MapboxDirections/MBRoute.swift
Outdated
| @@ -156,18 +156,16 @@ open class Route: NSObject, NSSecureCoding { | |||
| open let expectedTravelTime: TimeInterval | |||
|
|
|||
| /** | |||
| A string specifying the primary mode of transportation for the route. | |||
|
|
|||
| The value of this property is `MBDirectionsProfileIdentifierAutomobile`, `MBDirectionsProfileIdentifierAutomobileAvoidingTraffic`, `MBDirectionsProfileIdentifierCycling`, or `MBDirectionsProfileIdentifierWalking`, depending on the `profileIdentifier` property of the original `RouteOptions` object. This property reflects the primary mode of transportation used for the route. Individual steps along the route might use different modes of transportation as necessary. | |||
There was a problem hiding this comment.
Developers may not be aware of this nuance, so we might want to leave it in:
The route options object’s
profileIdentifierproperty reflects the primary mode of transportation used for the route. Individual steps along the route might use different modes of transportation as necessary.
MapboxDirectionsTests/V5Tests.swift
Outdated
| XCTAssertTrue(opts.includesSteps) | ||
| XCTAssertTrue(opts.includesAlternativeRoutes) | ||
| XCTAssertEqual(opts.routeShapeResolution, .full) | ||
|
|
||
| XCTAssertNotNil(route) |
There was a problem hiding this comment.
Move this assertion up above any assertions that depend on route being non-nil.
MapboxDirectionsTests/V5Tests.swift
Outdated
| @@ -52,6 +52,13 @@ class V5Tests: XCTestCase { | |||
| XCTAssertEqual(task.state, .completed) | |||
| } | |||
|
|
|||
| let opts = route!.routeOptions | |||
|
|
|||
| XCTAssertEqual(opts.profileIdentifier, .automobile) | |||
There was a problem hiding this comment.
Might as well assert that route!.routeOptions is equal to options. That way we can be sure they’re literally the same object; no need to compare individual properties on them.
1ec5
added
the
backwards incompatible
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of returning the profile identifier on the route, this replaces it with the entire RouteOptions used to create the directions request.
/cc @frederoni @1ec5