[shared_preferences_linux] Add support for Linux

Fixes flutter/flutter#41720

packages/shared_preferences/shared_preferences/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.8
+
+* Adds support for Linux.
+
 ## 0.5.7+3
 
 * Post-v2 Android embedding cleanup.

packages/shared_preferences/shared_preferences/lib/shared_preferences.dart

@@ -4,8 +4,11 @@
 
 import 'dart:async';
 
+import 'package:flutter/foundation.dart';
 import 'package:meta/meta.dart';
+import 'package:platform/platform.dart';
 
+import 'package:shared_preferences_linux/shared_preferences_linux.dart';
 import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
 
 /// Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing
@@ -18,8 +21,14 @@ class SharedPreferences {
   static const String _prefix = 'flutter.';
   static Completer<SharedPreferences> _completer;
 
-  static SharedPreferencesStorePlatform get _store =>
-      SharedPreferencesStorePlatform.instance;
+  static SharedPreferencesStorePlatform get _store {
+    // This is a workaround until https://github.com/flutter/flutter/issues/52267
+    // is fixed. There is no way currently to register a Dart-only plugin.
+    if (!kIsWeb && LocalPlatform().isLinux) {
+      return SharedPreferencesLinux();
+    }
+    return SharedPreferencesStorePlatform.instance;
+  }
 
   /// Loads and parses the [SharedPreferences] for this app from disk.
   ///

packages/shared_preferences/shared_preferences/pubspec.yaml

@@ -5,7 +5,7 @@ homepage: https://github.com/flutter/plugins/tree/master/packages/shared_prefere
 # 0.5.y+z is compatible with 1.0.0, if you land a breaking change bump
 # the version to 2.0.0.
 # See more details: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0
-version: 0.5.7+3
+version: 0.5.8
 
 flutter:
   plugin:
@@ -24,6 +24,9 @@ dependencies:
   meta: ^1.0.4
   flutter:
     sdk: flutter
+  platform: 2.2.1
+  shared_preferences_linux:
+    path: ../shared_preferences_linux
   shared_preferences_platform_interface: ^1.0.0
   # The design on https://flutter.dev/go/federated-plugins was to leave
   # this constraint as "any". We cannot do it right now as it fails pub publish

packages/shared_preferences/shared_preferences_linux/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.dart_tool/
+
+.packages
+.pub/
+
+build/

packages/shared_preferences/shared_preferences_linux/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: e491544588e8d34fdf31d5f840b4649850ef167a
+  channel: master
+
+project_type: plugin

packages/shared_preferences/shared_preferences_linux/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+* Initial release to support shared_preferences on Linux.

packages/shared_preferences/shared_preferences_linux/LICENSE

@@ -0,0 +1,27 @@
+// Copyright 2020 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/shared_preferences/shared_preferences_linux/README.md

@@ -0,0 +1,23 @@
+# shared_preferences_linux
+
+The Linux implementation of [`shared_preferences`][1].
+
+## Usage
+
+### Import the package
+
+This package has been endorsed, meaning that you only need to add `shared_preferences`
+as a dependency in your `pubspec.yaml`. It will be automatically included in your app
+when you depend on `package:shared_preferences`.
+
+This is what the above means to your `pubspec.yaml`:
+
+```yaml
+...
+dependencies:
+  ...
+  shared_preferences: ^0.5.8
+  ...
+```
+
+[1]: ../

packages/shared_preferences/shared_preferences_linux/example/.gitignore

@@ -0,0 +1,43 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Exceptions to above rules.
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages

packages/shared_preferences/shared_preferences_linux/example/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: e491544588e8d34fdf31d5f840b4649850ef167a
+  channel: master
+
+project_type: app

packages/shared_preferences/shared_preferences_linux/example/README.md

@@ -0,0 +1,8 @@
+# shared_preferences_example
+
+Demonstrates how to use the shared_preferences plugin.
+
+## Getting Started
+
+For help getting started with Flutter, view our online
+[documentation](http://flutter.io/).

packages/shared_preferences/shared_preferences_linux/example/lib/main.dart

@@ -0,0 +1,87 @@
+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// ignore_for_file: public_member_api_docs
+
+import 'dart:async';
+
+import 'package:flutter/material.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+void main() {
+  runApp(MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'SharedPreferences Demo',
+      home: SharedPreferencesDemo(),
+    );
+  }
+}
+
+class SharedPreferencesDemo extends StatefulWidget {
+  SharedPreferencesDemo({Key key}) : super(key: key);
+
+  @override
+  SharedPreferencesDemoState createState() => SharedPreferencesDemoState();
+}
+
+class SharedPreferencesDemoState extends State<SharedPreferencesDemo> {
+  Future<SharedPreferences> _prefs = SharedPreferences.getInstance();
+  Future<int> _counter;
+
+  Future<void> _incrementCounter() async {
+    final SharedPreferences prefs = await _prefs;
+    final int counter = (prefs.getInt('counter') ?? 0) + 1;
+
+    setState(() {
+      _counter = prefs.setInt("counter", counter).then((bool success) {
+        return counter;
+      });
+    });
+  }
+
+  @override
+  void initState() {
+    super.initState();
+    _counter = _prefs.then((SharedPreferences prefs) {
+      return (prefs.getInt('counter') ?? 0);
+    });
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text("SharedPreferences Demo"),
+      ),
+      body: Center(
+          child: FutureBuilder<int>(
+              future: _counter,
+              builder: (BuildContext context, AsyncSnapshot<int> snapshot) {
+                switch (snapshot.connectionState) {
+                  case ConnectionState.waiting:
+                    return const CircularProgressIndicator();
+                  default:
+                    if (snapshot.hasError) {
+                      return Text('Error: ${snapshot.error}');
+                    } else {
+                      return Text(
+                        'Button tapped ${snapshot.data} time${snapshot.data == 1 ? '' : 's'}.\n\n'
+                        'This should persist across restarts.',
+                      );
+                    }
+                }
+              })),
+      floatingActionButton: FloatingActionButton(
+        onPressed: _incrementCounter,
+        tooltip: 'Increment',
+        child: const Icon(Icons.add),
+      ),
+    );
+  }
+}

