Merge branch 'feature/property-list-viewmodels' into develop

SmartToolFactory · SmartToolFactory · commit 3bb1a39a149d · 2020-09-07T20:08:47.000+03:00
diff --git a/app/src/main/java/com/smarttoolfactory/propertyfindar/ui/BottomNavigationFragmentStateAdapter.kt b/app/src/main/java/com/smarttoolfactory/propertyfindar/ui/BottomNavigationFragmentStateAdapter.kt
@@ -24,23 +24,26 @@ class BottomNavigationFragmentStateAdapter(fragmentManager: FragmentManager, lif
 
     override fun createFragment(position: Int): Fragment {
         return when (position) {
+
+            // Home Dynamic Feature Module
             0 -> NavHostContainerFragment.createNavHostContainerFragment(
                 R.layout.fragment_navhost_home,
                 R.id.nested_nav_host_fragment_home
             )
 
-            // Vertical NavHost Post Fragment Container
+            // Favorites Dynamic Feature Module
             1 -> NavHostContainerFragment.createNavHostContainerFragment(
                 R.layout.fragment_navhost_favorites,
                 R.id.nested_nav_host_fragment_favorites
             )
 
-            // Horizontal NavHost Post Fragment Container
+            // Notification Dynamic Feature Module
             2 -> NavHostContainerFragment.createNavHostContainerFragment(
                 R.layout.fragment_navhost_notification,
                 R.id.nested_nav_host_fragment_notification
             )
 
+            // Notification Account Feature Module
             else -> NavHostContainerFragment.createNavHostContainerFragment(
                 R.layout.fragment_navhost_account,
                 R.id.nested_nav_host_fragment_account
diff --git a/features/home/src/main/java/com/smarttoolfactory/home/viewbindings/ViewBindings.kt b/features/home/src/main/java/com/smarttoolfactory/home/viewbindings/ViewBindings.kt
@@ -0,0 +1,71 @@
+package com.smarttoolfactory.home.viewbindings
+
+import android.view.View
+import android.widget.ImageButton
+import android.widget.ImageView
+import androidx.databinding.BindingAdapter
+import androidx.recyclerview.widget.ListAdapter
+import androidx.recyclerview.widget.RecyclerView
+import com.bumptech.glide.Glide
+import com.bumptech.glide.request.RequestOptions
+import com.smarttoolfactory.domain.model.PropertyItem
+import com.smarttoolfactory.home.R
+
+/*
+    *** Bindings for RecyclerView ***
+ */
+
+/**
+ * [BindingAdapter]s for the [PropertyItem]s to ListAdapter.
+ */
+@BindingAdapter("app:items")
+fun RecyclerView.setItems(items: List<PropertyItem>?) {
+
+    items?.let {
+        (adapter as ListAdapter<PropertyItem, *>)?.submitList(items)
+    }
+}
+
+/**
+ * Binding adapter used with this class android:src used with binding of this object
+ * loads image from url into specified view
+ *
+ * @param view image to be loaded into
+ * @param path of the image to be fetched
+ */
+@BindingAdapter("imageSrc")
+fun setImageUrl(view: ImageView, path: String?) {
+
+    try {
+
+        val requestOptions = RequestOptions()
+        requestOptions.placeholder(R.drawable.placeholder)
+
+        Glide
+            .with(view.context)
+            .setDefaultRequestOptions(requestOptions)
+            .load(path)
+            .into(view)
+    } catch (e: Exception) {
+        e.printStackTrace()
+    }
+}
+
+/**
+ * Display or hide a view based on a condition
+ *
+ * @param condition if it's true this View's visibility is set to [View.VISIBLE]
+ */
+@BindingAdapter("visibilityBasedOn")
+fun View.visibilityBasedOn(condition: Boolean) {
+    visibility = if (condition) View.VISIBLE else View.GONE
+}
+
+@BindingAdapter("favoriteImageSrc")
+fun ImageButton.setFavoriteImageSrc(favorite: Boolean) {
+
+    val imageResource = if (favorite) R.drawable.ic_baseline_favorite_24
+    else R.drawable.ic_baseline_favorite_24
+
+    setImageResource(imageResource)
+}
diff --git a/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/AbstractPropertyListVM.kt b/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/AbstractPropertyListVM.kt
@@ -0,0 +1,34 @@
+package com.smarttoolfactory.home.viewmodel
+
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.ViewModel
+import com.smarttoolfactory.core.util.Event
+import com.smarttoolfactory.core.viewstate.ViewState
+import com.smarttoolfactory.domain.model.PropertyItem
+
+/**
+ * Common class for multiple [ViewModel]s for [PropertyItem]s with Flow, RxJava3, and Pagination
+ */
+abstract class AbstractPropertyListVM : ViewModel() {
+
+    companion object {
+        const val PROPERTY_LIST = "PROPERTY_LIST"
+        const val PROPERTY_DETAIL = "PROPERTY_DETAIL"
+
+        const val ORDER_BY_NONE = ""
+        const val ORDER_BY_PRICE_ASCENDING = "pa"
+        const val ORDER_BY_PRICE_DESCENDING = "pd"
+        const val ORDER_BY_BEDS_ASCENDING = "ba"
+        const val ORDER_BY_DES_DESCENDING = "bd"
+    }
+
+    abstract val goToDetailScreen: LiveData<Event<PropertyItem>>
+
+    abstract val propertyListViewState: LiveData<ViewState<List<PropertyItem>>>
+
+    abstract fun getPropertyList()
+
+    abstract fun refreshPropertyList()
+
+    abstract fun onClick(propertyItem: PropertyItem)
+}
diff --git a/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelFlow.kt b/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelFlow.kt
@@ -0,0 +1,71 @@
+package com.smarttoolfactory.home.viewmodel
+
+import androidx.hilt.lifecycle.ViewModelInject
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
+import com.smarttoolfactory.core.util.Event
+import com.smarttoolfactory.core.util.convertToFlowViewState
+import com.smarttoolfactory.core.viewstate.Status
+import com.smarttoolfactory.core.viewstate.ViewState
+import com.smarttoolfactory.domain.model.PropertyItem
+import com.smarttoolfactory.domain.usecase.GetPropertiesUseCaseFlow
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.flow.onStart
+
+class PropertyListViewModelFlow @ViewModelInject constructor(
+    private val coroutineScope: CoroutineScope,
+    private val getPropertiesUseCase: GetPropertiesUseCaseFlow
+) : AbstractPropertyListVM() {
+
+    private val _goToDetailScreen = MutableLiveData<Event<PropertyItem>>()
+
+    override val goToDetailScreen: LiveData<Event<PropertyItem>>
+        get() = _goToDetailScreen
+
+    private val _propertyViewState = MutableLiveData<ViewState<List<PropertyItem>>>()
+
+    override val propertyListViewState: LiveData<ViewState<List<PropertyItem>>>
+        get() = _propertyViewState
+
+    /**
+     * Function to retrieve data from repository with offline-first which checks
+     * local data source first.
+     *
+     * * Check out Local Source first
+     * * If empty data or null returned throw empty set exception
+     * * If error occurred while fetching data from remote: Try to fetch data from db
+     * * If data is fetched from remote source: delete old data, save new data and return new data
+     * * If both network and db don't have any data throw empty set exception
+     *
+     */
+    override fun getPropertyList() {
+
+        getPropertiesUseCase.getPropertiesOfflineFirst("")
+            .convertToFlowViewState()
+            .onStart {
+                _propertyViewState.value = ViewState(status = Status.LOADING)
+            }
+            .onEach {
+                _propertyViewState.value = it
+            }
+            .launchIn(coroutineScope)
+    }
+
+    override fun refreshPropertyList() {
+        getPropertiesUseCase.getPropertiesOfflineLast("")
+            .convertToFlowViewState()
+            .onStart {
+                _propertyViewState.value = ViewState(status = Status.LOADING)
+            }
+            .onEach {
+                _propertyViewState.value = it
+            }
+            .launchIn(coroutineScope)
+    }
+
+    override fun onClick(item: PropertyItem) {
+        _goToDetailScreen.value = Event(item)
+    }
+}
diff --git a/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelRxJava3.kt b/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelRxJava3.kt
@@ -0,0 +1,59 @@
+package com.smarttoolfactory.home.viewmodel
+
+import androidx.hilt.lifecycle.ViewModelInject
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
+import com.smarttoolfactory.core.util.Event
+import com.smarttoolfactory.core.util.convertFromSingleToObservableViewStateWithLoading
+import com.smarttoolfactory.core.viewstate.Status
+import com.smarttoolfactory.core.viewstate.ViewState
+import com.smarttoolfactory.domain.model.PropertyItem
+import com.smarttoolfactory.domain.usecase.GetPropertiesUseCaseRxJava3
+import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
+
+class PropertyListViewModelRxJava3 @ViewModelInject constructor(
+    private val getPropertiesUseCase: GetPropertiesUseCaseRxJava3
+) : AbstractPropertyListVM() {
+
+    private val _goToDetailScreen = MutableLiveData<Event<PropertyItem>>()
+
+    override val goToDetailScreen: LiveData<Event<PropertyItem>>
+        get() = _goToDetailScreen
+
+    private val _propertyListViewState = MutableLiveData<ViewState<List<PropertyItem>>>()
+
+    override val propertyListViewState: LiveData<ViewState<List<PropertyItem>>>
+        get() = _propertyListViewState
+
+    override fun getPropertyList() {
+        getPropertiesUseCase.getPropertiesOfflineFirst(ORDER_BY_NONE)
+            .convertFromSingleToObservableViewStateWithLoading()
+            .observeOn(AndroidSchedulers.mainThread())
+            .subscribe(
+                {
+                    _propertyListViewState.value = it
+                },
+                {
+                    _propertyListViewState.value = ViewState(status = Status.ERROR, error = it)
+                }
+            )
+    }
+
+    override fun refreshPropertyList() {
+        getPropertiesUseCase.getPropertiesOfflineLast(ORDER_BY_NONE)
+            .convertFromSingleToObservableViewStateWithLoading()
+            .observeOn(AndroidSchedulers.mainThread())
+            .subscribe(
+                {
+                    _propertyListViewState.value = it
+                },
+                {
+                    _propertyListViewState.value = ViewState(status = Status.ERROR, error = it)
+                }
+            )
+    }
+
+    override fun onClick(item: PropertyItem) {
+        _goToDetailScreen.value = Event(item)
+    }
+}
diff --git a/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/ViewModelFactory.kt b/features/home/src/main/java/com/smarttoolfactory/home/viewmodel/ViewModelFactory.kt
@@ -0,0 +1,42 @@
+package com.smarttoolfactory.home.viewmodel
+
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.ViewModelProvider
+import com.smarttoolfactory.domain.usecase.GetPropertiesUseCaseFlow
+import com.smarttoolfactory.domain.usecase.GetPropertiesUseCaseRxJava3
+import javax.inject.Inject
+import kotlinx.coroutines.CoroutineScope
+
+class PropertyListFlowViewModelFactory @Inject constructor(
+    private val coroutineScope: CoroutineScope,
+    private val getPropertiesUseCase: GetPropertiesUseCaseFlow
+) : ViewModelProvider.Factory {
+
+    @Suppress("UNCHECKED_CAST")
+    override fun <T : ViewModel> create(modelClass: Class<T>): T {
+
+        if (modelClass != PropertyListViewModelFlow::class.java) {
+            throw IllegalArgumentException("Unknown ViewModel class")
+        }
+
+        return PropertyListViewModelFlow(
+            coroutineScope,
+            getPropertiesUseCase
+        ) as T
+    }
+}
+
+class PropertyListRxJava3ViewModelFactory @Inject constructor(
+    private val getPropertiesUseCase: GetPropertiesUseCaseRxJava3
+) : ViewModelProvider.Factory {
+
+    @Suppress("UNCHECKED_CAST")
+    override fun <T : ViewModel> create(modelClass: Class<T>): T {
+
+        if (modelClass != PropertyListViewModelRxJava3::class.java) {
+            throw IllegalArgumentException("Unknown ViewModel class")
+        }
+
+        return PropertyListViewModelRxJava3(getPropertiesUseCase) as T
+    }
+}
diff --git a/features/home/src/main/res/drawable/ic_baseline_favorite_24.xml b/features/home/src/main/res/drawable/ic_baseline_favorite_24.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M12,21.35l-1.45,-1.32C5.4,15.36 2,12.28 2,8.5 2,5.42 4.42,3 7.5,3c1.74,0 3.41,0.81 4.5,2.09C13.09,3.81 14.76,3 16.5,3 19.58,3 22,5.42 22,8.5c0,3.78 -3.4,6.86 -8.55,11.54L12,21.35z"/>
+</vector>
diff --git a/features/home/src/main/res/drawable/ic_baseline_favorite_border_24.xml b/features/home/src/main/res/drawable/ic_baseline_favorite_border_24.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M16.5,3c-1.74,0 -3.41,0.81 -4.5,2.09C10.91,3.81 9.24,3 7.5,3 4.42,3 2,5.42 2,8.5c0,3.78 3.4,6.86 8.55,11.54L12,21.35l1.45,-1.32C18.6,15.36 22,12.28 22,8.5 22,5.42 19.58,3 16.5,3zM12.1,18.55l-0.1,0.1 -0.1,-0.1C7.14,14.24 4,11.39 4,8.5 4,6.5 5.5,5 7.5,5c1.54,0 3.04,0.99 3.57,2.36h1.87C13.46,5.99 14.96,5 16.5,5c2,0 3.5,1.5 3.5,3.5 0,2.89 -3.14,5.74 -7.9,10.05z"/>
+</vector>
diff --git a/features/home/src/main/res/drawable/placeholder.png b/features/home/src/main/res/drawable/placeholder.png
diff --git a/features/home/src/test/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelFlowTest.kt b/features/home/src/test/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelFlowTest.kt
diff --git a/features/home/src/test/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelRxJava3Test.kt b/features/home/src/test/java/com/smarttoolfactory/home/viewmodel/PropertyListViewModelRxJava3Test.kt
diff --git a/libraries/domain/src/main/java/com/smarttoolfactory/domain/usecase/GetPropertiesUseCaseFlow.kt b/libraries/domain/src/main/java/com/smarttoolfactory/domain/usecase/GetPropertiesUseCaseFlow.kt
