Merge pull request #16947 from wordpress-mobile/issue/16491-fix-percent-sign-localized

Fix percent sign should be localized

Author: irfano

WordPress/src/main/java/org/wordpress/android/ui/jetpack/backup/download/BackupDownloadViewModel.kt

@@ -58,8 +58,8 @@ import org.wordpress.android.ui.jetpack.common.providers.JetpackAvailableItemsPr
 import org.wordpress.android.ui.jetpack.usecases.GetActivityLogItemUseCase
 import org.wordpress.android.ui.pages.SnackbarMessageHolder
 import org.wordpress.android.ui.utils.UiString.UiStringRes
-import org.wordpress.android.ui.utils.UiString.UiStringResWithParams
 import org.wordpress.android.ui.utils.UiString.UiStringText
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.util.wizard.WizardManager
 import org.wordpress.android.util.wizard.WizardNavigationTarget
 import org.wordpress.android.util.wizard.WizardState
@@ -98,7 +98,8 @@ class BackupDownloadViewModel @Inject constructor(
     private val stateListItemBuilder: BackupDownloadStateListItemBuilder,
     private val postBackupDownloadUseCase: PostBackupDownloadUseCase,
     private val getBackupDownloadStatusUseCase: GetBackupDownloadStatusUseCase,
-    @Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher
+    @Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher,
+    private val percentFormatter: PercentFormatter
 ) : ScopedViewModel(mainDispatcher) {
     private var isStarted = false
     private lateinit var site: SiteModel
@@ -348,10 +349,7 @@ class BackupDownloadViewModel @Inject constructor(
                     contentState as JetpackListItemState.ProgressState
                     contentState.copy(
                             progress = state.progress ?: 0,
-                            progressLabel = UiStringResWithParams(
-                                    string.backup_download_progress_label,
-                                    listOf(UiStringText(state.progress?.toString() ?: "0"))
-                            )
+                            progressLabel = UiStringText(percentFormatter.format(state.progress ?: 0))
                     )
                 } else {
                     contentState

WordPress/src/main/java/org/wordpress/android/ui/jetpack/backup/download/builders/BackupDownloadStateListItemBuilder.kt

@@ -28,12 +28,14 @@ import org.wordpress.android.ui.utils.UiString.UiStringResWithParams
 import org.wordpress.android.ui.utils.UiString.UiStringText
 import org.wordpress.android.util.extensions.toFormattedDateString
 import org.wordpress.android.util.extensions.toFormattedTimeString
+import org.wordpress.android.util.text.PercentFormatter
 import java.util.Date
 import javax.inject.Inject
 
 @Reusable
 class BackupDownloadStateListItemBuilder @Inject constructor(
-    private val checkboxSpannableLabel: CheckboxSpannableLabel
+    private val checkboxSpannableLabel: CheckboxSpannableLabel,
+    private val percentFormatter: PercentFormatter
 ) {
     fun buildDetailsListStateItems(
         published: Date,
@@ -242,10 +244,7 @@ class BackupDownloadStateListItemBuilder @Inject constructor(
 
     private fun buildProgressState(progress: Int) = ProgressState(
             progress = progress,
-            progressLabel = UiStringResWithParams(
-                    R.string.backup_download_progress_label,
-                    listOf(UiStringText(progress.toString()))
-            )
+            progressLabel = UiStringText(percentFormatter.format(progress))
     )
 
     private fun buildBulletState(

WordPress/src/main/java/org/wordpress/android/ui/jetpack/restore/RestoreViewModel.kt

@@ -61,8 +61,8 @@ import org.wordpress.android.ui.jetpack.restore.usecases.PostRestoreUseCase
 import org.wordpress.android.ui.jetpack.usecases.GetActivityLogItemUseCase
 import org.wordpress.android.ui.pages.SnackbarMessageHolder
 import org.wordpress.android.ui.utils.UiString.UiStringRes
-import org.wordpress.android.ui.utils.UiString.UiStringResWithParams
 import org.wordpress.android.ui.utils.UiString.UiStringText
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.util.wizard.WizardManager
 import org.wordpress.android.util.wizard.WizardNavigationTarget
 import org.wordpress.android.util.wizard.WizardState
@@ -102,7 +102,8 @@ class RestoreViewModel @Inject constructor(
     private val stateListItemBuilder: RestoreStateListItemBuilder,
     private val postRestoreUseCase: PostRestoreUseCase,
     private val getRestoreStatusUseCase: GetRestoreStatusUseCase,
-    @Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher
+    @Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher,
+    private val percentFormatter: PercentFormatter
 ) : ScopedViewModel(mainDispatcher) {
     private var isStarted = false
     private lateinit var site: SiteModel
@@ -415,10 +416,7 @@ class RestoreViewModel @Inject constructor(
                     contentState as JetpackListItemState.ProgressState
                     contentState.copy(
                             progress = restoreStatus.progress ?: 0,
-                            progressLabel = UiStringResWithParams(
-                                    R.string.restore_progress_label,
-                                    listOf(UiStringText(restoreStatus.progress?.toString() ?: "0"))
-                            ),
+                            progressLabel = UiStringText(percentFormatter.format(restoreStatus.progress ?: 0)),
                             progressInfoLabel = if (restoreStatus.currentEntry != null) {
                                 UiStringText("${restoreStatus.currentEntry}")
                             } else {

WordPress/src/main/java/org/wordpress/android/ui/jetpack/restore/builders/RestoreStateListItemBuilder.kt

@@ -30,13 +30,15 @@ import org.wordpress.android.ui.utils.UiString.UiStringResWithParams
 import org.wordpress.android.ui.utils.UiString.UiStringText
 import org.wordpress.android.util.extensions.toFormattedDateString
 import org.wordpress.android.util.extensions.toFormattedTimeString
+import org.wordpress.android.util.text.PercentFormatter
 import java.util.Date
 import javax.inject.Inject
 
 @Reusable
 class RestoreStateListItemBuilder @Inject constructor(
     private val checkboxSpannableLabel: CheckboxSpannableLabel,
-    private val htmlMessageUtils: HtmlMessageUtils
+    private val htmlMessageUtils: HtmlMessageUtils,
+    private val percentFormatter: PercentFormatter
 ) {
     @Suppress("LongParameterList")
     fun buildDetailsListStateItems(
@@ -296,9 +298,7 @@ class RestoreStateListItemBuilder @Inject constructor(
     private fun buildProgressState(progress: Int, isIndeterminate: Boolean = false) = ProgressState(
             progress = progress,
             isIndeterminate = isIndeterminate,
-            progressLabel = UiStringResWithParams(
-                    R.string.restore_progress_label, listOf(UiStringText(progress.toString()))
-            )
+            progressLabel = UiStringText(percentFormatter.format(progress))
     )
 
     private fun buildBulletState(

WordPress/src/main/java/org/wordpress/android/ui/jetpack/scan/builders/ScanStateListItemsBuilder.kt

@@ -26,6 +26,7 @@ import org.wordpress.android.ui.utils.HtmlMessageUtils
 import org.wordpress.android.ui.utils.UiString.UiStringRes
 import org.wordpress.android.ui.utils.UiString.UiStringResWithParams
 import org.wordpress.android.ui.utils.UiString.UiStringText
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.viewmodel.ResourceProvider
 import javax.inject.Inject
 
@@ -36,7 +37,8 @@ class ScanStateListItemsBuilder @Inject constructor(
     private val resourceProvider: ResourceProvider,
     private val threatItemBuilder: ThreatItemBuilder,
     private val threatDetailsListItemsBuilder: ThreatDetailsListItemsBuilder,
-    private val scanStore: ScanStore
+    private val scanStore: ScanStore,
+    private val percentFormatter: PercentFormatter
 ) {
     @Suppress("LongParameterList")
     suspend fun buildScanStateListItems(
@@ -199,10 +201,7 @@ class ScanStateListItemsBuilder @Inject constructor(
         val scanDescription = DescriptionState(UiStringRes(descriptionRes))
         val scanProgress = ProgressState(
                 progress = progress,
-                progressLabel = UiStringResWithParams(
-                        R.string.scan_progress_label,
-                        listOf(UiStringText(progress.toString()))
-                )
+                progressLabel = UiStringText(percentFormatter.format(progress))
         )
 
         items.add(scanIcon)

WordPress/src/main/java/org/wordpress/android/ui/stats/refresh/lists/detail/PostDayViewsMapper.kt

@@ -11,14 +11,16 @@ import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.Value
 import org.wordpress.android.ui.stats.refresh.utils.HUNDRED_THOUSAND
 import org.wordpress.android.ui.stats.refresh.utils.StatsDateFormatter
 import org.wordpress.android.ui.stats.refresh.utils.StatsUtils
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.viewmodel.ResourceProvider
 import javax.inject.Inject
 
 class PostDayViewsMapper
 @Inject constructor(
     private val resourceProvider: ResourceProvider,
     private val statsUtils: StatsUtils,
-    private val statsDateFormatter: StatsDateFormatter
+    private val statsDateFormatter: StatsDateFormatter,
+    private val percentFormatter: PercentFormatter
 ) {
     fun buildTitle(
         selectedItem: Day,
@@ -63,7 +65,10 @@ class PostDayViewsMapper
             val percentage = when (previousValue) {
                 value -> "0"
                 0 -> "∞"
-                else -> mapIntToString((difference * 100 / previousValue), isFormattedNumber)
+                else -> {
+                    val percentageValue = difference.toFloat() / previousValue
+                    percentFormatter.format(percentageValue)
+                }
             }
             val formattedDifference = mapIntToString(difference, isFormattedNumber)
             if (positive) {

WordPress/src/main/java/org/wordpress/android/ui/stats/refresh/lists/sections/insights/usecases/MostPopularInsightsUseCase.kt

@@ -22,6 +22,7 @@ import org.wordpress.android.ui.stats.refresh.utils.ActionCardHandler
 import org.wordpress.android.ui.stats.refresh.utils.DateUtils
 import org.wordpress.android.ui.stats.refresh.utils.ItemPopupMenuHandler
 import org.wordpress.android.ui.stats.refresh.utils.StatsSiteProvider
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.viewmodel.ResourceProvider
 import javax.inject.Inject
 import javax.inject.Named
@@ -37,7 +38,8 @@ class MostPopularInsightsUseCase
     private val dateUtils: DateUtils,
     private val resourceProvider: ResourceProvider,
     private val popupMenuHandler: ItemPopupMenuHandler,
-    private val actionCardHandler: ActionCardHandler
+    private val actionCardHandler: ActionCardHandler,
+    private val percentFormatter: PercentFormatter
 ) : StatelessUseCase<InsightsMostPopularModel>(MOST_POPULAR_DAY_AND_HOUR, mainDispatcher, backgroundDispatcher) {
     override suspend fun loadCachedData(): InsightsMostPopularModel? {
         return mostPopularStore.getMostPopularInsights(statsSiteProvider.siteModel)
@@ -73,11 +75,11 @@ class MostPopularInsightsUseCase
         } else {
             val highestDayPercent = resourceProvider.getString(
                     R.string.stats_most_popular_percent_views,
-                    domainModel.highestDayPercent.roundToInt()
+                    percentFormatter.format(domainModel.highestDayPercent.roundToInt())
             )
             val highestHourPercent = resourceProvider.getString(
                     R.string.stats_most_popular_percent_views,
-                    domainModel.highestHourPercent.roundToInt()
+                    percentFormatter.format(domainModel.highestHourPercent.roundToInt())
             )
             items.add(
                     QuickScanItem(

WordPress/src/main/java/org/wordpress/android/ui/stats/refresh/utils/StatsUtils.kt

@@ -5,6 +5,7 @@ import org.wordpress.android.R
 import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.BarChartItem.Bar
 import org.wordpress.android.ui.stats.refresh.lists.sections.BlockListItem.LineChartItem.Line
 import org.wordpress.android.util.LocaleManagerWrapper
+import org.wordpress.android.util.text.PercentFormatter
 import org.wordpress.android.viewmodel.ResourceProvider
 import java.text.DecimalFormat
 import java.util.TreeMap
@@ -19,7 +20,8 @@ const val MILLION = 1000000
 class StatsUtils
 @Inject constructor(
     private val resourceProvider: ResourceProvider,
-    private val localeManager: LocaleManagerWrapper
+    private val localeManager: LocaleManagerWrapper,
+    private val percentFormatter: PercentFormatter
 ) {
     private val suffixes = TreeMap(
             mapOf(
@@ -194,7 +196,10 @@ class StatsUtils
             val percentage = when (previousValue) {
                 value -> "0"
                 0L -> "∞"
-                else -> mapLongToString((difference * 100 / previousValue), isFormattedNumber)
+                else -> {
+                    val percentageValue = difference.toFloat() / previousValue
+                    percentFormatter.format(percentageValue)
+                }
             }
             val formattedDifference = mapLongToString(difference, isFormattedNumber)
             if (positive) {

WordPress/src/main/java/org/wordpress/android/util/text/PercentFormatter.kt

@@ -0,0 +1,52 @@
+package org.wordpress.android.util.text
+
+import android.icu.text.NumberFormat
+import org.wordpress.android.util.LocaleManagerWrapper
+import java.math.RoundingMode
+import javax.inject.Inject
+
+private const val MAXIMUM_FRACTION_DIGITS = 0
+private const val FORMAT_DIVISOR = 100
+
+/**
+ * Used to format a string with a percent sign (%) based on the locale.
+ * @param localeManagerWrapper provides the Locale used to return the localized formatted string
+ */
+class PercentFormatter @Inject constructor(
+    private val localeManagerWrapper: LocaleManagerWrapper
+) {
+    /**
+     * Returns a String with a percent sign (%) using the given Float parameter. The returned String uses the
+     * default Locale.
+     * @param value the value to be returned formatted
+     * @return the formatted string
+     */
+    fun format(
+        value: Float,
+        maxFractionDigits: Int = MAXIMUM_FRACTION_DIGITS,
+        rounding: RoundingMode = RoundingMode.DOWN
+    ): String {
+        val percentFormatter = NumberFormat.getPercentInstance(localeManagerWrapper.getLocale()).apply {
+            maximumFractionDigits = maxFractionDigits
+            roundingMode = rounding.ordinal
+        }
+        return percentFormatter.format(value)
+    }
+
+    /**
+     * Returns a String with a percent sign (%) using the given Int parameter. The Int value will be returned as the
+     * percentage (e.g. if the Int value is 10, the returned String for Locale.US will be "10%"). The returned String
+     * uses the default Locale.
+     * @param value the value to be returned formatted
+     * @return the formatted string
+     */
+    fun format(
+        value: Int,
+        maxFractionDigits: Int = MAXIMUM_FRACTION_DIGITS,
+        rounding: RoundingMode = RoundingMode.DOWN
+    ) = format(
+            value = value.toFloat() / FORMAT_DIVISOR,
+            maxFractionDigits,
+            rounding
+    )
+}

WordPress/src/main/res/values-ar/strings.xml

@@ -731,7 +731,6 @@ Language: ar
     <string name="restore_complete_failed_icon_content_description">أيقونة الخطأ</string>
     <string name="restore_complete_failed_action_button_content_description">زر الانتهاء</string>
     <string name="restore_another_process_running">هناك عملية استعادة أخرى قيد التشغيل.</string>
-    <string name="restore_progress_label">%1$s%%</string>
     <string name="restore_complete_visit_site_action_button">زيارة الموقع</string>
     <string name="restore_complete_icon_content_description">أيقونة الاستعادة</string>
     <string name="restore_complete_done_button_content_description">زر الانتهاء</string>
@@ -809,7 +808,6 @@ Language: ar
     <string name="backup_download_complete_download_action_button_content_description">زر التنزيل</string>
     <string name="backup_download_complete_description_with_two_parameters">أنشأنا نسخة احتياطية من موقعك بنجاح من %1$s %2$s.</string>
     <string name="backup_download_complete_icon_content_description">أيقونة جاهزية النسخ الاحتياطية القابلة للتنزيل</string>
-    <string name="backup_download_progress_label">%1$s%%</string>
     <string name="backup_download_complete_page_title">نسختك الاحتياطية</string>
     <string name="backup_download_progress_header">إنشاء نسخة احتياطية قابلة للتنزيل من موقعك في الوقت الحالي</string>
     <string name="backup_download_progress_icon_content_description">جاري إنشاء أيقونة نسخة احتياطية قابلة للتنزيل</string>
@@ -1776,10 +1774,7 @@ Language: ar
     <string name="notification_channel_reminder_title">تذكير</string>
     <string name="stats_select_next_period_description">تحديد الفترة التالية</string>
     <string name="stats_select_previous_period_description">تحديد الفترة السابقة</string>
-    <string name="stats_most_popular_percent_views">%1$d%% من المشاهدات</string>
     <string name="stats_insights_popular">الوقت الأكثر شعبية</string>
-    <string name="stats_traffic_change">%1$s (%2$s%%)</string>
-    <string name="stats_traffic_increase">+%1$s (%2$s%%)</string>
     <string name="new_site_creation_site_preview_content_description">عرض معاينة الموقع</string>
     <string name="new_site_creation_clear_all_content_description">مسح</string>
     <string name="site_created_but_not_fetched_snackbar_message">يبدو أنَّ الاتصال بطيء لديك. إذا كنت لا ترى موقعك الجديد في القائمة، فحاول التحديث مجددًا.</string>