support SharedPreferencesWithCache and SharedPreferencesAsync. (#76)

* support SharedPreferencesWithCache and SharedPreferencesAsync.

issue #75

* add test:  RxSharedPreferences.async

* add test:  RxSharedPreferences.withCache

* bump constraints

* include tests

* shared_preferences: ^2.3.0 in sample

* fix samples

* min flutter 3.22

* gradle wrapper up

* sdk 34

* fix sample

* fix android sample

* CI

* pub upgrade

* fix lint

* use allowList in SharedPreferencesAsyncAdapter

Author: hoc081098

.github/workflows/build-example.yml

@@ -23,7 +23,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '17'
 
       - uses: subosito/[email protected]
         with:
@@ -64,7 +64,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: [ '3.3.0', '3.7.0' ]
+        version: [ '3.22.0' ]
     defaults:
       run:
         working-directory: ./example
@@ -74,7 +74,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: '11'
+          java-version: '17'
 
       - uses: subosito/[email protected]
         with:

.github/workflows/tests.yml

@@ -41,14 +41,16 @@ jobs:
       - name: Run tests
         run: flutter test --coverage --coverage-path=lcov.info
 
-      - uses: codecov/[email protected]
+      - uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         if: ${{ matrix.channel == 'stable' }}
 
   test-old-versions:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: [ '3.3.0', '3.7.0' ]
+        version: [ '3.22.0' ]
     steps:
       - uses: actions/checkout@v4
 

example/android/app/build.gradle

@@ -1,3 +1,16 @@
+plugins {
+    id "com.android.application"
+    id "kotlin-android"
+    id "dev.flutter.flutter-gradle-plugin"
+}
+
+kotlin {
+    jvmToolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+        vendor = JvmVendorSpec.AZUL
+    }
+}
+
 def localProperties = new Properties()
 def localPropertiesFile = rootProject.file('local.properties')
 if (localPropertiesFile.exists()) {
@@ -6,11 +19,6 @@ if (localPropertiesFile.exists()) {
     }
 }
 
-def flutterRoot = localProperties.getProperty('flutter.sdk')
-if (flutterRoot == null) {
-    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
-}
-
 def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
 if (flutterVersionCode == null) {
     flutterVersionCode = '1'
@@ -21,12 +29,9 @@ if (flutterVersionName == null) {
     flutterVersionName = '1.0'
 }
 
-apply plugin: 'com.android.application'
-apply plugin: 'kotlin-android'
-apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
-
 android {
-    compileSdkVersion 31
+    compileSdkVersion 34
+    namespace 'com.hoc.example'
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -35,8 +40,8 @@ android {
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.hoc.example"
-        minSdkVersion 16
-        targetSdkVersion 30
+        minSdkVersion 24
+        targetSdkVersion 34
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }
@@ -48,12 +53,17 @@ android {
             signingConfig signingConfigs.debug
         }
     }
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
 }
 
 flutter {
     source '../..'
 }
 
-dependencies {
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-}
+dependencies {}

example/android/app/src/main/AndroidManifest.xml

@@ -1,9 +1,9 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.hoc.example">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <application
         android:label="example"
         android:icon="@mipmap/ic_launcher">
         <activity
+            android:exported="true"
             android:name=".MainActivity"
             android:launchMode="singleTop"
             android:theme="@style/LaunchTheme"

example/android/build.gradle

