[WIP] Pull to refresh - Manual sync (#310)

* Pull to refresh - Manual sync

* Added changes after code review

Author: ioana-farcas

app/build.gradle

@@ -73,6 +73,7 @@ dependencies {
     implementation "com.jakewharton.rxbinding2:rxbinding-design-kotlin:${rxbinding_version}"
     implementation "com.jakewharton.rxbinding2:rxbinding-appcompat-v7-kotlin:${rxbinding_version}"
     implementation "com.jakewharton.rxbinding2:rxbinding-recyclerview-v7-kotlin:${rxbinding_version}"
+    implementation "com.jakewharton.rxbinding2:rxbinding-support-v4-kotlin:${rxbinding_version}"
     implementation 'com.jakewharton.rxrelay2:rxrelay:2.0.0'
     implementation 'com.f2prateek.rx.preferences2:rx-preferences:2.0.0'
     implementation 'io.reactivex.rxjava2:rxkotlin:2.3.0'

app/src/androidTest/java/mozilla/lockbox/ItemListTest.kt

@@ -44,4 +44,11 @@ open class ItemListTest {
         itemList { selectFirstItemInSortMenu() }
         itemList { spinnerDisplaysFirstItemSelection() }
     }
+
+    @Test
+    fun testPullToRefresh() {
+        navigator.gotoItemList(false)
+        itemList { pullToRefresh() }
+        navigator.checkAtItemList()
+    }
 }

app/src/androidTest/java/mozilla/lockbox/robots/BaseTestRobot.kt

@@ -12,6 +12,7 @@ import android.support.test.espresso.NoActivityResumedException
 import android.support.test.espresso.ViewInteraction
 import android.support.test.espresso.action.ViewActions.closeSoftKeyboard
 import android.support.test.espresso.action.ViewActions.replaceText
+import android.support.test.espresso.action.ViewActions.swipeDown
 import android.support.test.espresso.assertion.ViewAssertions.matches
 import android.support.test.espresso.matcher.ViewMatchers.withId
 import android.support.test.espresso.matcher.ViewMatchers.withText
@@ -37,6 +38,9 @@ interface BaseTestRobot {
         }
     }
 
+    fun swipeDown(resId: Int): ViewInteraction =
+        onView(withId(resId)).perform(swipeDown())
+
     fun back(remainInApplication: Boolean = true) {
         Espresso.closeSoftKeyboard()
         try {

app/src/androidTest/java/mozilla/lockbox/robots/ItemListRobot.kt

@@ -13,6 +13,7 @@ import android.support.test.espresso.contrib.NavigationViewActions.navigateTo
 import android.support.test.espresso.matcher.ViewMatchers.withId
 import br.com.concretesolutions.kappuccino.actions.ClickActions.click
 import br.com.concretesolutions.kappuccino.assertions.VisibilityAssertions.displayed
+import kotlinx.android.synthetic.main.fragment_item_list.view.*
 import mozilla.lockbox.R
 
 // ItemList
@@ -61,6 +62,8 @@ class ItemListRobot : BaseTestRobot {
     fun tapAccountSetting() = menuOption(R.id.account_setting_menu_item)
 
     fun selectItem(position: Int = 0) = clickListItem(R.id.entriesView, position)
+
+    fun pullToRefresh() = swipeDown(R.id.entriesView)
 }
 
 fun itemList(f: ItemListRobot.() -> Unit) = ItemListRobot().apply(f)

app/src/main/java/mozilla/lockbox/presenter/ItemListPresenter.kt

@@ -40,6 +40,9 @@ interface ItemListView {
     fun updateAccountProfile(profile: AccountViewModel)
     fun updateItemListSort(sort: Setting.ItemListSort)
     fun loading(isLoading: Boolean)
+    val refreshItemList: Observable<Unit>
+    val isRefreshing: Boolean
+    fun stopRefreshing()
 }
 
 @ExperimentalCoroutinesApi
@@ -62,7 +65,14 @@ class ItemListPresenter(
                     DataStore.SyncState.NotSyncing -> false
                 }
             }
-            .subscribe(view::loading)
+            .subscribe { syncing ->
+                when (view.isRefreshing) {
+                    true -> if (!syncing) {
+                        view.stopRefreshing()
+                    }
+                    false -> view.loading(syncing)
+                }
+            }
             .addTo(compositeDisposable)
 
         Observables.combineLatest(dataStore.list, settingStore.itemListSortOrder)
@@ -115,6 +125,11 @@ class ItemListPresenter(
                 dispatcher.dispatch(SettingAction.ItemListSortOrder(sortBy))
             }.addTo(compositeDisposable)
 
+        view.refreshItemList
+            .doOnDispose { view.stopRefreshing() }
+            .subscribe { dispatcher.dispatch(DataStoreAction.Sync) }
+            .addTo(compositeDisposable)
+
         accountStore.profile
             .filterNotNull()
             .map {

app/src/main/java/mozilla/lockbox/view/ItemListFragment.kt

@@ -21,8 +21,9 @@ import android.widget.AdapterView
 import androidx.navigation.NavController
 import androidx.navigation.findNavController
 import androidx.navigation.ui.setupWithNavController
-import com.jakewharton.rxbinding2.support.design.widget.itemSelections
 import android.widget.Spinner
+import com.jakewharton.rxbinding2.support.design.widget.itemSelections
+import com.jakewharton.rxbinding2.support.v4.widget.refreshes
 import com.jakewharton.rxbinding2.support.v7.widget.navigationClicks
 import com.jakewharton.rxbinding2.view.clicks
 import com.squareup.picasso.Picasso
@@ -71,6 +72,7 @@ class ItemListFragment : CommonFragment(), ItemListView {
         setupNavigationView(navController, view.navView)
         setupListView(view.entriesView)
         setupSpinner(view)
+        view.refreshContainer.setColorSchemeResources(R.color.refresh_blue)
         super.onViewCreated(view, savedInstanceState)
     }
 
@@ -197,4 +199,10 @@ class ItemListFragment : CommonFragment(), ItemListView {
         view!!.filterButton.isEnabled = !isLoading
         view!!.sortButton.isClickable = !isLoading
     }
-}
+
+    override val refreshItemList: Observable<Unit> get() = view!!.refreshContainer.refreshes()
+    override val isRefreshing: Boolean get() = view!!.refreshContainer.isRefreshing
+    override fun stopRefreshing() {
+        view!!.refreshContainer.isRefreshing = false
+    }
+}

