shared_preferences: update for official packages/shared_preferences 2.2.0 (#69)

Signed-off-by: Hidenori Matsubayashi <Hidenori.Matsubayashi@gmail.com>

README.md

@@ -18,7 +18,7 @@ The plugins for elinux are basically designed to be API compatible with the offi
 | [video_player_elinux](packages/video_player) | [video_player](https://github.com/flutter/plugins/tree/master/packages/video_player) |
 | [camera_elinux](packages/camera) | [camera](https://github.com/flutter/plugins/tree/master/packages/camera) |
 | [path_provider_elinux](packages/path_provider) | [path_provider](https://github.com/flutter/packages/tree/main/packages/path_provider) |
-| [shared_preferences_elinux](packages/shared_preferences) | [shared_preferences](https://github.com/flutter/plugins/tree/master/packages/shared_preferences) |
+| [shared_preferences_elinux](packages/shared_preferences) | [shared_preferences](https://github.com/flutter/packages/tree/main/packages/shared_preferences) |
 | [joystick](packages/joystick) | - |
 
 ## Getting Started

packages/shared_preferences/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.2.0
+* Update for shared_preferences 2.2.0
+
 ## 1.0.1
 * Update for flutter 3.3.0 release
 

packages/shared_preferences/README.md

@@ -1,6 +1,6 @@
 # shared\_preferences\_elinux
 
-The eLinux implementation of [`shared_preferences`](https://github.com/flutter/plugins/tree/master/packages/shared_preferences).
+The eLinux implementation of [`shared_preferences`](https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences).
 
 ## Usage
 

packages/shared_preferences/example/elinux/flutter/main.dart

@@ -1,12 +0,0 @@
-//
-// Generated file. Do not edit.
-//
-// @dart=2.12
-
-import 'package:shared_preferences_elinux_example/main.dart' as entrypoint;
-import 'generated_plugin_registrant.dart';
-
-Future<void> main() async {
-  registerPlugins();
-  entrypoint.main();
-}

packages/shared_preferences/example/integration_test/shared_preferences_test.dart

@@ -7,94 +7,336 @@ import 'dart:async';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
 import 'package:shared_preferences_elinux/shared_preferences_elinux.dart';
+import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
+import 'package:shared_preferences_platform_interface/types.dart';
 
 void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
   group('SharedPreferencesELinux', () {
-    const Map<String, dynamic> kTestValues = <String, dynamic>{
-      'flutter.String': 'hello world',
-      'flutter.bool': true,
-      'flutter.int': 42,
-      'flutter.double': 3.14159,
-      'flutter.List': <String>['foo', 'bar'],
-    };
-
-    const Map<String, dynamic> kTestValues2 = <String, dynamic>{
-      'flutter.String': 'goodbye world',
-      'flutter.bool': false,
-      'flutter.int': 1337,
-      'flutter.double': 2.71828,
-      'flutter.List': <String>['baz', 'quox'],
-    };
-
     late SharedPreferencesELinux preferences;
 
+    const Map<String, Object> flutterTestValues = <String, Object>{
+      'flutter.String': 'hello world',
+      'flutter.Bool': true,
+      'flutter.Int': 42,
+      'flutter.Double': 3.14159,
+      'flutter.StringList': <String>['foo', 'bar'],
+    };
+
+    const Map<String, Object> prefixTestValues = <String, Object>{
+      'prefix.String': 'hello world',
+      'prefix.Bool': true,
+      'prefix.Int': 42,
+      'prefix.Double': 3.14159,
+      'prefix.StringList': <String>['foo', 'bar'],
+    };
+
+    const Map<String, Object> nonPrefixTestValues = <String, Object>{
+      'String': 'hello world',
+      'Bool': true,
+      'Int': 42,
+      'Double': 3.14159,
+      'StringList': <String>['foo', 'bar'],
+    };
+
+    final Map<String, Object> allTestValues = <String, Object>{};
+
+    allTestValues.addAll(flutterTestValues);
+    allTestValues.addAll(prefixTestValues);
+    allTestValues.addAll(nonPrefixTestValues);
+
+    Future<void> addData() async {
+      await preferences.setValue('String', 'String', allTestValues['String']!);
+      await preferences.setValue('Bool', 'Bool', allTestValues['Bool']!);
+      await preferences.setValue('Int', 'Int', allTestValues['Int']!);
+      await preferences.setValue('Double', 'Double', allTestValues['Double']!);
+      await preferences.setValue(
+          'StringList', 'StringList', allTestValues['StringList']!);
+      await preferences.setValue(
+          'String', 'prefix.String', allTestValues['prefix.String']!);
+      await preferences.setValue(
+          'Bool', 'prefix.Bool', allTestValues['prefix.Bool']!);
+      await preferences.setValue(
+          'Int', 'prefix.Int', allTestValues['prefix.Int']!);
+      await preferences.setValue(
+          'Double', 'prefix.Double', allTestValues['prefix.Double']!);
+      await preferences.setValue('StringList', 'prefix.StringList',
+          allTestValues['prefix.StringList']!);
+      await preferences.setValue(
+          'String', 'flutter.String', allTestValues['flutter.String']!);
+      await preferences.setValue(
+          'Bool', 'flutter.Bool', allTestValues['flutter.Bool']!);
+      await preferences.setValue(
+          'Int', 'flutter.Int', allTestValues['flutter.Int']!);
+      await preferences.setValue(
+          'Double', 'flutter.Double', allTestValues['flutter.Double']!);
+      await preferences.setValue('StringList', 'flutter.StringList',
+          allTestValues['flutter.StringList']!);
+    }
+
     setUp(() async {
-      preferences = SharedPreferencesELinux.instance;
+      preferences = SharedPreferencesELinux();
+      await addData();
     });
 
-    tearDown(() {
-      preferences.clear();
+    tearDown(() async {
+      await preferences.clearWithParameters(
+        ClearParameters(
+          filter: PreferencesFilter(prefix: ''),
+        ),
+      );
     });
 
-    testWidgets('reading', (WidgetTester _) async {
-      final all = await preferences.getAll();
-      expect(all['String'], isNull);
-      expect(all['bool'], isNull);
-      expect(all['int'], isNull);
-      expect(all['double'], isNull);
-      expect(all['List'], isNull);
+    testWidgets('getAll', (WidgetTester _) async {
+      final Map<String, Object> values = await preferences.getAll();
+      expect(values['flutter.String'], allTestValues['flutter.String']);
+      expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+      expect(values['flutter.Int'], allTestValues['flutter.Int']);
+      expect(values['flutter.Double'], allTestValues['flutter.Double']);
+      expect(values['flutter.StringList'], allTestValues['flutter.StringList']);
     });
 
-    testWidgets('writing', (WidgetTester _) async {
-      await Future.wait(<Future<bool>>[
-        preferences.setValue(
-            'String', 'String', kTestValues2['flutter.String']),
-        preferences.setValue('Bool', 'bool', kTestValues2['flutter.bool']),
-        preferences.setValue('Int', 'int', kTestValues2['flutter.int']),
-        preferences.setValue(
-            'Double', 'double', kTestValues2['flutter.double']),
-        preferences.setValue('StringList', 'List', kTestValues2['flutter.List'])
-      ]);
-      final all = await preferences.getAll();
-      expect(all['String'], kTestValues2['flutter.String']);
-      expect(all['bool'], kTestValues2['flutter.bool']);
-      expect(all['int'], kTestValues2['flutter.int']);
-      expect(all['double'], kTestValues2['flutter.double']);
-      expect(all['List'], kTestValues2['flutter.List']);
+    group('withPrefix', () {
+      testWidgets('remove', (WidgetTester _) async {
+        const String key = 'flutter.String';
+        await preferences.remove(key);
+        final Map<String, Object> values =
+            await preferences.getAllWithPrefix('');
+        expect(values[key], isNull);
+      });
+
+      testWidgets('clear', (WidgetTester _) async {
+        await preferences.clear();
+        final Map<String, Object> values = await preferences.getAll();
+        expect(values['flutter.String'], null);
+        expect(values['flutter.Bool'], null);
+        expect(values['flutter.Int'], null);
+        expect(values['flutter.Double'], null);
+        expect(values['flutter.StringList'], null);
+      });
+
+      testWidgets('get all with prefix', (WidgetTester _) async {
+        final Map<String, Object> values =
+            await preferences.getAllWithPrefix('prefix.');
+        expect(values['prefix.String'], allTestValues['prefix.String']);
+        expect(values['prefix.Bool'], allTestValues['prefix.Bool']);
+        expect(values['prefix.Int'], allTestValues['prefix.Int']);
+        expect(values['prefix.Double'], allTestValues['prefix.Double']);
+        expect(values['prefix.StringList'], allTestValues['prefix.StringList']);
+      });
+
+      testWidgets('getAllWithNoPrefix', (WidgetTester _) async {
+        final Map<String, Object> values =
+            await preferences.getAllWithPrefix('');
+        expect(values['String'], allTestValues['String']);
+        expect(values['Bool'], allTestValues['Bool']);
+        expect(values['Int'], allTestValues['Int']);
+        expect(values['Double'], allTestValues['Double']);
+        expect(values['StringList'], allTestValues['StringList']);
+        expect(values['flutter.String'], allTestValues['flutter.String']);
+        expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+        expect(values['flutter.Int'], allTestValues['flutter.Int']);
+        expect(values['flutter.Double'], allTestValues['flutter.Double']);
+        expect(
+            values['flutter.StringList'], allTestValues['flutter.StringList']);
+      });
+
+      testWidgets('clearWithPrefix', (WidgetTester _) async {
+        await preferences.clearWithPrefix('prefix.');
+        Map<String, Object> values =
+            await preferences.getAllWithPrefix('prefix.');
+        expect(values['prefix.String'], null);
+        expect(values['prefix.Bool'], null);
+        expect(values['prefix.Int'], null);
+        expect(values['prefix.Double'], null);
+        expect(values['prefix.StringList'], null);
+        values = await preferences.getAllWithPrefix('flutter.');
+        expect(values['flutter.String'], allTestValues['flutter.String']);
+        expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+        expect(values['flutter.Int'], allTestValues['flutter.Int']);
+        expect(values['flutter.Double'], allTestValues['flutter.Double']);
+        expect(
+            values['flutter.StringList'], allTestValues['flutter.StringList']);
+      });
+
+      testWidgets('clearWithNoPrefix', (WidgetTester _) async {
+        await preferences.clearWithPrefix('');
+        final Map<String, Object> values =
+            await preferences.getAllWithPrefix('');
+        expect(values['String'], null);
+        expect(values['Bool'], null);
+        expect(values['Int'], null);
+        expect(values['Double'], null);
+        expect(values['StringList'], null);
+        expect(values['flutter.String'], null);
+        expect(values['flutter.Bool'], null);
+        expect(values['flutter.Int'], null);
+        expect(values['flutter.Double'], null);
+        expect(values['flutter.StringList'], null);
+      });
     });
 
-    testWidgets('removing', (WidgetTester _) async {
-      const String key = 'testKey';
+    group('withParameters', () {
+      testWidgets('remove', (WidgetTester _) async {
+        const String key = 'flutter.String';
+        await preferences.remove(key);
+        final Map<String, Object> values =
+            await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: ''),
+          ),
+        );
+        expect(values[key], isNull);
+      });
 
-      await Future.wait([
-        preferences.setValue('String', key, kTestValues['flutter.String']),
-        preferences.setValue('Bool', key, kTestValues['flutter.bool']),
-        preferences.setValue('Int', key, kTestValues['flutter.int']),
-        preferences.setValue('Double', key, kTestValues['flutter.double']),
-        preferences.setValue('StringList', key, kTestValues['flutter.List'])
-      ]);
-      await preferences.remove(key);
-      final all = await preferences.getAll();
-      expect(all['testKey'], isNull);
-    });
+      testWidgets('clear', (WidgetTester _) async {
+        await preferences.clear();
+        final Map<String, Object> values = await preferences.getAll();
+        expect(values['flutter.String'], null);
+        expect(values['flutter.Bool'], null);
+        expect(values['flutter.Int'], null);
+        expect(values['flutter.Double'], null);
+        expect(values['flutter.StringList'], null);
+      });
 
-    testWidgets('clearing', (WidgetTester _) async {
-      await Future.wait(<Future<bool>>[
-        preferences.setValue('String', 'String', kTestValues['flutter.String']),
-        preferences.setValue('Bool', 'bool', kTestValues['flutter.bool']),
-        preferences.setValue('Int', 'int', kTestValues['flutter.int']),
-        preferences.setValue('Double', 'double', kTestValues['flutter.double']),
-        preferences.setValue('StringList', 'List', kTestValues['flutter.List'])
-      ]);
-      await preferences.clear();
-      final all = await preferences.getAll();
-      expect(all['String'], null);
-      expect(all['bool'], null);
-      expect(all['int'], null);
-      expect(all['double'], null);
-      expect(all['List'], null);
+      testWidgets('get all with prefix', (WidgetTester _) async {
+        final Map<String, Object> values =
+            await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: 'prefix.'),
+          ),
+        );
+        expect(values['prefix.String'], allTestValues['prefix.String']);
+        expect(values['prefix.Bool'], allTestValues['prefix.Bool']);
+        expect(values['prefix.Int'], allTestValues['prefix.Int']);
+        expect(values['prefix.Double'], allTestValues['prefix.Double']);
+        expect(values['prefix.StringList'], allTestValues['prefix.StringList']);
+      });
+
+      testWidgets('get all with allow list', (WidgetTester _) async {
+        final Map<String, Object> values =
+            await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(
+              prefix: 'prefix.',
+              allowList: <String>{'prefix.String'},
+            ),
+          ),
+        );
+        expect(values['prefix.String'], allTestValues['prefix.String']);
+        expect(values['prefix.Bool'], null);
+        expect(values['prefix.Int'], null);
+        expect(values['prefix.Double'], null);
+        expect(values['prefix.StringList'], null);
+      });
+
+      testWidgets('getAllWithNoPrefix', (WidgetTester _) async {
+        final Map<String, Object> values =
+            await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: ''),
+          ),
+        );
+        expect(values['String'], allTestValues['String']);
+        expect(values['Bool'], allTestValues['Bool']);
+        expect(values['Int'], allTestValues['Int']);
+        expect(values['Double'], allTestValues['Double']);
+        expect(values['StringList'], allTestValues['StringList']);
+        expect(values['flutter.String'], allTestValues['flutter.String']);
+        expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+        expect(values['flutter.Int'], allTestValues['flutter.Int']);
+        expect(values['flutter.Double'], allTestValues['flutter.Double']);
+        expect(
+            values['flutter.StringList'], allTestValues['flutter.StringList']);
+      });
+
+      testWidgets('clearWithParameters', (WidgetTester _) async {
+        await preferences.clearWithParameters(
+          ClearParameters(
+            filter: PreferencesFilter(prefix: 'prefix.'),
+          ),
+        );
+        Map<String, Object> values = await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: 'prefix.'),
+          ),
+        );
+        expect(values['prefix.String'], null);
+        expect(values['prefix.Bool'], null);
+        expect(values['prefix.Int'], null);
+        expect(values['prefix.Double'], null);
+        expect(values['prefix.StringList'], null);
+        values = await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: 'flutter.'),
+          ),
+        );
+        expect(values['flutter.String'], allTestValues['flutter.String']);
+        expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+        expect(values['flutter.Int'], allTestValues['flutter.Int']);
+        expect(values['flutter.Double'], allTestValues['flutter.Double']);
+        expect(
+            values['flutter.StringList'], allTestValues['flutter.StringList']);
+      });
+
+      testWidgets('clearWithParameters with allow list',
+          (WidgetTester _) async {
+        await addData();
+        await preferences.clearWithParameters(
+          ClearParameters(
+            filter: PreferencesFilter(
+              prefix: 'prefix.',
+              allowList: <String>{'prefix.StringList'},
+            ),
+          ),
+        );
+        Map<String, Object> values = await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: 'prefix.'),
+          ),
+        );
+        expect(values['prefix.String'], allTestValues['prefix.String']);
+        expect(values['prefix.Bool'], allTestValues['prefix.Bool']);
+        expect(values['prefix.Int'], allTestValues['prefix.Int']);
+        expect(values['prefix.Double'], allTestValues['prefix.Double']);
+        expect(values['prefix.StringList'], null);
+        values = await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: 'flutter.'),
+          ),
+        );
+        expect(values['flutter.String'], allTestValues['flutter.String']);
+        expect(values['flutter.Bool'], allTestValues['flutter.Bool']);
+        expect(values['flutter.Int'], allTestValues['flutter.Int']);
+        expect(values['flutter.Double'], allTestValues['flutter.Double']);
+        expect(
+            values['flutter.StringList'], allTestValues['flutter.StringList']);
+      });
+
+      testWidgets('clearWithNoPrefix', (WidgetTester _) async {
+        await preferences.clearWithParameters(
+          ClearParameters(
+            filter: PreferencesFilter(prefix: ''),
+          ),
+        );
+        final Map<String, Object> values =
+            await preferences.getAllWithParameters(
+          GetAllParameters(
+            filter: PreferencesFilter(prefix: ''),
+          ),
+        );
+        expect(values['String'], null);
+        expect(values['Bool'], null);
+        expect(values['Int'], null);
+        expect(values['Double'], null);
+        expect(values['StringList'], null);
+        expect(values['flutter.String'], null);
+        expect(values['flutter.Bool'], null);
+        expect(values['flutter.Int'], null);
+        expect(values['flutter.Double'], null);
+        expect(values['flutter.StringList'], null);
+      });
     });
   });
 }

