feat: move error strings from hardcode in VM to string resources

kheynov · kheynov · commit ba38509af8e3 · 2022-12-08T23:03:44.000+07:00
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/create_room/CreateRoomFragment.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/create_room/CreateRoomFragment.kt
@@ -119,7 +119,9 @@ class CreateRoomFragment : Fragment() {
         when (action) {
             is CreateRoomFragmentViewModel.Action.ShowError -> {
                 Toast.makeText(
-                    context, "Error: ${action.error}", Toast.LENGTH_SHORT
+                    context,
+                    "Error: ${action.error.getText(context)}",
+                    Toast.LENGTH_SHORT
                 ).show()
             }
             CreateRoomFragmentViewModel.Action.ShowSuccess -> {
@@ -135,11 +137,9 @@ class CreateRoomFragment : Fragment() {
                     }
                     fragment.arguments = args
                     activity?.supportFragmentManager?.beginTransaction()
-                        ?.replace(R.id.fragment_container, fragment)?.commit()
-                        ?: Log.i(
-                            "CreateRoomFragment",
-                            "Unable to navigate"
-                        )
+                        ?.replace(R.id.fragment_container, fragment)?.commit() ?: Log.i(
+                        "CreateRoomFragment", "Unable to navigate"
+                    )
                 }
             }
         }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/create_room/CreateRoomFragmentViewModel.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/create_room/CreateRoomFragmentViewModel.kt
@@ -9,10 +9,12 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.receiveAsFlow
 import kotlinx.coroutines.launch
+import ru.kheynov.secretsanta.R
 import ru.kheynov.secretsanta.domain.entities.RoomDTO
 import ru.kheynov.secretsanta.domain.use_cases.rooms.RoomsUseCases
 import ru.kheynov.secretsanta.utils.Resource
 import ru.kheynov.secretsanta.utils.SantaException
+import ru.kheynov.secretsanta.utils.UiText
 import java.time.LocalDate
 import javax.inject.Inject
 
@@ -34,7 +36,7 @@ class CreateRoomFragmentViewModel @Inject constructor(
     val actions: Flow<Action> = _actions.receiveAsFlow()
 
     sealed interface Action {
-        data class ShowError(val error: String) : Action
+        data class ShowError(val error: UiText) : Action
         object ShowSuccess : Action
     }
 
@@ -45,7 +47,13 @@ class CreateRoomFragmentViewModel @Inject constructor(
         viewModelScope.launch {
             _state.value = State.Loading
             if (room.roomName.isBlank()) {
-                _actions.send(Action.ShowError("Room name can't be empty"))
+                _actions.send(
+                    Action.ShowError(
+                        UiText.StringResource(
+                            R.string.room_name_empty_error
+                        )
+                    )
+                )
                 _state.value = State.Idle
                 return@launch
             }
@@ -59,7 +67,13 @@ class CreateRoomFragmentViewModel @Inject constructor(
                         _state.value = State.Error(res.exception)
                     } else {
                         _state.value = State.Idle
-                        _actions.send(Action.ShowError(res.exception.javaClass.simpleName.toString()))
+                        _actions.send(
+                            Action.ShowError(
+                                UiText.PlainText(
+                                    res.exception.javaClass.simpleName.toString()
+                                )
+                            )
+                        )
                     }
                 }
             }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/join_room/JoinRoomFragment.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/join_room/JoinRoomFragment.kt
@@ -59,23 +59,29 @@ class JoinRoomFragment : Fragment() {
                 viewModel.state.collect(::updateUI)
             }
         }
