Add routable points option and parse results #145

bsudekum · 2018-04-30T22:47:40Z

Closes: #144

Adds the option to get routable points back in the response and also an option to request routable points.

Currently, the response will look like:

 routable_points: {
    points: [{ coordinates: [lon, lat] }]
}

Paging codable experts @JThramer @frederoni, I'm slightly unsure if this is the preferred method for parsing optional + nested dictionaries.

frederoni · 2018-05-02T08:43:43Z

MapboxGeocoder/MBPlacemark.swift

+
+        if let points = try? container.nestedContainer(keyedBy: RoutableLocationsKeys.self, forKey: .routableLocations),
+            let coordinatePairs = try points.decodeIfPresent([[CLLocationDegrees]].self, forKey: .points) {
+            let coordinates = coordinatePairs.map { CLLocationCoordinate2D(geoJSON: $0) }


Adding support for Codable CLLocationCoordinate2D by adding an extension would be cleaner but wouldn't be worth it until the decoding bottleneck is fixed.

frederoni · 2018-05-02T08:45:09Z

MapboxGeocoder/MBPlacemark.swift

+    /**
+     An array of locations representing the location a user should navigate to to reach the `Placemark`.
+     */
+    @objc open var routableLocations: [CLLocationCoordinate2D]?


routableCoordinates since it's a list of coordinates?
or, make it [CLLocation]? so that it also bridges to Objective-C?

Yes, let’s use an array of CLLocation or Placemark, for Objective-C compatibility.

1ec5 · 2018-05-04T17:49:52Z

MapboxGeocoder/MBPlacemark.swift

+    /**
+     An array of locations representing the location a user should navigate to to reach the `Placemark`.
+     */
+    @objc open var routableLocations: [CLLocationCoordinate2D]?


Should this property be available on all Placemark objects, or only GeocodedPlacemark objects? Consider that a “routable location” makes little sense for a QualifyingPlacemark.

1ec5 · 2018-05-04T17:50:09Z

MapboxGeocoder/MBGeocodeOptions.swift

@@ -64,6 +64,14 @@ open class GeocodeOptions: NSObject {
     */
    @objc open var locale: Locale?

+
+    /**
+     If true, the response will possibly include a `routableLocation`.


A Boolean value that determines whether the resulting placemarks have the Placemark.routableLocation property set.

1ec5 · 2018-05-04T17:58:24Z

MapboxGeocoder/MBGeocodeOptions.swift

+    /**
+     If true, the response will possibly include a `routableLocation`.
+
+     `routableLocation` represents the best location for a vehicle to navigate to.


Let’s remove this line in favor of more documentation for routableLocation itself.

1ec5 · 2018-05-04T17:58:50Z

MapboxGeocoder/MBGeocodeOptions.swift

+
+     `routableLocation` represents the best location for a vehicle to navigate to.
+     */
+    @objc open var includeRoutableLocations: Bool = false


Rename this property to includesRoutableLocations.

1ec5 · 2018-05-04T18:16:35Z

MapboxGeocoder/MBPlacemark.swift

@@ -352,6 +364,11 @@ open class Placemark: NSObject, Codable {
        }
        return String(describing: houseNumber)
    }
+
+    /**
+     An array of locations representing the location a user should navigate to to reach the `Placemark`.


An array of locations that serve as hints for navigating to the placemark.

If the GeocodeOptions.includesRoutableLocations property is set to true, this property contains locations that are suitable to use as a waypoint in a routing engine such as MapboxDirections.swift. Otherwise, if the GeocodeOptions.includesRoutableLocations property is set to false, this property is set to nil.

For the placemark’s geographic center, use the location property. The routable locations may differ from the geographic center. For example, if a house’s driveway leads to a street other than the nearest street (by straight-line distance), then this property may contain the location where the driveway meets the street. A route to the placemark’s geographic center may be impassable, but a route to the routable location would end on the correct street with access to the house.

akitchen · 2018-05-18T19:25:27Z

Is anything needed to move this forward, other than bumping CI following the funny business with Travis?

1ec5 · 2018-05-18T22:01:56Z

MapboxGeocoder/MBPlacemark.swift

+
+     For the placemark’s geographic center, use the `location` property. The routable locations may differ from the geographic center. For example, if a house’s driveway leads to a street other than the nearest street (by straight-line distance), then this property may contain the location where the driveway meets the street. A route to the placemark’s geographic center may be impassable, but a route to the routable location would end on the correct street with access to the house.
+     */
+    @objc open var routableLocations: [CLLocation]?


I think we should move this property to GeocodedPlacemark, since it doesn’t make sense as a property of QualifyingPlacemark. We’ll need to define an initializer explicitly for GeocodedPlacemark.

/ref #145 (comment)

frederoni · 2018-05-29T21:06:10Z

<br>
after a second look at the description, it looks like

```json
"routable_points": {
    "points": [{ "coordinates": [lon, lat] }]
}
```
is the correct response.

Bobby Sudekum added 2 commits April 30, 2018 15:43

Add routable points option and parse results

772fefe

spelling

163c78e

bsudekum requested review from frederoni and JThramer May 1, 2018 18:38

frederoni reviewed May 2, 2018

View reviewed changes

1ec5 reviewed May 4, 2018

View reviewed changes

Doc update, change names and types

d9e787e

1ec5 reviewed May 18, 2018

View reviewed changes

frederoni added 2 commits May 29, 2018 23:02

Encode and decode routable points

c8aaa8b

Test routable points

81494fa

Update routable points structure

f1ef7db

frederoni force-pushed the routable branch from c67fbea to f1ef7db Compare May 29, 2018 22:25

bsudekum merged commit 2dec3ec into master May 30, 2018

bsudekum deleted the routable branch May 30, 2018 17:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add routable points option and parse results #145

Add routable points option and parse results #145

bsudekum commented Apr 30, 2018

frederoni May 2, 2018

frederoni May 2, 2018 •

edited

Loading

1ec5 May 4, 2018

1ec5 May 4, 2018

1ec5 May 4, 2018

1ec5 May 4, 2018

1ec5 May 4, 2018

1ec5 May 4, 2018

akitchen commented May 18, 2018

1ec5 May 18, 2018

frederoni commented May 29, 2018 •

edited

Loading

Add routable points option and parse results #145

Add routable points option and parse results #145

Conversation

bsudekum commented Apr 30, 2018

Choose a reason for hiding this comment

frederoni May 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akitchen commented May 18, 2018

Choose a reason for hiding this comment

frederoni commented May 29, 2018 • edited Loading

frederoni May 2, 2018 •

edited

Loading

frederoni commented May 29, 2018 •

edited

Loading