packages/shared_preferences/example/lib/main.dart

@@ -1,4 +1,4 @@
-// Copyright 2021 Sony Group Corporation. All rights reserved.
+// Copyright 2023 Sony Group Corporation. All rights reserved.
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
@@ -11,13 +11,15 @@ import 'package:flutter/material.dart';
 import 'package:shared_preferences_elinux/shared_preferences_elinux.dart';
 
 void main() {
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
   @override
   Widget build(BuildContext context) {
-    return MaterialApp(
+    return const MaterialApp(
       title: 'SharedPreferences Demo',
       home: SharedPreferencesDemo(),
     );
@@ -25,18 +27,18 @@ class MyApp extends StatelessWidget {
 }
 
 class SharedPreferencesDemo extends StatefulWidget {
-  SharedPreferencesDemo({Key? key}) : super(key: key);
+  const SharedPreferencesDemo({super.key});
 
   @override
   SharedPreferencesDemoState createState() => SharedPreferencesDemoState();
 }
 
 class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
-  final prefs = SharedPreferencesELinux.instance;
+  final SharedPreferencesELinux prefs = SharedPreferencesELinux();
   late Future<int> _counter;
 
   Future<void> _incrementCounter() async {
-    final values = await prefs.getAll();
+    final Map<String, Object> values = await prefs.getAll();
     final int counter = (values['counter'] as int? ?? 0) + 1;
 
     setState(() {
@@ -50,7 +52,7 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
   void initState() {
     super.initState();
     _counter = prefs.getAll().then((Map<String, Object> values) {
-      return (values['counter'] as int? ?? 0);
+      return values['counter'] as int? ?? 0;
     });
   }
 
@@ -58,16 +60,18 @@ class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
   Widget build(BuildContext context) {
     return Scaffold(
       appBar: AppBar(
-        title: const Text("SharedPreferences Demo"),
+        title: const Text('SharedPreferences Demo'),
       ),
       body: Center(
           child: FutureBuilder<int>(
               future: _counter,
               builder: (BuildContext context, AsyncSnapshot<int> snapshot) {
                 switch (snapshot.connectionState) {
+                  case ConnectionState.none:
                   case ConnectionState.waiting:
                     return const CircularProgressIndicator();
-                  default:
+                  case ConnectionState.active:
+                  case ConnectionState.done:
                     if (snapshot.hasError) {
                       return Text('Error: ${snapshot.error}');
                     } else {

packages/shared_preferences/example/pubspec.yaml

@@ -3,17 +3,18 @@ description: Demonstrates how to use the shared_preferences_elinux plugin.
 publish_to: none
 
 environment:
-  sdk: ">=2.12.0 <3.0.0"
-  flutter: ">=2.10.0"
+  sdk: ">=2.18.0 <4.0.0"
+  flutter: ">=3.3.0"
 
 dependencies:
   flutter:
     sdk: flutter
   shared_preferences_elinux:
     path: ../
+  shared_preferences_platform_interface: ^2.3.0
 
 dev_dependencies:
-  flutter_driver:
+  flutter_test:
     sdk: flutter
   integration_test:
     sdk: flutter

packages/shared_preferences/lib/shared_preferences_elinux.dart

@@ -1,4 +1,4 @@
-// Copyright 2021 Sony Group Corporation. All rights reserved.
+// Copyright 2023 Sony Group Corporation. All rights reserved.
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
@@ -8,21 +8,26 @@ import 'dart:convert' show json;
 
 import 'package:file/file.dart';
 import 'package:file/local.dart';
-import 'package:meta/meta.dart';
+import 'package:flutter/foundation.dart' show debugPrint, visibleForTesting;
 import 'package:path/path.dart' as path;
 import 'package:path_provider_elinux/path_provider_elinux.dart';
 import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
+import 'package:shared_preferences_platform_interface/types.dart';
 
 /// The Linux implementation of [SharedPreferencesStorePlatform].
 ///
 /// This class implements the `package:shared_preferences` functionality for Linux.
 class SharedPreferencesELinux extends SharedPreferencesStorePlatform {
-  /// The default instance of [SharedPreferencesELinux] to use.
+  /// Deprecated instance of [SharedPreferencesELinux].
+  /// Use [SharedPreferencesStorePlatform.instance] instead.
+  @Deprecated('Use `SharedPreferencesStorePlatform.instance` instead.')
   static SharedPreferencesELinux instance = SharedPreferencesELinux();
 
-  /// Registers the eLinux implementation.
+  static const String _defaultPrefix = 'flutter.';
+
+  /// Registers the ELinux implementation.
   static void registerWith() {
-    SharedPreferencesStorePlatform.instance = instance;
+    SharedPreferencesStorePlatform.instance = SharedPreferencesELinux();
   }
 
   /// Local copy of preferences
@@ -30,51 +35,60 @@ class SharedPreferencesELinux extends SharedPreferencesStorePlatform {
 
   /// File system used to store to disk. Exposed for testing only.
   @visibleForTesting
-  FileSystem fs = LocalFileSystem();
+  FileSystem fs = const LocalFileSystem();
+
+  /// The path_provider_elinux instance used to find the support directory.
+  @visibleForTesting
+  PathProviderELinux pathProvider = PathProviderELinux();
 
   /// Gets the file where the preferences are stored.
   Future<File?> _getLocalDataFile() async {
-    final pathProvider = PathProviderELinux();
-    final directory = await pathProvider.getApplicationSupportPath();
-    if (directory == null) return null;
+    final String? directory = await pathProvider.getApplicationSupportPath();
+    if (directory == null) {
+      return null;
+    }
     return fs.file(path.join(directory, 'shared_preferences.json'));
   }
 
-  /// Gets the preferences from the stored file. Once read, the preferences are
-  /// maintained in memory.
-  Future<Map<String, Object>> _readPreferences() async {
-    if (_cachedPreferences != null) {
-      return _cachedPreferences!;
-    }
-
-    Map<String, Object> preferences = {};
+  /// Gets the preferences from the stored file and saves them in cache.
+  Future<Map<String, Object>> _reload() async {
+    Map<String, Object> preferences = <String, Object>{};
     final File? localDataFile = await _getLocalDataFile();
     if (localDataFile != null && localDataFile.existsSync()) {
-      String stringMap = localDataFile.readAsStringSync();
+      final String stringMap = localDataFile.readAsStringSync();
       if (stringMap.isNotEmpty) {
-        preferences = json.decode(stringMap).cast<String, Object>();
+        final Object? data = json.decode(stringMap);
+        if (data is Map) {
+          preferences = data.cast<String, Object>();
+        }
       }
     }
     _cachedPreferences = preferences;
     return preferences;
   }
 
+  /// Checks for cached preferences and returns them or loads preferences from
+  /// file and returns and caches them.
+  Future<Map<String, Object>> _readPreferences() async {
+    return _cachedPreferences ?? await _reload();
+  }
+
   /// Writes the cached preferences to disk. Returns [true] if the operation
   /// succeeded.
   Future<bool> _writePreferences(Map<String, Object> preferences) async {
     try {
-      var localDataFile = await _getLocalDataFile();
+      final File? localDataFile = await _getLocalDataFile();
       if (localDataFile == null) {
-        print("Unable to determine where to write preferences.");
+        debugPrint('Unable to determine where to write preferences.');
         return false;
       }
       if (!localDataFile.existsSync()) {
         localDataFile.createSync(recursive: true);
       }
-      var stringMap = json.encode(preferences);
+      final String stringMap = json.encode(preferences);
       localDataFile.writeAsStringSync(stringMap);
     } catch (e) {
-      print("Error saving preferences to disk: $e");
+      debugPrint('Error saving preferences to disk: $e');
       return false;
     }
     return true;
@@ -82,26 +96,65 @@ class SharedPreferencesELinux extends SharedPreferencesStorePlatform {
 
   @override
   Future<bool> clear() async {
-    var preferences = await _readPreferences();
-    preferences.clear();
+    return clearWithParameters(
+      ClearParameters(
+        filter: PreferencesFilter(prefix: _defaultPrefix),
+      ),
+    );
+  }
+
+  @override
+  Future<bool> clearWithPrefix(String prefix) async {
+    return clearWithParameters(
+        ClearParameters(filter: PreferencesFilter(prefix: prefix)));
+  }
+
+  @override
+  Future<bool> clearWithParameters(ClearParameters parameters) async {
+    final PreferencesFilter filter = parameters.filter;
+    final Map<String, Object> preferences = await _readPreferences();
+    preferences.removeWhere((String key, _) =>
+        key.startsWith(filter.prefix) &&
+        (filter.allowList == null || filter.allowList!.contains(key)));
     return _writePreferences(preferences);
   }
 
   @override
   Future<Map<String, Object>> getAll() async {
-    return _readPreferences();
+    return getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: _defaultPrefix),
+      ),
+    );
+  }
+
+  @override
+  Future<Map<String, Object>> getAllWithPrefix(String prefix) async {
+    return getAllWithParameters(
+        GetAllParameters(filter: PreferencesFilter(prefix: prefix)));
+  }
+
+  @override
+  Future<Map<String, Object>> getAllWithParameters(
+      GetAllParameters parameters) async {
+    final PreferencesFilter filter = parameters.filter;
+    final Map<String, Object> withPrefix =
+        Map<String, Object>.from(await _readPreferences());
+    withPrefix.removeWhere((String key, _) => !(key.startsWith(filter.prefix) &&
+        (filter.allowList?.contains(key) ?? true)));
+    return withPrefix;
   }
 
   @override
   Future<bool> remove(String key) async {
-    var preferences = await _readPreferences();
+    final Map<String, Object> preferences = await _readPreferences();
     preferences.remove(key);
     return _writePreferences(preferences);
   }
 
   @override
   Future<bool> setValue(String valueType, String key, Object value) async {
-    var preferences = await _readPreferences();
+    final Map<String, Object> preferences = await _readPreferences();
     preferences[key] = value;
     return _writePreferences(preferences);
   }

packages/shared_preferences/pubspec.yaml

@@ -2,11 +2,11 @@ name: shared_preferences_elinux
 description: eLinux implementation of the shared_preferences plugin
 homepage: https://github.com/sony/flutter-elinux-plugins
 repository: https://github.com/sony/flutter-elinux-plugins/tree/main/packages/shared_preferences
-version: 1.0.1
+version: 2.2.0
 
 environment:
-  sdk: ">=2.12.0 <3.0.0"
-  flutter: ">=2.10.0"
+  sdk: ">=2.18.0 <4.0.0"
+  flutter: ">=3.3.0"
 
 flutter:
   plugin:
@@ -26,7 +26,7 @@ dependencies:
       url: https://github.com/sony/flutter-elinux-plugins.git
       path: packages/path_provider
       ref: main
-  shared_preferences_platform_interface: ^2.0.0
+  shared_preferences_platform_interface: ^2.3.0
 
 dev_dependencies:
   flutter_test:

packages/shared_preferences/test/shared_preferences_elinux_test.dart

@@ -1,84 +1,280 @@
-// Copyright 2021 Sony Group Corporation. All rights reserved.
+// Copyright 2023 Sony Group Corporation. All rights reserved.
 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
+import 'dart:convert';
+
 import 'package:file/memory.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:path/path.dart' as path;
 import 'package:path_provider_elinux/path_provider_elinux.dart';
+import 'package:path_provider_platform_interface/path_provider_platform_interface.dart';
 import 'package:shared_preferences_elinux/shared_preferences_elinux.dart';
 import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
+import 'package:shared_preferences_platform_interface/types.dart';
 
 void main() {
   late MemoryFileSystem fs;
+  late PathProviderELinux pathProvider;
 
   SharedPreferencesELinux.registerWith();
 
+  const Map<String, Object> flutterTestValues = <String, Object>{
+    'flutter.String': 'hello world',
+    'flutter.Bool': true,
+    'flutter.Int': 42,
+    'flutter.Double': 3.14159,
+    'flutter.StringList': <String>['foo', 'bar'],
+  };
+
+  const Map<String, Object> prefixTestValues = <String, Object>{
+    'prefix.String': 'hello world',
+    'prefix.Bool': true,
+    'prefix.Int': 42,
+    'prefix.Double': 3.14159,
+    'prefix.StringList': <String>['foo', 'bar'],
+  };
+
+  const Map<String, Object> nonPrefixTestValues = <String, Object>{
+    'String': 'hello world',
+    'Bool': true,
+    'Int': 42,
+    'Double': 3.14159,
+    'StringList': <String>['foo', 'bar'],
+  };
+
+  final Map<String, Object> allTestValues = <String, Object>{};
+
+  allTestValues.addAll(flutterTestValues);
+  allTestValues.addAll(prefixTestValues);
+  allTestValues.addAll(nonPrefixTestValues);
+
   setUp(() {
     fs = MemoryFileSystem.test();
+    pathProvider = FakePathProviderELinux();
   });
 
-  Future<String> _getFilePath() async {
-    final pathProvider = PathProviderLinux();
-    final directory = await pathProvider.getApplicationSupportPath();
+  Future<String> getFilePath() async {
+    final String? directory = await pathProvider.getApplicationSupportPath();
     return path.join(directory!, 'shared_preferences.json');
   }
 
-  _writeTestFile(String value) async {
-    fs.file(await _getFilePath())
+  Future<void> writeTestFile(String value) async {
+    fs.file(await getFilePath())
       ..createSync(recursive: true)
       ..writeAsStringSync(value);
   }
 
-  Future<String> _readTestFile() async {
-    return fs.file(await _getFilePath()).readAsStringSync();
+  Future<String> readTestFile() async {
+    return fs.file(await getFilePath()).readAsStringSync();
   }
 
-  SharedPreferencesLinux _getPreferences() {
-    var prefs = SharedPreferencesLinux();
+  SharedPreferencesELinux getPreferences() {
+    final SharedPreferencesELinux prefs = SharedPreferencesELinux();
     prefs.fs = fs;
+    prefs.pathProvider = pathProvider;
     return prefs;
   }
 
   test('registered instance', () {
+    SharedPreferencesELinux.registerWith();
     expect(
-        SharedPreferencesStorePlatform.instance, isA<SharedPreferencesLinux>());
+        SharedPreferencesStorePlatform.instance, isA<SharedPreferencesELinux>());
   });
 
   test('getAll', () async {
-    await _writeTestFile('{"key1": "one", "key2": 2}');
-    var prefs = _getPreferences();
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
 
-    var values = await prefs.getAll();
-    expect(values, hasLength(2));
-    expect(values['key1'], 'one');
-    expect(values['key2'], 2);
+    final Map<String, Object> values = await prefs.getAll();
+    expect(values, hasLength(5));
+    expect(values, flutterTestValues);
+  });
+
+  test('getAllWithPrefix', () async {
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+
+    final Map<String, Object> values = await prefs.getAllWithPrefix('prefix.');
+    expect(values, hasLength(5));
+    expect(values, prefixTestValues);
+  });
+
+  test('getAllWithParameters', () async {
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+
+    final Map<String, Object> values = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: 'prefix.'),
+      ),
+    );
+    expect(values, hasLength(5));
+    expect(values, prefixTestValues);
+  });
+
+  test('getAllWithParameters with allow list', () async {
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+
+    final Map<String?, Object?> all = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(
+          prefix: 'prefix.',
+          allowList: <String>{'prefix.Bool'},
+        ),
+      ),
+    );
+    expect(all.length, 1);
+    expect(all['prefix.Bool'], prefixTestValues['prefix.Bool']);
   });
 
   test('remove', () async {
-    await _writeTestFile('{"key1":"one","key2":2}');
-    var prefs = _getPreferences();
+    await writeTestFile('{"key1":"one","key2":2}');
+    final SharedPreferencesELinux prefs = getPreferences();
 
     await prefs.remove('key2');
 
-    expect(await _readTestFile(), '{"key1":"one"}');
+    expect(await readTestFile(), '{"key1":"one"}');
   });
 
   test('setValue', () async {
-    await _writeTestFile('{}');
-    var prefs = _getPreferences();
+    await writeTestFile('{}');
+    final SharedPreferencesELinux prefs = getPreferences();
 
     await prefs.setValue('', 'key1', 'one');
     await prefs.setValue('', 'key2', 2);
 
-    expect(await _readTestFile(), '{"key1":"one","key2":2}');
+    expect(await readTestFile(), '{"key1":"one","key2":2}');
   });
 
   test('clear', () async {
-    await _writeTestFile('{"key1":"one","key2":2}');
-    var prefs = _getPreferences();
+    await writeTestFile(json.encode(flutterTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
 
+    expect(await readTestFile(), json.encode(flutterTestValues));
     await prefs.clear();
-    expect(await _readTestFile(), '{}');
+    expect(await readTestFile(), '{}');
+  });
+
+  test('clearWithPrefix', () async {
+    await writeTestFile(json.encode(flutterTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+    await prefs.clearWithPrefix('prefix.');
+    final Map<String, Object> noValues =
+        await prefs.getAllWithPrefix('prefix.');
+    expect(noValues, hasLength(0));
+
+    final Map<String, Object> values = await prefs.getAll();
+    expect(values, hasLength(5));
+    expect(values, flutterTestValues);
+  });
+
+  test('getAllWithNoPrefix', () async {
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+
+    final Map<String, Object> values = await prefs.getAllWithPrefix('');
+    expect(values, hasLength(15));
+    expect(values, allTestValues);
+  });
+
+  test('clearWithNoPrefix', () async {
+    await writeTestFile(json.encode(flutterTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+    await prefs.clearWithPrefix('');
+    final Map<String, Object> noValues = await prefs.getAllWithPrefix('');
+    expect(noValues, hasLength(0));
+  });
+
+  test('clearWithParameters', () async {
+    await writeTestFile(json.encode(flutterTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+    await prefs.clearWithParameters(
+      ClearParameters(
+        filter: PreferencesFilter(prefix: 'prefix.'),
+      ),
+    );
+    final Map<String, Object> noValues = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: 'prefix.'),
+      ),
+    );
+    expect(noValues, hasLength(0));
+
+    final Map<String, Object> values = await prefs.getAll();
+    expect(values, hasLength(5));
+    expect(values, flutterTestValues);
+  });
+
+  test('clearWithParameters with allow list', () async {
+    await writeTestFile(json.encode(prefixTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+    await prefs.clearWithParameters(
+      ClearParameters(
+        filter: PreferencesFilter(
+          prefix: 'prefix.',
+          allowList: <String>{'prefix.StringList'},
+        ),
+      ),
+    );
+    final Map<String, Object> someValues = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: 'prefix.'),
+      ),
+    );
+    expect(someValues, hasLength(4));
+  });
+
+  test('getAllWithNoPrefix', () async {
+    await writeTestFile(json.encode(allTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+
+    final Map<String, Object> values = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: ''),
+      ),
+    );
+    expect(values, hasLength(15));
+    expect(values, allTestValues);
+  });
+
+  test('clearWithNoPrefix', () async {
+    await writeTestFile(json.encode(flutterTestValues));
+    final SharedPreferencesELinux prefs = getPreferences();
+    await prefs.clearWithParameters(
+      ClearParameters(
+        filter: PreferencesFilter(prefix: ''),
+      ),
+    );
+    final Map<String, Object> noValues = await prefs.getAllWithParameters(
+      GetAllParameters(
+        filter: PreferencesFilter(prefix: ''),
+      ),
+    );
+    expect(noValues, hasLength(0));
   });
 }
+
+/// Fake implementation of PathProviderELinux that returns hard-coded paths,
+/// allowing tests to run on any platform.
+///
+/// Note that this should only be used with an in-memory filesystem, as the
+/// path it returns is a root path that does not actually exist on Linux.
+class FakePathProviderELinux extends PathProviderPlatform
+    implements PathProviderELinux {
+  @override
+  Future<String?> getApplicationSupportPath() async => r'/appsupport';
+
+  @override
+  Future<String?> getTemporaryPath() async => null;
+
+  @override
+  Future<String?> getLibraryPath() async => null;
+
+  @override
+  Future<String?> getApplicationDocumentsPath() async => null;
+
+  @override
+  Future<String?> getDownloadsPath() async => null;
+}