Dynamic abbreviations in banner instructions

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationView.java

@@ -32,7 +32,7 @@
 import com.mapbox.mapboxsdk.plugins.locationlayer.LocationLayerPlugin;
 import com.mapbox.mapboxsdk.plugins.locationlayer.modes.RenderMode;
 import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera;
-import com.mapbox.services.android.navigation.ui.v5.instruction.InstructionLoader;
+import com.mapbox.services.android.navigation.ui.v5.instruction.ImageCoordinator;
 import com.mapbox.services.android.navigation.ui.v5.instruction.InstructionView;
 import com.mapbox.services.android.navigation.ui.v5.route.NavigationMapRoute;
 import com.mapbox.services.android.navigation.ui.v5.summary.SummaryBottomSheet;
@@ -181,7 +181,7 @@ public void onRestoreInstanceState(Bundle savedInstanceState) {
   public void onDestroy() {
     mapView.onDestroy();
     navigationViewModel.onDestroy(isChangingConfigurations());
-    InstructionLoader.getInstance().shutdown();
+    ImageCoordinator.getInstance().shutdown();
     if (camera != null) {
       camera.onDestroy();
     }
@@ -404,7 +404,7 @@ public MapboxMap getMapboxMap() {
   }
 
   private void initializeView() {
-    InstructionLoader.getInstance().initialize(getContext());
+    ImageCoordinator.getInstance().initialize(getContext());
     inflate(getContext(), R.layout.navigation_view_layout, this);
     bind();
     initializeNavigationViewModel();

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/instruction/AbbreviationCoordinator.java

@@ -0,0 +1,152 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import android.widget.TextView;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+import com.mapbox.services.android.navigation.ui.v5.instruction.InstructionLoader.BannerComponentNode;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * This class allows text to be constructed to fit a given TextView, given specified
+ * BannerComponents containing abbreviation information and given a list of BannerComponentNodes,
+ * constructed by InstructionLoader.
+ */
+class AbbreviationCoordinator {
+  private static final String SINGLE_SPACE = " ";
+  private Map<Integer, List<Integer>> abbreviations;
+  private TextViewUtils textViewUtils;
+
+  AbbreviationCoordinator(TextViewUtils textViewUtils) {
+    this.abbreviations = new HashMap<>();
+    this.textViewUtils = textViewUtils;
+  }
+
+  AbbreviationCoordinator() {
+    this(new TextViewUtils());
+  }
+
+  /**
+   * Adds the given BannerComponents object to the list of abbreviations so that when the list of
+   * BannerComponentNodes is completed, text can be abbreviated properly to fit the specified
+   * TextView.
+   *
+   * @param bannerComponents object holding the abbreviation information
+   * @param index in the list of BannerComponentNodes
+   */
+  void addPriorityInfo(BannerComponents bannerComponents, int index) {
+    Integer abbreviationPriority = bannerComponents.abbreviationPriority();
+    if (abbreviations.get(abbreviationPriority) == null) {
+      abbreviations.put(abbreviationPriority, new ArrayList<Integer>());
+    }
+    abbreviations.get(abbreviationPriority).add(index);
+  }
+
+  /**
+   * Using the abbreviations HashMap which should already be populated, abbreviates the text in the
+   * bannerComponentNodes until the text fits the given TextView.
+   *
+   * @param bannerComponentNodes containing the text to construct
+   * @param textView to check the text fits
+   * @return the properly abbreviated string that will fit in the TextView
+   */
+  String abbreviateBannerText(List<BannerComponentNode> bannerComponentNodes, TextView textView) {
+    String bannerText = join(bannerComponentNodes);
+
+    if (abbreviations.isEmpty()) {
+      return bannerText;
+    }
+
+    bannerText = abbreviateUntilTextFits(textView, bannerText, bannerComponentNodes);
+
+    abbreviations.clear();
+    return bannerText;
+  }
+
+  private String abbreviateUntilTextFits(TextView textView, String startingText,
+                                         List<BannerComponentNode> bannerComponentNodes) {
+    int currAbbreviationPriority = 0;
+    int maxAbbreviationPriority = Collections.max(abbreviations.keySet());
+    String bannerText = startingText;
+
+    while (shouldKeepAbbreviating(textView, bannerText, currAbbreviationPriority, maxAbbreviationPriority)) {
+      List<Integer> indices = abbreviations.get(currAbbreviationPriority++);
+
+      boolean abbreviationPriorityExists = abbreviateAtAbbreviationPriority(bannerComponentNodes, indices);
+
+      if (abbreviationPriorityExists) {
+        bannerText = join(bannerComponentNodes);
+      }
+    }
+
+    return bannerText;
+  }
+
+  private boolean shouldKeepAbbreviating(TextView textView, String bannerText,
+                                         int currAbbreviationPriority, int maxAbbreviationPriority) {
+    return !textViewUtils.textFits(textView, bannerText) && currAbbreviationPriority <= maxAbbreviationPriority;
+  }
+
+  private boolean abbreviateAtAbbreviationPriority(List<BannerComponentNode> bannerComponentNodes,
+                                                   List<Integer> indices) {
+    if (indices == null) {
+      return false;
+    }
+
+    for (Integer index : indices) {
+      abbreviate(bannerComponentNodes.get(index));
+    }
+
+    return true;
+  }
+
+  private void abbreviate(BannerComponentNode bannerComponentNode) {
+    ((AbbreviationNode) bannerComponentNode).setAbbreviate(true);
+  }
+
+  private String join(List<BannerComponentNode> tokens) {
+    StringBuilder stringBuilder = new StringBuilder();
+    Iterator<BannerComponentNode> iterator = tokens.iterator();
+    BannerComponentNode bannerComponentNode;
+
+    if (iterator.hasNext()) {
+      bannerComponentNode = iterator.next();
+      bannerComponentNode.setStartIndex(stringBuilder.length());
+      stringBuilder.append(bannerComponentNode);
+
+      while (iterator.hasNext()) {
+        stringBuilder.append(SINGLE_SPACE);
+        bannerComponentNode = iterator.next();
+        bannerComponentNode.setStartIndex(stringBuilder.length());
+        stringBuilder.append(bannerComponentNode);
+      }
+    }
+
+    return stringBuilder.toString();
+  }
+
+  /**
+   * Class used by InstructionLoader to determine that a BannerComponent contains an abbreviation
+   */
+  static class AbbreviationNode extends BannerComponentNode {
+    boolean abbreviate;
+
+    AbbreviationNode(BannerComponents bannerComponents, int startIndex) {
+      super(bannerComponents, startIndex);
+    }
+
+    @Override
+    public String toString() {
+      return abbreviate ? bannerComponents.abbreviation() : bannerComponents.text();
+    }
+
+    void setAbbreviate(boolean abbreviate) {
+      this.abbreviate = abbreviate;
+    }
+  }
+}

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/instruction/BannerShield.java

@@ -0,0 +1,40 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+
+class BannerShield {
+  private String url;
+  private String text;
+  private int nodeIndex;
+  private int startIndex = -1;
+
+  BannerShield(BannerComponents bannerComponents, int nodeIndex) {
+    this.url = bannerComponents.imageBaseUrl();
+    this.nodeIndex = nodeIndex;
+    this.text = bannerComponents.text();
+  }
+
+  String getUrl() {
+    return url;
+  }
+
+  public String getText() {
+    return text;
+  }
+
+  public int getNodeIndex() {
+    return nodeIndex;
+  }
+
+  public void setStartIndex(int startIndex) {
+    this.startIndex = startIndex;
+  }
+
+  public int getStartIndex() {
+    return startIndex;
+  }
+
+  int getEndIndex() {
+    return startIndex + text.length();
+  }
+}