Add Scale bar plugin

app/build.gradle

@@ -113,6 +113,7 @@ dependencies {
   implementation project(':plugin-annotation')
   implementation project(':plugin-markerview')
   implementation project(':ktx-mapbox-maps')
+  implementation project(':plugin-scalebar')
 }
 
 apply from: "${rootDir}/gradle/checkstyle.gradle"

app/src/androidTest/java/com/mapbox/mapboxsdk/plugins/scalebar/ScaleBarTest.java

@@ -0,0 +1,250 @@
+package com.mapbox.mapboxsdk.plugins.scalebar;
+
+
+import android.app.Activity;
+import android.support.test.runner.AndroidJUnit4;
+import android.support.v4.content.ContextCompat;
+import android.view.View;
+
+import com.mapbox.mapboxsdk.maps.MapView;
+import com.mapbox.mapboxsdk.plugins.BaseActivityTest;
+import com.mapbox.mapboxsdk.plugins.testapp.R;
+import com.mapbox.mapboxsdk.plugins.testapp.activity.TestActivity;
+import com.mapbox.pluginscalebar.ScaleBarOptions;
+import com.mapbox.pluginscalebar.ScaleBarPlugin;
+import com.mapbox.pluginscalebar.ScaleBarWidget;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import timber.log.Timber;
+
+import static com.mapbox.mapboxsdk.plugins.annotation.MapboxMapAction.invoke;
+import static junit.framework.TestCase.assertFalse;
+import static junit.framework.TestCase.assertTrue;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+/**
+ * Basic smoke tests for ScaleBar
+ */
+@RunWith(AndroidJUnit4.class)
+public class ScaleBarTest extends BaseActivityTest {
+  private ScaleBarPlugin scaleBarPlugin;
+  private Activity activity;
+  private ScaleBarWidget scaleBarWidget;
+
+  @Override
+  protected Class getActivityClass() {
+    return TestActivity.class;
+  }
+
+  private void setupScaleBar() {
+    Timber.i("Retrieving layer");
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      scaleBarPlugin = new ScaleBarPlugin(idlingResource.getMapView(), mapboxMap);
+      activity = rule.getActivity();
+      scaleBarWidget = scaleBarPlugin.create(new ScaleBarOptions(activity));
+      assertNotNull(scaleBarPlugin);
+      assertNotNull(scaleBarWidget);
+    });
+  }
+
+  @Test
+  public void testScaleBarEnable() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(View.VISIBLE, scaleBarWidget.getVisibility());
+      assertTrue(scaleBarPlugin.isEnabled());
+      scaleBarPlugin.setEnabled(false);
+      assertEquals(View.GONE, scaleBarWidget.getVisibility());
+      assertFalse(scaleBarPlugin.isEnabled());
+    });
+  }
+
+  @Test
+  public void testScaleBarColor() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(ContextCompat.getColor(activity, android.R.color.black), scaleBarWidget.getTextColor());
+      assertEquals(ContextCompat.getColor(activity, android.R.color.black), scaleBarWidget.getPrimaryColor());
+      assertEquals(ContextCompat.getColor(activity, android.R.color.white), scaleBarWidget.getSecondaryColor());
+
+
+      int textColor = R.color.colorAccent;
+      int colorPrimary = R.color.colorPrimary;
+      int colorSecondary = R.color.colorPrimaryDark;
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setTextColor(textColor);
+      option.setPrimaryColor(colorPrimary);
+      option.setSecondaryColor(colorSecondary);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(ContextCompat.getColor(activity, textColor), scaleBarWidget.getTextColor());
+      assertEquals(ContextCompat.getColor(activity, colorPrimary), scaleBarWidget.getPrimaryColor());
+      assertEquals(ContextCompat.getColor(activity, colorSecondary), scaleBarWidget.getSecondaryColor());
+    });
+  }
+
+  @Test
+  public void testScaleBarWidth() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(MapView.class, scaleBarWidget.getParent().getClass());
+      MapView parent = (MapView) scaleBarWidget.getParent();
+      assertEquals(parent.getWidth(), scaleBarWidget.getMapViewWidth());
+    });
+  }
+
+  @Test
+  public void testMargin() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_margin_left),
+        scaleBarWidget.getMarginLeft(), 0);
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_margin_top),
+        scaleBarWidget.getMarginTop(), 0);
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_text_margin),
+        scaleBarWidget.getTextBarMargin(), 0);
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setMarginLeft(R.dimen.fab_margin);
+      option.setMarginTop(R.dimen.fab_margin);
+      option.setTextBarMargin(R.dimen.fab_margin);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getMarginLeft(), 0);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getMarginTop(), 0);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getTextBarMargin(), 0);
+
+      option = new ScaleBarOptions(activity);
+      option.setMarginLeft(100f);
+      option.setMarginTop(50f);
+      option.setTextBarMargin(30f);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(100f, scaleBarWidget.getMarginLeft(), 0);
+      assertEquals(50f, scaleBarWidget.getMarginTop(), 0);
+      assertEquals(30f, scaleBarWidget.getTextBarMargin(), 0);
+
+    });
+  }
+
+  @Test
+  public void testBarHeight() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_height),
+        scaleBarWidget.getBarHeight(), 0);
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setBarHeight(R.dimen.fab_margin);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getBarHeight(), 0);
+
+      option = new ScaleBarOptions(activity);
+      option.setBarHeight(100f);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(100f, scaleBarWidget.getBarHeight(), 0);
+
+    });
+  }
+
+  @Test
+  public void testTextSize() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_text_size),
+        scaleBarWidget.getTextSize(), 0);
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setTextSize(R.dimen.fab_margin);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getTextSize(), 0);
+
+      option = new ScaleBarOptions(activity);
+      option.setTextSize(100f);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(100f, scaleBarWidget.getTextSize(), 0);
+
+    });
+  }
+
+  @Test
+  public void testBorderWidth() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(activity.getResources().getDimension(R.dimen.mapbox_scale_bar_border_width),
+        scaleBarWidget.getBorderWidth(), 0);
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setBorderWidth(R.dimen.fab_margin);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(activity.getResources().getDimension(R.dimen.fab_margin),
+        scaleBarWidget.getBorderWidth(), 0);
+
+      option = new ScaleBarOptions(activity);
+      option.setBorderWidth(100f);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(100f, scaleBarWidget.getBorderWidth(), 0);
+
+    });
+  }
+
+
+  @Test
+  public void testRefreshInterval() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(ScaleBarOptions.REFRESH_INTERVAL_DEFAULT, scaleBarWidget.getRefreshInterval(), 0);
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setRefreshInterval(1000);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertEquals(1000, scaleBarWidget.getRefreshInterval(), 0);
+
+    });
+  }
+
+  @Test
+  public void testMetrics() {
+    validateTestSetup();
+    setupScaleBar();
+    invoke(mapboxMap, (uiController, mapboxMap) -> {
+      assertEquals(ScaleBarOptions.LocaleUnitResolver.isMetricSystem(), scaleBarWidget.isMetricUnit());
+
+      ScaleBarOptions option = new ScaleBarOptions(activity);
+      option.setMetricUnit(true);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertTrue(scaleBarWidget.isMetricUnit());
+
+      option = new ScaleBarOptions(activity);
+      option.setMetricUnit(false);
+      scaleBarWidget = scaleBarPlugin.create(option);
+      assertNotNull(scaleBarWidget);
+      assertFalse(scaleBarWidget.isMetricUnit());
+    });
+  }
+}

