Intersections indicate preferred lane usage #529

jill-cardamon · 2021-03-24T14:25:41Z

Description

This PR adds new Directions API response properties that indicate preferred lane usage #516.

Add new Lane object properties
Add new Instruction component property
Update tests for lane object propeties
Update tests for instruction component property
Update CHANGELOG.md

Implementation

For the banner instruction component object property active_direction: added preferredDirection argument (of type LaneIndication?) associated value of the VisualInstruction.Component.lane(indications:isUsable:) enumeration case.

For the lane object properties active and valid_indication: Added Intersection.preferredApproachLanes property (of type IndexSet?) modeled after Intersection.usableApproachLanes, added Intersection.usableLaneIndication property (of type LaneIndication?).

1ec5 · 2021-03-29T17:12:55Z

The build is currently erroring on type checking:

/Users/distiller/project/Tests/MapboxDirectionsTests/VisualInstructionTests.swift:259:107: error: type of expression is ambiguous without more context
            if case let VisualInstruction.Component.lane(indications, isUsable) = laneIndicationComponents[0] {
                                                                                  ~~~~~~~~~~~~~~~~~~~~~~~~^~~
/Users/distiller/project/Tests/MapboxDirectionsTests/VisualInstructionTests.swift:263:107: error: type of expression is ambiguous without more context
            if case let VisualInstruction.Component.lane(indications, isUsable) = laneIndicationComponents[1] {
                                                                                  ~~~~~~~~~~~~~~~~~~~~~~~~^~~
                     ^

Looks like the tests just need to be updated to account for a new argument to .lane.

README.md

jill-cardamon · 2021-03-29T17:49:19Z

I had one assertion that was failing, so I didn't push those updated tests.

CHANGELOG.md

README.md

Sources/MapboxDirections/Intersection.swift

1ec5 · 2021-04-02T01:17:30Z

CHANGELOG.md

@@ -6,6 +6,9 @@
 * This library requires Turf v2.0.0-alpha.3. ([#525](https://github.com/mapbox/mapbox-directions-swift/pull/525))
 * The `Incident.impact` property is now an `Incident.Impact` value instead of a string. ([#519](https://github.com/mapbox/mapbox-directions-swift/pull/519))

+## v2.0.0
+* Added the `Intersection.preferredApproachLanes`, `Intersection.usableLaneIndication`, `Lane.isActive`, and `Lane.validIndication` properties that indicate preferred lane usage. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))


The Lane struct is internal, so we shouldn’t mention it in the changelog; the additions to Intersection are what concern developers. However, we should also mention that the VisualInstruction.Component.lane(indications:isUsable:) case has been renamed to VisualInstruction.Component.lane(indications:isUsable:preferredDirection:).

1ec5

There’s a little bit of fallout from the original merge in the readme. Otherwise, there are a few minor nits; feel free to merge once they’re addressed.

1ec5 · 2021-04-02T22:06:16Z

CHANGELOG.md

@@ -6,6 +6,9 @@
 * This library requires Turf v2.0.0-alpha.3. ([#525](https://github.com/mapbox/mapbox-directions-swift/pull/525))
 * The `Incident.impact` property is now an `Incident.Impact` value instead of a string. ([#519](https://github.com/mapbox/mapbox-directions-swift/pull/519))

+## v2.0.0


Even the whole section above is for v2.0.0, but we can clean it up after merging the PR.

1ec5 · 2021-04-02T22:07:23Z

README.md

-
-## Pricing
-
-API calls made to the Directions API are individually billed by request. Review the [pricing information](https://docs.mapbox.com/api/navigation/directions/#directions-api-pricing) and the [pricing page](https://www.mapbox.com/pricing/#directions) for current rates.


This part shouldn’t be removed. We expect it to no longer be part of the diff after rebasing, but it should remain in the codebase because it’s now in release-v2.0.

1ec5 · 2021-04-02T22:11:53Z

Sources/MapboxDirections/Intersection.swift

+            var usableIndications = [LaneIndication]()
+            lanes.forEach { lane in
+                if lane.validIndication != nil {
+                    usableIndications.append(lane.validIndication!)
+                }
+            }


Nit: This can be written more succinctly and without an implicitly unwrapped optional:

Suggested change

var usableIndications = [LaneIndication]()

lanes.forEach { lane in

if lane.validIndication != nil {

usableIndications.append(lane.validIndication!)

}

}

let usableIndications = lanes.compactMap { lane.validIndication }

1ec5 · 2021-04-02T22:14:14Z

CHANGELOG.md

@@ -6,6 +6,9 @@
 * This library requires Turf v2.0.0-alpha.3. ([#525](https://github.com/mapbox/mapbox-directions-swift/pull/525))
 * The `Incident.impact` property is now an `Incident.Impact` value instead of a string. ([#519](https://github.com/mapbox/mapbox-directions-swift/pull/519))

+## v2.0.0
+* Added the `Intersection.preferredApproachLanes` and `Intersection.usableLaneIndication` properties that indicate preferred lane usage. `VisualInstruction.Component.lane(indications:isUsable:)` has been renamed to `VisualInstruction.Component.lane(indications:isUsable:preferredDirection:)`. Note that comparison for `Intersection`s is now stricter around road classes, regions, and rest stops. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))


Suggested change

* Added the `Intersection.preferredApproachLanes` and `Intersection.usableLaneIndication` properties that indicate preferred lane usage. `VisualInstruction.Component.lane(indications:isUsable:)` has been renamed to `VisualInstruction.Component.lane(indications:isUsable:preferredDirection:)`. Note that comparison for `Intersection`s is now stricter around road classes, regions, and rest stops. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))

* Added the `Intersection.preferredApproachLanes` and `Intersection.usableLaneIndication` properties that indicate preferred lane usage. `VisualInstruction.Component.lane(indications:isUsable:)` has been renamed to `VisualInstruction.Component.lane(indications:isUsable:preferredDirection:)`. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))

* Comparing two `Intersection`s with `==` now considers whether the `Intersection.restStop`, `Intersection.regionCode`, and `Intersection.outletMapboxStreetsRoadClass` properties are equal. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))

1ec5 · 2021-04-02T22:16:43Z

Sources/MapboxDirections/Lane.swift

+        let str = validIndication?.descriptions.first
+        try container.encodeIfPresent(str, forKey: .preferred)


Nit: Use a more descriptive constant name or inline it into the next line:

Suggested change

let str = validIndication?.descriptions.first

try container.encodeIfPresent(str, forKey: .preferred)

try container.encodeIfPresent(validIndication?.descriptions.first, forKey: .preferred)

1ec5 · 2021-04-02T22:18:30Z

Sources/MapboxDirections/Lane.swift

+        if let str = try container.decodeIfPresent(String.self, forKey: .preferred) {
+            validIndication = LaneIndication(descriptions: [str])
+        }


This is a bit of a workaround for the fact that LaneIndication always corresponds to an array of values in JSON, whereas we’re using the type here out of convenience for roundtripping one “description” element within such an array. To make the use of lane indication descriptions more apparent, we can name the variable a bit more verbosely:

Suggested change

if let str = try container.decodeIfPresent(String.self, forKey: .preferred) {

validIndication = LaneIndication(descriptions: [str])

}

if let validIndicationDescription = try container.decodeIfPresent(String.self, forKey: .preferred) {

validIndication = LaneIndication(descriptions: [validIndicationDescription])

}

jill-cardamon self-assigned this Mar 24, 2021

jill-cardamon added this to the v2.0.0 (RC) milestone Mar 24, 2021

jill-cardamon added Core improvement Improvement for an existing feature. platform parity labels Mar 24, 2021

jill-cardamon linked an issue Mar 24, 2021 that may be closed by this pull request

Intersections should indicate preferred lane usage #516

Closed

jill-cardamon marked this pull request as ready for review March 29, 2021 15:02

1ec5 reviewed Mar 29, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

jill-cardamon force-pushed the jill/preferredLaneUsage-516 branch from 05463ba to 92880c5 Compare March 31, 2021 17:43

jill-cardamon commented Apr 1, 2021

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

1ec5 reviewed Apr 2, 2021

View reviewed changes

Jill Cardamon added 7 commits April 2, 2021 17:54

initial implementation

ce18dad

properties added to VisualInstructionComponent pass updated tests

169088e

encoding/decoding for usableLaneIndication is finished, all tests pass

ef188fa

update CHANGELOG.md

887acc2

make sure VisualInstructionTests pass

3eb3e16

all tests pass

133c671

remove pricing from README.md

ee8d778

jill-cardamon force-pushed the jill/preferredLaneUsage-516 branch from 92880c5 to ee8d778 Compare April 2, 2021 21:55

1ec5 approved these changes Apr 2, 2021

View reviewed changes

incorporate feedback, checkout release-v2.0 version of README.md

78a4484

1ec5 approved these changes Apr 2, 2021

View reviewed changes

jill-cardamon merged commit 800f942 into release-v2.0 Apr 2, 2021

1ec5 deleted the jill/preferredLaneUsage-516 branch April 2, 2021 23:11

This was referenced Apr 5, 2021

Fix VisualInstruction.component.lane type mismatch #532

Merged

Preferred lane direction should be a ManeuverDirection, not a LaneIndication #534

Closed

jill-cardamon mentioned this pull request Apr 12, 2021

Preferred lane direction is now a ManeuverDirection #535

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Intersections indicate preferred lane usage #529

Intersections indicate preferred lane usage #529

jill-cardamon commented Mar 24, 2021 •

edited

Loading

1ec5 commented Mar 29, 2021 •

edited

Loading

jill-cardamon commented Mar 29, 2021

1ec5 Apr 2, 2021

1ec5 left a comment

1ec5 Apr 2, 2021

1ec5 Apr 2, 2021

1ec5 Apr 2, 2021

1ec5 Apr 2, 2021

1ec5 Apr 2, 2021

1ec5 Apr 2, 2021 •

edited

Loading


		## Pricing

		API calls made to the Directions API are individually billed by request. Review the [pricing information](https://docs.mapbox.com/api/navigation/directions/#directions-api-pricing) and the [pricing page](https://www.mapbox.com/pricing/#directions) for current rates.

	* Added the `Intersection.preferredApproachLanes` and `Intersection.usableLaneIndication` properties that indicate preferred lane usage. `VisualInstruction.Component.lane(indications:isUsable:)` has been renamed to `VisualInstruction.Component.lane(indications:isUsable:preferredDirection:)`. Note that comparison for `Intersection`s is now stricter around road classes, regions, and rest stops. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))
	* Added the `Intersection.preferredApproachLanes` and `Intersection.usableLaneIndication` properties that indicate preferred lane usage. `VisualInstruction.Component.lane(indications:isUsable:)` has been renamed to `VisualInstruction.Component.lane(indications:isUsable:preferredDirection:)`. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))
	* Comparing two `Intersection`s with `==` now considers whether the `Intersection.restStop`, `Intersection.regionCode`, and `Intersection.outletMapboxStreetsRoadClass` properties are equal. ([#529](https://github.com/mapbox/mapbox-directions-swift/pull/529))

		let str = validIndication?.descriptions.first
		try container.encodeIfPresent(str, forKey: .preferred)

	let str = validIndication?.descriptions.first
	try container.encodeIfPresent(str, forKey: .preferred)
	try container.encodeIfPresent(validIndication?.descriptions.first, forKey: .preferred)

Intersections indicate preferred lane usage #529

Intersections indicate preferred lane usage #529

Conversation

jill-cardamon commented Mar 24, 2021 • edited Loading

Description

Implementation

1ec5 commented Mar 29, 2021 • edited Loading

jill-cardamon commented Mar 29, 2021

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 left a comment

Choose a reason for hiding this comment

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 Apr 2, 2021

Choose a reason for hiding this comment

1ec5 Apr 2, 2021 • edited Loading

Choose a reason for hiding this comment

jill-cardamon commented Mar 24, 2021 •

edited

Loading

1ec5 commented Mar 29, 2021 •

edited

Loading

1ec5 Apr 2, 2021 •

edited

Loading