Merge branch 'master' of github.com:bufferapp/clean-architecture-components-boilerplate

Author: hitherejoe

build.gradle

@@ -12,7 +12,7 @@ buildscript {
         classpath "com.dicedmelon.gradle:jacoco-android:0.1.1"
 
 
-        // NOTE: Do not place yrofour application dependencies here; they belong
+        // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
 }

cache/src/main/java/org/buffer/android/boilerplate/cache/BufferooCacheImpl.kt

@@ -17,13 +17,13 @@ import javax.inject.Inject
  */
 class BufferooCacheImpl @Inject constructor(val bufferoosDatabase: BufferoosDatabase,
                                             private val entityMapper: BufferooEntityMapper,
-                                            private val preferencesHelper: PreferencesHelper):
+                                            private val preferencesHelper: PreferencesHelper) :
         BufferooCache {
 
     private val EXPIRATION_TIME = (60 * 10 * 1000).toLong()
 
     /**
-     * Retrieve an instance from the database, used for tests
+     * Retrieve an instance from the database, used for tests.
      */
     internal fun getDatabase(): BufferoosDatabase {
         return bufferoosDatabase
@@ -64,7 +64,7 @@ class BufferooCacheImpl @Inject constructor(val bufferoosDatabase: BufferoosData
     }
 
     /**
-     * Checked whether there are instances of [CachedBufferoo] stored in the cache
+     * Check whether there are instances of [CachedBufferoo] stored in the cache.
      */
     override fun isCached(): Single<Boolean> {
         return Single.defer {
@@ -73,14 +73,14 @@ class BufferooCacheImpl @Inject constructor(val bufferoosDatabase: BufferoosData
     }
 
     /**
-     * Set a point in time at when the cache was last updated
+     * Set a point in time at when the cache was last updated.
      */
     override fun setLastCacheTime(lastCache: Long) {
         preferencesHelper.lastCacheTime = lastCache
     }
 
     /**
-     * Check whether the current cached data exceeds the defined [EXPIRATION_TIME] time
+     * Check whether the current cached data exceeds the defined [EXPIRATION_TIME] time.
      */
     override fun isExpired(): Boolean {
         val currentTime = System.currentTimeMillis()

data/src/main/java/org/buffer/android/boilerplate/data/repository/BufferooCache.kt

@@ -12,42 +12,38 @@ import org.buffer.android.boilerplate.data.model.BufferooEntity
 interface BufferooCache {
 
     /**
-     * Clear all Bufferoos from the cache
+     * Clear all Bufferoos from the cache.
      */
     fun clearBufferoos(): Completable
 
     /**
-     * Save a given list of Bufferoos to the cache
+     * Save a given list of Bufferoos to the cache.
      */
     fun saveBufferoos(bufferoos: List<BufferooEntity>): Completable
 
     /**
-     * Retrieve a list of Bufferoos, from the cache
+     * Retrieve a list of Bufferoos, from the cache.
      */
     fun getBufferoos(): Flowable<List<BufferooEntity>>
 
     /**
-     * Checks if an element (User) exists in the cache.
-
-     * @param userId The id used to look for inside the cache.
-     * *
-     * @return true if the element is cached, otherwise false.
+     * Check whether there is a list of Bufferoos stored in the cache.
+     *
+     * @return true if the list is cached, otherwise false
      */
     fun isCached(): Single<Boolean>
 
     /**
-     * Checks if an element (User) exists in the cache.
-
-     * @param userId The id used to look for inside the cache.
-     * *
-     * @return true if the element is cached, otherwise false.
+     * Set a point in time at when the cache was last updated.
+     *
+     * @param lastCache the point in time at when the cache was last updated
      */
     fun setLastCacheTime(lastCache: Long)
 
     /**
-     * Checks if the cache is expired.
-
-     * @return true, the cache is expired, otherwise false.
+     * Check if the cache is expired.
+     *
+     * @return true if the cache is expired, otherwise false
      */
     fun isExpired(): Boolean