Route refreshing (#634)

* vk-3621-route-refreshing: added routeRefreshSource protocol to allow refreshing route with both RefreshedRoute and another Route instance; CHANGELOG updated
mapbox · Jan 12, 2022 · c361a77 · c361a77
1 parent 81e4e76
commit c361a77
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Added the `RouteResponse.roadClassViolations` property, which indicates any requested `RouteOptions.roadClassesToAvoid` values that could not be satisfied when calculating the routes. You can use convenience `RouteResponse.exclusionViolations(routeIndex:legIndex:stepIndex:intersectionIndex:)` method to search for a specific item. ([#627](https://github.com/mapbox/mapbox-directions-swift/pull/627))
 * Fixed an issue where `PolyLineString` encoded an invalid GeoJSON LineString. ([#638](https://github.com/mapbox/mapbox-directions-swift/pull/638))
+* Added `RouteRefreshSource` protocol to allow refreshing `Route` objects with `RefreshedRoute` or another `Route` instance. ([#634](https://github.com/mapbox/mapbox-directions-swift/pull/634))
 
 ## v2.1.0
 

diff --git a/MapboxDirections.xcodeproj/project.pbxproj b/MapboxDirections.xcodeproj/project.pbxproj
@@ -76,6 +76,10 @@
 		2BBBD08E257FA1CD004EB3D6 /* BlockedLanes.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BBBD08C257FA1CD004EB3D6 /* BlockedLanes.swift */; };
 		2BBBD08F257FA1CD004EB3D6 /* BlockedLanes.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BBBD08C257FA1CD004EB3D6 /* BlockedLanes.swift */; };
 		2BBBD090257FA1CD004EB3D6 /* BlockedLanes.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BBBD08C257FA1CD004EB3D6 /* BlockedLanes.swift */; };
+		2BF398C527620CD7000C9A72 /* RouteRefreshSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */; };
+		2BF398C627620CD7000C9A72 /* RouteRefreshSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */; };
+		2BF398C727620CD7000C9A72 /* RouteRefreshSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */; };
+		2BF398C827620CD7000C9A72 /* RouteRefreshSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */; };
 		35828C9E217A003F00ED546E /* OfflineDirections.swift in Sources */ = {isa = PBXBuildFile; fileRef = 35828C9D217A003F00ED546E /* OfflineDirections.swift */; };
 		35828C9F217A003F00ED546E /* OfflineDirections.swift in Sources */ = {isa = PBXBuildFile; fileRef = 35828C9D217A003F00ED546E /* OfflineDirections.swift */; };
 		35828CA0217A003F00ED546E /* OfflineDirections.swift in Sources */ = {isa = PBXBuildFile; fileRef = 35828C9D217A003F00ED546E /* OfflineDirections.swift */; };
@@ -489,6 +493,7 @@
 		2BA98970253F007600B643F6 /* mapbox-directions-swift */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = "mapbox-directions-swift"; sourceTree = BUILT_PRODUCTS_DIR; };
 		2BBBD05D257E61ED004EB3D6 /* MapboxStreetsRoadClass.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MapboxStreetsRoadClass.swift; sourceTree = "<group>"; };
 		2BBBD08C257FA1CD004EB3D6 /* BlockedLanes.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BlockedLanes.swift; sourceTree = "<group>"; };
+		2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RouteRefreshSource.swift; sourceTree = "<group>"; };
 		3556CE9922649CF2009397B5 /* MapboxDirectionsTests-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "MapboxDirectionsTests-Bridging-Header.h"; path = "../objc/MapboxDirectionsTests-Bridging-Header.h"; sourceTree = "<group>"; };
 		35828C9D217A003F00ED546E /* OfflineDirections.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OfflineDirections.swift; sourceTree = "<group>"; };
 		35CC310A2285739700EA1966 /* WalkingOptionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WalkingOptionsTests.swift; sourceTree = "<group>"; };
@@ -824,6 +829,7 @@
 				2B5407EC2451B17E006C820B /* RouteRefreshResponse.swift */,
 				2B5F0DFF273BEB3600CC2C1A /* RoadClassExclusionViolation.swift */,
 				2B5407F12452FA8C006C820B /* RefreshedRoute.swift */,
+				2BF398C427620CD7000C9A72 /* RouteRefreshSource.swift */,
 				43538E3623ED3B1600E010D4 /* ResponseDisposition.swift */,
 				DA2E03E81CB0E0B000D1269A /* RouteStep.swift */,
 				C55FB44A1F6AEBF6006BD1E9 /* SpokenInstruction.swift */,
@@ -1439,6 +1445,7 @@
 				2B9F388A272AE23A001DBA12 /* IsochroneError.swift in Sources */,
 				431E93C823466B4000A71B44 /* CoreLocation.swift in Sources */,
 				AEDC212120B6125C0052DED8 /* VisualInstructionComponent.swift in Sources */,