+    }
+
+    override fun onResume() {
+        super.onResume()
         lifecycleScope.launch {
-            repeatOnLifecycle(Lifecycle.State.STARTED) {
-                viewModel.actions.collect(::handleAction)
-            }
+            viewModel.actions.collect(::handleAction)
         }
     }
 
     private fun handleAction(action: JoinRoomViewModel.Action) {
         when (action) {
             JoinRoomViewModel.Action.NavigateBack -> {
-                activity?.supportFragmentManager
-                    ?.popBackStack(null, FragmentManager.POP_BACK_STACK_INCLUSIVE)
+                activity?.supportFragmentManager?.popBackStack(
+                    null,
+                    FragmentManager.POP_BACK_STACK_INCLUSIVE
+                )
                 activity?.viewModels<MainActivityViewModel>()?.value?.navigateToRoomsList()
             }
             is JoinRoomViewModel.Action.ShowError -> {
-                Log.e("JoinRoomFragment", action.error)
-                Toast.makeText(context, action.error, Toast.LENGTH_SHORT).show()
+                Log.e("JoinRoomFragment", action.error.getText(context))
+                Toast.makeText(
+                    context, action.error.getText(context), Toast.LENGTH_SHORT
+                ).show()
             }
         }
     }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/join_room/JoinRoomViewModel.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/join_room/JoinRoomViewModel.kt
@@ -9,9 +9,11 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.receiveAsFlow
 import kotlinx.coroutines.launch
+import ru.kheynov.secretsanta.R
 import ru.kheynov.secretsanta.domain.use_cases.game.GameUseCases
 import ru.kheynov.secretsanta.utils.Resource
 import ru.kheynov.secretsanta.utils.SantaException
+import ru.kheynov.secretsanta.utils.UiText
 import javax.inject.Inject
 
 @HiltViewModel
@@ -26,7 +28,7 @@ class JoinRoomViewModel @Inject constructor(
     }
 
     sealed interface Action {
-        data class ShowError(val error: String) : Action
+        data class ShowError(val error: UiText) : Action
         object NavigateBack : Action
     }
 
@@ -40,7 +42,7 @@ class JoinRoomViewModel @Inject constructor(
         viewModelScope.launch {
             _state.value = State.Loading
             if (roomId.isBlank()) {
-                _actions.send(Action.ShowError("Room ID can't be empty"))
+                _actions.send(Action.ShowError(UiText.StringResource(R.string.room_id_empty_error)))
                 _state.value = State.Idle
                 return@launch
             }
@@ -53,7 +55,13 @@ class JoinRoomViewModel @Inject constructor(
                         _state.value = State.Error(res.exception)
                     } else {
                         _state.value = State.Idle
-                        _actions.send(Action.ShowError(res.exception.javaClass.simpleName.toString()))
+                        _actions.send(
+                            Action.ShowError(
+                                UiText.PlainText(
+                                    res.exception.javaClass.simpleName.toString()
+                                )
+                            )
+                        )
                     }
                 }
             }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/EditUserFragment.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/EditUserFragment.kt
@@ -72,7 +72,7 @@ class EditUserFragment : Fragment() {
         when (action) {
             Action.NavigateBack -> activity?.supportFragmentManager?.popBackStack()
             is Action.ShowError -> Toast.makeText(
-                context, "Error: ${action.error}", Toast.LENGTH_SHORT
+                context, "Error: ${action.error.getText(context)}", Toast.LENGTH_SHORT
             ).show()
         }
     }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/EditUserViewModel.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/EditUserViewModel.kt
@@ -9,9 +9,11 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.receiveAsFlow
 import kotlinx.coroutines.launch
+import ru.kheynov.secretsanta.R
 import ru.kheynov.secretsanta.domain.entities.UpdateUser
 import ru.kheynov.secretsanta.domain.use_cases.users.UsersUseCases
 import ru.kheynov.secretsanta.utils.Resource
+import ru.kheynov.secretsanta.utils.UiText
 import javax.inject.Inject
 
 @HiltViewModel
