Skip to content

Commit 790cbad

Browse files
kriedkried
committed
Add tests, update changelog and formatting for final destination
1 parent f020fe0 commit 790cbad

File tree

4 files changed

+132
-40
lines changed

4 files changed

+132
-40
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
### Map
1717

1818
* Fixed an issue when `NavigationMapView` would not display a map, when using CarPlay and custom tile storage location. ([#4399](https://github.com/mapbox/mapbox-navigation-ios/pull/4399))
19+
* Added `NavigationMapView.addDestinationAnnotation(_:identifier:styleLoaded:)`, `NavigationMapView.removeDestinationAnnotation(_:)` to present and remove the final destination annotation on a NavigationMapView. ([#4253](https://github.com/mapbox/mapbox-navigation-ios/pull/4253))
1920

2021
### Camera
2122

‎MapboxNavigation-SPM.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved‎

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Sources/MapboxNavigation/NavigationMapView.swift‎

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,7 +1273,7 @@ open class NavigationMapView: UIView {
12731273
final destination `PointAnnotation` will be stored in this property and added to the `MapView`
12741274
later on.
12751275
*/
1276-
var finalDestinationAnnotations: [PointAnnotation] = []
1276+
private(set) var finalDestinationAnnotations: [PointAnnotation] = []
12771277

12781278
/**
12791279
Adds the route waypoints to the map given the current leg index. Previous waypoints for completed legs will be omitted.
@@ -1335,31 +1335,25 @@ open class NavigationMapView: UIView {
13351335

13361336
if let lastLeg = route.legs.last,
13371337
let destinationCoordinate = lastLeg.destination?.coordinate {
1338-
addDestinationAnnotation(destinationCoordinate) { [weak self] in
1339-
guard self != nil else { return }
1340-
}
1338+
addDestinationAnnotation(destinationCoordinate, identifier: AnnotationIdentifier.finalDestinationAnnotation)
13411339
}
13421340
}
1343-
1341+
13441342
/**
1345-
Adds a final destination annotation to the map.
1346-
1343+
Adds a final destination annotation to the map. The annotation will be added only after fully loading `MapView` style. In such case
1344+
final destination will be stored and added to the `MapView` later on. `delegate` will be notified about the change via
1345+
`NavigationMapViewDelegate.navigationMapView(_:didAdd:pointAnnotationManager:)` method.
1346+
13471347
- parameter coordinate: Coordinate which represents the annotation location.
13481348
- parameter identifier: String to uniquely identify the destination annotation. Defaults to `nil` and a default identifier will be provided.
1349-
- parameter styleLoaded: An escaping closure to be executed when the `MapView` style has finished loading.
13501349
*/
13511350
public func addDestinationAnnotation(_ coordinate: CLLocationCoordinate2D,
1352-
identifier: String? = nil,
1353-
styleLoaded: @escaping () -> Void) {
1354-
let identifier = identifier ?? String("finalDestinationAnnotation_\(finalDestinationAnnotations.count)")
1351+
identifier: String? = nil) {
1352+
let count = pointAnnotationManager?.annotations.count ?? finalDestinationAnnotations.count
1353+
let identifier = identifier ?? "\(AnnotationIdentifier.finalDestinationAnnotation)_\(count)"
13551354
var destinationAnnotation = PointAnnotation(id: identifier, coordinate: coordinate)
13561355
destinationAnnotation.image = .init(image: .defaultMarkerImage, name: ImageIdentifier.markerImage)
1357-
1358-
mapView.mapboxMap.onNext(event: .styleLoaded) { [weak self] _ in
1359-
guard self != nil else { return }
1360-
styleLoaded()
1361-
}
1362-
1356+
13631357
// If `PointAnnotationManager` is available - add `PointAnnotation`, if not - remember it
13641358
// and add it only after fully loading `MapView` style.
13651359
if let pointAnnotationManager = pointAnnotationManager {
@@ -1373,18 +1367,20 @@ open class NavigationMapView: UIView {
13731367
}
13741368

13751369
/**
1376-
Removes a final destination annotation to the map.
1377-
1378-
- parameter identifier: String to uniquely identify the destination annotation to be removed. Defaults to `nil` and removes all destination annotations.
1370+
Removes a final destination annotation from the map.
1371+
1372+
- parameter identifier: String to uniquely identify the destination annotation to be removed. Defaults to `nil` and removes all destination annotations with non-custom identifiers.
13791373
*/
1380-
public func removeDestinationAnnotation(_ identifier: String? = nil) {
1381-
if let identifier {
1382-
finalDestinationAnnotations.removeAll(where: { $0.id == identifier })
1383-
pointAnnotationManager?.annotations.removeAll(where: { $0.id == identifier })
1374+
public func removeDestinationAnnotation(identifier: String? = nil) {
1375+
let filter: (PointAnnotation) -> Bool
1376+
if let identifier = identifier {
1377+
filter = { $0.id == identifier }
13841378
} else {
1385-
finalDestinationAnnotations.removeAll(where: { $0.id.contains("finalDestinationAnnotation") })
1386-
pointAnnotationManager?.annotations.removeAll(where: { $0.id.contains("finalDestinationAnnotation") })
1379+
filter = { $0.id.contains(AnnotationIdentifier.finalDestinationAnnotation) }
13871380
}
1381+
1382+
finalDestinationAnnotations.removeAll(where: filter)
1383+
pointAnnotationManager?.annotations.removeAll(where: filter)
13881384
}
13891385

13901386
/**
@@ -1456,11 +1452,6 @@ open class NavigationMapView: UIView {
14561452
*/
14571453
public var pointAnnotationManager: PointAnnotationManager?
14581454

1459-
func annotationsToRemove() -> [Annotation] {
1460-
let identifier = NavigationMapView.AnnotationIdentifier.finalDestinationAnnotation
1461-
return pointAnnotationManager?.annotations.filter({ $0.id == identifier }) ?? []
1462-
}
1463-
14641455
// MARK: Map Rendering and Observing
14651456

14661457
var routes: [Route]?

‎Tests/MapboxNavigationTests/NavigationMapViewTests.swift‎

Lines changed: 101 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import XCTest
22
import MapboxDirections
33
import TestHelper
44
import Turf
5-
import MapboxMaps
5+
@testable import MapboxMaps
66
@testable import MapboxNavigation
77
@testable import MapboxCoreNavigation
88

@@ -13,6 +13,7 @@ class NavigationMapViewTests: TestCase {
1313
]))
1414
var navigationMapView: NavigationMapView!
1515
var navigator: CoreNavigator!
16+
var pointAnnotationManager: PointAnnotationManager!
1617

1718
let options: NavigationRouteOptions = .init(coordinates: [
1819
CLLocationCoordinate2D(latitude: 40.311012, longitude: -112.47926),
@@ -22,11 +23,34 @@ class NavigationMapViewTests: TestCase {
2223
let route = response.routes!.first!
2324
return route
2425
}()
26+
27+
private let coordinate1 = CLLocationCoordinate2D(latitude: 40.311012, longitude: -112.47926)
28+
private let coordinate2 = CLLocationCoordinate2D(latitude: 30.176322, longitude: -102.806108)
29+
private let finalDestinationAnnotationTestPrefix = "MapboxNavigation-MapboxNavigation-resources_finalDestinationAnnotation"
30+
31+
private final class DisplayLinkCoordinatorSpy: DisplayLinkCoordinator {
32+
func add(_ participant: DisplayLinkParticipant) {}
33+
func remove(_ participant: DisplayLinkParticipant) {}
34+
}
35+
36+
private final class AnnotationImagesManagerSpy: AnnotationImagesManagerProtocol {
37+
func addImage(_ image: UIImage, id: String, sdf: Bool, contentInsets: UIEdgeInsets) {}
38+
func removeImage(_ imageName: String) {}
39+
func register(imagesConsumer: MapboxMaps.AnnotationImagesConsumer) {}
40+
func unregister(imagesConsumer: MapboxMaps.AnnotationImagesConsumer) {}
41+
}
2542

2643
override func setUp() {
2744
navigator = Navigator.shared
2845
super.setUp()
2946
navigationMapView = NavigationMapView(frame: CGRect(origin: .zero, size: .iPhone6Plus))
47+
let mapboxMap = navigationMapView.mapView.mapboxMap!
48+
pointAnnotationManager = PointAnnotationManager(id: "",
49+
style: mapboxMap.style,
50+
layerPosition: nil,
51+
displayLinkCoordinator: DisplayLinkCoordinatorSpy(),
52+
imagesManager: AnnotationImagesManagerSpy(),
53+
offsetPointCalculator: OffsetPointCalculator(mapboxMap: mapboxMap))
3054
}
3155

3256
override func tearDown() {
@@ -587,6 +611,82 @@ class NavigationMapViewTests: TestCase {
587611
XCTAssertFalse(style.layerExists(withId: NavigationMapView.LayerIdentifier.intersectionAnnotationsLayer))
588612
}
589613

614+
func testAddFinalDestinationWithDefaultIdentifierIfStyleNotLoaded() {
615+
XCTAssertTrue(navigationMapView.finalDestinationAnnotations.isEmpty)
616+
XCTAssertTrue(pointAnnotationManager.annotations.isEmpty)
617+
618+
navigationMapView.addDestinationAnnotation(coordinate1)
619+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 1)
620+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations[0].id, "\(finalDestinationAnnotationTestPrefix)_0")
621+
XCTAssertTrue(pointAnnotationManager.annotations.isEmpty)
622+
623+
navigationMapView.addDestinationAnnotation(coordinate2)
624+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 2)
625+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations[1].id, "\(finalDestinationAnnotationTestPrefix)_1")
626+
XCTAssertTrue(pointAnnotationManager.annotations.isEmpty)
627+
}
628+
629+
func testAddFinalDestinationWithCustomIdentifierIfStyleNotLoaded() {
630+
navigationMapView.addDestinationAnnotation(coordinate1, identifier: "custom")
631+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 1)
632+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations[0].id, "custom")
633+
}
634+
635+
func testRemovesFinalDestinationIfStyleNotLoaded() {
636+
navigationMapView.addDestinationAnnotation(coordinate1)
637+
navigationMapView.addDestinationAnnotation(coordinate2)
638+
639+
navigationMapView.removeDestinationAnnotation(identifier: "custom")
640+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 2)
641+
642+
navigationMapView.addDestinationAnnotation(coordinate2, identifier: "custom")
643+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 3)
644+
navigationMapView.removeDestinationAnnotation(identifier: "custom")
645+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 2)
646+
647+
navigationMapView.removeDestinationAnnotation()
648+
XCTAssertEqual(navigationMapView.finalDestinationAnnotations.count, 0)
649+
}
650+
651+
func testAddFinalDestinationWithDefaultIdentifierIfStyleLoaded() {
652+
navigationMapView.pointAnnotationManager = pointAnnotationManager
653+
654+
navigationMapView.addDestinationAnnotation(coordinate1)
655+
XCTAssertTrue(navigationMapView.finalDestinationAnnotations.isEmpty)
656+
XCTAssertEqual(pointAnnotationManager.annotations.count, 1)
657+
XCTAssertEqual(pointAnnotationManager.annotations[0].id, "\(finalDestinationAnnotationTestPrefix)_0")
658+
659+
navigationMapView.addDestinationAnnotation(coordinate2)
660+
XCTAssertTrue(navigationMapView.finalDestinationAnnotations.isEmpty)
661+
XCTAssertEqual(pointAnnotationManager.annotations.count, 2)
662+
XCTAssertEqual(pointAnnotationManager.annotations[1].id, "\(finalDestinationAnnotationTestPrefix)_1")
663+
}
664+
665+
func testAddFinalDestinationWithCustomIdentifierIfStyleLoaded() {
666+
navigationMapView.pointAnnotationManager = pointAnnotationManager
667+
668+
navigationMapView.addDestinationAnnotation(coordinate1, identifier: "custom")
669+
XCTAssertEqual(pointAnnotationManager.annotations.count, 1)
670+
XCTAssertEqual(pointAnnotationManager.annotations[0].id, "custom")
671+
}
672+
673+
func testRemovesFinalDestinationIfStyleLoaded() {
674+
navigationMapView.pointAnnotationManager = pointAnnotationManager
675+
navigationMapView.addDestinationAnnotation(coordinate1)
676+
navigationMapView.addDestinationAnnotation(coordinate2)
677+
678+
navigationMapView.removeDestinationAnnotation(identifier: "custom")
679+
XCTAssertEqual(pointAnnotationManager.annotations.count, 2)
680+
681+
navigationMapView.addDestinationAnnotation(coordinate2, identifier: "custom")
682+
XCTAssertEqual(pointAnnotationManager.annotations.count, 3)
683+
navigationMapView.removeDestinationAnnotation(identifier: "custom")
684+
XCTAssertEqual(pointAnnotationManager.annotations.count, 2)
685+
686+
navigationMapView.removeDestinationAnnotation()
687+
XCTAssertEqual(pointAnnotationManager.annotations.count, 0)
688+
}
689+
590690
private func configureIntersections() {
591691
let style = navigationMapView.mapView.mapboxMap.style
592692
var source = GeoJSONSource()

0 commit comments

Comments
 (0)