Added exit signs to the instruction banner and refactored instruction loader (#1195)

Author: Devota Aabel

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

@@ -27,7 +27,7 @@
 import com.mapbox.mapboxsdk.maps.OnMapReadyCallback;
 import com.mapbox.mapboxsdk.maps.Style;
 import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera;
-import com.mapbox.services.android.navigation.ui.v5.instruction.ImageCoordinator;
+import com.mapbox.services.android.navigation.ui.v5.instruction.ImageCreator;
 import com.mapbox.services.android.navigation.ui.v5.instruction.InstructionView;
 import com.mapbox.services.android.navigation.ui.v5.instruction.NavigationAlertView;
 import com.mapbox.services.android.navigation.ui.v5.map.NavigationMapboxMap;
@@ -712,7 +712,7 @@ private void shutdown() {
     navigationViewEventDispatcher.onDestroy(navigationViewModel.retrieveNavigation());
     mapView.onDestroy();
     navigationViewModel.onDestroy(isChangingConfigurations());
-    ImageCoordinator.getInstance().shutdown();
+    ImageCreator.getInstance().shutdown();
     navigationMap = null;
   }
 }

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

@@ -3,7 +3,6 @@
 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;
@@ -17,18 +16,24 @@
  * BannerComponents containing abbreviation information and given a list of BannerComponentNodes,
  * constructed by InstructionLoader.
  */