@@ -27,7 +29,7 @@ class EditUserViewModel @Inject constructor(
 
     sealed interface Action {
         object NavigateBack : Action
-        data class ShowError(val error: String) : Action
+        data class ShowError(val error: UiText) : Action
     }
 
     private val _state = MutableStateFlow<State>(State.Loading)
@@ -54,10 +56,10 @@ class EditUserViewModel @Inject constructor(
             _state.value = State.Loading
             with(name) {
                 if (isBlank()) {
-                    _actions.send(Action.ShowError("Name couldn't be blank"))
+                    _actions.send(Action.ShowError(UiText.StringResource(R.string.name_blank_error)))
                 }
                 if (length > 15) {
-                    _actions.send(Action.ShowError("Name too long"))
+                    _actions.send(Action.ShowError(UiText.StringResource(R.string.name_too_long)))
                 }
             }
             useCases.updateUserUseCase(updateUser = UpdateUser(username = name))
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/ProfileFragment.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/ProfileFragment.kt
@@ -113,7 +113,7 @@ class ProfileFragment : Fragment() {
             }
             is Action.ShowError -> Toast.makeText(
                 context!!,
-                "Error: ${action.error}",
+                "Error: ${action.error.getText(context)}",
                 Toast.LENGTH_SHORT
             )
                 .show()
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/ProfileFragmentViewModel.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/profile/ProfileFragmentViewModel.kt
@@ -13,6 +13,7 @@ import retrofit2.HttpException
 import ru.kheynov.secretsanta.domain.use_cases.users.UsersUseCases
 import ru.kheynov.secretsanta.utils.Resource
 import ru.kheynov.secretsanta.utils.SantaException
+import ru.kheynov.secretsanta.utils.UiText
 import javax.inject.Inject
 
 @HiltViewModel
@@ -28,7 +29,7 @@ class ProfileFragmentViewModel @Inject constructor(
     sealed interface Action {
         object NavigateToLoginScreen : Action
         object NavigateToEditUser : Action
-        data class ShowError(val error: String) : Action
+        data class ShowError(val error: UiText) : Action
     }
 
     private val _state = MutableStateFlow<State>(State.Loading)
@@ -51,7 +52,13 @@ class ProfileFragmentViewModel @Inject constructor(
                     if (res.exception is SantaException || res.exception is HttpException) {
                         _state.value = State.Error(res.exception)
                     } else {
-                        _actions.send(Action.ShowError(res.exception.javaClass.simpleName.toString()))
+                        _actions.send(
+                            Action.ShowError(
+                                UiText.PlainText(
+                                    res.exception.javaClass.simpleName.toString()
+                                )
+                            )
+                        )
                     }
                 }
                 is Resource.Success -> {
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/register_screen/RegisterActivity.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/register_screen/RegisterActivity.kt
@@ -45,12 +45,15 @@ class RegisterActivity : AppCompatActivity() {
                             .setText(viewModel.username)
 
                         registerButton.visibility = registerUsernameInput.visibility
-
                         registerTitleText.visibility = registerUsernameInput.visibility
                     }
                 }
             }
         }
+    }
+
+    override fun onResume() {
+        super.onResume()
         lifecycleScope.launch {
             viewModel.actions.collect(::handleActions)
         }
@@ -61,7 +64,7 @@ class RegisterActivity : AppCompatActivity() {
             RegisterActivityViewModel.Action.RouteToMain -> navigateToLoginScreen(this)
             is RegisterActivityViewModel.Action.ShowError -> Toast.makeText(
                 this,
-                "Error: ${action.error}",
+                "Error: ${action.error.getText(this)}",
                 Toast.LENGTH_SHORT
             ).show()
         }
diff --git a/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/register_screen/RegisterActivityViewModel.kt b/app/src/main/java/ru/kheynov/secretsanta/presentation/screens/register_screen/RegisterActivityViewModel.kt
@@ -15,6 +15,7 @@ import ru.kheynov.secretsanta.domain.entities.RegisterUser
 import ru.kheynov.secretsanta.domain.use_cases.users.UsersUseCases
 import ru.kheynov.secretsanta.utils.Resource
 import ru.kheynov.secretsanta.utils.SantaException
+import ru.kheynov.secretsanta.utils.UiText
 import javax.inject.Inject
 
 @HiltViewModel
@@ -38,7 +39,7 @@ class RegisterActivityViewModel @Inject constructor(
     val actions: Flow<Action> = _actions.receiveAsFlow()
 
     sealed interface Action {
-        data class ShowError(val error: String) : Action
+        data class ShowError(val error: UiText) : Action
         object RouteToMain : Action
     }
 
@@ -51,7 +52,13 @@ class RegisterActivityViewModel @Inject constructor(
                         _state.value = State.Error(res.exception)
                     } else {
                         _state.value = State.Idle
-                        _actions.send(Action.ShowError(res.exception.message.toString()))
+                        _actions.send(
+                            Action.ShowError(
+                                UiText.PlainText(
+                                    res.exception.message.toString()
+                                )
+                            )
+                        )
                     }
                 }
                 is Resource.Success -> {
diff --git a/app/src/main/java/ru/kheynov/secretsanta/utils/UiText.kt b/app/src/main/java/ru/kheynov/secretsanta/utils/UiText.kt
@@ -0,0 +1,16 @@
+package ru.kheynov.secretsanta.utils
+
+import android.content.Context
+import androidx.annotation.StringRes
+
+sealed class UiText {
+    data class PlainText(val value: String) : UiText()
+    class StringResource(@StringRes val resId: Int) : UiText()
+
+    fun getText(context: Context?): String {
+        return when (this) {
+            is PlainText -> value
+            is StringResource -> context?.getString(resId) ?: ""
+        }
+    }
+}
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -59,4 +59,8 @@
     <string name="join_room">Join room</string>
     <string name="copy_link_description">copy link</string>
     <string name="copy_link">Copy link</string>
+    <string name="room_name_empty_error">Room name can\'t be empty</string>
+    <string name="room_id_empty_error">Room ID can\'t be empty</string>
+    <string name="name_blank_error">Name couldn\'t be blank</string>
+    <string name="name_too_long">Name too long</string>
 </resources>

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,9 @@ class CreateRoomFragment : Fragment() {`
`119`	`119`	`when (action) {`
`120`	`120`	`is CreateRoomFragmentViewModel.Action.ShowError -> {`
`121`	`121`	`Toast.makeText(`
`122`		`- context, "Error: ${action.error}", Toast.LENGTH_SHORT`
	`122`	`+ context,`
	`123`	`+ "Error: ${action.error.getText(context)}",`
	`124`	`+ Toast.LENGTH_SHORT`
`123`	`125`	`).show()`
`124`	`126`	`}`
`125`	`127`	`CreateRoomFragmentViewModel.Action.ShowSuccess -> {`
`@@ -135,11 +137,9 @@ class CreateRoomFragment : Fragment() {`
`135`	`137`	`}`
`136`	`138`	`fragment.arguments = args`
`137`	`139`	`activity?.supportFragmentManager?.beginTransaction()`
`138`		`- ?.replace(R.id.fragment_container, fragment)?.commit()`
`139`		`- ?: Log.i(`
`140`		`- "CreateRoomFragment",`
`141`		`- "Unable to navigate"`
`142`		`- )`
	`140`	`+ ?.replace(R.id.fragment_container, fragment)?.commit() ?: Log.i(`
	`141`	`+ "CreateRoomFragment", "Unable to navigate"`
	`142`	`+ )`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,23 +59,29 @@ class JoinRoomFragment : Fragment() {`
`59`	`59`	`viewModel.state.collect(::updateUI)`
`60`	`60`	`}`
`61`	`61`	`}`
	`62`	`+ }`
	`63`	`+`
	`64`	`+ override fun onResume() {`
	`65`	`+ super.onResume()`
`62`	`66`	`lifecycleScope.launch {`
`63`		`- repeatOnLifecycle(Lifecycle.State.STARTED) {`
`64`		`- viewModel.actions.collect(::handleAction)`
`65`		`- }`
	`67`	`+ viewModel.actions.collect(::handleAction)`
`66`	`68`	`}`
`67`	`69`	`}`
`68`	`70`
`69`	`71`	`private fun handleAction(action: JoinRoomViewModel.Action) {`
`70`	`72`	`when (action) {`
`71`	`73`	`JoinRoomViewModel.Action.NavigateBack -> {`
`72`		`- activity?.supportFragmentManager`
`73`		`- ?.popBackStack(null, FragmentManager.POP_BACK_STACK_INCLUSIVE)`
	`74`	`+ activity?.supportFragmentManager?.popBackStack(`
	`75`	`+ null,`
	`76`	`+ FragmentManager.POP_BACK_STACK_INCLUSIVE`
	`77`	`+ )`
`74`	`78`	`activity?.viewModels<MainActivityViewModel>()?.value?.navigateToRoomsList()`
`75`	`79`	`}`
`76`	`80`	`is JoinRoomViewModel.Action.ShowError -> {`
`77`		`- Log.e("JoinRoomFragment", action.error)`
`78`		`- Toast.makeText(context, action.error, Toast.LENGTH_SHORT).show()`
	`81`	`+ Log.e("JoinRoomFragment", action.error.getText(context))`
	`82`	`+ Toast.makeText(`
	`83`	`+ context, action.error.getText(context), Toast.LENGTH_SHORT`
	`84`	`+ ).show()`
`79`	`85`	`}`
`80`	`86`	`}`
`81`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ class EditUserFragment : Fragment() {`
`72`	`72`	`when (action) {`
`73`	`73`	`Action.NavigateBack -> activity?.supportFragmentManager?.popBackStack()`
`74`	`74`	`is Action.ShowError -> Toast.makeText(`
`75`		`- context, "Error: ${action.error}", Toast.LENGTH_SHORT`
	`75`	`+ context, "Error: ${action.error.getText(context)}", Toast.LENGTH_SHORT`
`76`	`76`	`).show()`
`77`	`77`	`}`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ class ProfileFragment : Fragment() {`
`113`	`113`	`}`
`114`	`114`	`is Action.ShowError -> Toast.makeText(`
`115`	`115`	`context!!,`
`116`		`- "Error: ${action.error}",`
	`116`	`+ "Error: ${action.error.getText(context)}",`
`117`	`117`	`Toast.LENGTH_SHORT`
`118`	`118`	`)`
`119`	`119`	`.show()`
Original file line number	Diff line number	Diff line change
`@@ -45,12 +45,15 @@ class RegisterActivity : AppCompatActivity() {`
`45`	`45`	`.setText(viewModel.username)`
`46`	`46`
`47`	`47`	`registerButton.visibility = registerUsernameInput.visibility`
`48`		`-`
`49`	`48`	`registerTitleText.visibility = registerUsernameInput.visibility`
`50`	`49`	`}`
`51`	`50`	`}`
`52`	`51`	`}`
`53`	`52`	`}`
	`53`	`+ }`
	`54`	`+`
	`55`	`+ override fun onResume() {`
	`56`	`+ super.onResume()`
`54`	`57`	`lifecycleScope.launch {`
`55`	`58`	`viewModel.actions.collect(::handleActions)`
`56`	`59`	`}`
`@@ -61,7 +64,7 @@ class RegisterActivity : AppCompatActivity() {`
`61`	`64`	`RegisterActivityViewModel.Action.RouteToMain -> navigateToLoginScreen(this)`
`62`	`65`	`is RegisterActivityViewModel.Action.ShowError -> Toast.makeText(`
`63`	`66`	`this,`
`64`		`- "Error: ${action.error}",`
	`67`	`+ "Error: ${action.error.getText(this)}",`
`65`	`68`	`Toast.LENGTH_SHORT`
`66`	`69`	`).show()`
`67`	`70`	`}`