Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Preferences id cleanup #3018

Merged
merged 9 commits into from
Mar 11, 2013
Merged

Preferences id cleanup #3018

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e8ab064
Cleaned up the preferences ids
WebsiteDeveloper Mar 2, 2013
f5da97a
Fixed forgotten id
WebsiteDeveloper Mar 2, 2013
65789b5
Added preferences migration code
WebsiteDeveloper Mar 3, 2013
5c03b6f
Exported handleClientIdChange
WebsiteDeveloper Mar 3, 2013
2a9719f
Final migration handling implemented
WebsiteDeveloper Mar 3, 2013
e04355f
Reverted change in PreferencesManager
WebsiteDeveloper Mar 4, 2013
a7264e8
merged with master
WebsiteDeveloper Mar 10, 2013
56e001e
Added getClientId function
WebsiteDeveloper Mar 10, 2013
360546d
Fixed a typo
WebsiteDeveloper Mar 10, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/LiveDevelopment/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ define(function main(require, exports, module) {
UrlParams = require("utils/UrlParams").UrlParams,
Strings = require("strings");

var PREFERENCES_KEY = "com.adobe.brackets.live-development";
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of repeating this string everywhere, there should be a getClientId(moduleId) function in PreferencesManager.

var prefs;
var params = new UrlParams();
var config = {
Expand Down Expand Up @@ -220,7 +220,10 @@ define(function main(require, exports, module) {
});

// init prefs
prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_KEY, {highlight: true});
prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, {highlight: true});
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(prefs, "com.adobe.brackets.live-development", {highlight: true});

config.highlight = prefs.getValue("highlight");

// init commands
Expand Down
5 changes: 4 additions & 1 deletion src/brackets.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ define(function (require, exports, module) {

// Local variables
var params = new UrlParams(),
PREFERENCES_CLIENT_ID = "com.adobe.brackets.startup";
PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id;

// read URL params
params.parse();
Expand Down Expand Up @@ -202,6 +202,9 @@ define(function (require, exports, module) {
// an old version that might not have set the "afterFirstLaunch" pref.)
var prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID),
deferred = new $.Deferred();
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(prefs, "com.adobe.brackets.startup");

if (!params.get("skipSampleProjectLoad") && !prefs.getValue("afterFirstLaunch")) {
prefs.setValue("afterFirstLaunch", "true");
if (ProjectManager.isWelcomeProjectPath(initialProjectPath)) {
Expand Down
4 changes: 3 additions & 1 deletion src/document/DocumentManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ define(function (require, exports, module) {
/**
* Unique PreferencesManager clientID
*/
var PREFERENCES_CLIENT_ID = "com.adobe.brackets.DocumentManager";
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id;

/**
* @private
Expand Down Expand Up @@ -1244,6 +1244,8 @@ define(function (require, exports, module) {

// Setup preferences
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, "com.adobe.brackets.DocumentManager");

// Performance measurements
PerfUtils.createPerfMeasurement("DOCUMENT_MANAGER_GET_DOCUMENT_FOR_PATH", "DocumentManager.getDocumentForPath()");
Expand Down
6 changes: 4 additions & 2 deletions src/editor/Editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,13 @@ define(function (require, exports, module) {
TokenUtils = require("utils/TokenUtils"),
ViewUtils = require("utils/ViewUtils");

var PREFERENCES_CLIENT_ID = "com.adobe.brackets.Editor",
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id,
defaultPrefs = { useTabChar: false, tabSize: 4, indentUnit: 4 };

/** Editor preferences */
var _prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaultPrefs);
var _prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, "com.adobe.brackets.Editor", defaultPrefs);

/** @type {boolean} Global setting: When inserting new text, use tab characters? (instead of spaces) */
var _useTabChar = _prefs.getValue("useTabChar");
Expand Down
13 changes: 7 additions & 6 deletions src/extensions/default/RecentProjects/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
define(function (require, exports, module) {
"use strict";

var PREFERENCES_KEY = "com.adobe.brackets.brackets-recent-projects";
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id;

// Brackets modules
var ProjectManager = brackets.getModule("project/ProjectManager"),
Expand All @@ -48,14 +48,17 @@ define(function (require, exports, module) {
$dropdown,
$settings;

var prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(prefs, "com.adobe.brackets.brackets-recent-projects");

var MAX_PROJECTS = 20;

/**
* Get the stored list of recent projects, canonicalizing and updating paths as appropriate.
*/
function getRecentProjects() {
var prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_KEY),
recentProjects = prefs.getValue("recentProjects") || [],
var recentProjects = prefs.getValue("recentProjects") || [],
i;
for (i = 0; i < recentProjects.length; i++) {
recentProjects[i] = FileUtils.canonicalizeFolderPath(ProjectManager.updateWelcomeProjectPath(recentProjects[i]));
Expand All @@ -68,7 +71,6 @@ define(function (require, exports, module) {
*/
function add() {
var root = FileUtils.canonicalizeFolderPath(ProjectManager.getProjectRoot().fullPath),
prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_KEY),
recentProjects = getRecentProjects(),
index = recentProjects.indexOf(root);
if (index !== -1) {
Expand Down Expand Up @@ -108,8 +110,7 @@ define(function (require, exports, module) {
e.stopPropagation();

// Remove the project from the preferences.
var prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_KEY),
recentProjects = getRecentProjects(),
var recentProjects = getRecentProjects(),
index = recentProjects.indexOf($(this).data("path")),
newProjects = [],
i;
Expand Down
6 changes: 4 additions & 2 deletions src/language/JSLintUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ define(function (require, exports, module) {
AppInit = require("utils/AppInit"),
StatusBar = require("widgets/StatusBar");

var PREFERENCES_CLIENT_ID = module.id,
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id,
defaultPrefs = { enabled: !!brackets.config.enable_jslint };

/**
Expand Down Expand Up @@ -265,7 +265,9 @@ define(function (require, exports, module) {
CommandManager.register(Strings.CMD_JSLINT_FIRST_ERROR, Commands.NAVIGATE_GOTO_JSLINT_ERROR, _handleGotoJSLintError);

// Init PreferenceStorage
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaultPrefs);
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, module.id, defaultPrefs);

// Initialize items dependent on HTML DOM
AppInit.htmlReady(function () {
Expand Down
33 changes: 30 additions & 3 deletions src/preferences/PreferencesManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ define(function (require, exports, module) {

var PreferenceStorage = require("preferences/PreferenceStorage").PreferenceStorage;

var PREFERENCES_KEY = "com.adobe.brackets.preferences";
var PREFERENCES_CLIENT_ID = "com.adobe.brackets.preferences";

// Private Properties
var preferencesKey,
Expand Down Expand Up @@ -109,14 +109,40 @@ define(function (require, exports, module) {
_reset();
}
}

/**
* This method handles the copy of all old prefs to the new prefs
* TODO: remove All calls to this function and the function itself
*
* @param {!PreferenceStorage} newPrefs The new PreferenceStorage
* @param {!string} oldID The id of the old PreferenceStorage
* @param {?obj} defaults The defaults to add
*/
function handleClientIdChange(newPrefs, oldID, defaults) {
var oldPrefs = getPreferenceStorage(oldID);

defaults = defaults || {};

if (!newPrefs.getValue("newClientID")) {
var data = oldPrefs.getAllValues();

if ($.isEmptyObject(data)) {
data = defaults;
}

newPrefs.setAllValues(data, false);
newPrefs.setValue("newClientID", true);
}
delete prefStorage[oldID];
}

// Check localStorage for a preferencesKey. Production and unit test keys
// are used to keep preferences separate within the same storage implementation.
preferencesKey = localStorage.getItem("preferencesKey");

if (!preferencesKey) {
// use default key if none is found
preferencesKey = PREFERENCES_KEY;
preferencesKey = PREFERENCES_CLIENT_ID;
doLoadPreferences = true;
} else {
// using a non-default key, check for additional settings
Expand All @@ -129,6 +155,7 @@ define(function (require, exports, module) {
// Public API
exports.getPreferenceStorage = getPreferenceStorage;
exports.savePreferences = savePreferences;
exports.handleClientIdChange = handleClientIdChange;

// Unit test use only
exports._reset = _reset;
Expand Down
8 changes: 5 additions & 3 deletions src/project/ProjectManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ define(function (require, exports, module) {
/**
* Unique PreferencesManager clientID
*/
var PREFERENCES_CLIENT_ID = "com.adobe.brackets.ProjectManager";
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id;

/**
* @private
Expand Down Expand Up @@ -1347,8 +1347,10 @@ define(function (require, exports, module) {
var defaults = {
projectPath: _getWelcomeProjectPath() /* initialize to welcome project */
};
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaults);

_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, "com.adobe.brackets.ProjectManager", defaults);

if (!_prefs.getValue("welcomeProjectsFixed")) {
// One-time cleanup of duplicates in the welcome projects list--there used to be a bug where
// we would add lots of duplicate entries here.
Expand Down
7 changes: 4 additions & 3 deletions src/project/WorkingSetSort.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ define(function (require, exports, module) {
AppInit = require("utils/AppInit"),
Strings = require("strings");

var PREFERENCES_CLIENT_ID = "com.adobe.brackets.WorkingSetSort",
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id,
defaultPrefs = {
currentSort: Commands.SORT_WORKINGSET_BY_ADDED,
automaticSort: false
Expand Down Expand Up @@ -349,8 +349,9 @@ define(function (require, exports, module) {


// Initialize PreferenceStorage
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaultPrefs);

_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, "com.adobe.brackets.WorkingSetSort", defaultPrefs);

// Initialize items dependent on extensions/workingSet
AppInit.appReady(function () {
Expand Down
6 changes: 4 additions & 2 deletions src/utils/Resizer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ define(function (require, exports, module) {
PreferencesManager = require("preferences/PreferencesManager"),
EditorManager = require("editor/EditorManager");

var PREFERENCES_CLIENT_ID = module.id,
var PREFERENCES_CLIENT_ID = "com.adobe.brackets." + module.id,
defaultPrefs = { };

/**
Expand Down Expand Up @@ -389,7 +389,9 @@ define(function (require, exports, module) {
}

// Init PreferenceStorage
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID, defaultPrefs);
_prefs = PreferencesManager.getPreferenceStorage(PREFERENCES_CLIENT_ID);
//TODO: Remove preferences migration code
PreferencesManager.handleClientIdChange(_prefs, module.id, defaultPrefs);

// Scan DOM for horz-resizable and vert-resizable classes and make them resizable
AppInit.htmlReady(function () {
Expand Down