From 5cabdfdc8ef46766bd62d196a158929e61584b92 Mon Sep 17 00:00:00 2001
From: Joe Birch <hitherejoebirch@googlemail.com>
Date: Fri, 22 Sep 2017 15:40:29 +0100
Subject: [PATCH] Fix error / empty views

---
 ...bservableUseCase.kt => FlowableUseCase.kt} |  4 ++--
 .../domain/interactor/browse/GetBufferoos.kt  |  4 ++--
 .../boilerplate/ui/widget/empty/EmptyView.kt  |  2 ++
 .../boilerplate/ui/widget/error/ErrorView.kt  |  2 ++
 mobile-ui/src/main/res/layout/view_empty.xml  |  6 +++--
 mobile-ui/src/main/res/layout/view_error.xml  |  6 +++--
 readme.md                                     | 22 ++++++++++++-------
 7 files changed, 30 insertions(+), 16 deletions(-)
 rename domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/{ObservableUseCase.kt => FlowableUseCase.kt} (90%)

diff --git a/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/ObservableUseCase.kt b/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/FlowableUseCase.kt
similarity index 90%
rename from domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/ObservableUseCase.kt
rename to domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/FlowableUseCase.kt
index 35af7ee..d7f0586 100755
--- a/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/ObservableUseCase.kt
+++ b/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/FlowableUseCase.kt
@@ -14,14 +14,14 @@ import org.buffer.android.boilerplate.domain.executor.ThreadExecutor
 /**
  * Abstract class for a UseCase that returns an instance of a [Single].
  */