app/src/main/AndroidManifest.xml

@@ -249,6 +249,18 @@
               android:value=".activity.FeatureOverviewActivity" />
     </activity>
 
+    <activity
+            android:name=".activity.scalebar.ScalebarActivity"
+            android:description="@string/description_scalebar"
+            android:label="@string/title_scalebar">
+      <meta-data
+              android:name="@string/category"
+              android:value="@string/category_scalebar" />
+      <meta-data
+              android:name="android.support.PARENT_ACTIVITY"
+              android:value=".activity.FeatureOverviewActivity" />
+    </activity>
+
     <service
       android:name="com.mapbox.mapboxsdk.plugins.offline.offline.OfflineDownloadService"
       android:exported="false"/>

app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/activity/scalebar/ScalebarActivity.kt

@@ -0,0 +1,82 @@
+package com.mapbox.mapboxsdk.plugins.testapp.activity.scalebar
+
+import android.os.Bundle
+import android.support.v7.app.AppCompatActivity
+import com.mapbox.mapboxsdk.maps.MapboxMap
+import com.mapbox.mapboxsdk.maps.Style
+import com.mapbox.mapboxsdk.plugins.testapp.R
+import com.mapbox.pluginscalebar.ScaleBarOptions
+import com.mapbox.pluginscalebar.ScaleBarPlugin
+import kotlinx.android.synthetic.main.activity_scalebar.*
+
+/**
+ * Activity showing a scalebar used on a MapView.
+ */
+class ScalebarActivity : AppCompatActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_scalebar)
+        mapView.onCreate(savedInstanceState)
+        mapView.getMapAsync { mapboxMap ->
+            mapboxMap.setStyle(Style.MAPBOX_STREETS) {
+                addScalebar(mapboxMap)
+            }
+        }
+    }
+
+    private fun addScalebar(mapboxMap: MapboxMap) {
+        val scaleBarPlugin = ScaleBarPlugin(mapView, mapboxMap)
+        val scaleBarOptions = ScaleBarOptions(this)
+        scaleBarOptions
+                .setTextColor(R.color.mapboxRed)
+                .setTextSize(20f)
+                .setBarHeight(15f)
+                .setBorderWidth(5f)
+                .setMetricUnit(true)
+                .setRefreshInterval(15)
+                .setMarginTop(15f)
+                .setMarginLeft(16f)
+                .setTextBarMargin(15f)
+
+        scaleBarPlugin.create(scaleBarOptions)
+        fabScaleWidget.setOnClickListener {
+            scaleBarPlugin.isEnabled = !scaleBarPlugin.isEnabled
+        }
+    }
+
+
+    override fun onStart() {
+        super.onStart()
+        mapView.onStart()
+    }
+
+    override fun onResume() {
+        super.onResume()
+        mapView.onResume()
+    }
+
+    override fun onPause() {
+        super.onPause()
+        mapView.onPause()
+    }
+
+    override fun onStop() {
+        super.onStop()
+        mapView.onStop()
+    }
+
+    override fun onLowMemory() {
+        super.onLowMemory()
+        mapView.onLowMemory()
+    }
+
+    override fun onDestroy() {
+        super.onDestroy()
+        mapView.onDestroy()
+    }
+
+    override fun onSaveInstanceState(outState: Bundle) {
+        super.onSaveInstanceState(outState)
+        mapView.onSaveInstanceState(outState)
+    }
+}

