Merge pull request #1169 from mapbox/abbreviations

Add abbreviations

CHANGELOG.md

@@ -1,6 +1,11 @@
 ## Changes to the Mapbox Navigation SDK for iOS
 
-## v0.15.0 (tbd)
+## Master
+
+#### User Interface
+* Added support for abbreviated top banner instructions. [#1169](https://github.com/mapbox/mapbox-navigation-ios/pull/1169)
+
+## v0.15.0 (March 13, 2018)
 
 #### Breaking changes
 * `NavigationMapViewDelegate` and `RouteMapViewControllerDelegate`: `navigationMapView(_:didTap:)` is now `navigationMapView(_:didSelect:)` [#1063](https://github.com/mapbox/mapbox-navigation-ios/pull/1063)

Cartfile

@@ -1,5 +1,5 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" ~> 3.7
-github "mapbox/MapboxDirections.swift" ~> 0.17.0
+github "mapbox/MapboxDirections.swift" ~> 0.18.0
 github "mapbox/turf-swift" ~> 0.0.3
 github "mapbox/mapbox-events-ios" ~> 0.3
 github "ceeK/Solar" ~> 2.1.0

Cartfile.resolved

@@ -1,7 +1,7 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" "3.7.5"
 github "ceeK/Solar" "2.1.0"
 github "facebook/ios-snapshot-test-case" "2.1.4"
-github "mapbox/MapboxDirections.swift" "v0.17.0"
+github "mapbox/MapboxDirections.swift" "v0.18.0"
 github "mapbox/mapbox-events-ios" "v0.3.1"
 github "mapbox/mapbox-voice-swift" "v0.0.1"
 github "mapbox/turf-swift" "v0.0.4"

MapboxCoreNavigation.podspec

@@ -40,7 +40,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxCoreNavigation"
 
-  s.dependency "MapboxDirections.swift", "~> 0.17.0"
+  s.dependency "MapboxDirections.swift", "~> 0.18.0"
   s.dependency "MapboxMobileEvents", "~> 0.3"
   s.dependency "Turf", "~> 0.0.4"
 

MapboxNavigation-Documentation.podspec

@@ -43,7 +43,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.module_name = "MapboxNavigation"
 
-  s.dependency "MapboxDirections.swift", "~> 0.17.0"
+  s.dependency "MapboxDirections.swift", "~> 0.18.0"
   s.dependency "Mapbox-iOS-SDK", "~> 3.6"
   s.dependency "MapboxMobileEvents", "~> 0.3"
   s.dependency "Solar", "~> 2.1"

MapboxNavigation/InstructionPresenter.swift

@@ -14,26 +14,63 @@ class InstructionPresenter {
     var onShieldDownload: ShieldDownloadCompletion?
 
     private let imageRepository = ImageRepository.shared
-
+    
     func attributedText() -> NSAttributedString {
-        guard let label = self.label else {
-            return NSAttributedString()
-        }
-
         let string = NSMutableAttributedString()
-
-        for component in instruction {
+        fittedAttributedComponents().forEach { string.append($0) }
+        return string
+    }
+
+    func fittedAttributedComponents() -> [NSAttributedString] {
+        guard let label = self.label else { return [] }
+        var attributedPairs = self.attributedPairs()
+        let availableBounds = label.availableBounds()
+        let totalWidth = attributedPairs.attributedStrings.map { $0.size() }.reduce(.zero, +).width
+        let stringFits = totalWidth <= availableBounds.width
+
+        guard !stringFits else { return attributedPairs.attributedStrings }
+
+        let indexedComponents = attributedPairs.components.enumerated().map { IndexedVisualInstructionComponent(component: $1, index: $0) }
+        let filtered = indexedComponents.filter { $0.component.abbreviation != nil }
+        let sorted = filtered.sorted { $0.component.abbreviationPriority < $1.component.abbreviationPriority }
+        for component in sorted {
+            let isFirst = component.index == 0
+            let joinChar = isFirst ? "" : " "
+            guard component.component.type == .text else { continue }
+            guard let abbreviation = component.component.abbreviation else { continue }
+
+            attributedPairs.attributedStrings[component.index] = NSAttributedString(string: joinChar + abbreviation, attributes: attributesForLabel(label))
+            let newWidth = attributedPairs.attributedStrings.map { $0.size() }.reduce(.zero, +).width
+
+            if newWidth <= availableBounds.width {
+                break
+            }
+        }
+
+        return attributedPairs.attributedStrings
+    }
+
+    typealias AttributedInstructionComponents = (components: [VisualInstructionComponent], attributedStrings: [NSAttributedString])
+
+    func attributedPairs() -> AttributedInstructionComponents {
+        guard let label = self.label else { return (components: [], attributedStrings: []) }
+        var strings = [NSAttributedString]()
+        var processedComponents = [VisualInstructionComponent]()
+        let components = instruction
+
+        for component in components {
             let isFirst = component == instruction.first
-            let joinChar = !isFirst ? " " : ""
+            let joinChar = isFirst ? "" : " "
 
             if let shieldKey = component.shieldKey() {
                 if let cachedImage = imageRepository.cachedImageForKey(shieldKey) {
-                    string.append(NSAttributedString(string: joinChar))
-                    string.append(attributedString(withFont: label.font, shieldImage: cachedImage))
+                    processedComponents.append(component)
+                    strings.append(attributedString(withFont: label.font, shieldImage: cachedImage))
                 } else {
                     // Display road code while shield is downloaded
                     if let text = component.text {
-                        string.append(NSAttributedString(string: joinChar + text, attributes: attributesForLabel(label)))
+                        processedComponents.append(component)
+                        strings.append(NSAttributedString(string: joinChar + text, attributes: attributesForLabel(label)))
                     }
                     shieldImageForComponent(component, height: label.shieldHeight, completion: { [weak self] (image) in
                         guard image != nil else {
@@ -45,14 +82,27 @@ class InstructionPresenter {
                     })
                 }
             } else if let text = component.text {
-                if component.type == .delimiter && instructionHasDownloadedAllShields() {
-                    continue
+                // Hide delimiter if one of the adjacent components is a shield
+                if component.type == .delimiter {
+                    let componentBefore = components.component(before: component)
+                    let componentAfter = components.component(after: component)
+                    if let shieldKey = componentBefore?.shieldKey(),
+                        imageRepository.cachedImageForKey(shieldKey) != nil {
+                        continue
+                    }
+                    if let shieldKey = componentAfter?.shieldKey(),
+                        imageRepository.cachedImageForKey(shieldKey) != nil {
+                        continue
+                    }
                 }
-                string.append(NSAttributedString(string: (joinChar + text).abbreviated(toFit: label.availableBounds(), font: label.font), attributes: attributesForLabel(label)))
+                processedComponents.append(component)
+                strings.append(NSAttributedString(string: (joinChar + text), attributes: attributesForLabel(label)))
             }
         }
+
+        assert(processedComponents.count == strings.count, "The number of processed components must match the number of attributed strings")
 
-        return string
+        return (components: processedComponents, attributedStrings: strings)
     }
 
     private func shieldImageForComponent(_ component: VisualInstructionComponent, height: CGFloat, completion: @escaping (UIImage?) -> Void) {
@@ -103,3 +153,39 @@ class ShieldAttachment: NSTextAttachment {
         return CGRect(x: 0, y: font.descender - image.size.height / 2 + mid + 2, width: image.size.width, height: image.size.height).integral
     }
 }
+
+extension CGSize {
+    fileprivate static var greatestFiniteSize = CGSize(width: CGFloat.greatestFiniteMagnitude, height: CGFloat.greatestFiniteMagnitude)
+
+    fileprivate static func +(lhs: CGSize, rhs: CGSize) -> CGSize {
+        return CGSize(width: lhs.width + rhs.width, height: lhs.height +  rhs.height)
+    }
+}
+
+fileprivate struct IndexedVisualInstructionComponent {
+    let component: Array<VisualInstructionComponent>.Element
+    let index: Array<VisualInstructionComponent>.Index
+}
+
+extension Array where Element == VisualInstructionComponent {
+
+    fileprivate func component(before component: VisualInstructionComponent) -> VisualInstructionComponent? {
+        guard let index = self.index(of: component) else {
+            return nil
+        }
+        if index > 0 {
+            return self[index-1]
+        }
+        return nil
+    }
+
+    fileprivate func component(after component: VisualInstructionComponent) -> VisualInstructionComponent? {
+        guard let index = self.index(of: component) else {
+            return nil
+        }
+        if index+1 < self.endIndex {
+            return self[index+1]
+        }
+        return nil
+    }
+}

MapboxNavigation/InstructionsBannerView.swift

@@ -79,8 +79,7 @@ open class BaseInstructionsBannerView: UIControl {
     override open func prepareForInterfaceBuilder() {
         super.prepareForInterfaceBuilder()
         maneuverView.isStart = true
-
-        primaryLabel.instruction = [VisualInstructionComponent(type: .destination, text: "Primary text label", imageURL: nil, maneuverType: .none, maneuverDirection: .none)]
+        primaryLabel.instruction = [VisualInstructionComponent(type: .text, text: "Primary text label", imageURL: nil, maneuverType: .none, maneuverDirection: .none, abbreviation: nil, abbreviationPriority: NSNotFound)]
 
         distance = 100
     }

MapboxNavigation/NextBannerView.swift

@@ -53,7 +53,7 @@ open class NextBannerView: UIView {
     override open func prepareForInterfaceBuilder() {
         super.prepareForInterfaceBuilder()
         maneuverView.isEnd = true
-        instructionLabel.instruction = [VisualInstructionComponent(type: .destination, text: "Next step", imageURL: nil, maneuverType: .none, maneuverDirection: .none)]
+        instructionLabel.instruction = [VisualInstructionComponent(type: .text, text: "Next step", imageURL: nil, maneuverType: .none, maneuverDirection: .none, abbreviation: nil, abbreviationPriority: NSNotFound)]
     }
 
     func setupLayout() {