-class AbbreviationCoordinator {
+class AbbreviationCreator extends NodeCreator<AbbreviationCreator.AbbreviationNode, AbbreviationVerifier> {
   private static final String SINGLE_SPACE = " ";
   private Map<Integer, List<Integer>> abbreviations;
   private TextViewUtils textViewUtils;
 
-  AbbreviationCoordinator(TextViewUtils textViewUtils) {
-    this.abbreviations = new HashMap<>();
+  AbbreviationCreator(AbbreviationVerifier abbreviationVerifier, HashMap abbreviations,
+                      TextViewUtils textViewUtils) {
+    super(abbreviationVerifier);
+    this.abbreviations = abbreviations;
     this.textViewUtils = textViewUtils;
   }
 
-  AbbreviationCoordinator() {
-    this(new TextViewUtils());
+  AbbreviationCreator(AbbreviationVerifier abbreviationVerifier) {
+    this(abbreviationVerifier, new HashMap(), new TextViewUtils());
+  }
+
+  AbbreviationCreator() {
+    this(new AbbreviationVerifier());
   }
 
   /**
@@ -39,7 +44,7 @@ class AbbreviationCoordinator {
    * @param bannerComponents object holding the abbreviation information
    * @param index in the list of BannerComponentNodes
    */
-  void addPriorityInfo(BannerComponents bannerComponents, int index) {
+  private void addPriorityInfo(BannerComponents bannerComponents, int index) {
     Integer abbreviationPriority = bannerComponents.abbreviationPriority();
     if (abbreviations.get(abbreviationPriority) == null) {
       abbreviations.put(abbreviationPriority, new ArrayList<Integer>());
@@ -51,11 +56,12 @@ void addPriorityInfo(BannerComponents bannerComponents, int 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
+   * @param bannerComponentNodes containing the text to construct
    * @return the properly abbreviated string that will fit in the TextView
    */
-  String abbreviateBannerText(List<BannerComponentNode> bannerComponentNodes, TextView textView) {
+  private String abbreviateBannerText(TextView textView, List<BannerComponentNode>
+    bannerComponentNodes) {
     String bannerText = join(bannerComponentNodes);
 
     if (abbreviations.isEmpty()) {
@@ -89,12 +95,15 @@ private String abbreviateUntilTextFits(TextView textView, String startingText,
 
   private boolean shouldKeepAbbreviating(TextView textView, String bannerText,
                                          int currAbbreviationPriority, int maxAbbreviationPriority) {
-    return !textViewUtils.textFits(textView, bannerText) && currAbbreviationPriority <= maxAbbreviationPriority;
+
+    boolean textFits = textViewUtils.textFits(textView, bannerText);
+    boolean abbreviationPrioritiesLeft = currAbbreviationPriority <= maxAbbreviationPriority;
+    return !textFits && abbreviationPrioritiesLeft;
   }
 
   private boolean abbreviateAtAbbreviationPriority(List<BannerComponentNode> bannerComponentNodes,
                                                    List<Integer> indices) {
-    if (indices == null) {
+    if (indices == null || indices.isEmpty()) {
       return false;
     }
 
@@ -130,11 +139,24 @@ private String join(List<BannerComponentNode> tokens) {
     return stringBuilder.toString();
   }
 
+  @Override
+  AbbreviationNode setupNode(BannerComponents components, int index, int startIndex, String
+    modifier) {
+    addPriorityInfo(components, index);
+    return new AbbreviationCreator.AbbreviationNode(components, startIndex);
+  }
+
+  @Override
+  void preProcess(TextView textView, List<BannerComponentNode> bannerComponentNodes) {
+    String text = abbreviateBannerText(textView, bannerComponentNodes);
+    textView.setText(text);
+  }
+
   /**
    * Class used by InstructionLoader to determine that a BannerComponent contains an abbreviation
    */
   static class AbbreviationNode extends BannerComponentNode {
-    boolean abbreviate;
+    private boolean abbreviate;
 
     AbbreviationNode(BannerComponents bannerComponents, int startIndex) {
       super(bannerComponents, startIndex);
@@ -148,5 +170,9 @@ public String toString() {
     void setAbbreviate(boolean abbreviate) {
       this.abbreviate = abbreviate;
     }
+
+    boolean getAbbreviate() {
+      return abbreviate;
+    }
   }
 }

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

@@ -0,0 +1,15 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+import com.mapbox.core.utils.TextUtils;
+
+class AbbreviationVerifier implements NodeVerifier {
+  @Override
+  public boolean isNodeType(BannerComponents bannerComponents) {
+    return hasAbbreviation(bannerComponents);
+  }
+
+  private boolean hasAbbreviation(BannerComponents components) {
+    return !TextUtils.isEmpty(components.abbreviation());
+  }
+}

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

@@ -0,0 +1,25 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+
+/**
+ * Class used to construct a list of BannerComponents to be populated into a TextView
+ */
+class BannerComponentNode {
+  BannerComponents bannerComponents;
+  int startIndex;
+
+  BannerComponentNode(BannerComponents bannerComponents, int startIndex) {
+    this.bannerComponents = bannerComponents;
+    this.startIndex = startIndex;
+  }
+
+  @Override
+  public String toString() {
+    return bannerComponents.text();
+  }
+
+  void setStartIndex(int startIndex) {
+    this.startIndex = startIndex;
+  }
+}

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

@@ -0,0 +1,73 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import android.support.annotation.NonNull;
+import android.widget.TextView;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+import com.mapbox.api.directions.v5.models.BannerText;
+
+import java.util.ArrayList;
+import java.util.List;
+
+class BannerComponentTree {
+  private final NodeCreator[] nodeCreators;
+  private final List<BannerComponentNode> bannerComponentNodes;
+
+  /**
+   * Creates a master coordinator to make sure the coordinators passed in are used appropriately
+   *
+   * @param nodeCreators coordinators in the order that they should process banner components
+   */
+  BannerComponentTree(@NonNull BannerText bannerText, NodeCreator... nodeCreators) {
+    this.nodeCreators = nodeCreators;
+    bannerComponentNodes = parseBannerComponents(bannerText);
+  }
+
+  /**
+   * Parses the banner components and processes them using the nodeCreators in the order they
+   * were originally passed
+   *
+   * @param bannerText to parse
+   * @return the list of nodes representing the bannerComponents
+   */
+  private List<BannerComponentNode> parseBannerComponents(BannerText bannerText) {
+    int length = 0;
+    List<BannerComponentNode> bannerComponentNodes = new ArrayList<>();
+
+    for (BannerComponents components : bannerText.components()) {
+      BannerComponentNode node = null;
+      for (NodeCreator nodeCreator : nodeCreators) {
+        if (nodeCreator.isNodeType(components)) {
+          node = nodeCreator.setupNode(components, bannerComponentNodes.size(), length,
+            bannerText.modifier());
+          break;
+        }
+      }
+
+      if (node != null) {
+        bannerComponentNodes.add(node);
+        length += components.text().length();
+      }
+    }
+
+    return bannerComponentNodes;
+  }
+
+  /**
+   * Loads the instruction into the given text view. If things have to be done in a particular order,
+   * the coordinator methods preProcess and postProcess can be used. PreProcess should be used to
+   * load text into the textView (so there should only be one coordinator calling this method), and
+   * postProcess should be used to make changes to that text, i.e., to load images into the textView.
+   *
+   * @param textView in which to load text and images
+   */
+  void loadInstruction(TextView textView) {
+    for (NodeCreator nodeCreator : nodeCreators) {
+      nodeCreator.preProcess(textView, bannerComponentNodes);
+    }
+
+    for (NodeCreator nodeCreator : nodeCreators) {
+      nodeCreator.postProcess(textView, bannerComponentNodes);
+    }
+  }
+}

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

@@ -0,0 +1,70 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import android.content.Context;
+import android.view.LayoutInflater;
+import android.view.ViewGroup;
+import android.widget.TextView;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+import com.mapbox.services.android.navigation.ui.v5.R;
+
+import java.util.List;
+
+class ExitSignCreator extends NodeCreator<BannerComponentNode, ExitSignVerifier> {
+  private String exitNumber;
+  private int startIndex;
+  private TextViewUtils textViewUtils;
+  private String modifier;
+  private static final String EXIT = "exit";
+  private static final String EXIT_NUMBER = "exit-number";
+  private static final String LEFT = "left";
+
+  ExitSignCreator() {
+    super(new ExitSignVerifier());
+    textViewUtils = new TextViewUtils();
+  }
+
+  @Override
+  BannerComponentNode setupNode(BannerComponents components, int index, int startIndex,
+                                String modifier) {
+    if (components.type().equals(EXIT)) {
+      return null;
+    } else if (components.type().equals(EXIT_NUMBER)) {
+      exitNumber = components.text();
+      this.startIndex = startIndex;
+      this.modifier = modifier;
+    }
+
+    return new BannerComponentNode(components, startIndex);
+  }
+
+  /**
+   * One coordinator should override this method, and this should be the coordinator which populates
+   * the textView with text.
+   *
+   * @param textView             to populate
+   * @param bannerComponentNodes containing instructions
+   */
+  @Override
+  void postProcess(TextView textView, List<BannerComponentNode> bannerComponentNodes) {
+    if (exitNumber != null) {
+      LayoutInflater inflater = (LayoutInflater) textView.getContext().getSystemService(Context
+        .LAYOUT_INFLATER_SERVICE);
+
+      ViewGroup root = (ViewGroup) textView.getParent();
+
+      TextView exitSignView;
+
+      if (modifier.equals(LEFT)) {
+        exitSignView = (TextView) inflater.inflate(R.layout.exit_sign_view_left, root, false);
+      } else {
+        exitSignView = (TextView) inflater.inflate(R.layout.exit_sign_view_right, root, false);
+      }
+
+      exitSignView.setText(exitNumber);
+
+      textViewUtils.setImageSpan(textView, exitSignView, startIndex, startIndex + exitNumber
+        .length());
+    }
+  }
+}

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

@@ -0,0 +1,11 @@
+package com.mapbox.services.android.navigation.ui.v5.instruction;
+
+import com.mapbox.api.directions.v5.models.BannerComponents;
+
+class ExitSignVerifier implements NodeVerifier {
+
+  @Override
+  public boolean isNodeType(BannerComponents bannerComponents) {
+    return bannerComponents.type().equals("exit") || bannerComponents.type().equals("exit-number");
+  }
+}