[ios] MGLUserLocation, MGLUserLocationAnnotationView and MGLAnnotationImage now conforms to NSSecureCoding

Author: frederoni

platform/darwin/test/MGLCodingTests.m

@@ -1,6 +1,9 @@
 #import <Mapbox/Mapbox.h>
 #import <XCTest/XCTest.h>
 
+#if TARGET_OS_IPHONE
+#import "MGLUserLocation_Private.h"
+#endif
 
 @interface MGLCodingTests : XCTestCase
 @end
@@ -423,6 +426,44 @@ - (void)testAnnotationView {
     XCTAssertEqualObjects(NSStringFromCGVector(annotationView.centerOffset), NSStringFromCGVector(unarchivedAnnotationView.centerOffset));
     XCTAssertEqual(annotationView.scalesWithViewingDistance, unarchivedAnnotationView.scalesWithViewingDistance);
 }
-#end
+#endif
+
+#if TARGET_OS_IPHONE
+- (void)testUserLocation {
+    MGLUserLocation *userLocation = [[MGLUserLocation alloc] init];
+    userLocation.location = [[CLLocation alloc] initWithLatitude:1 longitude:1];
+    
+    NSString *filePath = [self temporaryFilePathForClass:[MGLUserLocation class]];
+    [NSKeyedArchiver archiveRootObject:userLocation toFile:filePath];
+    
+    MGLUserLocation *unarchivedUserLocation = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
+    
+    XCTAssertEqualObjects(userLocation, unarchivedUserLocation);
+    unarchivedUserLocation.location = [[CLLocation alloc] initWithLatitude:10 longitude:10];
+    XCTAssertNotEqualObjects(userLocation, unarchivedUserLocation);
+}
+#endif
+
+#if TARGET_OS_IPHONE
+- (void)testUserLocationAnnotationView {
+    MGLUserLocationAnnotationView *annotationView = [[MGLUserLocationAnnotationView alloc] init];
+    annotationView.enabled = NO;
+    annotationView.selected = YES;
+    annotationView.draggable = YES;
+    annotationView.centerOffset = CGVectorMake(10, 10);
+    annotationView.scalesWithViewingDistance = NO;
+    
+    NSString *filePath = [self temporaryFilePathForClass:[MGLUserLocationAnnotationView class]];
+    [NSKeyedArchiver archiveRootObject:annotationView toFile:filePath];
+    
+    MGLUserLocationAnnotationView *unarchivedAnnotationView = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
+    
+    XCTAssertEqual(annotationView.enabled, unarchivedAnnotationView.enabled);
+    XCTAssertEqual(annotationView.selected, unarchivedAnnotationView.selected);
+    XCTAssertEqual(annotationView.draggable, unarchivedAnnotationView.draggable);
+    XCTAssertEqualObjects(NSStringFromCGVector(annotationView.centerOffset), NSStringFromCGVector(unarchivedAnnotationView.centerOffset));
+    XCTAssertEqual(annotationView.scalesWithViewingDistance, unarchivedAnnotationView.scalesWithViewingDistance);
+}
+#endif
 
 @end

platform/ios/src/MGLUserLocation.h

@@ -11,7 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
  directly. Instead, you retrieve an existing MGLUserLocation object from the
  `userLocation` property of the map view displayed in your application.
  */
-@interface MGLUserLocation : NSObject <MGLAnnotation>
+@interface MGLUserLocation : NSObject <MGLAnnotation, NSSecureCoding>
 
 #pragma mark Determining the User’s Position
 

platform/ios/src/MGLUserLocation.m

@@ -26,6 +26,44 @@ - (instancetype)initWithMapView:(MGLMapView *)mapView
     return self;
 }
 
++ (BOOL)supportsSecureCoding {
+    return YES;
+}
+
+- (instancetype)initWithCoder:(NSCoder *)decoder {
+    if (self = [super init]) {
+        _location = [decoder decodeObjectOfClass:[CLLocation class] forKey:@"location"];
+        _title = [decoder decodeObjectOfClass:[NSString class] forKey:@"title"];
+        _subtitle = [decoder decodeObjectOfClass:[NSString class] forKey:@"subtitle"];
+    }
+    return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)coder {
+    [coder encodeObject:_location forKey:@"location"];
+    [coder encodeObject:_title forKey:@"title"];
+    [coder encodeObject:_subtitle forKey:@"subtitle"];
+}
+
+- (BOOL)isEqual:(id)other {
+    if (self == other) return YES;
+    if (![other isKindOfClass:[MGLUserLocation class]]) return NO;
+    
+    MGLUserLocation *otherUserLocation = other;
+    return ((!self.location && !otherUserLocation.location) || [self.location distanceFromLocation:otherUserLocation.location] == 0)
+    && ((!self.title && !otherUserLocation.title) || [self.title isEqualToString:otherUserLocation.title])
+    && ((!self.subtitle && !otherUserLocation.subtitle) || [self.subtitle isEqualToString:otherUserLocation.subtitle]);
+}
+
+- (NSUInteger)hash {
+    NSUInteger hash = [super hash];
+    hash += [_location hash];
+    hash += [_heading hash];
+    hash += [_title hash];
+    hash += [_subtitle hash];
+    return hash;
+}
+
 + (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key
 {
     return ! [key isEqualToString:@"location"] && ! [key isEqualToString:@"heading"];