app/src/main/res/drawable/ic_scale.xml

@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24.0"
+    android:viewportHeight="24.0">
+    <path
+        android:fillColor="#FF000000"
+        android:pathData="M23,15h-2v2h2v-2zM23,11h-2v2h2v-2zM23,19h-2v2c1,0 2,-1 2,-2zM15,3h-2v2h2L15,3zM23,7h-2v2h2L23,7zM21,3v2h2c0,-1 -1,-2 -2,-2zM3,21h8v-6L1,15v4c0,1.1 0.9,2 2,2zM3,7L1,7v2h2L3,7zM15,19h-2v2h2v-2zM19,3h-2v2h2L19,3zM19,19h-2v2h2v-2zM3,3C2,3 1,4 1,5h2L3,3zM3,11L1,11v2h2v-2zM11,3L9,3v2h2L11,3zM7,3L5,3v2h2L7,3z"/>
+</vector>

app/src/main/res/layout/activity_scalebar.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<android.support.design.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    tools:context=".activity.scalebar.ScalebarActivity">
+
+    <com.mapbox.mapboxsdk.maps.MapView
+        android:id="@+id/mapView"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        app:mapbox_cameraTargetLat="37.769145"
+        app:mapbox_cameraTargetLng="-122.447244"
+        app:mapbox_cameraZoom="9" />
+
+    <android.support.design.widget.FloatingActionButton
+        android:id="@+id/fabScaleWidget"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="end|bottom"
+        android:layout_margin="16dp"
+        android:tint="@android:color/white"
+        app:backgroundTint="@color/colorPrimary"
+        app:srcCompat="@drawable/ic_scale" />
+</android.support.design.widget.CoordinatorLayout>