[Feature] Added Decimal Formatting Capability

gradle/libs.versions.toml

@@ -120,6 +120,9 @@ androidx-work = { module = "androidx.work:work-runtime-ktx", version.ref = "andr
 androidx-work-testing = { module = "androidx.work:work-testing", version.ref = "androidx-work" }
 androidx-recyclerview = { module = "androidx.recyclerview:recyclerview", version = "1.3.2" }
 
+# Robolectric
+roboelectric = { module = "org.robolectric:robolectric", version = "4.13" }
+
 # Material
 material = { module = "com.google.android.material:material", version = "1.12.0" }
 

shared/domain/src/main/java/com/ivy/domain/features/Features.kt

@@ -7,6 +7,7 @@ interface Features {
     val showTitleSuggestions: BoolFeature
     val showCategorySearchBar: BoolFeature
     val hideTotalBalance: BoolFeature
+    val showDecimalNumber: BoolFeature
 
     val allFeatures: List<BoolFeature>
 }

shared/domain/src/main/java/com/ivy/domain/features/IvyFeatures.kt

@@ -8,7 +8,7 @@ class IvyFeatures @Inject constructor() : Features {
 
     override val sortCategoriesAlphabetically = BoolFeature(
         key = "sort_categories_alphabetically",
-        group = FeatureGroup.Other,
+        group = FeatureGroup.Category,
         name = "Sort Categories Alphabetically",
         description = "Sort income and expenses" +
                 " categories alphabetically"
@@ -52,13 +52,25 @@ class IvyFeatures @Inject constructor() : Features {
         defaultValue = false
     )
 
+    override val showDecimalNumber = BoolFeature(
+        key = "show_decimal_number",
+        group = FeatureGroup.Other,
+        name = "Show Decimal Number",
+        description = "Whether to show the decimal part in amounts",
+        defaultValue = true
+    )
+
     override val allFeatures: List<BoolFeature>
         get() = listOf(
             sortCategoriesAlphabetically,
             compactAccountsMode,
             compactCategoriesMode,
             showTitleSuggestions,
             showCategorySearchBar,
-            hideTotalBalance
+            hideTotalBalance,
+            /* will be uncommented when this functionality
+             * will be available across the application in up-coming PRs
+            showDecimalNumber
+             */
         )
 }

shared/ui/core/build.gradle.kts

@@ -9,4 +9,6 @@ android {
 dependencies {
     implementation(projects.shared.base)
     implementation(projects.shared.domain)
+
+    testImplementation(libs.roboelectric)
 }

shared/ui/core/src/main/java/com/ivy/ui/FormatMoneyUseCase.kt

@@ -0,0 +1,29 @@
+package com.ivy.ui
+
+import android.content.Context
+import com.ivy.domain.features.Features
+import com.ivy.ui.time.DevicePreferences
+import dagger.hilt.android.qualifiers.ApplicationContext
+import java.text.DecimalFormat
+import java.text.DecimalFormatSymbols
+import javax.inject.Inject
+
+class FormatMoneyUseCase @Inject constructor(
+    private val feature: Features,
+    private val devicePreferences: DevicePreferences,
+    @ApplicationContext private val context: Context
+) {
+
+    private val locale = devicePreferences.locale()
+    private val withoutDecimalFormatter = DecimalFormat("###,###", DecimalFormatSymbols(locale))
+    private val withDecimalFormatter = DecimalFormat("###,###.00", DecimalFormatSymbols(locale))
+
+    suspend fun format(value: Double): String {
+        val showDecimalPoint = feature.showDecimalNumber.isEnabled(context)
+
+        return when (showDecimalPoint) {
+            true -> withDecimalFormatter.format(value)
+            false -> withoutDecimalFormatter.format(value)
+        }
+    }
+}

shared/ui/core/src/test/java/com/ivy/ui/FormatMoneyUseCaseTest.kt

@@ -0,0 +1,102 @@
+package com.ivy.ui
+
+import android.content.Context
+import androidx.test.platform.app.InstrumentationRegistry
+import com.ivy.domain.features.BoolFeature
+import com.ivy.domain.features.FeatureGroup
+import com.ivy.domain.features.Features
+import com.ivy.ui.time.DevicePreferences
+import io.kotest.common.runBlocking
+import io.kotest.matchers.shouldBe
+import io.mockk.every
+import io.mockk.mockk
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.ParameterizedRobolectricTestRunner
+import java.util.Locale
+
+@RunWith(ParameterizedRobolectricTestRunner::class)
+class FormatMoneyUseCaseTest(private val param: TestData) {
+
+    private val context: Context = InstrumentationRegistry.getInstrumentation().context
+    private val features = mockk<Features>()
+    private val devicePreferences = mockk<DevicePreferences>()
+
+    class TestData(
+        val givenInput: Double,
+        val showDecimal: BoolFeature,
+        val locale: Locale,
+        val expectedOutPut: String
+    )
+
+    private lateinit var formatMoneyUseCase: FormatMoneyUseCase
+
+    @Test
+    fun `validate decimal formatting`(): Unit = runBlocking {
+        // given
+        every { features.showDecimalNumber } returns param.showDecimal
+        every { devicePreferences.locale() } returns param.locale
+        formatMoneyUseCase = FormatMoneyUseCase(features, devicePreferences, context)
+
+        // when
+        val result = formatMoneyUseCase.format(value = param.givenInput)
+
+        // then
+        result shouldBe param.expectedOutPut
+    }
+
+    companion object {
+        @JvmStatic
+        @ParameterizedRobolectricTestRunner.Parameters(name = "Input: {0}")
+        fun params() = listOf(
+            TestData(
+                givenInput = 1000.12,
+                showDecimal = BoolFeature(
+                    key = "show_decimal_number",
+                    group = FeatureGroup.Other,
+                    name = "Show Decimal Number",
+                    description = "Whether to show the decimal part in amounts",
+                    defaultValue = true
+                ),
+                locale = Locale.ENGLISH,
+                expectedOutPut = "1,000.12"
+            ),
+            TestData(
+                givenInput = 1000.12,
+                showDecimal = BoolFeature(
+                    key = "show_decimal_number",
+                    group = FeatureGroup.Other,
+                    name = "Show Decimal Number",
+                    description = "Whether to show the decimal part in amounts",
+                    defaultValue = false
+                ),
+                locale = Locale.ENGLISH,
+                expectedOutPut = "1,000"
+            ),
+            TestData(
+                givenInput = 1000.12,
+                showDecimal = BoolFeature(
+                    key = "show_decimal_number",
+                    group = FeatureGroup.Other,
+                    name = "Show Decimal Number",
+                    description = "Whether to show the decimal part in amounts",
+                    defaultValue = true
+                ),
+                locale = Locale.GERMAN,
+                expectedOutPut = "1.000,12"
+            ),
+            TestData(
+                givenInput = 1000.12,
+                showDecimal = BoolFeature(
+                    key = "show_decimal_number",
+                    group = FeatureGroup.Other,
+                    name = "Show Decimal Number",
+                    description = "Whether to show the decimal part in amounts",
+                    defaultValue = false
+                ),
+                locale = Locale.GERMAN,
+                expectedOutPut = "1.000"
+            ),
+        )
+    }
+}