app/src/main/res/layout/fragment_item_list.xml

@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="utf-8"?><!--
+<?xml version="1.0" encoding="utf-8"?>
+<!--
   ~ This Source Code Form is subject to the terms of the Mozilla Public
   ~ License, v. 2.0. If a copy of the MPL was not distributed with this
   ~ file, You can obtain one at http://mozilla.org/MPL/2.0/.
@@ -55,10 +56,17 @@
             </LinearLayout>
         </android.support.v7.widget.Toolbar>
 
-        <android.support.v7.widget.RecyclerView
-            android:id="@+id/entriesView"
+        <android.support.v4.widget.SwipeRefreshLayout
+            xmlns:android="http://schemas.android.com/apk/res/android"
+            android:id="@+id/refreshContainer"
             android:layout_width="match_parent"
-            android:layout_height="match_parent" />
+            android:layout_height="match_parent">
+
+            <android.support.v7.widget.RecyclerView
+                android:id="@+id/entriesView"
+                android:layout_width="match_parent"
+                android:layout_height="match_parent" />
+        </android.support.v4.widget.SwipeRefreshLayout>
 
         <RelativeLayout
             android:id="@+id/loadingView"

app/src/main/res/values/colors.xml

@@ -27,4 +27,5 @@
     <color name="green">#12bc00</color>
     <color name="dark_grey">#4a4a4f</color>
     <color name="selection">#14000000</color>
+    <color name="refresh_blue">#0e89c9</color>
 </resources>

app/src/test/java/mozilla/lockbox/presenter/ItemListPresenterTest.kt

@@ -35,6 +35,8 @@ import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.mockito.Mock
+import org.mockito.Mockito.spy
+import org.mockito.Mockito.verify
 import org.powermock.api.mockito.PowerMockito
 import org.powermock.core.classloader.annotations.PrepareForTest
 import org.robolectric.RobolectricTestRunner
@@ -94,6 +96,7 @@ open class ItemListPresenterTest {
         val sortItemSelectionStub = PublishSubject.create<Setting.ItemListSort>()
         val disclaimerActionStub = PublishSubject.create<AlertState>()
         val lockNowSelectionStub = PublishSubject.create<Unit>()
+        val refreshItemListStub = PublishSubject.create<Unit>()
 
         override val itemSelection: Observable<ItemViewModel>
             get() = itemSelectedStub
@@ -129,6 +132,14 @@ open class ItemListPresenterTest {
         override fun loading(isLoading: Boolean) {
             this.isLoading = isLoading
         }
+
+        override val refreshItemList: Observable<Unit>
+            get() = refreshItemListStub
+
+        override val isRefreshing: Boolean = false
+
+        override fun stopRefreshing() {
+        }
     }
 
     class FakeDataStore : DataStore() {
@@ -150,7 +161,7 @@ open class ItemListPresenterTest {
     private val settingStore = FakeSettingStore()
     private val profileStub = PublishSubject.create<Optional<Profile>>()
 
-    val view = FakeView()
+    val view: FakeView = spy(FakeView())
     val dispatcher = Dispatcher()
     val subject = ItemListPresenter(view, dispatcher, dataStore, settingStore, fingerprintStore, accountStore)
 
@@ -281,4 +292,17 @@ open class ItemListPresenterTest {
         dataStore.syncStateStub.onNext(DataStore.SyncState.NotSyncing)
         Assert.assertEquals(false, view.isLoading)
     }
+
+    @Test
+    fun `stop refreshing when stop syncing after pull to refresh`() {
+        whenCalled(view.isRefreshing).thenReturn(true)
+        dataStore.syncStateStub.onNext(DataStore.SyncState.NotSyncing)
+        verify(view).stopRefreshing()
+    }
+
+    @Test
+    fun `swipe down calls sync`() {
+        view.refreshItemListStub.onNext(Unit)
+        dispatcherObserver.assertLastValue(DataStoreAction.Sync)
+    }
 }