add options to configure distance formatter at runtime

abhishek1508 · abhishek1508 · commit 968196023629 · 2022-08-24T21:53:03.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 #### Features
 - Added `ComponentInstaller` for the `NavigationCameraComponent` that offers simplified integration of the `NavigationCamera`. [#6202](https://github.com/mapbox/mapbox-navigation-android/pull/6202)
 - Added `ComponentInstaller` for the `CameraModeButtonComponent` that offers simplified integration of the `NavigationCamera` mode button. [#6202](https://github.com/mapbox/mapbox-navigation-android/pull/6202)
-
+- Added `NavigationViewOptions#distanceFormatterOptions` to allow for specifying `DistanceFormatterOptions` at runtime. [#6222](https://github.com/mapbox/mapbox-navigation-android/pull/6222)
 #### Bug fixes and improvements
 
 ## Mapbox Navigation SDK 2.8.0-alpha.3 - 17 August, 2022
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewOptions.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewOptions.kt
@@ -2,6 +2,7 @@ package com.mapbox.navigation.dropin
 
 import android.content.Context
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.dropin.ViewOptionsCustomization.Companion.defaultRouteArrowOptions
 import com.mapbox.navigation.dropin.ViewOptionsCustomization.Companion.defaultRouteLineOptions
 import com.mapbox.navigation.ui.maps.NavigationStyles
@@ -33,6 +34,8 @@ internal class NavigationViewOptions(context: Context) {
         MutableStateFlow(false)
     private var _infoPanelForcedState: MutableStateFlow<Int> =
         MutableStateFlow(0)
+    private var _distanceFormatterOptions: MutableStateFlow<DistanceFormatterOptions> =
+        MutableStateFlow(DistanceFormatterOptions.Builder(context).build())
 
     var mapStyleUriDay: StateFlow<String> = _mapStyleUriDay.asStateFlow()
     var mapStyleUriNight: StateFlow<String> = _mapStyleUriNight.asStateFlow()
@@ -42,6 +45,8 @@ internal class NavigationViewOptions(context: Context) {
     val enableMapLongClickIntercept: StateFlow<Boolean> = _enableMapLongClickIntercept.asStateFlow()
     val isInfoPanelHideable: StateFlow<Boolean> = _isInfoPanelHideable.asStateFlow()
     val infoPanelForcedState: StateFlow<Int> = _infoPanelForcedState.asStateFlow()
+    val distanceFormatterOptions: StateFlow<DistanceFormatterOptions> =
+        _distanceFormatterOptions.asStateFlow()
 
     fun applyCustomization(customization: ViewOptionsCustomization) {
         customization.mapStyleUriDay?.also { _mapStyleUriDay.tryEmit(it) }
@@ -52,5 +57,6 @@ internal class NavigationViewOptions(context: Context) {
         customization.enableMapLongClickIntercept?.also { _enableMapLongClickIntercept.tryEmit(it) }
         customization.isInfoPanelHideable?.also { _isInfoPanelHideable.tryEmit(it) }
         customization.infoPanelForcedState?.also { _infoPanelForcedState.tryEmit(it) }
+        customization.distanceFormatterOptions?.also { _distanceFormatterOptions.tryEmit(it) }
     }
 }
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/ViewOptionsCustomization.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/ViewOptionsCustomization.kt
@@ -4,6 +4,7 @@ import android.content.Context
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.mapbox.maps.plugin.gestures.OnMapLongClickListener
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.ui.maps.NavigationStyles
 import com.mapbox.navigation.ui.maps.route.RouteLayerConstants
 import com.mapbox.navigation.ui.maps.route.arrow.model.RouteArrowOptions
@@ -71,6 +72,11 @@ class ViewOptionsCustomization {
      */
     var infoPanelForcedState: Int? = null
 
+    /**
+     * Set to override [DistanceFormatterOptions]
+     */
+    var distanceFormatterOptions: DistanceFormatterOptions? = null
+
     companion object {
         /**
          * Default route line options.
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/binder/infopanel/InfoPanelTripProgressBinder.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/binder/infopanel/InfoPanelTripProgressBinder.kt
@@ -27,11 +27,13 @@ internal class InfoPanelTripProgressBinder(
 
         val binding = MapboxInfoPanelTripProgressLayoutBinding.bind(viewGroup)
         return reloadOnChange(
-            navigationViewContext.styles.tripProgressStyle
-        ) { styles ->
+            navigationViewContext.styles.tripProgressStyle,
+            navigationViewContext.options.distanceFormatterOptions
+        ) { styles, formatterOptions ->
             TripProgressComponent(
                 store = navigationViewContext.store,
                 styles = styles,
+                distanceFormatterOptions = formatterOptions,
                 tripProgressView = binding.tripProgressView
             )
         }
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/maneuver/ManeuverViewBinder.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/maneuver/ManeuverViewBinder.kt
@@ -5,6 +5,7 @@ import android.transition.TransitionManager
 import android.view.ViewGroup
 import com.mapbox.maps.Style
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.dropin.R
 import com.mapbox.navigation.dropin.databinding.MapboxManeuverGuidanceLayoutBinding
@@ -19,6 +20,7 @@ import kotlinx.coroutines.flow.StateFlow
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 internal class ManeuverViewBinder(
     private val loadedMapStyle: StateFlow<Style?>,
+    private val formatterOptions: StateFlow<DistanceFormatterOptions>,
     private val maneuverViewOptions: StateFlow<ManeuverViewOptions>,
 ) : UIBinder {
     override fun bind(viewGroup: ViewGroup): MapboxNavigationObserver {
@@ -32,14 +34,16 @@ internal class ManeuverViewBinder(
 
         return reloadOnChange(
             loadedMapStyle,
-            maneuverViewOptions
-        ) { mapStyle, options ->
+            maneuverViewOptions,
+            formatterOptions
+        ) { mapStyle, options, distanceFormatterOptions ->
             if (mapStyle != null) {
                 ManeuverComponent(
                     maneuverView = binding.maneuverView,
                     userId = mapStyle.getUserId(),
                     styleId = mapStyle.getStyleId(),
-                    options = options
+                    options = options,
+                    formatterOptions = distanceFormatterOptions
                 )
             } else {
                 null
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/tripprogress/TripProgressComponent.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/tripprogress/TripProgressComponent.kt
@@ -21,14 +21,13 @@ import kotlinx.coroutines.launch
 internal class TripProgressComponent(
     val store: Store,
     @StyleRes val styles: Int,
-    val tripProgressView: MapboxTripProgressView
+    val distanceFormatterOptions: DistanceFormatterOptions,
+    private val tripProgressView: MapboxTripProgressView
 ) : UIComponent() {
 
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
         super.onAttached(mapboxNavigation)
         tripProgressView.updateStyle(styles)
-        val distanceFormatterOptions =
-            DistanceFormatterOptions.Builder(tripProgressView.context).build()
         val tripProgressFormatter = TripProgressUpdateFormatter
             .Builder(tripProgressView.context)
             .distanceRemainingFormatter(
diff --git a/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/coordinator/ManeuverCoordinator.kt b/libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/coordinator/ManeuverCoordinator.kt
@@ -33,6 +33,7 @@ internal class ManeuverCoordinator(
                     if (navigationState == NavigationState.ActiveNavigation) {
                         it ?: ManeuverViewBinder(
                             context.mapStyleLoader.loadedMapStyle,
+                            context.options.distanceFormatterOptions,
                             context.styles.maneuverViewOptions,
                         )
                     } else {
diff --git a/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/NavigationViewOptionsTest.kt b/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/NavigationViewOptionsTest.kt
@@ -6,6 +6,8 @@ import androidx.test.core.app.ApplicationProvider
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.mapbox.maps.Style
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
+import com.mapbox.navigation.base.formatter.UnitType
 import com.mapbox.navigation.ui.maps.route.RouteLayerConstants
 import com.mapbox.navigation.ui.maps.route.arrow.model.RouteArrowOptions
 import com.mapbox.navigation.ui.maps.route.line.model.MapboxRouteLineOptions
@@ -43,6 +45,7 @@ internal class NavigationViewOptionsTest {
         assertEquals(c.enableMapLongClickIntercept, sut.enableMapLongClickIntercept.value)
         assertEquals(c.isInfoPanelHideable, sut.isInfoPanelHideable.value)
         assertEquals(c.infoPanelForcedState, sut.infoPanelForcedState.value)
+        assertEquals(c.distanceFormatterOptions, sut.distanceFormatterOptions.value)
     }
 
     private fun customization() =
@@ -63,5 +66,9 @@ internal class NavigationViewOptionsTest {
             enableMapLongClickIntercept = false
             isInfoPanelHideable = true
             infoPanelForcedState = BottomSheetBehavior.STATE_EXPANDED
+            distanceFormatterOptions = DistanceFormatterOptions
+                .Builder(ctx)
+                .unitType(UnitType.METRIC)
+                .build()
         }
 }
diff --git a/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/binder/infopanel/InfoPanelTripProgressBinderTest.kt b/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/binder/infopanel/InfoPanelTripProgressBinderTest.kt
@@ -4,6 +4,7 @@ import android.content.Context
 import android.widget.FrameLayout
 import androidx.test.core.app.ApplicationProvider
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.dropin.NavigationViewContext
 import com.mapbox.navigation.dropin.internal.extensions.ReloadingComponent
 import io.mockk.MockKAnnotations
@@ -39,6 +40,9 @@ internal class InfoPanelTripProgressBinderTest {
     @Test
     fun `bind should return TripProgressComponent`() {
         every { mockNavContext.styles.tripProgressStyle } returns MutableStateFlow(1)
+        every { mockNavContext.options.distanceFormatterOptions } returns MutableStateFlow(
+            DistanceFormatterOptions.Builder(ctx).build()
+        )
         val result = sut.bind(FrameLayout(ctx))
 
         assertTrue(
diff --git a/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/component/tripprogress/TripProgressComponentTest.kt b/libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/component/tripprogress/TripProgressComponentTest.kt
@@ -4,6 +4,7 @@ import android.os.Build
 import com.mapbox.api.directions.v5.models.DirectionsRoute
 import com.mapbox.api.directions.v5.models.RouteLeg
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.trip.model.RouteProgress
 import com.mapbox.navigation.base.trip.model.RouteProgressState
@@ -78,6 +79,7 @@ class TripProgressComponentTest {
         TripProgressComponent(
             store,
             R.style.DropInStyleTripProgressView,
+            DistanceFormatterOptions.Builder(mockk(relaxed = true)).build(),
             tripProgressView
         ).onAttached(mapboxNavigation)
 
@@ -108,6 +110,7 @@ class TripProgressComponentTest {
         TripProgressComponent(
             store,
             R.style.DropInStyleTripProgressView,
+            DistanceFormatterOptions.Builder(mockk(relaxed = true)).build(),
             tripProgressView
         ).onAttached(mapboxNavigation)
 
diff --git a/libnavui-maneuver/src/main/java/com/mapbox/navigation/ui/maneuver/ComponentInstaller.kt b/libnavui-maneuver/src/main/java/com/mapbox/navigation/ui/maneuver/ComponentInstaller.kt
@@ -1,6 +1,8 @@
 package com.mapbox.navigation.ui.maneuver
 
+import android.content.Context
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.ui.base.installer.ComponentInstaller
 import com.mapbox.navigation.ui.base.installer.Installation
 import com.mapbox.navigation.ui.maneuver.internal.ManeuverComponent
@@ -24,13 +26,14 @@ fun ComponentInstaller.maneuver(
     maneuverView: MapboxManeuverView,
     config: ManeuverConfig.() -> Unit = {}
 ): Installation {
-    val componentConfig = ManeuverConfig().apply(config)
+    val componentConfig = ManeuverConfig(maneuverView.context).apply(config)
     return component(
         ManeuverComponent(
             maneuverView = maneuverView,
             userId = componentConfig.userId,
             styleId = componentConfig.styleId,
-            componentConfig.options
+            componentConfig.options,
+            componentConfig.distanceFormatterOptions
         )
     )
 }
@@ -39,7 +42,7 @@ fun ComponentInstaller.maneuver(
  * Maneuver view component configuration class.
  */
 @ExperimentalPreviewMapboxNavigationAPI
-class ManeuverConfig internal constructor() {
+class ManeuverConfig internal constructor(context: Context) {
     /**
      * [userId]
      */
@@ -50,6 +53,12 @@ class ManeuverConfig internal constructor() {
      */
     var styleId: String? = null
 
+    /**
+     * [DistanceFormatterOptions] to be used by [MapboxManeuverView].
+     */
+    var distanceFormatterOptions: DistanceFormatterOptions =
+        DistanceFormatterOptions.Builder(context).build()
+
     /**
      * Options used to create [MapboxManeuverView] instance.
      */
diff --git a/libnavui-maneuver/src/main/java/com/mapbox/navigation/ui/maneuver/internal/ManeuverComponent.kt b/libnavui-maneuver/src/main/java/com/mapbox/navigation/ui/maneuver/internal/ManeuverComponent.kt
@@ -22,10 +22,9 @@ class ManeuverComponent(
     val userId: String?,
     val styleId: String?,
     val options: ManeuverViewOptions,
+    private val formatterOptions: DistanceFormatterOptions,
     val maneuverApi: MapboxManeuverApi = MapboxManeuverApi(
-        MapboxDistanceFormatter(
-            DistanceFormatterOptions.Builder(maneuverView.context).build()
-        )
+        MapboxDistanceFormatter(formatterOptions)
     )
 ) : UIComponent() {
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
diff --git a/libnavui-maneuver/src/test/java/com/mapbox/navigation/ui/maneuver/internal/ManeuverComponentTest.kt b/libnavui-maneuver/src/test/java/com/mapbox/navigation/ui/maneuver/internal/ManeuverComponentTest.kt
@@ -1,9 +1,11 @@
 package com.mapbox.navigation.ui.maneuver.internal
 
+import android.os.Build
 import com.mapbox.api.directions.v5.DirectionsCriteria
 import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.trip.model.RouteProgress
 import com.mapbox.navigation.core.MapboxNavigation
@@ -33,7 +35,12 @@ import org.junit.After
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import org.robolectric.annotation.Config
 
+@RunWith(RobolectricTestRunner::class)
+@Config(sdk = [Build.VERSION_CODES.N])
 @ExperimentalCoroutinesApi
 @ExperimentalPreviewMapboxNavigationAPI
 class ManeuverComponentTest {
@@ -106,7 +113,9 @@ class ManeuverComponentTest {
                     userId = DirectionsCriteria.PROFILE_DEFAULT_USER,
                     styleId = "navigation-day-v1",
                     options = maneuverViewOptions,
-                    maneuverApi = mockManeuverApi
+                    maneuverApi = mockManeuverApi,
+                    formatterOptions =
+                    DistanceFormatterOptions.Builder(mockk(relaxed = true)).build()
                 )
 
             maneuverComponent.onAttached(mockNavigation)
@@ -143,7 +152,9 @@ class ManeuverComponentTest {
                     userId = DirectionsCriteria.PROFILE_DEFAULT_USER,
                     styleId = "navigation-day-v1",
                     options = maneuverViewOptions,
-                    maneuverApi = mockManeuverApi
+                    maneuverApi = mockManeuverApi,
+                    formatterOptions =
+                    DistanceFormatterOptions.Builder(mockk(relaxed = true)).build()
                 )
 
             maneuverComponent.onAttached(mockNavigation).also {
@@ -182,7 +193,9 @@ class ManeuverComponentTest {
                     userId = DirectionsCriteria.PROFILE_DEFAULT_USER,
                     styleId = "navigation-day-v1",
                     options = maneuverViewOptions,
-                    maneuverApi = mockManeuverApi
+                    maneuverApi = mockManeuverApi,
+                    formatterOptions =
+                    DistanceFormatterOptions.Builder(mockk(relaxed = true)).build()
                 )
 
             maneuverComponent.onAttached(mockNavigation)
@@ -217,7 +230,9 @@ class ManeuverComponentTest {
                     userId = DirectionsCriteria.PROFILE_DEFAULT_USER,
                     styleId = "navigation-day-v1",
                     options = maneuverViewOptions,
-                    maneuverApi = mockManeuverApi
+                    maneuverApi = mockManeuverApi,
+                    formatterOptions =
+                    DistanceFormatterOptions.Builder(mockk(relaxed = true)).build()
                 )
 
             maneuverComponent.onAttached(mockNavigation)
diff --git a/qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/customnavview/CustomizedViewModel.kt b/qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/customnavview/CustomizedViewModel.kt
@@ -15,4 +15,5 @@ class CustomizedViewModel : ViewModel() {
     val isInfoPanelHideable = MutableLiveData(false)
     val infoPanelStateOverride = MutableLiveData("--")
     val fullScreen = MutableLiveData(false)
+    val distanceFormatterMetric = MutableLiveData(false)
 }
diff --git a/qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/customnavview/MapboxNavigationViewCustomizedActivity.kt b/qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/customnavview/MapboxNavigationViewCustomizedActivity.kt
@@ -23,6 +23,8 @@ import com.mapbox.maps.Style
 import com.mapbox.maps.plugin.gestures.OnMapLongClickListener
 import com.mapbox.maps.plugin.gestures.gestures
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
+import com.mapbox.navigation.base.formatter.UnitType
 import com.mapbox.navigation.dropin.ActionButtonDescription
 import com.mapbox.navigation.dropin.ActionButtonDescription.Position.END
 import com.mapbox.navigation.dropin.ActionButtonDescription.Position.START
@@ -191,6 +193,12 @@ class MapboxNavigationViewCustomizedActivity : DrawerActivity() {
             ::toggleInfoPanelHiding
         )
 
+        bindSwitch(
+            menuBinding.useMetric,
+            viewModel.distanceFormatterMetric,
+            ::toggleUseMetric
+        )
+
         bindSpinner(
             menuBinding.spinnerInfoPanelVisibilityOverride,
             viewModel.infoPanelStateOverride,
@@ -432,6 +440,21 @@ class MapboxNavigationViewCustomizedActivity : DrawerActivity() {
         }
     }
 
+    private fun toggleUseMetric(showMetric: Boolean) {
+        val options = DistanceFormatterOptions
+            .Builder(this@MapboxNavigationViewCustomizedActivity)
+            .build()
+        if (showMetric) {
+            binding.navigationView.customizeViewOptions {
+                distanceFormatterOptions = options.toBuilder().unitType(UnitType.METRIC).build()
+            }
+        } else {
+            binding.navigationView.customizeViewOptions {
+                distanceFormatterOptions = options.toBuilder().unitType(UnitType.IMPERIAL).build()
+            }
+        }
+    }
+
     private fun customActionButton(text: String): View {
         return AppCompatTextView(this).apply {
             val w = resources.getDimensionPixelSize(R.dimen.mapbox_actionList_width)
diff --git a/qa-test-app/src/main/res/layout/layout_drawer_menu_nav_view_custom.xml b/qa-test-app/src/main/res/layout/layout_drawer_menu_nav_view_custom.xml

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ internal class ManeuverCoordinator(`
`33`	`33`	`if (navigationState == NavigationState.ActiveNavigation) {`
`34`	`34`	`it ?: ManeuverViewBinder(`
`35`	`35`	`context.mapStyleLoader.loadedMapStyle,`
	`36`	`+ context.options.distanceFormatterOptions,`
`36`	`37`	`context.styles.maneuverViewOptions,`
`37`	`38`	`)`
`38`	`39`	`} else {`