From 6720d1fc53c0f9033e37dac6c7653d1f12c7d637 Mon Sep 17 00:00:00 2001 From: Vladimir Enchev Date: Tue, 14 Apr 2015 16:49:05 +0300 Subject: [PATCH] local-settings renamed to application-settings --- CrossPlatformModules.csproj | 18 ++-- application-settings/Readme.md | 3 + .../application-settings-common.ts | 0 .../application-settings.android.ts | 2 +- .../application-settings.d.ts | 2 +- .../application-settings.ios.ts | 2 +- application-settings/package.json | 2 + apps/TelerikNEXT/app-view-model.ts | 6 +- apps/template-settings/view-model.ts | 52 +++++----- ...tests.ts => application-settings-tests.ts} | 98 +++++++++---------- apps/tests/testRunner.ts | 2 +- local-settings/Readme.md | 19 ---- local-settings/package.json | 2 - 13 files changed, 96 insertions(+), 112 deletions(-) create mode 100644 application-settings/Readme.md rename local-settings/local-settings-common.ts => application-settings/application-settings-common.ts (100%) rename local-settings/local-settings.android.ts => application-settings/application-settings.android.ts (95%) rename local-settings/local-settings.d.ts => application-settings/application-settings.d.ts (97%) rename local-settings/local-settings.ios.ts => application-settings/application-settings.ios.ts (95%) create mode 100644 application-settings/package.json rename apps/tests/{local-settings-tests.ts => application-settings-tests.ts} (55%) delete mode 100644 local-settings/Readme.md delete mode 100644 local-settings/package.json diff --git a/CrossPlatformModules.csproj b/CrossPlatformModules.csproj index 64e9e5417..c87ba9a84 100644 --- a/CrossPlatformModules.csproj +++ b/CrossPlatformModules.csproj @@ -548,7 +548,7 @@ timer.d.ts - + file-system-access.d.ts @@ -558,14 +558,14 @@ application.d.ts - - - local-settings.d.ts + + + application-settings.d.ts - - local-settings.d.ts + + application-settings.d.ts - + @@ -1153,7 +1153,7 @@ - + @@ -1192,7 +1192,7 @@ - + PreserveNewest diff --git a/application-settings/Readme.md b/application-settings/Readme.md new file mode 100644 index 000000000..935612404 --- /dev/null +++ b/application-settings/Readme.md @@ -0,0 +1,3 @@ + +Used to store strings, booleans and numbers in built-in key/value store +Uses SharedPreferences on Android and NSUserDefaults on iOS \ No newline at end of file diff --git a/local-settings/local-settings-common.ts b/application-settings/application-settings-common.ts similarity index 100% rename from local-settings/local-settings-common.ts rename to application-settings/application-settings-common.ts diff --git a/local-settings/local-settings.android.ts b/application-settings/application-settings.android.ts similarity index 95% rename from local-settings/local-settings.android.ts rename to application-settings/application-settings.android.ts index ae39d04f6..1e9599ff7 100644 --- a/local-settings/local-settings.android.ts +++ b/application-settings/application-settings.android.ts @@ -1,5 +1,5 @@ import appModule = require("application"); -import Common = require("local-settings/local-settings-common"); +import Common = require("application-settings/application-settings-common"); var sharedPreferences = appModule.android.context.getSharedPreferences("prefs.db", 0); diff --git a/local-settings/local-settings.d.ts b/application-settings/application-settings.d.ts similarity index 97% rename from local-settings/local-settings.d.ts rename to application-settings/application-settings.d.ts index 8810c4e1d..6d05c86e6 100644 --- a/local-settings/local-settings.d.ts +++ b/application-settings/application-settings.d.ts @@ -1,7 +1,7 @@ /** * Allows you to save and restore any kind of information related to your application. */ -declare module "local-settings" { +declare module "application-settings" { /** * Checks whether such a key exists. * @param key The key to check for. diff --git a/local-settings/local-settings.ios.ts b/application-settings/application-settings.ios.ts similarity index 95% rename from local-settings/local-settings.ios.ts rename to application-settings/application-settings.ios.ts index f86aba73e..6e24cdfc8 100644 --- a/local-settings/local-settings.ios.ts +++ b/application-settings/application-settings.ios.ts @@ -1,4 +1,4 @@ -import Common = require("local-settings/local-settings-common"); +import Common = require("application-settings/application-settings-common"); var userDefaults = NSUserDefaults.standardUserDefaults(); diff --git a/application-settings/package.json b/application-settings/package.json new file mode 100644 index 000000000..fe62ee33a --- /dev/null +++ b/application-settings/package.json @@ -0,0 +1,2 @@ +{ "name" : "application-settings", + "main" : "application-settings.js" } \ No newline at end of file diff --git a/apps/TelerikNEXT/app-view-model.ts b/apps/TelerikNEXT/app-view-model.ts index b04b1d3d2..da34fd8c5 100644 --- a/apps/TelerikNEXT/app-view-model.ts +++ b/apps/TelerikNEXT/app-view-model.ts @@ -1,6 +1,6 @@ import observable = require("data/observable"); import dialogs = require("ui/dialogs"); -import localSettings = require("local-settings"); +import appSettings = require("application-settings"); import button = require("ui/button"); var everlive = require("./lib/everlive"); @@ -36,7 +36,7 @@ var sessions: Array = new Array(); var FAVOURITES = "FAVOURITES"; var favourites: Array; try { - favourites = >JSON.parse(localSettings.getString(FAVOURITES, "[]")); + favourites = >JSON.parse(appSettings.getString(FAVOURITES, "[]")); } catch (error) { console.log("Error while retrieveing favourites: " + error); @@ -61,7 +61,7 @@ function removeFromFavourites(session: SessionModel) { function updateFavourites() { var newValue = JSON.stringify(favourites); - localSettings.setString(FAVOURITES, newValue); + appSettings.setString(FAVOURITES, newValue); } var el = new everlive("mzacGkKPFlZUfbMq"); diff --git a/apps/template-settings/view-model.ts b/apps/template-settings/view-model.ts index b70ba5788..b672965df 100644 --- a/apps/template-settings/view-model.ts +++ b/apps/template-settings/view-model.ts @@ -1,5 +1,5 @@ import observable = require("data/observable"); -import localSettings = require("local-settings"); +import appSettings = require("application-settings"); import dialogs = require("ui/dialogs"); var NAME = "settings-name"; @@ -11,45 +11,45 @@ var SOUND_VOLUME = "settings-sound-value"; export class SettingsViewModel extends observable.Observable { get name(): string { - return localSettings.getString(NAME, "John Doe"); + return appSettings.getString(NAME, "John Doe"); } set name(value: string) { - localSettings.setString(NAME, value); + appSettings.setString(NAME, value); } get height(): string { - return localSettings.getString(HEIGHT, "180"); + return appSettings.getString(HEIGHT, "180"); } set height(value: string) { - localSettings.setString(HEIGHT, value); + appSettings.setString(HEIGHT, value); } get weight(): string { - return localSettings.getString(WEIGHT, "80"); + return appSettings.getString(WEIGHT, "80"); } set weight(value: string) { - localSettings.setString(WEIGHT, value); + appSettings.setString(WEIGHT, value); } get vibrateEnabled(): boolean { - return localSettings.getBoolean(VIBRATE, true); + return appSettings.getBoolean(VIBRATE, true); } set vibrateEnabled(value: boolean) { - localSettings.setBoolean(VIBRATE, value); + appSettings.setBoolean(VIBRATE, value); } get soundEnabled(): boolean { - return localSettings.getBoolean(SOUND, true); + return appSettings.getBoolean(SOUND, true); } set soundEnabled(value: boolean) { - localSettings.setBoolean(SOUND, value); + appSettings.setBoolean(SOUND, value); } get soundVolume(): number { - return localSettings.getNumber(SOUND_VOLUME, 100); + return appSettings.getNumber(SOUND_VOLUME, 100); } set soundVolume(value: number) { - localSettings.setNumber(SOUND_VOLUME, value); + appSettings.setNumber(SOUND_VOLUME, value); } public promptName(args: observable.EventData) { @@ -65,7 +65,7 @@ export var settingsViewModel = new SettingsViewModel(); // Pure JavaScript code: //var observable = require("data/observable"); -//var localSettings = require("local-settings"); +//var appSettings = require("application-settings"); //var NAME = "settings-name"; //var HEIGHT = "settings-height"; @@ -76,43 +76,43 @@ export var settingsViewModel = new SettingsViewModel(); //var settings = new observable.Observable(); //Object.defineProperty(settings, "name", { -// get: function () { return localSettings.getString(NAME, "John Doe"); }, -// set: function (value) { localSettings.setString(NAME, value); }, +// get: function () { return appSettings.getString(NAME, "John Doe"); }, +// set: function (value) { appSettings.setString(NAME, value); }, // enumerable: true, // configurable: true //}); //Object.defineProperty(settings, "height", { -// get: function () { return localSettings.getString(HEIGHT, "180"); }, -// set: function (value) { localSettings.setString(HEIGHT, value); }, +// get: function () { return appSettings.getString(HEIGHT, "180"); }, +// set: function (value) { appSettings.setString(HEIGHT, value); }, // enumerable: true, // configurable: true //}); //Object.defineProperty(settings, "weight", { -// get: function () { return localSettings.getString(WEIGHT, "80"); }, -// set: function (value) { localSettings.setString(WEIGHT, value); }, +// get: function () { return appSettings.getString(WEIGHT, "80"); }, +// set: function (value) { appSettings.setString(WEIGHT, value); }, // enumerable: true, // configurable: true //}); //Object.defineProperty(settings, "vibrateEnabled", { -// get: function () { return localSettings.getBoolean(VIBRATE, true); }, -// set: function (value) { localSettings.setBoolean(VIBRATE, value); }, +// get: function () { return appSettings.getBoolean(VIBRATE, true); }, +// set: function (value) { appSettings.setBoolean(VIBRATE, value); }, // enumerable: true, // configurable: true //}); //Object.defineProperty(settings, "soundEnabled", { -// get: function () { return localSettings.getBoolean(SOUND, true); }, -// set: function (value) { localSettings.setBoolean(SOUND, value); }, +// get: function () { return appSettings.getBoolean(SOUND, true); }, +// set: function (value) { appSettings.setBoolean(SOUND, value); }, // enumerable: true, // configurable: true //}); //Object.defineProperty(settings, "soundVolume", { -// get: function () { return localSettings.getNumber(SOUND_VOLUME, 100); }, -// set: function (value) { localSettings.setNumber(SOUND_VOLUME, value); }, +// get: function () { return appSettings.getNumber(SOUND_VOLUME, 100); }, +// set: function (value) { appSettings.setNumber(SOUND_VOLUME, value); }, // enumerable: true, // configurable: true //}); diff --git a/apps/tests/local-settings-tests.ts b/apps/tests/application-settings-tests.ts similarity index 55% rename from apps/tests/local-settings-tests.ts rename to apps/tests/application-settings-tests.ts index 3bbd8413c..20fab911f 100644 --- a/apps/tests/local-settings-tests.ts +++ b/apps/tests/application-settings-tests.ts @@ -1,8 +1,8 @@ -// +// // # Local Settings // Using local settings methods requires to load "local settings" module. // ``` JavaScript -var LocalSettings = require("local-settings"); +var appSettings = require("application-settings"); // ``` // var TKUnit = require("./TKUnit"); @@ -14,118 +14,118 @@ var noStringKey: string = "noStringKey"; var noBoolKey: string = "noBoolKey"; var noNumberKey: string = "noNumberKey"; -// +// // ## Working with string, number and boolean values // export var testBoolean = function () { - LocalSettings.setBoolean(boolKey, false); - var boolValueBefore = LocalSettings.getBoolean(boolKey); - TKUnit.assert(false === boolValueBefore, "Cannot set boolean to false, currently it is: " + LocalSettings.getBoolean(boolKey)); + appSettings.setBoolean(boolKey, false); + var boolValueBefore = appSettings.getBoolean(boolKey); + TKUnit.assert(false === boolValueBefore, "Cannot set boolean to false, currently it is: " + appSettings.getBoolean(boolKey)); - // + // // ### Set and get boolean value and provide default value in case it is not set // ``` JavaScript - LocalSettings.setBoolean("boolKey", true); - var boolValue = LocalSettings.getBoolean("boolKey", false); + appSettings.setBoolean("boolKey", true); + var boolValue = appSettings.getBoolean("boolKey", false); // ``` // TKUnit.assert(true === boolValue, "Cannot set boolean to true"); - TKUnit.assert(true === LocalSettings.getBoolean(boolKey), "Cannot set boolean to true (no default)"); + TKUnit.assert(true === appSettings.getBoolean(boolKey), "Cannot set boolean to true (no default)"); }; export var testString = function () { - // + // // ### Set and get string value // ``` JavaScript - LocalSettings.setString("stringKey", "String value"); - var stringValue = LocalSettings.getString("stringKey"); + appSettings.setString("stringKey", "String value"); + var stringValue = appSettings.getString("stringKey"); // ``` // TKUnit.assert("String value" === stringValue, "Cannot set string value"); }; export var testNumber = function () { - // + // // ### Set and get numeric value. // We use `toFixed()` here in order to avoid floating point errors - ex: `54.321` becoming `54.320999999537`. // Beware the result of `toFixed()` is a string not a number therefore you cannot use `===` or `!==` when comparing with a number. // ``` JavaScript - LocalSettings.setNumber("numberKey", 54.321); - var value = parseFloat(LocalSettings.getNumber("numberKey").toFixed(3)); + appSettings.setNumber("numberKey", 54.321); + var value = parseFloat(appSettings.getNumber("numberKey").toFixed(3)); // ``` // TKUnit.assert(54.321 === value, "Cannot set number value 54.321 != " + value); }; export var testDefaults = function () { - // + // // ### Reading values that are not set before while providing default value // ``` JavaScript - var defaultValue = LocalSettings.getString("noStringKey", "No string value"); + var defaultValue = appSettings.getString("noStringKey", "No string value"); //// will return "No string value" if there is no value for "noStringKey" // ``` // TKUnit.assert("No string value" === defaultValue, "Bad default string value"); - TKUnit.assert(true === LocalSettings.getBoolean(noBoolKey, true), "Bad default boolean value"); - TKUnit.assert(123.45 === LocalSettings.getNumber(noNumberKey, 123.45), "Bad default number value"); + TKUnit.assert(true === appSettings.getBoolean(noBoolKey, true), "Bad default boolean value"); + TKUnit.assert(123.45 === appSettings.getNumber(noNumberKey, 123.45), "Bad default number value"); } export var testDefaultsWithNoDefaultValueProvided = function () { - // + // // ### Reading values that are not set before not providing default value // ``` JavaScript - var defaultValue = LocalSettings.getString("noStringKey"); + var defaultValue = appSettings.getString("noStringKey"); //// will return undefined if there is no value for "noStringKey" // ``` // TKUnit.assert("undefined" === typeof defaultValue, "Default string value is not undefined"); - TKUnit.assert("undefined" === typeof LocalSettings.getBoolean(noBoolKey), "Default boolean value is not undefined"); - TKUnit.assert("undefined" === typeof LocalSettings.getNumber(noNumberKey), "Default number value is not undefined"); + TKUnit.assert("undefined" === typeof appSettings.getBoolean(noBoolKey), "Default boolean value is not undefined"); + TKUnit.assert("undefined" === typeof appSettings.getNumber(noNumberKey), "Default number value is not undefined"); }; -// +// // ## Other functions // export var testHasKey = function () { - // + // // ### Checking for existence of value for key // ``` JavaScript - var hasKey = LocalSettings.hasKey("noBoolKey"); + var hasKey = appSettings.hasKey("noBoolKey"); //// will return false if there is no value for "noBoolKey" // ``` // TKUnit.assert(!hasKey, "There is a key: " + noBoolKey); - TKUnit.assert(!LocalSettings.hasKey(noStringKey), "There is a key: " + noStringKey); - TKUnit.assert(!LocalSettings.hasKey(noNumberKey), "There is a key: " + noNumberKey); + TKUnit.assert(!appSettings.hasKey(noStringKey), "There is a key: " + noStringKey); + TKUnit.assert(!appSettings.hasKey(noNumberKey), "There is a key: " + noNumberKey); - TKUnit.assert(LocalSettings.hasKey(boolKey), "There is no key: " + boolKey); - TKUnit.assert(LocalSettings.hasKey(stringKey), "There is no key: " + stringKey); - TKUnit.assert(LocalSettings.hasKey(numberKey), "There is no key: " + numberKey); + TKUnit.assert(appSettings.hasKey(boolKey), "There is no key: " + boolKey); + TKUnit.assert(appSettings.hasKey(stringKey), "There is no key: " + stringKey); + TKUnit.assert(appSettings.hasKey(numberKey), "There is no key: " + numberKey); }; export var testRemove = function () { - // + // // ### Removing value for key // ``` JavaScript - LocalSettings.remove("boolKey"); + appSettings.remove("boolKey"); // ``` // - TKUnit.assert(!LocalSettings.hasKey(boolKey), "Failed to remove key: " + boolKey); + TKUnit.assert(!appSettings.hasKey(boolKey), "Failed to remove key: " + boolKey); - LocalSettings.remove(stringKey); - TKUnit.assert(!LocalSettings.hasKey(stringKey), "Failed to remove key: " + stringKey); + appSettings.remove(stringKey); + TKUnit.assert(!appSettings.hasKey(stringKey), "Failed to remove key: " + stringKey); - LocalSettings.remove(numberKey); - TKUnit.assert(!LocalSettings.hasKey(numberKey), "Failed to remove key: " + numberKey); + appSettings.remove(numberKey); + TKUnit.assert(!appSettings.hasKey(numberKey), "Failed to remove key: " + numberKey); }; export var testInvalidKey = function () { try { - LocalSettings.hasKey(undefined); + appSettings.hasKey(undefined); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -133,7 +133,7 @@ export var testInvalidKey = function () { } try { - LocalSettings.hasKey(null); + appSettings.hasKey(null); TKUnit.assert(false, "There is a key null"); } catch (e) { @@ -141,19 +141,19 @@ export var testInvalidKey = function () { } try { - LocalSettings.hasKey(123); + appSettings.hasKey(123); TKUnit.assert(false, "There is a key number"); } catch (e) { // we should receive an exception here } - LocalSettings.hasKey("string"); + appSettings.hasKey("string"); }; export var testInvalidValue = function () { try { - LocalSettings.setBoolean(boolKey, "str"); + appSettings.setBoolean(boolKey, "str"); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -161,7 +161,7 @@ export var testInvalidValue = function () { } try { - LocalSettings.setBoolean(boolKey, 123); + appSettings.setBoolean(boolKey, 123); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -169,7 +169,7 @@ export var testInvalidValue = function () { } try { - LocalSettings.setString(boolKey, true); + appSettings.setString(boolKey, true); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -177,7 +177,7 @@ export var testInvalidValue = function () { } try { - LocalSettings.setString(boolKey, 123); + appSettings.setString(boolKey, 123); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -185,7 +185,7 @@ export var testInvalidValue = function () { } try { - LocalSettings.setNumber(boolKey, true); + appSettings.setNumber(boolKey, true); TKUnit.assert(false, "There is a key undefined"); } catch (e) { @@ -193,7 +193,7 @@ export var testInvalidValue = function () { } try { - LocalSettings.setNumber(boolKey, "123"); + appSettings.setNumber(boolKey, "123"); TKUnit.assert(false, "There is a key undefined"); } catch (e) { diff --git a/apps/tests/testRunner.ts b/apps/tests/testRunner.ts index 5141cbc90..3224a0a07 100644 --- a/apps/tests/testRunner.ts +++ b/apps/tests/testRunner.ts @@ -33,7 +33,7 @@ allTests["SCROLL-VIEW"] = require("./ui/scroll-view/scroll-view-tests"); allTests["APPLICATION"] = require("./application-tests"); allTests["FILE SYSTEM"] = require("./file-system-tests"); allTests["HTTP"] = require("./http-tests"); -allTests["LOCAL SETTINGS"] = require("./local-settings-tests"); +allTests["APPLICATION SETTINGS"] = require("./application-settings-tests"); allTests["IMAGE SOURCE"] = require("./image-source-tests"); allTests["TIMER"] = require("./timer-tests"); allTests["COLOR"] = require("./color-tests"); diff --git a/local-settings/Readme.md b/local-settings/Readme.md deleted file mode 100644 index 9afb33541..000000000 --- a/local-settings/Readme.md +++ /dev/null @@ -1,19 +0,0 @@ - -Used to store strings, booleans and numbers in built-in key/value store -Uses SharedPreferences on Android and NSUserDefaults on iOS - -Sample code: - -``` -UserPreferences.setBoolean("boolKey", false); -var bValue = UserPreferences.getBoolean("boolKey"); - -var sValue = UserPreferences.getString("noSuchStringKey", "No string value"); -// will return "No string value" if there is no such value - -var weHaveKey = UserPreferences.hasKey("boolKey"); - -if (weHaveKey) { - UserPreferences.remove("boolKey"); -} -``` \ No newline at end of file diff --git a/local-settings/package.json b/local-settings/package.json deleted file mode 100644 index 76306b5dc..000000000 --- a/local-settings/package.json +++ /dev/null @@ -1,2 +0,0 @@ -{ "name" : "local-settings", - "main" : "local-settings.js" } \ No newline at end of file