├── .editorconfig ├── .gitignore ├── .travis.yml ├── LICENSE ├── Readme.md ├── app ├── .gitignore ├── appTest.jks ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── epam │ │ └── example │ │ └── coroutinescache │ │ └── ExampleInstrumentedTest.kt │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── com │ │ └── epam │ │ └── example │ │ └── coroutinescache │ │ ├── App.kt │ │ ├── CacheProviders.kt │ │ ├── Data.kt │ │ ├── MainActivity.kt │ │ ├── Repository.kt │ │ └── RestApi.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── layout │ └── activity_main.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-mdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xxhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ ├── mipmap-xxxhdpi │ ├── ic_launcher.png │ └── ic_launcher_round.png │ └── values │ ├── colors.xml │ ├── strings.xml │ └── styles.xml ├── build.gradle ├── bumpVersion.gradle ├── core ├── .gitignore ├── build.gradle └── src │ ├── main │ └── java │ │ └── com │ │ └── epam │ │ └── coroutinecache │ │ ├── annotations │ │ ├── Expirable.kt │ │ ├── LifeTime.kt │ │ ├── ProviderKey.kt │ │ └── UseIfExpired.kt │ │ ├── api │ │ ├── CacheParams.kt │ │ ├── CoroutinesCache.kt │ │ └── ParameterizedDataProvider.kt │ │ ├── core │ │ ├── DiskCache.kt │ │ ├── Memory.kt │ │ ├── MemoryCache.kt │ │ ├── Persistence.kt │ │ ├── Record.kt │ │ ├── Source.kt │ │ └── actions │ │ │ ├── DeleteExpirableRecordsAction.kt │ │ │ ├── DeleteExpiredRecordsAction.kt │ │ │ ├── DeleteRecordAction.kt │ │ │ ├── GetRecordAction.kt │ │ │ └── SaveRecordAction.kt │ │ ├── di │ │ ├── ActionsModule.kt │ │ └── CacheModule.kt │ │ ├── internal │ │ ├── CacheObjectParams.kt │ │ ├── ProcessorProvider.kt │ │ ├── ProcessorProviderImpl.kt │ │ ├── ProxyProvider.kt │ │ ├── ProxyTranslator.kt │ │ └── RecordExpiredChecker.kt │ │ ├── mappers │ │ ├── GsonMapper.kt │ │ ├── JacksonMapper.kt │ │ ├── JsonMapper.kt │ │ └── MoshiMapper.kt │ │ └── utils │ │ ├── CacheLog.kt │ │ ├── NoParamsDataProvider.kt │ │ ├── Types.kt │ │ └── Utils.kt │ └── test │ └── java │ └── com │ └── epam │ └── coroutinecache │ ├── BaseTest.kt │ ├── DiskTest.kt │ ├── MemoryTest.kt │ ├── actions │ ├── DeleteRecordActionTest.kt │ ├── GetRecordActionTest.kt │ └── SaveRecordActionTest.kt │ └── utils │ ├── JsonFactoryChooser.kt │ ├── MapperProvider.kt │ └── MockDataString.kt ├── detekt-config.yml ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── ktlint.gradle ├── settings.gradle └── updateReadme.sh /.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{kt,kts}] 2 | indent_size=unset 3 | max_line_length=150 4 | insert_final_newline=false 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/* 5 | .DS_Store 6 | /build 7 | /captures 8 | .externalNativeBuild -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: android 2 | dist: trusty 3 | jdk: oraclejdk8 4 | 5 | env: 6 | global: 7 | - ANDROID_API_LEVEL=28 8 | - ANDROID_BUILD_TOOLS_VERSION=28.0.3 9 | 10 | android: 11 | components: 12 | # The BuildTools version used by your project 13 | - build-tools-$ANDROID_BUILD_TOOLS_VERSION 14 | # The SDK version used to compile your project 15 | - android-$ANDROID_API_LEVEL 16 | 17 | before_cache: 18 | - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock 19 | - rm -fr $HOME/.gradle/caches/*/plugin-resolution/ 20 | 21 | cache: 22 | directories: 23 | - $HOME/.gradle/caches/ 24 | - $HOME/.gradle/wrapper/ 25 | - $HOME/.android/build-cache 26 | 27 | licenses: 28 | - 'android-sdk-preview-license-.+' 29 | - 'android-sdk-license-.+' 30 | - 'google-gdk-license-.+' 31 | 32 | script: 33 | - ./gradlew ktlint detekt build check -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # CoroutinesCache 2 | 3 | [![Build Status](https://img.shields.io/travis/epam/CoroutinesCache/master.svg?label=master)](https://travis-ci.org/epam/CoroutinesCache) 4 | 5 | ## Preview 6 | The goal of this library is simple: caching your data models like **Picasso** caches your images, with no effort at all. 7 | 8 | Every Android application is a client application, which means it does not make sense to create and maintain a database just for caching data. 9 | 10 | Plus, the fact that you have some sort of legendary database for persisting your data does not solves by itself the real challenge: to be able to configure your caching needs in a flexible and simple way. 11 | 12 | Inspired by Retrofit api, CoroutinesCache is a reactive caching library for Android and Kotlin which turns your caching needs. 13 | 14 | To get full information about how library works follow next article: 15 | 16 | https://proandroiddev.com/caching-with-kotlin-coroutines-7d819276c820 17 | 18 | #### Note 19 | 20 | Coroutines Cache works only on `kotlin-coroutines:0.26.1` and above. 21 | 22 | ## Getting started 23 | 24 | Library is located in jcenter, add jcenter repository in main gradle file 25 | 26 | ```kotlin 27 | allprojects { 28 | repositories { 29 | ... 30 | jcenter() 31 | } 32 | } 33 | ``` 34 | 35 | Grab via Gradle: 36 | 37 | ```kotlin 38 | implementation 'com.epam.coroutinecache:coroutinecache:0.9.6' 39 | ``` 40 | or Maven: 41 | 42 | ```kotlin 43 | 44 | com.epam.coroutinecache 45 | coroutinecache 46 | 0.9.6 47 | pom 48 | 49 | ``` 50 | 51 | 52 | 53 | ## Usage 54 | 55 | To start use cache you need to create CoroutinesCache object: 56 | 57 | ```kotlin 58 | val coroutinesCache = CoroutinesCache(cacheParams: CacheParams, scope: CoroutineScope) 59 | ``` 60 | 61 | `CacheParams` defines cache location, json mapper and persistence size in Mb. 62 | 63 | First param of `CacheParams` is max size that could be saved in persistence in Mb. 64 | 65 | Second param is `JsonMapper` interface that provides one of several implementation: `GsonMapper`, `JacksonMapper`, `MoshiMapper`. For each of those mappers you need to add appropriate dependency in `build.gradle` file. 66 | 67 | Last param is directory where cache files will be stored. Be sure that directory exists and you has write permission there, otherwise you will get `IllegalStateException` 68 | 69 | ```kotlin 70 | class CacheParams (maxPersistenceCacheMB: Int, mapper: JsonMapper, directory: File) 71 | ``` 72 | 73 | Next step you need to create an interface with functions that will describe data, which should be stored. For each function you can add params by next annotations: 74 | 75 | 1. `@ProviderKey(key: String, entryClass: EntryClass)` - **key** that will be used for saving data, **entryClass** it is an another annotation `@EntryClass(rawType: KClass<*>, vararg typeParams: EntryClass = [])` that used to specify value's type needed for serialization/deserialization (to avoid obtaining type through reflection). **typeParams** used when you need parameterized type, such annotation for list should looks like: `EntryClass(List::class, EntryClass(Data::class))` 76 | 2. `@LifeTime(value: Long, timeUnit: TimeUnit)` - **value** describes how long record should be stored in memory or persistence. If this annotation isn't set, record will be stored without time limit 77 | 3. `@Expirable` - Set **expirable** param to true. If this annotation isn't set it means that record could be deleted from persistence, even it hasn't reached life limit in persistence low memory case. 78 | 4. `@UseIfExpired` - If this annotation is set it means that data will be retrieved from cache even if record reached its lifetime. Could be used only once, after getting, record will be deleted from cache. 79 | 80 | **Note:** In cases when data can be requested without any parameters you may use a method that should be a suspend function containing only one param that is also a suspend function without params that returns type **T**. It's result will be stored in the cache. And function's return value also should be **** 81 | In case, when you data request call requires some parameters and also you want to store data with different keys that depend on call parameters, then you should use a suspend method that takes an implementation of `ParameterizedDataProvider` interface. In that case data will be stored under modified key that is controlled by your implementation of `parameterizeKey` method. 82 | 83 | To connect interface and CoroutinesCache and your interface just call `CoroutinesCache.using(YourInterface::class.java)`. This method will return interface instance. To save and get data from cache just call methods from returned instance of your interface. 84 | ## Example 1 (no parameters) 85 | 86 | **CacheProviders** 87 | ```kotlin 88 | interface CacheProviders { 89 | @ProviderKey("TestKey", EntryClass(Data::class)) 90 | @LifeTime(value = 1L, unit = TimeUnit.MINUTES) 91 | @Expirable 92 | @UseIfExpired 93 | suspend fun getData(dataProvider: suspend () -> Data): Data 94 | } 95 | ``` 96 | 97 | **Repository** 98 | ```kotlin 99 | class Repository (private val cacheDirectory: File) { 100 | private val coroutinesCache = CoroutinesCache(CacheParams(10, GsonMapper(), cacheDirectory)) 101 | private val restApi = Retrofit...create(RestApi::class.java) 102 | private val cacheProviders = coroutinesCache.using(CacheProviders::class.java) 103 | 104 | suspend fun getData(): Data = cacheProviders.getData(restApi::getData) 105 | } 106 | ``` 107 | **MainActivity** 108 | ```kotlin 109 | class MainActivity : AppCompatActivity() { 110 | private val persistence by lazy { Repository(cacheDir) } 111 | override fun onCreate(savedInstanceState: Bundle?) { 112 | super.onCreate(savedInstanceState) 113 | setContentView(R.layout.activity_main) 114 | GlobalScope.launch (Dispatchers.Main) { 115 | val data = persistence.getData() 116 | messageView.text = data.toString() 117 | } 118 | } 119 | } 120 | ```` 121 | 122 | ## Example 2 (with parameters) 123 | 124 | **CacheProviders** 125 | ```kotlin 126 | interface CacheProviders { 127 | @ProviderKey("BaseKey", EntryClass(Data::class)) 128 | @LifeTime(value = 1L, unit = TimeUnit.MINUTES) 129 | @Expirable 130 | @UseIfExpired 131 | suspend fun getParameterizedData(provider: ParameterizedDataProvider): Data 132 | } 133 | ``` 134 | 135 | **Repository** 136 | ```kotlin 137 | class Repository (private val cacheDirectory: File) { 138 | private val coroutinesCache = CoroutinesCache(CacheParams(10, GsonMapper(), cacheDirectory)) 139 | private val restApi = Retrofit...create(RestApi::class.java) 140 | private val cacheProviders = coroutinesCache.using(CacheProviders::class.java) 141 | 142 | suspend fun getParametrizedData(search: String): Data = cacheProviders.getParameterizedData(DataProviderImpl()) 143 | 144 | private inner class DataProviderImpl(private val search: String) : ParameterizedDataProvider { 145 | 146 | override suspend fun getData(): Data = restApi.getParameterizedData(search) 147 | 148 | override fun parameterizeKey(baseKey: String): String = "${baseKey}_$search" 149 | } 150 | } 151 | ``` 152 | **MainActivity** 153 | ```kotlin 154 | class MainActivity : AppCompatActivity() { 155 | private val persistence by lazy { Repository(cacheDir) } 156 | override fun onCreate(savedInstanceState: Bundle?) { 157 | super.onCreate(savedInstanceState) 158 | setContentView(R.layout.activity_main) 159 | GlobalScope.launch (Dispatchers.Main) { 160 | val data = persistence.getParameterizedData("Hello world!") 161 | messageView.text = data.toString() 162 | } 163 | } 164 | } 165 | ```` 166 | 167 | To see full example, check app module in this repository. 168 | 169 | ## ProGuard 170 | Do not forget to keep your own data classes in proguard rules. For example, add this line for 'Data' class that is being cached with this library: 171 | ``` 172 | # Keep all of your data classes that are stored in CoroutineCache 173 | -keep class com.epam.example.coroutinescache.Data { *; } 174 | ``` 175 | 176 | Also, please add following instructions so that CoroutineCache may work properly: 177 | ``` 178 | # ProGuard instructions that are required for CoroutineCache to work properly 179 | -keepclassmembers enum com.epam.coroutinecache.core.Source { 180 | public *; 181 | } 182 | ``` 183 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /app/appTest.jks: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/epam/CoroutinesCache/ad111bb1d1a6a90849c28e39259f4d564f1aa171/app/appTest.jks -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | apply plugin: 'kotlin-android' 4 | 5 | apply plugin: 'kotlin-android-extensions' 6 | 7 | android { 8 | compileSdkVersion 28 9 | defaultConfig { 10 | applicationId "com.epam.example.coroutinescache" 11 | minSdkVersion 15 12 | targetSdkVersion 28 13 | versionCode appVersionCode.toInteger() 14 | versionName appVersionName 15 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 16 | } 17 | 18 | signingConfigs { 19 | releaseConfig { 20 | storeFile file('appTest.jks') 21 | storePassword 'apptest' 22 | keyAlias = 'apptest' 23 | keyPassword 'apptest' 24 | } 25 | } 26 | 27 | buildTypes { 28 | debug { 29 | minifyEnabled false 30 | debuggable true 31 | } 32 | 33 | release { 34 | debuggable false 35 | minifyEnabled true 36 | signingConfig signingConfigs.releaseConfig 37 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 38 | } 39 | } 40 | } 41 | 42 | dependencies { 43 | implementation fileTree(dir: 'libs', include: ['*.jar']) 44 | implementation project(":core") 45 | 46 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 47 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version" 48 | implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version" 49 | 50 | implementation "org.koin:koin-android:${koinVersion}" 51 | 52 | implementation 'com.android.support:appcompat-v7:28.0.0' 53 | implementation 'com.android.support.constraint:constraint-layout:1.1.3' 54 | 55 | implementation 'com.google.code.gson:gson:2.8.5' 56 | implementation 'com.squareup.moshi:moshi:1.6.0' 57 | implementation 'com.fasterxml.jackson.core:jackson-core:2.9.6' 58 | 59 | implementation 'com.squareup.retrofit2:retrofit:2.6.0' 60 | implementation "com.squareup.retrofit2:converter-gson:2.6.0" 61 | 62 | implementation 'com.jakewharton.retrofit:retrofit2-kotlin-coroutines-adapter:0.9.2' 63 | 64 | testImplementation 'junit:junit:4.12' 65 | androidTestImplementation 'com.android.support.test:runner:1.0.2' 66 | androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' 67 | } 68 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Don't forget to keep your data classes that are stored in CoroutineCache 2 | -keep class com.epam.example.coroutinescache.Data { *; } 3 | 4 | 5 | # ProGuard instructions that are required for CoroutineCache to work properly 6 | -keepclassmembers enum com.epam.coroutinecache.core.Source { 7 | public *; 8 | } -------------------------------------------------------------------------------- /app/src/androidTest/java/com/epam/example/coroutinescache/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import android.support.test.InstrumentationRegistry 4 | import android.support.test.runner.AndroidJUnit4 5 | import org.junit.Assert.assertEquals 6 | 7 | import org.junit.Test 8 | import org.junit.runner.RunWith 9 | 10 | /** 11 | * Instrumented test, which will execute on an Android device. 12 | * 13 | * See [testing documentation](http://d.android.com/tools/testing). 14 | */ 15 | @RunWith(AndroidJUnit4::class) 16 | class ExampleInstrumentedTest { 17 | @Test 18 | fun useAppContext() { 19 | // Context of the app under test. 20 | val appContext = InstrumentationRegistry.getTargetContext() 21 | assertEquals("com.epam.example.coroutinescache", appContext.packageName) 22 | } 23 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/App.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import android.app.Application 4 | import org.koin.android.ext.koin.androidContext 5 | import org.koin.core.context.startKoin 6 | 7 | class App : Application() { 8 | 9 | override fun onCreate() { 10 | super.onCreate() 11 | startKoin { 12 | androidContext(this@App) 13 | } 14 | } 15 | } -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/CacheProviders.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import com.epam.coroutinecache.annotations.ProviderKey 4 | import com.epam.coroutinecache.annotations.LifeTime 5 | import com.epam.coroutinecache.annotations.Expirable 6 | import com.epam.coroutinecache.annotations.EntryClass 7 | import com.epam.coroutinecache.annotations.UseIfExpired 8 | import com.epam.coroutinecache.api.ParameterizedDataProvider 9 | import java.util.concurrent.TimeUnit 10 | 11 | interface CacheProviders { 12 | 13 | @ProviderKey("TestKey", EntryClass(Data::class)) 14 | @LifeTime(value = 1L, unit = TimeUnit.MINUTES) 15 | @Expirable 16 | @UseIfExpired 17 | suspend fun getData(dataProvider: suspend () -> Data): Data 18 | 19 | @ProviderKey("AnotherKey", EntryClass(Data::class)) 20 | @LifeTime(value = 1L, unit = TimeUnit.MINUTES) 21 | @Expirable 22 | @UseIfExpired 23 | suspend fun getParameterizedData(provider: ParameterizedDataProvider): Data 24 | } -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/Data.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | data class Data( 4 | val userId: String, 5 | val id: String, 6 | val title: String, 7 | val completed: Boolean 8 | ) { 9 | override fun toString(): String { 10 | return "UserId: $userId, id: $id, title: $title, completed: $completed" 11 | } 12 | } -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import android.os.Bundle 4 | import android.support.v7.app.AppCompatActivity 5 | import kotlinx.android.synthetic.main.activity_main.* 6 | import kotlinx.coroutines.CoroutineScope 7 | import kotlinx.coroutines.Dispatchers.IO 8 | import kotlinx.coroutines.Dispatchers.Main 9 | import kotlinx.coroutines.SupervisorJob 10 | import kotlinx.coroutines.launch 11 | import kotlinx.coroutines.withContext 12 | import kotlin.coroutines.CoroutineContext 13 | 14 | class MainActivity : AppCompatActivity(), CoroutineScope { 15 | 16 | override val coroutineContext: CoroutineContext 17 | get() = SupervisorJob() 18 | 19 | private val persistence by lazy { Repository(cacheDir) } 20 | 21 | override fun onCreate(savedInstanceState: Bundle?) { 22 | super.onCreate(savedInstanceState) 23 | setContentView(R.layout.activity_main) 24 | pressMe.setOnClickListener { onClick() } 25 | } 26 | 27 | private fun onClick() { 28 | launch(Main) { 29 | val data = withContext(IO) { persistence.getParameterizedData("1234") } 30 | val result = data.toString() 31 | messageView.text = result 32 | } 33 | } 34 | } -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/Repository.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import com.epam.coroutinecache.api.CacheParams 4 | import com.epam.coroutinecache.api.CoroutinesCache 5 | import com.epam.coroutinecache.api.ParameterizedDataProvider 6 | import com.epam.coroutinecache.mappers.GsonMapper 7 | import retrofit2.Retrofit 8 | import retrofit2.converter.gson.GsonConverterFactory 9 | import java.io.File 10 | 11 | class Repository( 12 | cacheDirectory: File 13 | ) { 14 | 15 | private val coroutinesCache: CoroutinesCache = CoroutinesCache(CacheParams(MAX_CACHE_SIZE_MB, GsonMapper(), cacheDirectory)) 16 | 17 | private val restApi: RestApi = Retrofit.Builder() 18 | .baseUrl("https://jsonplaceholder.typicode.com") 19 | .addConverterFactory(GsonConverterFactory.create()) 20 | .build().create(RestApi::class.java) 21 | 22 | private val cacheProviders: CacheProviders = coroutinesCache.using(CacheProviders::class.java) 23 | 24 | suspend fun getData(): Data = cacheProviders.getData(restApi::getData) 25 | 26 | suspend fun getParameterizedData(search: String): Data = cacheProviders.getParameterizedData(DataProviderImpl(search)) 27 | 28 | private inner class DataProviderImpl(private val search: String) : ParameterizedDataProvider { 29 | 30 | override suspend fun getData(): Data = restApi.getParameterizedData(search) 31 | 32 | override fun parameterizeKey(baseKey: String): String = "${baseKey}_$search" 33 | } 34 | 35 | companion object { 36 | private const val MAX_CACHE_SIZE_MB = 10 37 | } 38 | } -------------------------------------------------------------------------------- /app/src/main/java/com/epam/example/coroutinescache/RestApi.kt: -------------------------------------------------------------------------------- 1 | package com.epam.example.coroutinescache 2 | 3 | import retrofit2.http.GET 4 | import retrofit2.http.Query 5 | 6 | interface RestApi { 7 | 8 | @GET("todos/1") 9 | suspend fun getData(): Data 10 | 11 | @GET("todos/1") 12 | suspend fun getParameterizedData(@Query("search") search: String): Data 13 | } -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 12 | 13 | 19 | 22 | 25 | 26 | 27 | 28 | 34 | 35 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 11 | 16 | 21 | 26 | 31 | 36 | 41 | 46 | 51 | 56 | 61 | 66 | 71 | 76 | 81 | 86 | 91 | 96 | 101 | 106 | 111 | 116 | 121 | 126 | 131 | 136 | 141 | 146 | 151 | 156 | 161 | 166 | 171 | 172 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | 10 | 18 | 19 | 20 |