Merge pull request #1 from pcpl2/feature/1.2.0

Feature/1.2.0

Author: pcpl2

README.md

@@ -1,8 +1,8 @@
 # SimpleCache 
 [![Build Status](https://travis-ci.org/pcpl2/CacheLib.svg?branch=master)](https://travis-ci.org/pcpl2/CacheLib) 
 [![SimpleCache](https://api.bintray.com/packages/pcpl2/maven/simplecache/images/download.svg) ](https://bintray.com/pcpl2/maven/simplecache/_latestVersion)
-[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=plastic)](https://android-arsenal.com/api?level=21)
 [![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+[![API](https://img.shields.io/badge/API-14%2B-green.svg?style=flat)](https://android-arsenal.com/api?level=21)
 [![Android Arsenal]( https://img.shields.io/badge/Android%20Arsenal-simplecache-green.svg?style=flat )]( https://android-arsenal.com/details/1/6965 )
 
 A simple library for saving data in the cache and reading them.
@@ -12,7 +12,7 @@ The library is hosted on jcenter. To use it, add the following to your module le
 
 ```gradle
 dependencies {
-    implementation 'com.github.pcpl2:simplecache:1.1.0'
+    implementation 'com.github.pcpl2:simplecache:1.2.0'
 }
 ```
 
@@ -21,17 +21,22 @@ dependencies {
 **To init instance of cache manager without filename:**
 
 ```kotlin
-val cacheManager = CacheManager.createInstance(appContext, null) 
+val cacheManager = CacheManager.createInstance(context = appContext)
 ```
 The `cacheManager` instance usage default cache file.
 
 **To init instance of cache manager with filename:**
 
 ```kotlin
-val cacheManager = CacheManager.createInstance(appContext, "filesCache")
+val cacheManager = CacheManager.createInstance(context = appContext, fileName = "filesCache")
 ```
 The `cacheManager` instance usage cache with file name `filesCache`.
 
+**To init instance of cache manager without autosave:**
+```kotlin
+val cacheManager = CacheManager.createInstance(context = appContext, autoSave = false)
+```
+If you have deactivated the automatic saving, you must remember to save the data using the `save` method.
 
 ## Add or update elements to cache: 
 The `set` function accepts 3 parameters: `key: Stirng, value: Any, lifetime: Long`.
@@ -55,6 +60,12 @@ cacheManager.set("IntValueKey", 255)
 cacheManager.set("BooleanKey", false)
 cacheManager.set("FloatKey", 5.55)
 ```
+## Save cache data 
+**To save cache on disk (if autosave disabled):**
+
+```kotlin
+cacheManager.save()
+```
 
 ## Getting element from cache: 
 The `get` function accepts 4 parameters: `key: Stirng, checkExpired: Boolean = true, success:  (value: Any, type: Class<*>) -> Unit, error: (() -> Unit)? = null`.
@@ -116,13 +127,13 @@ cacheManager.get(key = "FloatKey", checkExpired = false, success = { value, type
 ## Remove element from cache
 The `remove` function accept 1 parameter: `key: Stirng`.
 
-
 **To remove element from cache instance:**
 ```kotlin
 cacheManager.remove("FloatKey")
 ```
 
 ## Clear cache instance
+
 The `removeAllElements` function cleans the entire cache.
 
 **To clear cache istance:**
@@ -131,6 +142,16 @@ The `removeAllElements` function cleans the entire cache.
 cacheManager.removeAllElements()
 ```
 
+**To remove all elements in cache istance:**
+
+```kotlin
+cacheManager.removeAllElements()
+```
+
+The `dispose` function accept 1 parameter: `save: Boolean = true`.
+
+The save parameter is optional, default set as true.
+
 ## List of the cache files.
 The `getListOfCacheFiles` function accept 1 parameter: `ctx: Context` and return list of exist cache files.
 
@@ -140,6 +161,49 @@ The `getListOfCacheFiles` function accept 1 parameter: `ctx: Context` and return
 CacheManager.getListOfCacheFiles(appContext)
 ```
 
+# Global instances
+
+## Create global instacne 
+The `createGlobalInstance` function accept 4 parameters: `context: Context, instanceName: String, fileName: String = "CacheBase", autoSave: Boolean = true` and return cache instance.
+
+**To create global instance:**
+
+```kotlin
+CacheManager.createGlobalInstance(context = appContext, instanceName = "Instance1", fileName = "instanceFile1")
+```
+
+## Get global instacne 
+The `getGlobalInstance` function accept 1 parameter: `instanceName: String` and return cache instance.
+
+**To get global instance by name:**
+
+```kotlin
+val globalInstance2 = CacheManager.getGlobalInstance(instanceName = "Instance1")
+```
+
+**To get list of global instance names:**
+
+```kotlin
+var listOfIInstancesNames = CacheManager.getListOfGlobalInstanceNames()
+```
+
+## Remove global instance
+The `removeGlobalInstance` function accept 2 parameters: `instanceName: String, save: Boolean = true`.
+
+The save parameter is optional, default set as true.
+
+**To remove global instance by name:**
+
+```kotlin
+val globalInstance2 = CacheManager.removeGlobalInstance(instanceName = "Instance1")
+```
+
+**To remove all global instances:**
+
+```kotlin
+val globalInstance2 = CacheManager.removeAllGlobalInstances()
+```
+
 # Changelog
 Please see the [Changelog](https://github.com/pcpl2/CacheLib/wiki/Changelog) page to see what's recently changed.
 
@@ -159,4 +223,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-```
+```

simplecache/build.gradle

@@ -5,10 +5,10 @@ android {
     compileSdkVersion 27
 
     defaultConfig {
-        minSdkVersion 21
+        minSdkVersion 14
         targetSdkVersion 27
         versionCode 1
-        versionName "1.1.0"
+        versionName "1.2.0"
 
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
 
@@ -40,7 +40,7 @@ ext {
     siteUrl = 'https://github.com/pcpl2/CacheLib'
     gitUrl = 'https://github.com/pcpl2/CacheLib.git'
 
-    libraryVersion = '1.1.0'
+    libraryVersion = '1.2.0'
 
     developerId = 'pcpl2'
     developerName = 'Patryk Ławicki'
@@ -58,8 +58,8 @@ dependencies {
     implementation 'com.google.code.gson:gson:2.8.2'
 
     testImplementation 'junit:junit:4.12'
-    androidTestImplementation 'com.android.support.test:runner:1.0.1'
-    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
+    androidTestImplementation 'com.android.support.test:runner:1.0.2'
+    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 }
 

simplecache/src/androidTest/java/com/github/pcpl2/simplecache/SimpleCacheTest.kt

@@ -19,13 +19,85 @@ import org.junit.Assert.*
  */
 @RunWith(AndroidJUnit4::class)
 class SimpleCacheTest {
+
+    private val appContext = InstrumentationRegistry.getTargetContext()!!
+
     @Test
     @Throws(Exception::class)
-    fun simpleCacheTest() {
+    fun cacheWithAutoSaveTest() {
+        val cacheManager = CacheManager.createInstance(context = appContext)
+
+        cacheManager.set("String", "Hello World")
+        cacheManager.set("Int", 255)
+        cacheManager.set("Bool", false)
+        cacheManager.set("float", 5.55)
+        val testMap = HashMap<String, String>()
+        testMap["testKey"] = "TestValue"
+        cacheManager.set("map", testMap)
+        val testObject = TestObject(69, "Test String", false, 6.66f, testMap)
+        cacheManager.set("obj", testObject)
+        val testObject2 = TestObject(885, "Testing two!", true, 3.14f, testMap)
+
+        cacheManager.set("obj2", testObject2)
+
+        cacheManager.get(key = "String", success = { value, type ->
+            assertEquals("Hello World", value)
+            assert(type.isInstance(String::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "Int", checkExpired = true, success = { value, type ->
+            assertEquals(255, value)
+            assert(type.isInstance(Int::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "Bool", success = { value, type ->
+            assertEquals(false, value)
+            assert(type.isInstance(Boolean::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "float", success = { value, type ->
+            assertEquals(5.55, value)
+            assert(type.isInstance(Float::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "map", success = { value, type ->
+            assertEquals(testMap, value)
+            assert(type.isInstance(HashMap::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "obj", success = { value, type ->
+            assertEquals(testObject, value)
+            assert(type.isInstance(TestObject::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.get(key = "obj2", success = { value, type ->
+            assertEquals(testObject2, value)
+            assert(type.isInstance(TestObject::class))
+            Log.d("simpleCacheTest", value.toString())
+        })
+
+        cacheManager.remove("obj2")
 
-        val appContext = InstrumentationRegistry.getTargetContext()
+        cacheManager.get(key = "obj2", success = { _,  _ ->
 
-        val cacheManager = CacheManager.createInstance(appContext, null)
+        }, error = {
+            Log.d("simpleCacheTest", "obj2 is not exist.")
+            assert(true)
+        })
+
+        cacheManager.removeAllElements()
+    }
+
+    @Test
+    @Throws(Exception::class)
+    fun cacheWithoutAutoSaveTest() {
+        val cacheManager = CacheManager.createInstance(context = appContext, fileName = "NoAutoSave", autoSave = false)
 
         cacheManager.set("String", "Hello World")
         cacheManager.set("Int", 255)
@@ -34,12 +106,14 @@ class SimpleCacheTest {
         val testMap = HashMap<String, String>()
         testMap["testKey"] = "TestValue"
         cacheManager.set("map", testMap)
-        val testObject = TestObject(69, "abababa", false, 6.66f, testMap)
+        val testObject = TestObject(69, "Test String", false, 6.66f, testMap)
         cacheManager.set("obj", testObject)
         val testObject2 = TestObject(885, "Testing two!", true, 3.14f, testMap)
 
         cacheManager.set("obj2", testObject2)
 
+        cacheManager.save()
+
         cacheManager.get(key = "String", success = { value, type ->
             assertEquals("Hello World", value)
             assert(type.isInstance(String::class))
@@ -91,8 +165,46 @@ class SimpleCacheTest {
             assert(true)
         })
 
-        Log.d("simpleCacheTest", CacheManager.getListOfCacheFiles(appContext).toString())
+        cacheManager.removeAllElements()
+    }
+
+    @Test
+    fun cacheListFilesTest() {
+        val files = CacheManager.getListOfCacheFiles(appContext)
+        Log.d("simpleCacheTest",files.toString())
+
+        assert(files.size == 2)
+    }
+
+    @Test
+    fun globalInstancesTest() {
+        val instanceName1 = "Instance1"
+        val instanceName2 = "Instance2"
+
+        val instance1 = CacheManager.createGlobalInstance(context = appContext, instanceName = instanceName1, fileName = "instanceFile1")
+        val instance2 = CacheManager.createGlobalInstance(context = appContext, instanceName = instanceName2, fileName = "InstanceFile2")
+
+        val globalInstance1 = CacheManager.getGlobalInstance(instanceName1)
+        val globalInstance2 = CacheManager.getGlobalInstance(instanceName2)
+
+        assert(instance1 == globalInstance1)
+        assert(instance1 != globalInstance2)
+        assert(instance2 == globalInstance2)
+
+        var listOfIInstancesNames = CacheManager.getListOfGlobalInstanceNames()
+
+        assert(listOfIInstancesNames.contains(instanceName2))
+
+        CacheManager.removeGlobalInstance(instanceName1)
+
+        listOfIInstancesNames = CacheManager.getListOfGlobalInstanceNames()
+
+        assert(!listOfIInstancesNames.contains(instanceName1))
+
+        CacheManager.removeAllGlobalInstances()
+
+        listOfIInstancesNames = CacheManager.getListOfGlobalInstanceNames()
 
-        assertEquals("com.github.pcpl2.simplecache.test", appContext.packageName)
+        assert(listOfIInstancesNames.isEmpty())
     }
 }