-abstract class ObservableUseCase<T, in Params> constructor(
+abstract class FlowableUseCase<T, in Params> constructor(
         private val threadExecutor: ThreadExecutor,
         private val postExecutionThread: PostExecutionThread) {
 
     private val disposables = CompositeDisposable()
 
     /**
-     * Builds a [Single] which will be used when the current [ObservableUseCase] is executed.
+     * Builds a [Single] which will be used when the current [FlowableUseCase] is executed.
      */
     protected abstract fun buildUseCaseObservable(params: Params? = null): Flowable<T>
 
diff --git a/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt b/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt
index 65523d8..39e31da 100644
--- a/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt
+++ b/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt
@@ -3,7 +3,7 @@ package org.buffer.android.boilerplate.domain.interactor.browse
 import io.reactivex.Flowable
 import org.buffer.android.boilerplate.domain.executor.PostExecutionThread
 import org.buffer.android.boilerplate.domain.executor.ThreadExecutor
-import org.buffer.android.boilerplate.domain.interactor.ObservableUseCase
+import org.buffer.android.boilerplate.domain.interactor.FlowableUseCase
 import org.buffer.android.boilerplate.domain.model.Bufferoo
 import org.buffer.android.boilerplate.domain.repository.BufferooRepository
 import javax.inject.Inject
@@ -14,7 +14,7 @@ import javax.inject.Inject
 open class GetBufferoos @Inject constructor(val bufferooRepository: BufferooRepository,
                                             threadExecutor: ThreadExecutor,
                                             postExecutionThread: PostExecutionThread):
-        ObservableUseCase<List<Bufferoo>, Void?>(threadExecutor, postExecutionThread) {
+        FlowableUseCase<List<Bufferoo>, Void?>(threadExecutor, postExecutionThread) {
 
     public override fun buildUseCaseObservable(params: Void?): Flowable<List<Bufferoo>> {
         return bufferooRepository.getBufferoos()
diff --git a/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/empty/EmptyView.kt b/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/empty/EmptyView.kt
index a21ee01..70de626 100644
--- a/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/empty/EmptyView.kt
+++ b/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/empty/EmptyView.kt
@@ -4,6 +4,7 @@ import android.content.Context
 import android.util.AttributeSet
 import android.view.LayoutInflater
 import android.widget.RelativeLayout
+import kotlinx.android.synthetic.main.view_empty.view.*
 import org.buffer.android.boilerplate.ui.R
 
 /**
@@ -28,6 +29,7 @@ class EmptyView: RelativeLayout {
 
     private fun init() {
         LayoutInflater.from(context).inflate(R.layout.view_empty, this)
+        button_check_again.setOnClickListener { emptyListener?.onCheckAgainClicked() }
     }
 
 }
\ No newline at end of file
diff --git a/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/error/ErrorView.kt b/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/error/ErrorView.kt
index 1e016b7..ce79e51 100644
--- a/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/error/ErrorView.kt
+++ b/mobile-ui/src/main/java/org/buffer/android/boilerplate/ui/widget/error/ErrorView.kt
@@ -4,6 +4,7 @@ import android.content.Context
 import android.util.AttributeSet
 import android.view.LayoutInflater
 import android.widget.RelativeLayout
+import kotlinx.android.synthetic.main.view_error.view.*
 import org.buffer.android.boilerplate.ui.R
 
 /**
@@ -28,6 +29,7 @@ class ErrorView : RelativeLayout {
 
     private fun init() {
         LayoutInflater.from(context).inflate(R.layout.view_error, this)
+        button_try_again.setOnClickListener { errorListener?.onTryAgainClicked() }
     }
 
 }
\ No newline at end of file
diff --git a/mobile-ui/src/main/res/layout/view_empty.xml b/mobile-ui/src/main/res/layout/view_empty.xml
index d70c523..0fad093 100644
--- a/mobile-ui/src/main/res/layout/view_empty.xml
+++ b/mobile-ui/src/main/res/layout/view_empty.xml
@@ -7,14 +7,16 @@
         android:id="@+id/text_message"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_centerInParent="true" />
+        android:layout_centerInParent="true"
+        android:text="@string/label_empty_result" />
 
     <Button
         android:id="@+id/button_check_again"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:layout_below="@+id/text_message"
+        android:layout_centerHorizontal="true"
         android:padding="16dp"
-        android:layout_centerHorizontal="true" />
+        android:text="@string/button_try_again" />
 
 </merge>
\ No newline at end of file
diff --git a/mobile-ui/src/main/res/layout/view_error.xml b/mobile-ui/src/main/res/layout/view_error.xml
index d1d9c04..95f5467 100644
--- a/mobile-ui/src/main/res/layout/view_error.xml
+++ b/mobile-ui/src/main/res/layout/view_error.xml
@@ -7,14 +7,16 @@
         android:id="@+id/text_message"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_centerInParent="true" />
+        android:layout_centerInParent="true"
+        android:text="@string/label_error_result" />
 
     <Button
         android:id="@+id/button_try_again"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:layout_below="@+id/text_message"
+        android:layout_centerHorizontal="true"
         android:padding="16dp"
-        android:layout_centerHorizontal="true" />
+        android:text="@string/button_try_again" />
 
 </merge>
\ No newline at end of file
diff --git a/readme.md b/readme.md
index db2aa75..a4fe1aa 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,18 @@
 [![Build Status](https://travis-ci.org/bufferapp/android-clean-architecture-boilerplate.svg?branch=master)](https://travis-ci.org/bufferapp/android-clean-architecture-boilerplate) [![codecov](https://codecov.io/gh/bufferapp/android-clean-architecture-boilerplate/branch/master/graph/badge.svg)](https://codecov.io/gh/bufferapp/android-clean-architecture-boilerplate) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/278fa00f492d48a288ab64188d15fb61)](https://www.codacy.com/app/hitherejoe/android-clean-architecture-boilerplate?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bufferapp/android-clean-architecture-boilerplate&amp;utm_campaign=Badge_Grade) 
 
-# Android Clean Architecture Boilerplate
+# Android Clean Architecture Components Boilerplate
+
+
+Note: This is a fork of our original [Clean Architecture Boilerplate](https://github.com/bufferapp/android-clean-architecture-boilerplate), except in this repo we have switched out the MVP approach found in the presentation layer to now use ViewModels from the Android Architecture Components Library.
+The caching layer now also uses Room.
+
 
 Welcome 👋 We hope this boilerplate is not only helpful to other developers, but also that it helps to educate in the area of architecture. We created this boilerplate for a few reasons:
 
 1. To experiment with modularisation
-2. To share some approaches to clean architecture, especially as we've been [talking a lot about it](https://academy.realm.io/posts/converting-an-app-to-use-clean-architecture/)
-3. To use as a starting point in future projects where clean architecture feels appropriate
+2. TO experiment with the Android Architecture Components
+3. To share some approaches to clean architecture, especially as we've been [talking a lot about it](https://academy.realm.io/posts/converting-an-app-to-use-clean-architecture/)
+4. To use as a starting point in future projects where clean architecture feels appropriate
 
 It is written 100% in Kotlin with both UI and Unit tests - we will also be keeping this up-to-date as libraries change!
 
@@ -19,6 +25,8 @@ Clean Architecture will not be appropriate for every project, so it is down to y
 ## Languages, libraries and tools used
 
 * [Kotlin](https://kotlinlang.org/)
+* [Room](https://developer.android.com/topic/libraries/architecture/room.html)
+* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html)
 * Android Support Libraries
 * [RxJava2](https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0)
 * [Dagger 2 (2.11)](https://github.com/google/dagger)
@@ -59,13 +67,11 @@ This layer makes use of the Android Framework and is used to create all of our U
 
 ### Presentation
 
-This layer's responsibilty is to handle the presentation of the User Interface, but at the same time knows nothing about the user interface itself. This layer has no dependance on the Android Framework, it is a pure Kotlin module. Each Presenter class that is created implements the [Presenter](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/BasePresenter.kt) interface defined within an instance of a contract - in this case the [BrowseContract](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/browse/BrowseBufferoosContract.kt), which also contains an interface for the [View](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/BaseView.kt) interface.
-
-When a Presenter is constructed, an instance of this View is passed in. This view is then used and the presenter is set for it using the implemented [setPresenter()](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/browse/BrowseBufferoosPresenter.kt#L15) call.
+This layer's responsibilty is to handle the presentation of the User Interface, but at the same time knows nothing about the user interface itself. This layer has no dependance on the Android Framework, it is a pure Kotlin module. Each ViewModel class that is created implements the ViewModel class found within the Architecture components library. This ViewModel can then be used by the UI layer to communicate with UseCases and retrieve data. The [BrowseBufferoosViewModel]() returns an instance of a Resource which contains data that can be used by the UI - this includes the [ResourceState](), data to be used by the UI and a message if required (for error states).
 
-The presenters use an instance of a [SingleUseCase](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/ObservableUseCase.kt) from the Domain layer to retrieve data. Note here that there is no direct name reference to the UseCase that we are using - we do inject an instance of the [GetBufferoos](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt) UseCase, however.
+The ViewModels use an instance of a [FlowableUseCase](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/FlowableUseCase.kt) from the Domain layer to retrieve data. Note here that there is no direct name reference to the UseCase that we are using - we do inject an instance of the [GetBufferoos](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/domain/src/main/java/org/buffer/android/boilerplate/domain/interactor/browse/GetBufferoos.kt) UseCase, however.
 
-The presenter receives data from the Domain layer in the form of a [Bufferoo](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/model/BufferooView.kt). These instances are mapped to instance of this layers model, which is a BufferooView using the [BufferooMapper](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/mapper/BufferooMapper.kt).
+The ViewModel receives data from the Domain layer in the form of a [Bufferoo](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/model/BufferooView.kt). These instances are mapped to instance of this layers model, which is a BufferooView using the [BufferooMapper](https://github.com/bufferapp/android-clean-architecture-boilerplate/blob/master/presentation/src/main/java/org/buffer/android/boilerplate/presentation/mapper/BufferooMapper.kt).
 
 ### Domain