packages/shared_preferences/shared_preferences_linux/example/pubspec.yaml

@@ -0,0 +1,14 @@
+name: shared_preferences_example
+description: Demonstrates how to use the shared_preferences plugin.
+
+dependencies:
+  flutter:
+    sdk: flutter
+  shared_preferences:
+    path: ../../shared_preferences/
+  shared_preferences_linux:
+    path: ../
+
+flutter:
+  uses-material-design: true
+

packages/shared_preferences/shared_preferences_linux/lib/shared_preferences_linux.dart

@@ -0,0 +1,93 @@
+// Copyright 2020 The Chromium 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:async';
+import 'dart:convert' show json;
+import 'package:file/file.dart';
+import 'package:file/local.dart';
+import 'package:meta/meta.dart';
+import 'package:path/path.dart' as path;
+import 'package:path_provider/path_provider.dart';
+import 'package:shared_preferences_platform_interface/shared_preferences_platform_interface.dart';
+
+/// The Linux implementation of [SharedPreferencesStorePlatform].
+///
+/// This class implements the `package:shared_preferences` functionality for Linux.
+class SharedPreferencesLinux extends SharedPreferencesStorePlatform {
+  /// Local copy of preferences
+  Map<String, Object> _cachedPreferences;
+
+  /// File system used to store to disk. Exposed for testing only.
+  @visibleForTesting
+  FileSystem fs = LocalFileSystem();
+
+  /// Gets the file were the preferences are stored.
+  Future<File> _getLocalDataFile() async {
+    var directory = await getApplicationSupportDirectory();
+    var filePath = path.join(directory.path, 'shared_preferences.json');
+    return fs.file(filePath);
+  }
+
+  /// 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;
+    }
+
+    _cachedPreferences = {};
+    var localDataFile = await _getLocalDataFile();
+    if (localDataFile.existsSync()) {
+      String stringMap = localDataFile.readAsStringSync();
+      if (stringMap.isNotEmpty) {
+        _cachedPreferences = json.decode(stringMap) as Map<String, Object>;
+      }
+    }
+
+    return _cachedPreferences;
+  }
+
+  /// 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();
+      if (!localDataFile.existsSync()) {
+        localDataFile.createSync(recursive: true);
+      }
+      var stringMap = json.encode(preferences);
+      localDataFile.writeAsStringSync(stringMap);
+    } catch (e) {
+      print("Error saving preferences to disk: $e");
+      return false;
+    }
+    return true;
+  }
+
+  @override
+  Future<bool> clear() async {
+    var preferences = await _readPreferences();
+    preferences.clear();
+    return _writePreferences(preferences);
+  }
+
+  @override
+  Future<Map<String, Object>> getAll() async {
+    return _readPreferences();
+  }
+
+  @override
+  Future<bool> remove(String key) async {
+    var preferences = await _readPreferences();
+    preferences.remove(key);
+    return _writePreferences(preferences);
+  }
+
+  @override
+  Future<bool> setValue(String valueType, String key, Object value) async {
+    var preferences = await _readPreferences();
+    preferences[key] = value;
+    return _writePreferences(preferences);
+  }
+}