Merge pull request #16 from collinjackson/shared_preferences

Add Shared Preferences plugin

Author: collinjackson

packages/shared-preferences/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.atom/
+.idea
+.packages
+.pub/
+build/
+ios/.generated/
+packages
+pubspec.lock

packages/shared-preferences/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2017-05-05
+
+* Initial Open Source release.

packages/shared-preferences/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2017, the Flutter project 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/README.md

@@ -0,0 +1,36 @@
+# shared_preferences
+
+Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing
+a persistent store for simple data. Data is persisted to disk automatically
+and asynchronously.
+
+## Usage
+To use this plugin, add shared_preferences as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
+
+### Example
+
+``` dart
+import 'package:flutter/material.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+void main() {
+  runApp(new MaterialApp(
+    home: new Scaffold(
+      body: new Center(
+      child: new RaisedButton(
+        onPressed: _incrementCounter,
+        child: new Text('Increment Counter'),
+        ),
+      ),
+    ),
+  ));
+}
+
+_incrementCounter() async {
+  SharedPreferences prefs = await SharedPreferences.getInstance();
+  int counter = (prefs.getInt('counter') ?? 0) + 1;
+  print('Pressed $counter times.');
+  prefs.setInt('counter', counter);
+}
+```
+

packages/shared-preferences/android/.gitignore

@@ -0,0 +1,12 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures
+
+/gradle
+/gradlew
+/gradlew.bat

packages/shared-preferences/android/build.gradle

@@ -0,0 +1,32 @@
+group 'io.flutter.plugins.shared_preferences'
+version '1.0-SNAPSHOT'
+
+buildscript {
+    repositories {
+        jcenter()
+    }
+
+    dependencies {
+        classpath 'com.android.tools.build:gradle:2.3.0'
+    }
+}
+
+allprojects {
+    repositories {
+        jcenter()
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion 25
+    buildToolsVersion '25.0.0'
+
+    defaultConfig {
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+    lintOptions {
+        disable 'InvalidPackage'
+    }
+}

packages/shared-preferences/android/gradle.properties

@@ -0,0 +1 @@
+org.gradle.jvmargs=-Xmx1536M

packages/shared-preferences/android/settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'shared_preferences'

packages/shared-preferences/android/src/main/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="io.flutter.plugins.shared_preferences"
+  android:versionCode="1"
+  android:versionName="0.0.1">
+
+  <uses-sdk android:minSdkVersion="16" android:targetSdkVersion="21" />
+</manifest>

packages/shared-preferences/android/src/main/java/io/flutter/plugins/shared_preferences/SharedPreferencesPlugin.java

@@ -0,0 +1,92 @@
+// 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.
+
+package io.flutter.plugins.shared_preferences;
+
+import android.content.Context;
+import io.flutter.app.FlutterActivity;
+import io.flutter.plugin.common.MethodChannel;
+import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
+import io.flutter.plugin.common.MethodChannel.Result;
+import io.flutter.plugin.common.MethodCall;
+import io.flutter.view.FlutterView;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * SharedPreferencesPlugin
+ */
+public class SharedPreferencesPlugin implements MethodCallHandler {
+  private static final String SHARED_PREFERENCES_NAME = "FlutterSharedPreferences";
+  private static final String CHANNEL_NAME = "plugins.flutter.io/shared_preferences";
+
+  private final android.content.SharedPreferences preferences;
+  private final android.content.SharedPreferences.Editor editor;
+
+  public static SharedPreferencesPlugin register(FlutterActivity activity) {
+    return new SharedPreferencesPlugin(activity);
+  }
+
+  private SharedPreferencesPlugin(FlutterActivity activity) {
+    preferences = activity.getSharedPreferences(SHARED_PREFERENCES_NAME, Context.MODE_PRIVATE);
+    editor = preferences.edit();
+    new MethodChannel(activity.getFlutterView(), CHANNEL_NAME).setMethodCallHandler(this);
+  }
+
+  // Filter preferences to only those set by the flutter app.
+  private Map<String, Object> getAllPrefs() {
+    Map<String, ?> allPrefs = preferences.getAll();
+    Map<String, Object> filteredPrefs = new HashMap<>();
+    for (String key : allPrefs.keySet()) {
+      if (key.startsWith("flutter.")) {
+        filteredPrefs.put(key, allPrefs.get(key));
+      }
+    }
+    return filteredPrefs;
+  }
+
+  @Override
+  public void onMethodCall(MethodCall call, MethodChannel.Result result) {
+    String key = call.argument("key");
+    switch (call.method) {
+      case "setBool":
+        editor.putBoolean(key, (boolean) call.argument("value")).apply();
+        result.success(null);
+        break;
+      case "setDouble":
+        editor.putFloat(key, (float) call.argument("value")).apply();
+        result.success(null);
+        break;
+      case "setInt":
+        editor.putInt(key, (int) call.argument("value")).apply();
+        result.success(null);
+        break;
+      case "setString":
+        editor.putString(key, (String) call.argument("value")).apply();
+        result.success(null);
+        break;
+      case "setStringSet":
+        editor.putStringSet(key, new HashSet<>((List<String>) call.argument("value"))).apply();
+        result.success(null);
+        break;
+      case "commit":
+        result.success(editor.commit());
+        break;
+      case "getAll":
+        result.success(getAllPrefs());
+        break;
+      case "clear":
+        for (String keyToDelete : getAllPrefs().keySet()) {
+          editor.remove(keyToDelete);
+        }
+        result.success(editor.commit());
+        break;
+      default:
+        result.notImplemented();
+        break;
+    }
+  }
+}