LocationItem.swift

//
//  LocationItem.swift
//  LocationPicker
//
//  Created by Jerome Tan on 3/30/16.
//
//  The MIT License (MIT)
//
//  Copyright (c) 2016 Jerome Tan
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in all
//  copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//  SOFTWARE.

import MapKit

/**
 A `MKMapItem` encapsulation class to save you from importing `MapKit` everywhere in you project and provide some convenience.
 
 - important:
 This class is a encapsulation of `MKMapItem`, you can access the `MKMapItem` object via `mapItem` property.
 
 - Note:
 `LocationItem` provides some get-only computed property to access properties of `MKMapItem` object more easily.
 
        var name: String
        var coordinate: (latitude: Double, longitude: Double)
        var addressDictionary: [NSObject: AnyObject]?
        var formattedAddressString: String?
 
 This class provides two initialization methods, you can either provide a `MKMapItem` object or provide a coordinate and an address dictionary to initialize.
 
 This class is hashable, the hash value of this class is the hash value of the combined string of latitude and longitude.
 
 This class is equalable, objects have the same latitude and longitude are equal.
 
 Objects of this class can be encoded and decoded.
 
        let locationData = NSKeyedArchiver.archivedDataWithRootObject(locationItem)
        let locationItem = NSKeyedUnarchiver.unarchiveObjectWithData(locationData) as! LocationItem
 */
public class LocationItem: NSObject, NSCoding {
    
    public let mapItem: MKMapItem
    
    
    /// The name of the location. A reference to `MKMapItem` object's property `name`.
    public var name: String {
        get {
            return mapItem.name ?? ""
        }
    }
    
    /// The coordinate of the location. A reference to `MKMapItem` object's property `placemark.coordinate` and converted to tuple. Only when the `allowArbitraryLocation` property of `LocationPicker` class is set to `true`, can this property be `nil`.
    public var coordinate: (latitude: Double, longitude: Double)? {
        get {
            let coordinate = mapItem.placemark.coordinate
            if CLLocationCoordinate2DIsValid(coordinate) {
                return coordinateTuple(fromObject: coordinate)
            } else {
                return nil
            }
        }
    }
    
    /// The address dictionary of the location. A reference to `MKMapItem` object's property `placemark.addressDictionary`
    /// - Note: This dictionary along with a coordinate can be used to create a `MKPlacemark` object which can create a `MKMapItem` object.
    public var addressDictionary: [AnyHashable: Any]? {
        get {
            return mapItem.placemark.addressDictionary
        }
    }
    
    /// The address of the location. This is the value to the key _"FormattedAddressLines"_ in `addressDictionary`. It is the address text formatted according to user's region.
    /// - Note: If you would like to format the address yourself, you can use `addressDictionary` property to create one.
    
    public var formattedAddressString: String? {
        get {
            guard let addressParts = (addressDictionary?["FormattedAddressLines"] as? [String]) else { return nil }
            return addressParts.count > 1 ? addressParts[1] : addressParts[0]
        }
    }
    
    
    public override var hashValue: Int {
        get {
            if let coordinate = coordinate {
                return "\(coordinate.latitude), \(coordinate.longitude)".hashValue
            } else {
                return mapItem.name?.hashValue ?? "".hashValue
            }
        }
    }
    
    public override var description: String {
        get {
            return "Location item with map item: " + mapItem.description
        }
    }
    
    
    public init(mapItem: MKMapItem) {
        self.mapItem = mapItem
    }
    
    public init(coordinate: (latitude: Double, longitude: Double), addressDictionary: [String: AnyObject]) {
        let placeMark = MKPlacemark(coordinate: coordinateObject(fromTuple: coordinate), addressDictionary: addressDictionary)
        self.mapItem = MKMapItem(placemark: placeMark)
    }
    
    public init(locationName: String) {
        // Create map item with name and invalid placemark coordinate (since placemark is not optional in MKMapItem)
        let placeMark = MKPlacemark(coordinate: kCLLocationCoordinate2DInvalid, addressDictionary: nil)
        self.mapItem = MKMapItem(placemark: placeMark)
        self.mapItem.name = locationName
    }
    
    public override func isEqual(_ object: Any?) -> Bool {
        guard let object = object else { return false }
        return (object as AnyObject).hashValue == hashValue
    }
    
    
    public required convenience init(coder aDecoder: NSCoder) {
        let latitude = aDecoder.decodeDouble(forKey: "latitude")
        let longitude = aDecoder.decodeDouble(forKey: "longitude")
        let addressDictionary = aDecoder.decodeObject(forKey: "addressDictionary") as! [String: AnyObject]
        self.init(coordinate: (latitude, longitude), addressDictionary: addressDictionary)
    }
    
    public func encode(with aCoder: NSCoder) {
        aCoder.encode(mapItem.placemark.coordinate.latitude, forKey: "latitude")
        aCoder.encode(mapItem.placemark.coordinate.longitude, forKey: "longitude")
        aCoder.encode(addressDictionary, forKey: "addressDictionary")
    }
    
}