Merge pull request #145 from mapbox/routable

Add routable points option and parse results

Author: Bobby Sudekum

MapboxGeocoder/MBGeocodeOptions.swift

@@ -64,6 +64,12 @@ open class GeocodeOptions: NSObject {
      */
     @objc open var locale: Locale?
 
+    
+    /**
+     A Boolean value that determines whether the resulting placemarks have the `Placemark.routableLocation` property set.
+     */
+    @objc open var includesRoutableLocations: Bool = false
+    
     fileprivate override init() {
         self.maximumResultCount = 0
         super.init()
@@ -101,6 +107,9 @@ open class GeocodeOptions: NSObject {
         if let languageCode = (locale as NSLocale?)?.object(forKey: .languageCode) as? String {
             params.append(URLQueryItem(name: "language", value: languageCode))
         }
+        
+        params.append(URLQueryItem(name: "routing", value: String(describing: includesRoutableLocations)))
+        
         return params
     }
 }

MapboxGeocoder/MBGeocoder.swift

@@ -70,7 +70,7 @@ extension CLLocationCoordinate2D {
     /**
      Initializes a coordinate pair based on the given GeoJSON array.
      */
-    internal init(geoJSON array: [Double]) {
+    internal init(geoJSON array: [CLLocationDegrees]) {
         assert(array.count == 2)
         self.init(latitude: array[1], longitude: array[0])
     }
@@ -83,6 +83,13 @@ extension CLLocation {
     internal convenience init(coordinate: CLLocationCoordinate2D) {
         self.init(latitude: coordinate.latitude, longitude: coordinate.longitude)
     }
+    
+    /**
+     Returns a GeoJSON compatible array of coordinates.
+     */
+    internal func geojson() -> [CLLocationDegrees] {
+        return [coordinate.longitude, coordinate.latitude]
+    }
 }
 
 /**

MapboxGeocoder/MBPlacemark.swift

@@ -385,12 +385,71 @@ internal struct Properties: Codable {
     let category: String?
 }
 
+// Used internally for flattening and transforming routable_points.points.coordinates
+internal struct RoutableLocation: Codable {
+    internal let coordinates: [Double]
+    
+    internal var coordinate: CLLocationCoordinate2D? {
+        if coordinates.count >= 2 {
+            return CLLocationCoordinate2D(latitude: coordinates[1], longitude: coordinates[0])
+        }
+        return nil
+    }
+}
+
 /**
  A concrete subclass of `Placemark` to represent results of geocoding requests.
  */
 @objc(MBGeocodedPlacemark)
 open class GeocodedPlacemark: Placemark {
 
+    private enum CodingKeys: String, CodingKey {
+        case routableLocations = "routable_points"
+    }
+    
+    private enum PointsCodingKeys: String, CodingKey {
+        case points
+    }
+    
+    /**
+     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.
+     */
+    @objc open var routableLocations: [CLLocation]?
+    
+    public required init(from decoder: Decoder) throws {
+        try super.init(from: decoder)
+        
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        
+        if let pointsContainer = try? container.nestedContainer(keyedBy: PointsCodingKeys.self, forKey: .routableLocations),
+            var coordinatesContainer = try? pointsContainer.nestedUnkeyedContainer(forKey: .points) {
+            
+            if let routableLocation = try coordinatesContainer.decodeIfPresent(RoutableLocation.self),
+                let coordinate = routableLocation.coordinate {
+                routableLocations = [CLLocation(coordinate: coordinate)]
+            }
+        }
+    }
+    
+    public override func encode(to encoder: Encoder) throws {
+        try super.encode(to: encoder)
+        
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        
+        if let routableLocations = routableLocations,
+            !routableLocations.isEmpty {
+            var pointsContainer = container.nestedContainer(keyedBy: PointsCodingKeys.self, forKey: .routableLocations)
+            var coordinatesContainer = pointsContainer.nestedUnkeyedContainer(forKey: .points)
+            let routableLocation = RoutableLocation(coordinates: [routableLocations[0].coordinate.longitude,
+                                                                  routableLocations[0].coordinate.latitude])
+            try coordinatesContainer.encode(routableLocation)
+        }
+    }
+    
     @objc open override var debugDescription: String {
         return qualifiedName!
     }

MapboxGeocoderTests/ForwardGeocodingTests.swift

@@ -39,6 +39,9 @@ class ForwardGeocodingTests: XCTestCase {
             XCTAssertEqual(task.state, URLSessionTask.State.completed)
         }
 
+        XCTAssertEqual(addressPlacemark.routableLocations![0].coordinate.longitude, CLLocationDegrees(138.995284))
+        XCTAssertEqual(addressPlacemark.routableLocations![0].coordinate.latitude, CLLocationDegrees(-34.470403))
+        
         XCTAssertEqual(addressPlacemark.description, "Pennsylvania Ave", "forward geocode should populate description")
         XCTAssertEqual(addressPlacemark.debugDescription, "Pennsylvania Ave, Wasaga Beach, Ontario L9Z 3A8, Canada", "forward geocode should populate debug description")
         XCTAssertEqual(addressPlacemark.name, "Pennsylvania Ave", "forward geocode should populate name")

MapboxGeocoderTests/fixtures/forward_valid.json

@@ -1 +1 @@
-{"type":"FeatureCollection","query":["1600","pennsylvania","ave"],"features":[{"id":"address.10133733172573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Wasaga Beach, Ontario L9Z 3A8, Canada","relevance":0.39,"properties":{},"center":[-79.9850737,44.5047077],"geometry":{"type":"Point","coordinates":[-79.9850737,44.5047077]},"context":[{"id":"place.655624","text":"Wasaga Beach","wikidata":"Q3047234"},{"id":"postcode.17609609551414490","text":"L9Z 3A8"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":"Q1904"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":null}]},{"id":"address.6485281316573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Vaughan, Ontario L4K 3X6, Canada","relevance":0.39,"properties":{},"center":[-79.532497,43.802232],"geometry":{"type":"Point","coordinates":[-79.532497,43.802232]},"context":[{"id":"neighborhood.5043724752221980","text":"Vellore Woods"},{"id":"place.646758","text":"Vaughan","wikidata":"Q44013"},{"id":"postcode.6385804433309570","text":"L4K 3X6"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":"Q1904"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":"Q16"}]},{"id":"address.12769812476573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Stellarton, Nova Scotia B0K 1S0, Canada","relevance":0.39,"properties":{},"center":[-62.661376,45.556068],"geometry":{"type":"Point","coordinates":[-62.661376,45.556068]},"context":[{"id":"place.593196","text":"Stellarton","wikidata":"Q3498168"},{"id":"postcode.13310912212063190","text":"B0K 1S0"},{"id":"region.10539239752558240","text":"Nova Scotia","short_code":"CA-NS","wikidata":" Q10116"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":null}]},{"id":"address.6456604709573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Vaughan, Ontario L4K 3X8, Canada","relevance":0.39,"properties":{},"center":[-79.531684,43.802706],"geometry":{"type":"Point","coordinates":[-79.531684,43.802706]},"context":[{"id":"neighborhood.5043724752221980","text":"Vellore Woods"},{"id":"place.646758","text":"Vaughan","wikidata":"Q44013"},{"id":"postcode.6367605302663760","text":"L4K 3X8"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":null},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":"Q16"}]}],"attribution":"NOTICE: © 2016 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service (https://www.mapbox.com/about/maps/). This response and the information it contains may not be retained."}
+{"type":"FeatureCollection","query":["1600","pennsylvania","ave"],"features":[{"id":"address.10133733172573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Wasaga Beach, Ontario L9Z 3A8, Canada","relevance":0.39,"properties":{},"center":[-79.9850737,44.5047077],"routable_points":{"points":[{"coordinates":[138.995284,-34.470403]}]},"geometry":{"type":"Point","coordinates":[-79.9850737,44.5047077]},"context":[{"id":"place.655624","text":"Wasaga Beach","wikidata":"Q3047234"},{"id":"postcode.17609609551414490","text":"L9Z 3A8"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":"Q1904"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":null}]},{"id":"address.6485281316573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Vaughan, Ontario L4K 3X6, Canada","relevance":0.39,"properties":{},"center":[-79.532497,43.802232],"geometry":{"type":"Point","coordinates":[-79.532497,43.802232]},"context":[{"id":"neighborhood.5043724752221980","text":"Vellore Woods"},{"id":"place.646758","text":"Vaughan","wikidata":"Q44013"},{"id":"postcode.6385804433309570","text":"L4K 3X6"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":"Q1904"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":"Q16"}]},{"id":"address.12769812476573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Stellarton, Nova Scotia B0K 1S0, Canada","relevance":0.39,"properties":{},"center":[-62.661376,45.556068],"geometry":{"type":"Point","coordinates":[-62.661376,45.556068]},"context":[{"id":"place.593196","text":"Stellarton","wikidata":"Q3498168"},{"id":"postcode.13310912212063190","text":"B0K 1S0"},{"id":"region.10539239752558240","text":"Nova Scotia","short_code":"CA-NS","wikidata":" Q10116"},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":null}]},{"id":"address.6456604709573100","type":"Feature","text":"Pennsylvania Ave","place_name":"Pennsylvania Ave, Vaughan, Ontario L4K 3X8, Canada","relevance":0.39,"properties":{},"center":[-79.531684,43.802706],"geometry":{"type":"Point","coordinates":[-79.531684,43.802706]},"context":[{"id":"neighborhood.5043724752221980","text":"Vellore Woods"},{"id":"place.646758","text":"Vaughan","wikidata":"Q44013"},{"id":"postcode.6367605302663760","text":"L4K 3X8"},{"id":"region.13373639426376420","text":"Ontario","short_code":"CA-ON","wikidata":null},{"id":"country.15589894856372040","text":"Canada","short_code":"ca","wikidata":"Q16"}]}],"attribution":"NOTICE: © 2016 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service (https://www.mapbox.com/about/maps/). This response and the information it contains may not be retained."}