Skip to content

Incremental and hierarchical fallback #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Incremental and hierarchical fallback #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7428237
Change localeSupported to associative array
cdjackson Mar 14, 2015
f6231f1
Add fallback code from @jamescarter-le and fix to pass tests
cdjackson Mar 14, 2015
52e003e
Add hierarchical fallback
cdjackson Mar 14, 2015
70a2764
Merge branch 'master' of https://github.com/doshprompt/angular-locali…
cdjackson May 3, 2015
9a6709b
Resolve merge formatting errors
cdjackson May 3, 2015
beb9ba1
Fixed bug loading files.
cdjackson May 3, 2015
2fdd3b7
Updated fallback tests and added new test cases
cdjackson May 3, 2015
8d40c28
Fix bug with multiple paths in ready. Add test case!
cdjackson May 4, 2015
3cf6af2
Merge branch 'master' of https://github.com/doshprompt/angular-locali…
cdjackson May 15, 2015
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
196 changes: 137 additions & 59 deletions src/localization.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Events', 'ngLocalize.InstalledLanguages'])
.service('locale', function ($injector, $http, $q, $log, $rootScope, $window, localeConf, localeEvents, localeSupported, localeFallbacks) {
var TOKEN_REGEX = new RegExp('^[\\w\\.-]+\\.[\\w\\s\\.-]+\\w(:.*)?$'),

currentLocale,
deferrences,
locales = [],
languageBundles,
deferrences = {},
bundles,
cookieStore;

Expand Down Expand Up @@ -37,14 +38,22 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
return result;
}

function getBundle(tok) {
/**
* Return the bundle for the requested token and language
* @param tok The requested token. The token is split between paths using the point
* @param lang The requested language
* @returns {*} The bundle object if the bundle has been loaded.
* If the bundle is not loaded, returns null
*/
function getBundle(tok, lang) {
var result = null,
path = tok ? tok.split('.') : [],
i;

if (path.length > 1) {
result = bundles;
result = languageBundles[lang];

// Iterate through the bundle tree to find the requested bundle
for (i = 0; i < path.length - 1; i++) {
if (result[path[i]]) {
result = result[path[i]];
Expand All @@ -58,13 +67,23 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
return result;
}

function loadBundle(token) {
/**
* Loads a language bundle from the server.
* @param token The token, including the path and string name (separated by a .)
* Mulitple folders can be separated by a '.' - the last token being the
* filename.
* @param lang The requested localization
*/
function loadBundle(token, lang) {
var path = token ? token.split('.') : '',
root = bundles,
url = localeConf.basePath + '/' + currentLocale,
root = languageBundles[lang],
url = localeConf.basePath + '/' + lang,
i;

// If the path is defined...
if (path.length > 1) {
// Concatenate the path together to form the URL
// Build a tree object where the bundle information will be loaded
for (i = 0; i < path.length - 1; i++) {
if (!root[path[i]]) {
root[path[i]] = {};
Expand All @@ -74,10 +93,12 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
}

if (!root._loading) {
// Remember that we're loading this bundle to stop subsequent calls to the server
root._loading = true;

url += localeConf.fileExtension;

// Request the data from the server
$http.get(url)
.success(function (data) {
var key,
Expand All @@ -96,8 +117,9 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
$rootScope.$broadcast(localeEvents.resourceUpdates);

// If we issued a Promise for this file, resolve it now.
if (deferrences[path]) {
deferrences[path].resolve(path);
var localpath = path + "." + lang;
if (deferrences[localpath]) {
deferrences[localpath].resolve(localpath);
}
})
.error(function (data) {
Expand All @@ -110,28 +132,39 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
}
}

function bundleReady(path) {
/**
* Checks if a bundle has been loaded, and if not, loaded it
* @param path bundle path
* @param locale requested locale
* @returns promise. If the bundle is loaded, the promise is already resolved
*/
function bundleReady(path, locale) {
var bundle,
token;

path = path || localeConf.langFile;
token = path + "._LOOKUP_";

bundle = getBundle(token);
// Get the bundle if it's loaded. Returns null if not loaded
bundle = getBundle(token, locale);

var localepath = path + "." + locale;

if (!deferrences[path]) {
deferrences[path] = $q.defer();
// Create a promise for this bundle
if (!deferrences[localepath]) {
deferrences[localepath] = $q.defer();
}

if (bundle && !bundle._loading) {
deferrences[path].resolve(path);
} else {
if (!bundle) {
loadBundle(token);
}
// The bundle has been loaded, so full-fill our promise
deferrences[localepath].resolve(localepath);
} else if (!bundle) {
// The bundle is not loaded, so load it
loadBundle(token, locale);
}

return deferrences[path].promise;
// Return the promise for the bundle we requested
return deferrences[localepath].promise;
}

function ready(path) {
Expand All @@ -147,16 +180,15 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
throw new Error("locale.ready requires either an Array or comma-separated list.");
}

if (paths.length > 1) {
outstanding = [];
paths.forEach(function (path) {
outstanding.push(bundleReady(path));
outstanding = [];
paths.forEach(function (path) {
// Load all bundles that may be required by the fallback hierarchy
locales.forEach(function(locale) {
outstanding.push(bundleReady(path, locale));
});
deferred = $q.all(outstanding);
} else {
deferred = bundleReady(path);
}
});

deferred = $q.all(outstanding);
return deferred;
}

Expand Down Expand Up @@ -187,7 +219,24 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
}

function getLocalizedString(txt, subs) {
var result = '',
var bundle,
key,
A,
isValidToken = false;

for (var i = 0; i < locales.length; i++) {
var result = getStringForLocale(txt, subs, locales[i]);
if(result != null) {
return result;
}
}

$log.info("[localizationService] Key not found: " + txt);
return "%%KEY_NOT_FOUND%%";
}

function getStringForLocale(txt, subs, locale) {
var result = null,
bundle,
key,
A,
Expand All @@ -199,56 +248,85 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
subs = angular.fromJson(A[1]);
}

// If the token isn't valid, then just return it
isValidToken = isToken(txt);
if (isValidToken) {
if (!angular.isObject(subs)) {
subs = [subs];
}
if (!isValidToken) {
return txt;
}

bundle = getBundle(txt);
if (bundle && !bundle._loading) {
key = getKey(txt);
if (!angular.isObject(subs)) {
subs = [subs];
}

if (bundle[key]) {
result = applySubstitutions(bundle[key], subs);
} else {
$log.info("[localizationService] Key not found: " + txt);
result = "%%KEY_NOT_FOUND%%";
}
} else {
if (!bundle) {
loadBundle(txt);
}
// Load the file
bundle = getBundle(txt, locale);
if (bundle && !bundle._loading) {
key = getKey(txt);

if (bundle[key]) {
return applySubstitutions(bundle[key], subs);
}
} else {
result = txt;
if (!bundle) {
loadBundle(txt, locale);
}
}

return result;
return null;
}

function setLocale(value) {
var lang;
var fall;

if (angular.isString(value)) {
if(!angular.isString(value)) {
lang = localeConf.defaultLocale;
}
else {
value = value.trim();
if (localeSupported.indexOf(value) != -1) {

// Get the fallback first - if it's not valid, then use the default
if(localeSupported[localeFallbacks[value.split('-')[0]]] != null) {
fall = localeFallbacks[value.split('-')[0]];
}
else {
fall = localeConf.defaultLocale;
}

// Check if the requested locale is supported - if not, use the fallback
if(localeSupported[value] != null) {
lang = value;
} else {
lang = localeFallbacks[value.split('-')[0]]
if (angular.isUndefined(lang)) {
lang = localeConf.defaultLocale;
}
}
} else {
lang = localeConf.defaultLocale;
else {
lang = fall;
fall = localeConf.defaultLocale;
}
}

if (languageBundles == null) {
languageBundles = {};
angular.forEach(localeSupported, function(value, key) {
languageBundles[key] = {};
});
}

// If the language has changed, then we need to reset the state
// so we reload files next time
if (lang != currentLocale) {
bundles = {};
deferrences = {};
// Note that we don't reset the deferrences array since the array
// path includes the language, we don't need to reload all locales
currentLocale = lang;

// Create the locales list.
locales = [];
if(lang != localeConf.defaultLocale) {
locales.push(lang);
}
if(fall != localeConf.defaultLocale) {
locales.push(fall);
}
locales.push(localeConf.defaultLocale);

$rootScope.$broadcast(localeEvents.localeChanges, currentLocale);
$rootScope.$broadcast(localeEvents.resourceUpdates);

Expand Down Expand Up @@ -371,4 +449,4 @@ angular.module('ngLocalize', ['ngSanitize', 'ngLocalize.Config', 'ngLocalize.Eve
updateText(elem, attrs.i18nAttr);
});
};
});
});
6 changes: 3 additions & 3 deletions src/localization.langs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
angular.module('ngLocalize.InstalledLanguages', [])
.value('localeSupported', [
'en-US'
])
.value('localeSupported', {
'en-US': "English (United States)"
})
.value('localeFallbacks', {
'en': 'en-US'
});
Loading