@@ -1,16 +1,3 @@
-buildscript {
-    ext.kotlin_version = '1.6.10'
-    repositories {
-        google()
-        jcenter()
-    }
-
-    dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.0'
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-    }
-}
-
 allprojects {
     repositories {
         google()
@@ -26,6 +13,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip

example/android/settings.gradle

@@ -1,11 +1,25 @@
-include ':app'
+pluginManagement {
+    def flutterSdkPath = {
+        def properties = new Properties()
+        file("local.properties").withInputStream { properties.load(it) }
+        def flutterSdkPath = properties.getProperty("flutter.sdk")
+        assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
+        return flutterSdkPath
+    }()
 
-def localPropertiesFile = new File(rootProject.projectDir, "local.properties")
-def properties = new Properties()
+    includeBuild("$flutterSdkPath/packages/flutter_tools/gradle")
 
-assert localPropertiesFile.exists()
-localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) }
+    repositories {
+        google()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
 
-def flutterSdkPath = properties.getProperty("flutter.sdk")
-assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
-apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle"
+plugins {
+    id "dev.flutter.flutter-plugin-loader" version "1.0.0"
+    id "com.android.application" version "8.5.2" apply false
+    id "org.jetbrains.kotlin.android" version "2.0.0" apply false
+}
+
+include ":app"

example/lib/dialog.dart

@@ -36,7 +36,7 @@ extension DialogExtensions on BuildContext {
     }
 
     try {
-      await rxPrefs.updateStringList(key, (currentList) {
+      await rxPrefs.updateStringList(listKey, (currentList) {
         final list = currentList ?? const <String>[];
         if (list.contains(string)) {
           throw StateError('Duplicated $string!');
@@ -78,7 +78,7 @@ extension DialogExtensions on BuildContext {
 
     try {
       await rxPrefs.updateStringList(
-        key,
+        listKey,
         (currentList) => [
           for (final s in (currentList ?? const <String>[]))
             if (s != needRemove) s

example/lib/home.dart

@@ -7,13 +7,13 @@ import 'package:flutter_provider/flutter_provider.dart';
 import 'package:rx_shared_preferences/rx_shared_preferences.dart';
 import 'package:rxdart_ext/rxdart_ext.dart';
 
-const key = 'com.hoc.list';
+const listKey = 'com.hoc.list';
 
 class MyHomePage extends StatefulWidget {
-  const MyHomePage({Key? key}) : super(key: key);
+  const MyHomePage({super.key});
 
   @override
-  _MyHomePageState createState() => _MyHomePageState();
+  State<MyHomePage> createState() => _MyHomePageState();
 }
 
 class _MyHomePageState extends State<MyHomePage> {
@@ -23,7 +23,7 @@ class _MyHomePageState extends State<MyHomePage> {
   late final StateStream<ViewState> list$ = controller.stream
       .startWith(null)
       .switchMap((_) => context.rxPrefs
-          .getStringListStream(key)
+          .getStringListStream(listKey)
           .map((list) => ViewState.success(list ?? const []))
           .onErrorReturnWith((e, s) => ViewState.failure(e, s)))
       .debug(identifier: '<<STATE>>', log: debugPrint)
@@ -146,6 +146,7 @@ extension BuildContextX on BuildContext {
   }
 }
 
+@immutable
 class ViewState {
   final List<String> items;
   final bool isLoading;
@@ -155,7 +156,7 @@ class ViewState {
 
   const ViewState._(this.items, this.isLoading, this.error);
 
-  ViewState.success(List<String> items) : this._(items, false, null);
+  const ViewState.success(List<String> items) : this._(items, false, null);
 
   ViewState.failure(Object e, StackTrace s)
       : this._([], false, AsyncError(e, s));

example/lib/main.dart

@@ -8,8 +8,8 @@ void main() {
   WidgetsFlutterBinding.ensureInitialized();
 
   /// Singleton instance for app
-  final rxPrefs = RxSharedPreferences(
-    SharedPreferences.getInstance(),
+  final rxPrefs = RxSharedPreferences.async(
+    SharedPreferencesAsync(),
     kReleaseMode ? null : const RxSharedPreferencesDefaultLogger(),
   );
 
@@ -22,7 +22,7 @@ void main() {
 }
 
 class MyApp extends StatelessWidget {
-  const MyApp({Key? key}) : super(key: key);
+  const MyApp({super.key});
 
   @override
   Widget build(BuildContext context) {