+				2BF398C627620CD7000C9A72 /* RouteRefreshSource.swift in Sources */,
 				2B9F3886272AE23A001DBA12 /* IsochroneOptions.swift in Sources */,
 				439255792344113D006EEE88 /* DirectionsError.swift in Sources */,
 				DA1A10C71D00F969009F82FA /* Directions.swift in Sources */,
@@ -1532,6 +1539,7 @@
 				2B9F388B272AE23A001DBA12 /* IsochroneError.swift in Sources */,
 				431E93C923466B4100A71B44 /* CoreLocation.swift in Sources */,
 				AEDC212220B6125D0052DED8 /* VisualInstructionComponent.swift in Sources */,
+				2BF398C727620CD7000C9A72 /* RouteRefreshSource.swift in Sources */,
 				2B9F3887272AE23A001DBA12 /* IsochroneOptions.swift in Sources */,
 				4392557A2344113E006EEE88 /* DirectionsError.swift in Sources */,
 				DA1A10ED1D010247009F82FA /* Directions.swift in Sources */,
@@ -1625,6 +1633,7 @@
 				2B9F388C272AE23A001DBA12 /* IsochroneError.swift in Sources */,
 				431E93CA23466B4200A71B44 /* CoreLocation.swift in Sources */,
 				AEDC212320B6125E0052DED8 /* VisualInstructionComponent.swift in Sources */,
+				2BF398C827620CD7000C9A72 /* RouteRefreshSource.swift in Sources */,
 				2B9F3888272AE23A001DBA12 /* IsochroneOptions.swift in Sources */,
 				4392557B2344113F006EEE88 /* DirectionsError.swift in Sources */,
 				DA1A11041D0103A3009F82FA /* Directions.swift in Sources */,
@@ -1684,6 +1693,7 @@
 				2B9F3889272AE23A001DBA12 /* IsochroneError.swift in Sources */,
 				431E93C723466B3F00A71B44 /* CoreLocation.swift in Sources */,
 				AEDC211D20B6104B0052DED8 /* VisualInstructionComponent.swift in Sources */,
+				2BF398C527620CD7000C9A72 /* RouteRefreshSource.swift in Sources */,
 				2B9F3885272AE23A001DBA12 /* IsochroneOptions.swift in Sources */,
 				439255772344113B006EEE88 /* DirectionsError.swift in Sources */,
 				DA2E03E91CB0E0B000D1269A /* RouteStep.swift in Sources */,

diff --git a/Sources/MapboxDirections/RouteRefreshResponse.swift b/Sources/MapboxDirections/RouteRefreshResponse.swift
@@ -99,9 +99,9 @@ extension Route {
      
      - parameter refreshedRoute: The route containing leg attributes to merge into the receiver. If this route contains fewer legs than the receiver, this method skips legs from the beginning of the route to make up the difference, so that merging the attributes from a one-leg route affects only the last leg of the receiver.
      */
-    public func refreshLegAttributes(from refreshedRoute: RefreshedRoute) {
-        for (leg, refreshedLeg) in zip(legs.suffix(refreshedRoute.legs.count), refreshedRoute.legs) {
-            leg.attributes = refreshedLeg.attributes
+    public func refreshLegAttributes(from refreshedRoute: RouteRefreshSource) {
+        for (leg, refreshedLeg) in zip(legs.suffix(refreshedRoute.refreshedLegs.count), refreshedRoute.refreshedLegs) {
+            leg.attributes = refreshedLeg.refreshedAttributes
         }
     }
 }
diff --git a/Sources/MapboxDirections/RouteRefreshSource.swift b/Sources/MapboxDirections/RouteRefreshSource.swift
@@ -0,0 +1,37 @@
+import Foundation
+
+/**
+ A skeletal route containing infromation to refresh `Route` object attributes.
+ */
+public protocol RouteRefreshSource {
+    var refreshedLegs: [RouteLegRefreshSource] { get }
+}
+
+/**
+ A skeletal route leg containing infromation to refresh `RouteLeg` object attributes.
+ */
+public protocol RouteLegRefreshSource {
+    var refreshedAttributes: RouteLeg.Attributes { get }
+}
+
+extension Route: RouteRefreshSource {
+    public var refreshedLegs: [RouteLegRefreshSource] {
+        legs
+    }
+}
+extension RouteLeg: RouteLegRefreshSource {
+    public var refreshedAttributes: Attributes {
+        attributes
+    }
+}
+
+extension RefreshedRoute: RouteRefreshSource {
+    public var refreshedLegs: [RouteLegRefreshSource] {
+        legs
+    }
+}
+extension RefreshedRouteLeg: RouteLegRefreshSource {
+    public var refreshedAttributes: RouteLeg.Attributes {
+        attributes
+    }
+}