refactor: rename getUsers to observeUsers for clarity and consistency

Author: hoc081098

.idea/kotlinc.xml

@@ -11,7 +11,8 @@ import kotlin.reflect.KProperty
 value class SelfReference<T>(
   val value: T,
 ) : ReadOnlyProperty<Any?, T> {
-  override fun getValue(
+  @Suppress("OVERRIDE_BY_INLINE", "NOTHING_TO_INLINE")
+  override inline fun getValue(
     thisRef: Any?,
     property: KProperty<*>,
   ): T = value

core/src/main/java/com/hoc/flowmvi/core/selfReference.kt

@@ -80,7 +80,7 @@ internal class UserRepositoryImpl(
       .first()
 
   @OptIn(FlowExtPreview::class)
-  override fun getUsers() =
+  override fun observeUsers() =
     changesFlow
       .onEach { Timber.d("[USER_REPO] Change=$it") }
       .scanWith(::getUsersFromRemoteWithRetry) { acc, change ->

data/src/main/java/com/hoc/flowmvi/data/UserRepositoryImpl.kt

@@ -56,12 +56,12 @@ class UserRepositoryImplRealAPITest : KoinTest {
   private val userRepo by inject<UserRepository>()
 
   @Test
-  fun getUsers() =
+  fun observeUsers() =
     runBlocking {
       kotlin.runCatching {
         val result =
           userRepo
-            .getUsers()
+            .observeUsers()
             .first()
         assertTrue(result.isRight())
         assertTrue(result.rightValueOrThrow.isNotEmpty())

data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplRealAPITest.kt

@@ -285,15 +285,15 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallSuccess_emitsInitial() =
+  fun test_observeUsers_withApiCallSuccess_emitsInitial() =
     runTest {
       coEvery { userApiService.getUsers() } returns USER_RESPONSES
       every { responseToDomain(any()) } returnsMany VALID_NES_USERS
 
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       delay(5_000)
       job.cancel()
@@ -313,15 +313,15 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallError_rethrows() =
+  fun test_observeUsers_withApiCallError_rethrows() =
     runTest {
       coEvery { userApiService.getUsers() } throws IOException()
       every { errorMapper(ofType<IOException>()) } returns UserError.NetworkError
 
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       delay(20_000)
       job.cancel()
@@ -337,7 +337,7 @@ class UserRepositoryImplTest {
     }
 
   @Test
-  fun test_getUsers_withApiCallSuccess_emitsInitialAndUpdatedUsers() =
+  fun test_observeUsers_withApiCallSuccess_emitsInitialAndUpdatedUsers() =
     runTest {
       val user = USERS.last()
       val userResponse = USER_RESPONSES.last()
@@ -352,7 +352,7 @@ class UserRepositoryImplTest {
       val events = mutableListOf<Either<UserError, List<User>>>()
       val job =
         launch(start = CoroutineStart.UNDISPATCHED) {
-          repo.getUsers().toList(events)
+          repo.observeUsers().toList(events)
         }
       repo.add(user)
       repo.remove(user)

data/src/test/java/com/hoc/flowmvi/data/UserRepositoryImplTest.kt

@@ -1,7 +1,7 @@
 package com.hoc.flowmvi.domain
 
 import com.hoc.flowmvi.domain.usecase.AddUserUseCase
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.domain.usecase.SearchUsersUseCase
@@ -11,7 +11,7 @@ import org.koin.dsl.module
 @JvmField
 val domainModule =
   module {
-    factoryOf(::GetUsersUseCase)
+    factoryOf(::ObserveUsersUseCase)
 
     factoryOf(::RefreshGetUsersUseCase)
 

domain/src/main/java/com/hoc/flowmvi/domain/DomainModule.kt

@@ -6,7 +6,7 @@ import com.hoc.flowmvi.domain.model.UserError
 import kotlinx.coroutines.flow.Flow
 
 interface UserRepository {
-  fun getUsers(): Flow<Either<UserError, List<User>>>
+  fun observeUsers(): Flow<Either<UserError, List<User>>>
 
   suspend fun refresh(): Either<UserError, Unit>
 

domain/src/main/java/com/hoc/flowmvi/domain/repository/UserRepository.kt

@@ -6,8 +6,8 @@ import com.hoc.flowmvi.domain.model.UserError
 import com.hoc.flowmvi.domain.repository.UserRepository
 import kotlinx.coroutines.flow.Flow
 
-class GetUsersUseCase(
+class ObserveUsersUseCase(
   private val userRepository: UserRepository,
 ) {
-  operator fun invoke(): Flow<Either<UserError, List<User>>> = userRepository.getUsers()
+  operator fun invoke(): Flow<Either<UserError, List<User>>> = userRepository.observeUsers()
 }

domain/src/main/java/com/hoc/flowmvi/domain/usecase/GetUsersUseCase.kt renamed to domain/src/main/java/com/hoc/flowmvi/domain/usecase/ObserveUsersUseCase.kt

@@ -6,7 +6,7 @@ import com.hoc.flowmvi.domain.model.User
 import com.hoc.flowmvi.domain.model.UserError
 import com.hoc.flowmvi.domain.repository.UserRepository
 import com.hoc.flowmvi.domain.usecase.AddUserUseCase
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.domain.usecase.SearchUsersUseCase
@@ -60,7 +60,7 @@ class UseCaseTest {
   val coroutineRule = TestCoroutineDispatcherRule()
 
   private lateinit var userRepository: UserRepository
-  private lateinit var getUsersUseCase: GetUsersUseCase
+  private lateinit var observeUsersUseCase: ObserveUsersUseCase
   private lateinit var refreshUseCase: RefreshGetUsersUseCase
   private lateinit var removeUserUseCase: RemoveUserUseCase
   private lateinit var addUserUseCase: AddUserUseCase
@@ -72,7 +72,7 @@ class UseCaseTest {
   fun setup() {
     userRepository = mockk()
 
-    getUsersUseCase = GetUsersUseCase(userRepository)
+    observeUsersUseCase = ObserveUsersUseCase(userRepository)
     refreshUseCase = RefreshGetUsersUseCase(userRepository)
     removeUserUseCase = RemoveUserUseCase(userRepository)
     addUserUseCase = AddUserUseCase(userRepository)
@@ -86,25 +86,25 @@ class UseCaseTest {
   }
 
   @Test
-  fun test_getUsersUseCase_whenSuccess_emitsUsers() =
+  fun test_observeUsersUseCase_whenSuccess_emitsUsers() =
     runTest {
       val usersRight = USERS.right()
-      every { userRepository.getUsers() } returns flowOf(usersRight)
+      every { userRepository.observeUsers() } returns flowOf(usersRight)
 
-      val result = getUsersUseCase()
+      val result = observeUsersUseCase()
 
-      verify { userRepository.getUsers() }
+      verify { userRepository.observeUsers() }
       assertEquals(usersRight, result.first())
     }
 
   @Test
-  fun test_getUsersUseCase_whenError_throwsError() =
+  fun test_observeUsersUseCase_whenError_throwsError() =
     runTest {
-      every { userRepository.getUsers() } returns flowOf(errorLeft)
+      every { userRepository.observeUsers() } returns flowOf(errorLeft)
 
-      val result = getUsersUseCase()
+      val result = observeUsersUseCase()
 
-      verify { userRepository.getUsers() }
+      verify { userRepository.observeUsers() }
       assertEquals(errorLeft, result.first())
     }
 

domain/src/test/java/com/hoc/flowmvi/domain/UseCaseTest.kt

@@ -3,7 +3,7 @@ package com.hoc.flowmvi.ui.main
 import androidx.lifecycle.viewModelScope
 import arrow.core.flatMap
 import com.hoc.flowmvi.core.selfReferenced
-import com.hoc.flowmvi.domain.usecase.GetUsersUseCase
+import com.hoc.flowmvi.domain.usecase.ObserveUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RefreshGetUsersUseCase
 import com.hoc.flowmvi.domain.usecase.RemoveUserUseCase
 import com.hoc.flowmvi.mvi_base.AbstractMviViewModel
@@ -33,7 +33,7 @@ import timber.log.Timber
 @FlowPreview
 @ExperimentalCoroutinesApi
 class MainVM(
-  private val getUsersUseCase: GetUsersUseCase,
+  private val observeUsersUseCase: ObserveUsersUseCase,
   private val refreshGetUsers: RefreshGetUsersUseCase,
   private val removeUser: RemoveUserUseCase,
 ) : AbstractMviViewModel<ViewIntent, ViewState, SingleEvent>() {
@@ -78,7 +78,7 @@ class MainVM(
   //region Processors
   private fun Flow<ViewIntent>.toUserChangeFlow(): Flow<PartialStateChange.Users> {
     val userChanges =
-      defer(getUsersUseCase::invoke)
+      defer { observeUsersUseCase() }
         .onEach { either -> Timber.tag(logTag).d("Emit users.size=${either.map { it.size }}") }
         .map { result ->
           result.fold(