NAVAND-979: use distance-dependent default rounding increments

Author: dzinad

changelog/unreleased/bugfixes/dd2.md

@@ -0,0 +1 @@
+- Made default rounding increment in `DistanceFormatterOptions` dependent on distance numerical value.

libnavigation-base/api/current.txt

@@ -63,10 +63,11 @@ package com.mapbox.navigation.base.formatter {
     field public static final int INCREMENT_ONE_HUNDRED = 100; // 0x64
     field public static final int INCREMENT_TEN = 10; // 0xa
     field public static final int INCREMENT_TWENTY_FIVE = 25; // 0x19
+    field public static final int INCREMENT_UNDEFINED = -1; // 0xffffffff
     field public static final com.mapbox.navigation.base.formatter.Rounding INSTANCE;
   }
 
-  @IntDef({com.mapbox.navigation.base.formatter.Rounding.INCREMENT_FIVE, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_TEN, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_TWENTY_FIVE, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_FIFTY, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_ONE_HUNDRED}) @kotlin.annotation.Retention(kotlin.annotation.AnnotationRetention.BINARY) public static @interface Rounding.Increment {
+  @IntDef({com.mapbox.navigation.base.formatter.Rounding.INCREMENT_UNDEFINED, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_FIVE, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_TEN, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_TWENTY_FIVE, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_FIFTY, com.mapbox.navigation.base.formatter.Rounding.INCREMENT_ONE_HUNDRED}) @kotlin.annotation.Retention(kotlin.annotation.AnnotationRetention.BINARY) public static @interface Rounding.Increment {
   }
 
   public enum UnitType {

libnavigation-base/src/main/java/com/mapbox/navigation/base/formatter/DistanceFormatterOptions.kt

@@ -78,7 +78,7 @@ class DistanceFormatterOptions private constructor(
         private val applicationContext: Context = applicationContext.applicationContext
         private var locale: Locale = applicationContext.inferDeviceLocale()
         private var unitType: UnitType? = null
-        private var roundingIncrement = Rounding.INCREMENT_FIFTY
+        private var roundingIncrement = Rounding.INCREMENT_UNDEFINED
 
         /**
          * Policy for the various units of measurement.

libnavigation-base/src/main/java/com/mapbox/navigation/base/formatter/Rounding.kt

@@ -6,6 +6,12 @@ import androidx.annotation.IntDef
  * Rounding
  */
 object Rounding {
+
+    /**
+     * Undefined rounding increment.
+     */
+    const val INCREMENT_UNDEFINED = -1
+
     /**
      * Rounding increment 5
      *
@@ -46,6 +52,7 @@ object Rounding {
      */
     @Retention(AnnotationRetention.BINARY)
     @IntDef(
+        INCREMENT_UNDEFINED,
         INCREMENT_FIVE,
         INCREMENT_TEN,
         INCREMENT_TWENTY_FIVE,

libnavigation-core/src/main/java/com/mapbox/navigation/core/formatter/MapboxDistanceUtil.kt

@@ -3,6 +3,7 @@ package com.mapbox.navigation.core.formatter
 import android.content.Context
 import android.content.res.Configuration
 import android.content.res.Resources
+import com.mapbox.navigation.base.formatter.Rounding
 import com.mapbox.navigation.base.formatter.UnitType
 import com.mapbox.navigation.core.R
 import com.mapbox.turf.TurfConstants
@@ -16,6 +17,7 @@ import kotlin.math.roundToInt
  */
 object MapboxDistanceUtil {
 
+    private const val INVALID_ROUNDING_INCREMENT = 50
     private val enLanguage = Locale("en").language
 
     /**
@@ -84,12 +86,28 @@ object MapboxDistanceUtil {
             distanceInMeters !in 0.0..Double.MAX_VALUE -> smallValue(
                 0.0,
                 roundingIncrement,
+                INVALID_ROUNDING_INCREMENT,
+                TurfConstants.UNIT_METERS,
+                UnitType.METRIC
+            )
+            distanceInMeters < 25.0 -> smallValue(
+                distanceInMeters,
+                roundingIncrement,
+                5,
+                TurfConstants.UNIT_METERS,
+                UnitType.METRIC
+            )
+            distanceInMeters < 100 -> smallValue(
+                distanceInMeters,
+                roundingIncrement,
+                25,
                 TurfConstants.UNIT_METERS,
                 UnitType.METRIC
             )
             distanceInMeters < 1000.0 -> smallValue(
                 distanceInMeters,
                 roundingIncrement,
+                50,
                 TurfConstants.UNIT_METERS,
                 UnitType.METRIC
             )
@@ -128,6 +146,7 @@ object MapboxDistanceUtil {
             distanceInMiles !in 0.0..Double.MAX_VALUE -> smallValue(
                 0.0,
                 roundingIncrement,
+                INVALID_ROUNDING_INCREMENT,
                 TurfConstants.UNIT_YARDS,
                 UnitType.IMPERIAL
             )
@@ -137,12 +156,30 @@ object MapboxDistanceUtil {
                     TurfConstants.UNIT_MILES,
                     TurfConstants.UNIT_YARDS
                 )
-                smallValue(
-                    distanceInYards,
-                    roundingIncrement,
-                    TurfConstants.UNIT_YARDS,
-                    UnitType.IMPERIAL
-                )
+                when {
+                    distanceInYards < 20 -> smallValue(
+                        distanceInYards,
+                        roundingIncrement,
+                        10,
+                        TurfConstants.UNIT_YARDS,
+                        UnitType.IMPERIAL
+                    )
+                    distanceInYards < 100 -> smallValue(
+                        distanceInYards,
+                        roundingIncrement,
+                        25,
+                        TurfConstants.UNIT_YARDS,
+                        UnitType.IMPERIAL
+                    )
+                    else -> smallValue(
+                        distanceInYards,
+                        roundingIncrement,
+                        50,
+                        TurfConstants.UNIT_YARDS,
+                        UnitType.IMPERIAL
+                    )
+                }
+
             }
             distanceInMiles < 3.0 -> largeValue(
                 distanceInMiles,
@@ -170,6 +207,7 @@ object MapboxDistanceUtil {
             distanceInMiles !in 0.0..Double.MAX_VALUE -> smallValue(
                 0.0,
                 roundingIncrement,
+                INVALID_ROUNDING_INCREMENT,
                 TurfConstants.UNIT_FEET,
                 UnitType.IMPERIAL
             )
@@ -182,6 +220,7 @@ object MapboxDistanceUtil {
                 smallValue(
                     distanceInFeet,
                     roundingIncrement,
+                    50,
                     TurfConstants.UNIT_FEET,
                     UnitType.IMPERIAL
                 )
@@ -206,12 +245,15 @@ object MapboxDistanceUtil {
     private fun smallValue(
         distance: Double,
         roundingIncrement: Int,
+        defaultRoundingIncrement: Int,
         unitTypeString: String,
         unitType: UnitType
     ): FormattingData {
+        val inferredRoundingIncrement = if (roundingIncrement == Rounding.INCREMENT_UNDEFINED)
+            defaultRoundingIncrement else roundingIncrement
         val roundedValue = roundSmallDistance(
             distance,
-            roundingIncrement,
+            inferredRoundingIncrement,
         )
         return FormattingData(
             roundedValue.toDouble(),
@@ -266,6 +308,7 @@ object MapboxDistanceUtil {
      * @param distanceInMeters in meters
      * @param roundingIncrement used to alter the original value for display purposes
      * @param unitType indicates whether the value should be returned as metric or imperial
+     * @param locale a specified locale to use rather than the default locale provided by the context
      * @return an object containing values for displaying the formatted distance
      */
     @JvmOverloads