Updated InstructionLoader APIs to be public and to take in a BannerText object instead of a list of BannerComponents

Author: Devota Aabel

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

@@ -25,32 +25,39 @@
  * If a shield URL is found, {@link Picasso} is used to load the image.  Then, once the image is loaded,
  * a new {@link ImageSpan} is created and set to the appropriate position of the {@link Spannable}/
  */
-class InstructionLoader {
+public class InstructionLoader {
   private ImageCoordinator imageCoordinator;
   private AbbreviationCoordinator abbreviationCoordinator;
   private TextView textView;
   private List<BannerComponentNode> bannerComponentNodes;
 
-  InstructionLoader(TextView textView, @NonNull List<BannerComponents> bannerComponents) {
-    this(textView, bannerComponents, ImageCoordinator.getInstance(), new AbbreviationCoordinator());
+  /**
+   * Creates an InstructionLoader which can handle highway shields and also takes into account
+   * abbreviations.
+   *
+   * @param textView to populate with instruction
+   * @param bannerText containing components to populate into textView
+   */
+  public InstructionLoader(TextView textView, BannerText bannerText) {
+    this(textView, bannerText, ImageCoordinator.getInstance(), new AbbreviationCoordinator());
   }
 
-  InstructionLoader(TextView textView, @NonNull List<BannerComponents> bannerComponents,
+  InstructionLoader(TextView textView, @NonNull BannerText bannerText,
                     ImageCoordinator imageCoordinator, AbbreviationCoordinator abbreviationCoordinator) {
     this.abbreviationCoordinator = abbreviationCoordinator;
     this.textView = textView;
     bannerComponentNodes = new ArrayList<>();
     this.imageCoordinator = imageCoordinator;
 
-    bannerComponentNodes = parseBannerComponents(bannerComponents);
+    bannerComponentNodes = parseBannerComponents(bannerText.components());
   }
 
   /**
    * Takes the given components from the {@link BannerText} and creates
    * a new {@link Spannable} with text / {@link ImageSpan}s which is loaded
    * into the given {@link TextView}.
    */
-  void loadInstruction() {
+  public void loadInstruction() {
     setText(textView, bannerComponentNodes);
     loadImages(textView, bannerComponentNodes);
   }

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

@@ -598,7 +598,7 @@ private void distanceText(InstructionModel model) {
 
   private InstructionLoader createInstructionLoader(TextView textView, BannerText bannerText) {
     if (hasComponents(bannerText)) {
-      return new InstructionLoader(textView, bannerText.components());
+      return new InstructionLoader(textView, bannerText);
     } else {
       return null;
     }

libandroid-navigation-ui/src/test/java/com/mapbox/services/android/navigation/ui/v5/instruction/InstructionLoaderTest.java

@@ -3,6 +3,7 @@
 import android.widget.TextView;
 
 import com.mapbox.api.directions.v5.models.BannerComponents;
+import com.mapbox.api.directions.v5.models.BannerText;
 
 import org.junit.Test;
 
@@ -27,8 +28,10 @@ public void onInstructionLoaderCreated_priorityInfoIsAdded() {
       .build();
     List<BannerComponents> bannerComponentsList = new ArrayList<>();
     bannerComponentsList.add(bannerComponents);
+    BannerText bannerText = mock(BannerText.class);
+    when(bannerText.components()).thenReturn(bannerComponentsList);
 
-    new InstructionLoader(textView, bannerComponentsList, imageCoordinator, abbreviationCoordinator);
+    new InstructionLoader(textView, bannerText, imageCoordinator, abbreviationCoordinator);
 
     verify(abbreviationCoordinator).addPriorityInfo(bannerComponents, 0);
   }
@@ -43,8 +46,10 @@ public void onInstructionLoaderCreated_shieldInfoIsAdded() {
       .build();
     List<BannerComponents> bannerComponentsList = new ArrayList<>();
     bannerComponentsList.add(bannerComponents);
+    BannerText bannerText = mock(BannerText.class);
+    when(bannerText.components()).thenReturn(bannerComponentsList);
 
-    new InstructionLoader(textView, bannerComponentsList, imageCoordinator, abbreviationCoordinator);
+    new InstructionLoader(textView, bannerText, imageCoordinator, abbreviationCoordinator);
 
     verify(imageCoordinator).addShieldInfo(bannerComponents, 0);
   }
@@ -62,7 +67,10 @@ public void onLoadInstruction_textIsAbbreviated() {
     bannerComponentsList.add(bannerComponents);
     String abbreviatedText = "abbreviated text";
     when(abbreviationCoordinator.abbreviateBannerText(any(List.class), any(TextView.class))).thenReturn(abbreviatedText);
-    InstructionLoader instructionLoader = new InstructionLoader(textView, bannerComponentsList, imageCoordinator, abbreviationCoordinator);
+    BannerText bannerText = mock(BannerText.class);
+    when(bannerText.components()).thenReturn(bannerComponentsList);
+    InstructionLoader instructionLoader = new InstructionLoader(textView, bannerText, imageCoordinator,
+      abbreviationCoordinator);
 
     instructionLoader.loadInstruction();
 
@@ -81,7 +89,10 @@ public void onLoadInstruction_imagesAreLoaded() {
     bannerComponentsList.add(bannerComponents);
     String abbreviatedText = "abbreviated text";
     when(abbreviationCoordinator.abbreviateBannerText(any(List.class), any(TextView.class))).thenReturn(abbreviatedText);
-    InstructionLoader instructionLoader = new InstructionLoader(textView, bannerComponentsList, imageCoordinator, abbreviationCoordinator);
+    BannerText bannerText = mock(BannerText.class);
+    when(bannerText.components()).thenReturn(bannerComponentsList);
+    InstructionLoader instructionLoader = new InstructionLoader(textView, bannerText, imageCoordinator,
+      abbreviationCoordinator);
 
     instructionLoader.loadInstruction();