From 4e926aa58185094ae7e37456823e6edeba8caad2 Mon Sep 17 00:00:00 2001
From: alex
Date: Fri, 1 Feb 2013 12:37:11 +0100
Subject: [PATCH 1/4] reformatted code
---
README.markdown | 325 ++++++++++++++++++-------------------
build/README | 7 -
build/jquery.localize.js | 178 --------------------
builder | 2 -
src/jquery.localize.coffee | 130 ---------------
src/jquery.localize.js | 285 ++++++++++++++++++++++++++++++++
6 files changed, 445 insertions(+), 482 deletions(-)
delete mode 100644 build/README
delete mode 100644 build/jquery.localize.js
delete mode 100755 builder
delete mode 100644 src/jquery.localize.coffee
create mode 100644 src/jquery.localize.js
diff --git a/README.markdown b/README.markdown
index e31065c..c4b4255 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,165 +1,160 @@
-# jquery.localize.js
-
-## a jQuery plugin that makes it easy to i18n your static web site.
-
-## Synopsis
-
-* Lazily loads JSON translation files based on a simple naming convention.
-* By default, applies the translations to your document based on simple attribute convention.
-* Recently updated for jQuery 1.7 (tests use jQuery 1.7.2)
-
-## Basic Usage
-
-## Step 0. Load the jquery-localize plugin on your page.
-
-It's the file located at `build/jquery.localize.js`
-
-## Step 1. Mark up tags whose content you want to be translated
-
-Somewhere in your html:
-
-
Hello!
-
-## Step 2. Provide a JSON language file that has translations:
-
-example-fr.json:
-
- {
- "greeting": "Bonjour!"
- }
-
-## Step 3. Use the localize plugin.
-
- // In a browser where the language is set to French
- $("[data-localize]").localize("example")
-
- // You can also override the language detection, and pass in a language code
- $("[data-localize]").localize("example", { language: "fr" })
-
-# Gory Details
-
-## Language file loading
-
-The first argument of the localize method is the name of the language pack. You might have a different language pack for different parts of your website.
-
-Here's an example of loading several language packs:
-
- $("[data-localize]")
- .localize("header")
- .localize("sidebar")
- .localize("footer")
-
-
-If the language of the browser were set to "fr", then the plugin would try to load:
-
-* header-fr.json
-* sidebar-fr.json
-* footer-fr.json
-
-if the language of the browser also had a country code, like "fr-FR", then the plugin would ALSO try to load:
-
-* header-fr-FR.json
-* sidebar-fr-FR.json
-* footer-fr-FR.json
-
-This let's you define partial language refinements for different regions. For instance, you can have the base language translation file for a language that translates 100 different phrases, and for countries were maybe a some of those phrases would be out of place, you can just provide a country-specific file with _just those special phrases_ defined.
-
-## Skipping Languages (aka Optimizing for My Language)
-
-This is useful if you've got a default language. For example, if all of your content is served in english, then you probably don't want the overhead of loading up unecessary (and probably non-existant) english langauge packs (foo-en.json)
-
-You can tell the localize plugin to always skip certain languages using the skipLanguage option:
-
- # using a string will skip ONLY if the language code matches exactly
- # this would prevent loading only if the language was "en-US"
- $("[data-localize]").localize("example", { skipLanguage: "en-US" })
-
- # using a regex will skip if the regex matches
- # this would prevent loading of any english language translations
- $("[data-localize]").localize("example", { skipLanguage: /^en/ })
-
- # using an array of strings will skip if any of the strings matches exactly
- $("[data-localize]").localize("example", { skipLanguage: ["en", "en-US"] })
-
-## Applying the language file
-
-If you rely on the default callback and use the "data-localize" attribute then the changes will be applied for you.
-
-## Examples:
-
-**HTML:**
-
-
Tracker Pro XT Deluxe
-
Search...
-
Go!
-
Use at your own risk.
-
Dashboard
-
Bug List
-
Logout
-
-**application-es.json (fake spanish)**
-
- {
- "title": "Tracker Pro XT Deluxo",
- "search": {
- "placeholder": "Searcho...",
- "button": "Vamos!"
- },
- "footer": {
- "disclaimer": "Bewaro."
- },
- "menu": {
- "dashboard": "Dashboardo",
- "list": "Bug Listo",
- "logout": "Exito"
- }
- }
-
-**Localize it!**
-
- $("[data-localize]").localize("application", { language: "es" })
-
-## Callbacks
-
-You can provide a callback if you want to augment or replace the default callback provided by the plugin. Your callback should take at least 1 argument: the language data (contents of your json file). It can optionally accept a second argument, which is a reference to the default callback function. This is handy if you still want the default behavior, but also need to do something else with the language data.
-
- $("[data-localize]").localize("application", {
- language: "es",
- callback: function(data, defaultCallback){
- data.title = data.title + currentBugName();
- defaultCallback(data)
- }
- })
-
-See the test/samples for working examples.
-
-# Contributing
-
-This plugin is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/).
-The included `builder` script will run `coffee` with the necessary flags to
-automatically update the compiled javascript in the build/ directory any time you
-save changes to the coffee code under src/.
-
-If you're interested in contributing, please fork the [repository](https://github.com/coderifous/jquery-localize),
-make your changes, and send pull-requests.
-
-Tests use QUnit. Run them by serving from the root of the project and
-navigating to the test/ directory, which has an index.html that takes it from
-there.
-
-Learn more about [how to fork](http://help.github.com/fork-a-repo/) and
-[pull-requests](http://help.github.com/pull-requests/).
-
-# Credits & Licensing
-
-Copyright (c) Jim Garvin (http://github.com/coderifous), 2008.
-
-Dual licensed under the GPL (http://dev.jquery.com/browser/trunk/jquery/GPL-LICENSE.txt) and MIT (http://dev.jquery.com/browser/trunk/jquery/MIT-LICENSE.txt) licenses.
-
-Written by Jim Garvin (@coderifous) for use on LMGTFY.com.
-Please use it, and contribute changes.
-
-http://github.com/coderifous/jquery-localize
-
-Based off of Keith Wood's Localisation jQuery plugin.
-http://keith-wood.name/localisation.html
+# jquery.localize.js
+
+## a jQuery plugin that makes it easy to i18n your static web site.
+
+## Synopsis
+
+* Lazily loads JSON translation files based on a simple naming convention.
+* By default, applies the translations to your document based on simple attribute convention.
+* Recently updated for jQuery 1.7 (tests use jQuery 1.7.2)
+
+## Basic Usage
+
+## Step 0. Load the jquery-localize plugin on your page.
+
+It's the file located at `build/jquery.localize.js`
+
+## Step 1. Mark up tags whose content you want to be translated
+
+Somewhere in your html:
+
+
Hello!
+
+## Step 2. Provide a JSON language file that has translations:
+
+example-fr.json:
+
+ {
+ "greeting": "Bonjour!"
+ }
+
+## Step 3. Use the localize plugin.
+
+ // In a browser where the language is set to French
+ $("[data-localize]").localize("example")
+
+ // You can also override the language detection, and pass in a language code
+ $("[data-localize]").localize("example", { language: "fr" })
+
+# Gory Details
+
+## Language file loading
+
+The first argument of the localize method is the name of the language pack. You might have a different language pack for different parts of your website.
+
+Here's an example of loading several language packs:
+
+ $("[data-localize]")
+ .localize("header")
+ .localize("sidebar")
+ .localize("footer")
+
+
+If the language of the browser were set to "fr", then the plugin would try to load:
+
+* header-fr.json
+* sidebar-fr.json
+* footer-fr.json
+
+if the language of the browser also had a country code, like "fr-FR", then the plugin would ALSO try to load:
+
+* header-fr-FR.json
+* sidebar-fr-FR.json
+* footer-fr-FR.json
+
+This let's you define partial language refinements for different regions. For instance, you can have the base language translation file for a language that translates 100 different phrases, and for countries were maybe a some of those phrases would be out of place, you can just provide a country-specific file with _just those special phrases_ defined.
+
+## Skipping Languages (aka Optimizing for My Language)
+
+This is useful if you've got a default language. For example, if all of your content is served in english, then you probably don't want the overhead of loading up unecessary (and probably non-existant) english langauge packs (foo-en.json)
+
+You can tell the localize plugin to always skip certain languages using the skipLanguage option:
+
+ # using a string will skip ONLY if the language code matches exactly
+ # this would prevent loading only if the language was "en-US"
+ $("[data-localize]").localize("example", { skipLanguage: "en-US" })
+
+ # using a regex will skip if the regex matches
+ # this would prevent loading of any english language translations
+ $("[data-localize]").localize("example", { skipLanguage: /^en/ })
+
+ # using an array of strings will skip if any of the strings matches exactly
+ $("[data-localize]").localize("example", { skipLanguage: ["en", "en-US"] })
+
+## Applying the language file
+
+If you rely on the default callback and use the "data-localize" attribute then the changes will be applied for you.
+
+## Examples:
+
+**HTML:**
+
+
Tracker Pro XT Deluxe
+
Search...
+
Go!
+
Use at your own risk.
+
Dashboard
+
Bug List
+
Logout
+
+**application-es.json (fake spanish)**
+
+ {
+ "title": "Tracker Pro XT Deluxo",
+ "search": {
+ "placeholder": "Searcho...",
+ "button": "Vamos!"
+ },
+ "footer": {
+ "disclaimer": "Bewaro."
+ },
+ "menu": {
+ "dashboard": "Dashboardo",
+ "list": "Bug Listo",
+ "logout": "Exito"
+ }
+ }
+
+**Localize it!**
+
+ $("[data-localize]").localize("application", { language: "es" })
+
+## Callbacks
+
+You can provide a callback if you want to augment or replace the default callback provided by the plugin. Your callback should take at least 1 argument: the language data (contents of your json file). It can optionally accept a second argument, which is a reference to the default callback function. This is handy if you still want the default behavior, but also need to do something else with the language data.
+
+ $("[data-localize]").localize("application", {
+ language: "es",
+ callback: function(data, defaultCallback){
+ data.title = data.title + currentBugName();
+ defaultCallback(data)
+ }
+ })
+
+See the test/samples for working examples.
+
+# Contributing
+
+If you're interested in contributing, please fork the [repository](https://github.com/alexwebgr/jquery-localize),
+make your changes, and send pull-requests.
+
+Tests use QUnit. Run them by serving from the root of the project and
+navigating to the test/ directory, which has an index.html that takes it from
+there.
+
+Learn more about [how to fork](http://help.github.com/fork-a-repo/) and
+[pull-requests](http://help.github.com/pull-requests/).
+
+# Credits & Licensing
+
+Copyright (c) Jim Garvin (http://github.com/coderifous), 2008.
+
+Dual licensed under the GPL (http://dev.jquery.com/browser/trunk/jquery/GPL-LICENSE.txt) and MIT (http://dev.jquery.com/browser/trunk/jquery/MIT-LICENSE.txt) licenses.
+
+Written by Jim Garvin (@coderifous) for use on LMGTFY.com.
+Please use it, and contribute changes.
+
+http://github.com/coderifous/jquery-localize
+
+Based off of Keith Wood's Localisation jQuery plugin.
+http://keith-wood.name/localisation.html
diff --git a/build/README b/build/README
deleted file mode 100644
index f395898..0000000
--- a/build/README
+++ /dev/null
@@ -1,7 +0,0 @@
-Files in this directory are generated.
-
-Do not edit any files in this directory.
-
-These files are only checked in to git for the convenience of people that want
-to use the javascript library without having to download the repository and
-build it on their machine.
diff --git a/build/jquery.localize.js b/build/jquery.localize.js
deleted file mode 100644
index 439c6e2..0000000
--- a/build/jquery.localize.js
+++ /dev/null
@@ -1,178 +0,0 @@
-// Generated by CoffeeScript 1.3.3
-(function() {
- var $, normaliseLang;
-
- $ = jQuery;
-
- normaliseLang = function(lang) {
- lang = lang.replace(/_/, '-').toLowerCase();
- if (lang.length > 3) {
- lang = lang.substring(0, 3) + lang.substring(3).toUpperCase();
- }
- return lang;
- };
-
- $.defaultLanguage = normaliseLang(navigator.language || navigator.userLanguage);
-
- $.localize = function(pkg, options) {
- var defaultCallback, fileExtension, intermediateLangData, jsonCall, lang, loadLanguage, localizeElement, localizeForSpecialKeys, localizeImageElement, localizeInputElement, localizeOptgroupElement, notifyDelegateLanguageLoaded, regexify, setAttrFromValueForKey, setTextFromValueForKey, valueForKey, wrappedSet;
- if (options == null) {
- options = {};
- }
- wrappedSet = this;
- intermediateLangData = {};
- fileExtension = options.fileExtension || "json";
- loadLanguage = function(pkg, lang, level) {
- var file;
- if (level == null) {
- level = 1;
- }
- switch (level) {
- case 1:
- intermediateLangData = {};
- if (options.loadBase) {
- file = pkg + ("." + fileExtension);
- return jsonCall(file, pkg, lang, level);
- } else {
- return loadLanguage(pkg, lang, 2);
- }
- break;
- case 2:
- if (lang.length >= 2) {
- file = "" + pkg + "-" + (lang.substring(0, 2)) + "." + fileExtension;
- return jsonCall(file, pkg, lang, level);
- }
- break;
- case 3:
- if (lang.length >= 5) {
- file = "" + pkg + "-" + (lang.substring(0, 5)) + "." + fileExtension;
- return jsonCall(file, pkg, lang, level);
- }
- }
- };
- jsonCall = function(file, pkg, lang, level) {
- var ajaxOptions, successFunc;
- if (options.pathPrefix != null) {
- file = "" + options.pathPrefix + "/" + file;
- }
- successFunc = function(d) {
- $.extend(intermediateLangData, d);
- notifyDelegateLanguageLoaded(intermediateLangData);
- return loadLanguage(pkg, lang, level + 1);
- };
- ajaxOptions = {
- url: file,
- dataType: "json",
- async: false,
- timeout: options.timeout != null ? options.timeout : 500,
- success: successFunc
- };
- if (window.location.protocol === "file:") {
- ajaxOptions.error = function(xhr) {
- return successFunc($.parseJSON(xhr.responseText));
- };
- }
- return $.ajax(ajaxOptions);
- };
- notifyDelegateLanguageLoaded = function(data) {
- if (options.callback != null) {
- return options.callback(data, defaultCallback);
- } else {
- return defaultCallback(data);
- }
- };
- defaultCallback = function(data) {
- $.localize.data[pkg] = data;
- return wrappedSet.each(function() {
- var elem, key, value;
- elem = $(this);
- key = elem.data("localize");
- key || (key = elem.attr("rel").match(/localize\[(.*?)\]/)[1]);
- value = valueForKey(key, data);
- return localizeElement(elem, key, value);
- });
- };
- localizeElement = function(elem, key, value) {
- if (elem.is('input')) {
- localizeInputElement(elem, key, value);
- } else if (elem.is('img')) {
- localizeImageElement(elem, key, value);
- } else if (elem.is('optgroup')) {
- localizeOptgroupElement(elem, key, value);
- } else if (!$.isPlainObject(value)) {
- elem.html(value);
- }
- if ($.isPlainObject(value)) {
- return localizeForSpecialKeys(elem, value);
- }
- };
- localizeInputElement = function(elem, key, value) {
- if (elem.is("[placeholder]")) {
- return elem.attr("placeholder", value);
- } else {
- return elem.val(value);
- }
- };
- localizeForSpecialKeys = function(elem, value) {
- setAttrFromValueForKey(elem, "title", value);
- return setTextFromValueForKey(elem, "text", value);
- };
- localizeOptgroupElement = function(elem, key, value) {
- return elem.attr("label", value);
- };
- localizeImageElement = function(elem, key, value) {
- setAttrFromValueForKey(elem, "alt", value);
- return setAttrFromValueForKey(elem, "src", value);
- };
- valueForKey = function(key, data) {
- var keys, value, _i, _len;
- keys = key.split(/\./);
- value = data;
- for (_i = 0, _len = keys.length; _i < _len; _i++) {
- key = keys[_i];
- value = value != null ? value[key] : null;
- }
- return value;
- };
- setAttrFromValueForKey = function(elem, key, value) {
- value = valueForKey(key, value);
- if (value != null) {
- return elem.attr(key, value);
- }
- };
- setTextFromValueForKey = function(elem, key, value) {
- value = valueForKey(key, value);
- if (value != null) {
- return elem.text(value);
- }
- };
- regexify = function(string_or_regex_or_array) {
- var thing;
- if (typeof string_or_regex_or_array === "string") {
- return "^" + string_or_regex_or_array + "$";
- } else if (string_or_regex_or_array.length != null) {
- return ((function() {
- var _i, _len, _results;
- _results = [];
- for (_i = 0, _len = string_or_regex_or_array.length; _i < _len; _i++) {
- thing = string_or_regex_or_array[_i];
- _results.push(regexify(thing));
- }
- return _results;
- })()).join("|");
- } else {
- return string_or_regex_or_array;
- }
- };
- lang = normaliseLang(options.language ? options.language : $.defaultLanguage);
- if (!(options.skipLanguage && lang.match(regexify(options.skipLanguage)))) {
- loadLanguage(pkg, lang, 1);
- }
- return wrappedSet;
- };
-
- $.fn.localize = $.localize;
-
- $.localize.data = {};
-
-}).call(this);
diff --git a/builder b/builder
deleted file mode 100755
index 5c0fcc2..0000000
--- a/builder
+++ /dev/null
@@ -1,2 +0,0 @@
-coffee -wco build src/*.coffee &
-coffee -wc test/*.coffee &
diff --git a/src/jquery.localize.coffee b/src/jquery.localize.coffee
deleted file mode 100644
index 7eb5cdf..0000000
--- a/src/jquery.localize.coffee
+++ /dev/null
@@ -1,130 +0,0 @@
-# Copyright (c) Jim Garvin (http://github.com/coderifous), 2008.
-# Dual licensed under the GPL (http://dev.jquery.com/browser/trunk/jquery/GPL-LICENSE.txt) and MIT (http://dev.jquery.com/browser/trunk/jquery/MIT-LICENSE.txt) licenses.
-# Written by Jim Garvin (@coderifous) for use on LMGTFY.com.
-# http://github.com/coderifous/jquery-localize
-# Based off of Keith Wood's Localisation jQuery plugin.
-# http://keith-wood.name/localisation.html
-
-$ = jQuery
-
-# Ensures language code is in the format aa-AA.
-normaliseLang = (lang) ->
- lang = lang.replace(/_/, '-').toLowerCase()
- if lang.length > 3
- lang = lang.substring(0, 3) + lang.substring(3).toUpperCase()
- lang
-
-# Mozilla uses .language, IE uses .userLanguage
-$.defaultLanguage = normaliseLang(navigator.language || navigator.userLanguage)
-
-$.localize = (pkg, options = {}) ->
- wrappedSet = this
- intermediateLangData = {}
- fileExtension = options.fileExtension || "json"
-
- loadLanguage = (pkg, lang, level = 1) ->
- switch level
- when 1
- intermediateLangData = {}
- if options.loadBase
- file = pkg + ".#{fileExtension}"
- jsonCall(file, pkg, lang, level)
- else
- loadLanguage(pkg, lang, 2)
- when 2
- if lang.length >= 2
- file = "#{pkg}-#{lang.substring(0, 2)}.#{fileExtension}"
- jsonCall(file, pkg, lang, level)
- when 3
- if lang.length >= 5
- file = "#{pkg}-#{lang.substring(0, 5)}.#{fileExtension}"
- jsonCall(file, pkg, lang, level)
-
- jsonCall = (file, pkg, lang, level) ->
- file = "#{options.pathPrefix}/#{file}" if options.pathPrefix?
- successFunc = (d) ->
- $.extend(intermediateLangData, d)
- notifyDelegateLanguageLoaded(intermediateLangData)
- loadLanguage(pkg, lang, level + 1)
- ajaxOptions =
- url: file
- dataType: "json"
- async: false
- timeout: if options.timeout? then options.timeout else 500
- success: successFunc
- # hack to work with serving from local file system.
- # local file:// urls won't work in chrome:
- # http://code.google.com/p/chromium/issues/detail?id=40787
- if window.location.protocol == "file:"
- ajaxOptions.error = (xhr) -> successFunc($.parseJSON(xhr.responseText))
- $.ajax(ajaxOptions)
-
- notifyDelegateLanguageLoaded = (data) ->
- if options.callback?
- options.callback(data, defaultCallback)
- else
- defaultCallback(data)
-
- defaultCallback = (data) ->
- $.localize.data[pkg] = data
- wrappedSet.each ->
- elem = $(this)
- key = elem.data("localize")
- key ||= elem.attr("rel").match(/localize\[(.*?)\]/)[1]
- value = valueForKey(key, data)
- localizeElement(elem, key, value)
-
- localizeElement = (elem, key, value) ->
- if elem.is('input') then localizeInputElement(elem, key, value)
- else if elem.is('img') then localizeImageElement(elem, key, value)
- else if elem.is('optgroup') then localizeOptgroupElement(elem, key, value)
- else unless $.isPlainObject(value) then elem.html(value)
- localizeForSpecialKeys(elem, value) if $.isPlainObject(value)
-
- localizeInputElement = (elem, key, value) ->
- if elem.is("[placeholder]")
- elem.attr("placeholder", value)
- else
- elem.val(value)
-
- localizeForSpecialKeys = (elem, value) ->
- setAttrFromValueForKey(elem, "title", value)
- setTextFromValueForKey(elem, "text", value)
-
- localizeOptgroupElement = (elem, key, value) ->
- elem.attr("label", value)
-
- localizeImageElement = (elem, key, value) ->
- setAttrFromValueForKey(elem, "alt", value)
- setAttrFromValueForKey(elem, "src", value)
-
- valueForKey = (key, data) ->
- keys = key.split(/\./)
- value = data
- for key in keys
- value = if value? then value[key] else null
- value
-
- setAttrFromValueForKey = (elem, key, value) ->
- value = valueForKey(key, value)
- elem.attr(key, value) if value?
-
- setTextFromValueForKey = (elem, key, value) ->
- value = valueForKey(key, value)
- elem.text(value) if value?
-
- regexify = (string_or_regex_or_array) ->
- if typeof(string_or_regex_or_array) == "string"
- "^" + string_or_regex_or_array + "$"
- else if string_or_regex_or_array.length?
- (regexify(thing) for thing in string_or_regex_or_array).join("|")
- else
- string_or_regex_or_array
-
- lang = normaliseLang(if options.language then options.language else $.defaultLanguage)
- loadLanguage(pkg, lang, 1) unless (options.skipLanguage && lang.match(regexify(options.skipLanguage)))
-
- wrappedSet
-
-$.fn.localize = $.localize
-$.localize.data = {}
diff --git a/src/jquery.localize.js b/src/jquery.localize.js
new file mode 100644
index 0000000..28fc1aa
--- /dev/null
+++ b/src/jquery.localize.js
@@ -0,0 +1,285 @@
+/**
+ * @url https://github.com/alexwebgr/jquery-localize
+ * @desc simple plugin for localization using data-localize attributes and json files
+ */
+(function ()
+{
+ var $,normaliseLang;
+
+ $ = jQuery;
+
+ normaliseLang = function (lang)
+ {
+ lang = lang.replace(/_/, '-').toLowerCase();
+
+ if (lang.length > 3)
+ lang = lang.substring(0, 3) + lang.substring(3).toUpperCase();
+
+ return lang;
+ };
+
+ $.defaultLanguage = normaliseLang(navigator.language || navigator.userLanguage);
+
+ $.localize = function (pkg, options)
+ {
+ var defaultCallback,
+ fileExtension,
+ intermediateLangData,
+ jsonCall,
+ lang,
+ loadLanguage,
+ localizeElement,
+ localizeForSpecialKeys,
+ localizeImageElement,
+ localizeInputElement,
+ localizeOptgroupElement,
+ notifyDelegateLanguageLoaded,
+ regexify,
+ setAttrFromValueForKey,
+ setTextFromValueForKey,
+ valueForKey,
+ wrappedSet
+ ;
+
+ if (options == null)
+ {
+ options = {};
+ }
+ wrappedSet = this;
+ intermediateLangData = {};
+ fileExtension = options.fileExtension || "json";
+ loadLanguage = function (pkg, lang, level)
+ {
+ var file;
+
+ if (level == null)
+ level = 1;
+
+ switch (level)
+ {
+ case 1:
+ intermediateLangData = {};
+ if (options.loadBase)
+ {
+ file = pkg + ("." + fileExtension);
+
+ return jsonCall(file, pkg, lang, level);
+ }
+ else
+ {
+ return loadLanguage(pkg, lang, 2);
+ }
+ break;
+ case 2:
+ if (lang.length >= 2)
+ {
+ file = "" + pkg + "-" + (lang.substring(0, 2)) + "." + fileExtension;
+
+ return jsonCall(file, pkg, lang, level);
+ }
+ break;
+ case 3:
+ if (lang.length >= 5)
+ {
+ file = "" + pkg + "-" + (lang.substring(0, 5)) + "." + fileExtension;
+
+ return jsonCall(file, pkg, lang, level);
+ }
+ break;
+ }
+ };
+
+ jsonCall = function (file, pkg, lang, level)
+ {
+ var ajaxOptions, successFunc;
+
+ if (options.pathPrefix != null)
+ file = "" + options.pathPrefix + "/" + file;
+
+ successFunc = function (d)
+ {
+ $.extend(intermediateLangData, d);
+ notifyDelegateLanguageLoaded(intermediateLangData);
+
+ return loadLanguage(pkg, lang, level + 1);
+ };
+
+ ajaxOptions =
+ {
+ url:file,
+ dataType:"json",
+ async:false,
+ timeout:options.timeout != null ? options.timeout : 500,
+ success:successFunc
+ };
+
+ if (window.location.protocol === "file:")
+ {
+ ajaxOptions.error = function (xhr)
+ {
+ return successFunc($.parseJSON(xhr.responseText));
+ };
+ }
+
+ return $.ajax(ajaxOptions);
+ };
+
+ notifyDelegateLanguageLoaded = function (data)
+ {
+ if (options.callback != null)
+ return options.callback(data, defaultCallback);
+ else
+ return defaultCallback(data);
+ };
+
+ defaultCallback = function (data)
+ {
+ $.localize.data[pkg] = data;
+
+ return wrappedSet.each(function ()
+ {
+ var elem, key, value;
+
+ elem = $(this);
+ key = elem.data("localize");
+ key || (key = elem.attr("rel").match(/localize\[(.*?)\]/)[1]);
+ value = valueForKey(key, data);
+
+ return localizeElement(elem, key, value);
+ });
+ };
+
+ localizeElement = function (elem, key, value)
+ {
+ if (elem.is('input'))
+ {
+ localizeInputElement(elem, key, value);
+ }
+ else if (elem.is('img'))
+ {
+ localizeImageElement(elem, key, value);
+ }
+ else if (elem.is('optgroup'))
+ {
+ localizeOptgroupElement(elem, key, value);
+ }
+ else if (!$.isPlainObject(value))
+ {
+ elem.html(value);
+ }
+ if ($.isPlainObject(value))
+ {
+ return localizeForSpecialKeys(elem, value);
+ }
+ };
+
+ localizeInputElement = function (elem, key, value)
+ {
+ if (elem.is("[placeholder]"))
+ {
+ return elem.attr("placeholder", value);
+ }
+ else
+ {
+ return elem.val(value);
+ }
+ };
+
+ localizeForSpecialKeys = function (elem, value)
+ {
+ setAttrFromValueForKey(elem, "title", value);
+
+ return setTextFromValueForKey(elem, "text", value);
+ };
+
+ localizeOptgroupElement = function (elem, key, value)
+ {
+ return elem.attr("label", value);
+ };
+
+ localizeImageElement = function (elem, key, value)
+ {
+ setAttrFromValueForKey(elem, "alt", value);
+
+ return setAttrFromValueForKey(elem, "src", value);
+ };
+
+ valueForKey = function (key, data)
+ {
+ var keys, value, _i, _len;
+
+ keys = key.split(/\./);
+ value = data;
+
+ for (_i = 0, _len = keys.length; _i < _len; _i++)
+ {
+ key = keys[_i];
+ value = value != null ? value[key] : null;
+ }
+
+ return value;
+ };
+
+ setAttrFromValueForKey = function (elem, key, value)
+ {
+ value = valueForKey(key, value);
+
+ if (value != null)
+ {
+ return elem.attr(key, value);
+ }
+ };
+
+ setTextFromValueForKey = function (elem, key, value)
+ {
+ value = valueForKey(key, value);
+
+ if (value != null)
+ {
+ return elem.text(value);
+ }
+ };
+
+ regexify = function (string_or_regex_or_array)
+ {
+ var thing;
+
+ if (typeof string_or_regex_or_array === "string")
+ {
+ return "^" + string_or_regex_or_array + "$";
+ }
+ else if (string_or_regex_or_array.length != null)
+ {
+ return ((function ()
+ {
+ var _i, _len, _results;
+
+ _results = [];
+
+ for (_i = 0, _len = string_or_regex_or_array.length; _i < _len; _i++)
+ {
+ thing = string_or_regex_or_array[_i];
+ _results.push(regexify(thing));
+ }
+
+ return _results;
+ })()).join("|");
+ }
+ else
+ {
+ return string_or_regex_or_array;
+ }
+ };
+
+ lang = normaliseLang(options.language ? options.language : $.defaultLanguage);
+
+ if (!(options.skipLanguage && lang.match(regexify(options.skipLanguage))))
+ loadLanguage(pkg, lang, 1);
+
+ return wrappedSet;
+ };
+
+ $.fn.localize = $.localize;
+ $.localize.data = {};
+
+}).call(this);
From 3bd21966f1500da2e536adfc3fc6777afe0f7ff6 Mon Sep 17 00:00:00 2001
From: alex
Date: Fri, 1 Feb 2013 14:41:57 +0100
Subject: [PATCH 2/4] refactored examples
---
README.markdown | 4 +-
src/jquery.localize.js | 57 +-
test/examples/absolute_prefix_path.html | 56 +-
test/examples/basic_usage.html | 72 +-
test/examples/custom_callback_usage.html | 71 +-
test/examples/language_and_country.html | 54 +-
test/examples/skip_language.html | 68 +-
test/index.html | 66 +-
test/lang/custom/test-fo.json | 4 +-
test/lang/test-en-US.json | 4 +-
test/lang/test-en.json | 2 +-
test/lang/test-ja-XX.json | 2 +-
test/lang/test-ja.json | 36 +-
test/localize_test.coffee | 274 +-
test/vendor/qunit.css | 526 ++--
test/vendor/qunit.js | 3052 ++++++++++++----------
16 files changed, 2284 insertions(+), 2064 deletions(-)
diff --git a/README.markdown b/README.markdown
index c4b4255..ed5649b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,6 +1,6 @@
# jquery.localize.js
-## a jQuery plugin that makes it easy to i18n your static web site.
+## a jQuery plugin that makes it easy to localize your static web site.
## Synopsis
@@ -12,7 +12,7 @@
## Step 0. Load the jquery-localize plugin on your page.
-It's the file located at `build/jquery.localize.js`
+It's the file located at `src/jquery.localize.js`
## Step 1. Mark up tags whose content you want to be translated
diff --git a/src/jquery.localize.js b/src/jquery.localize.js
index 28fc1aa..a21daf9 100644
--- a/src/jquery.localize.js
+++ b/src/jquery.localize.js
@@ -4,22 +4,16 @@
*/
(function ()
{
- var $,normaliseLang;
-
+ var $, normaliseLang;
$ = jQuery;
-
normaliseLang = function (lang)
{
lang = lang.replace(/_/, '-').toLowerCase();
-
if (lang.length > 3)
lang = lang.substring(0, 3) + lang.substring(3).toUpperCase();
-
return lang;
};
-
$.defaultLanguage = normaliseLang(navigator.language || navigator.userLanguage);
-
$.localize = function (pkg, options)
{
var defaultCallback,
@@ -40,7 +34,6 @@
valueForKey,
wrappedSet
;
-
if (options == null)
{
options = {};
@@ -51,10 +44,8 @@
loadLanguage = function (pkg, lang, level)
{
var file;
-
if (level == null)
level = 1;
-
switch (level)
{
case 1:
@@ -62,48 +53,40 @@
if (options.loadBase)
{
file = pkg + ("." + fileExtension);
-
return jsonCall(file, pkg, lang, level);
}
else
{
return loadLanguage(pkg, lang, 2);
}
- break;
+ break;
case 2:
if (lang.length >= 2)
{
file = "" + pkg + "-" + (lang.substring(0, 2)) + "." + fileExtension;
-
return jsonCall(file, pkg, lang, level);
}
- break;
+ break;
case 3:
if (lang.length >= 5)
{
file = "" + pkg + "-" + (lang.substring(0, 5)) + "." + fileExtension;
-
return jsonCall(file, pkg, lang, level);
}
- break;
+ break;
}
};
-
jsonCall = function (file, pkg, lang, level)
{
var ajaxOptions, successFunc;
-
if (options.pathPrefix != null)
file = "" + options.pathPrefix + "/" + file;
-
successFunc = function (d)
{
$.extend(intermediateLangData, d);
notifyDelegateLanguageLoaded(intermediateLangData);
-
return loadLanguage(pkg, lang, level + 1);
};
-
ajaxOptions =
{
url:file,
@@ -112,7 +95,6 @@
timeout:options.timeout != null ? options.timeout : 500,
success:successFunc
};
-
if (window.location.protocol === "file:")
{
ajaxOptions.error = function (xhr)
@@ -120,10 +102,8 @@
return successFunc($.parseJSON(xhr.responseText));
};
}
-
return $.ajax(ajaxOptions);
};
-
notifyDelegateLanguageLoaded = function (data)
{
if (options.callback != null)
@@ -131,24 +111,19 @@
else
return defaultCallback(data);
};
-
defaultCallback = function (data)
{
$.localize.data[pkg] = data;
-
return wrappedSet.each(function ()
{
var elem, key, value;
-
elem = $(this);
key = elem.data("localize");
key || (key = elem.attr("rel").match(/localize\[(.*?)\]/)[1]);
value = valueForKey(key, data);
-
return localizeElement(elem, key, value);
});
};
-
localizeElement = function (elem, key, value)
{
if (elem.is('input'))
@@ -172,7 +147,6 @@
return localizeForSpecialKeys(elem, value);
}
};
-
localizeInputElement = function (elem, key, value)
{
if (elem.is("[placeholder]"))
@@ -184,66 +158,51 @@
return elem.val(value);
}
};
-
localizeForSpecialKeys = function (elem, value)
{
setAttrFromValueForKey(elem, "title", value);
-
return setTextFromValueForKey(elem, "text", value);
};
-
localizeOptgroupElement = function (elem, key, value)
{
return elem.attr("label", value);
};
-
localizeImageElement = function (elem, key, value)
{
setAttrFromValueForKey(elem, "alt", value);
-
return setAttrFromValueForKey(elem, "src", value);
};
-
valueForKey = function (key, data)
{
var keys, value, _i, _len;
-
keys = key.split(/\./);
value = data;
-
for (_i = 0, _len = keys.length; _i < _len; _i++)
{
key = keys[_i];
value = value != null ? value[key] : null;
}
-
return value;
};
-
setAttrFromValueForKey = function (elem, key, value)
{
value = valueForKey(key, value);
-
if (value != null)
{
return elem.attr(key, value);
}
};
-
setTextFromValueForKey = function (elem, key, value)
{
value = valueForKey(key, value);
-
if (value != null)
{
return elem.text(value);
}
};
-
regexify = function (string_or_regex_or_array)
{
var thing;
-
if (typeof string_or_regex_or_array === "string")
{
return "^" + string_or_regex_or_array + "$";
@@ -253,15 +212,12 @@
return ((function ()
{
var _i, _len, _results;
-
_results = [];
-
for (_i = 0, _len = string_or_regex_or_array.length; _i < _len; _i++)
{
thing = string_or_regex_or_array[_i];
_results.push(regexify(thing));
}
-
return _results;
})()).join("|");
}
@@ -270,16 +226,11 @@
return string_or_regex_or_array;
}
};
-
lang = normaliseLang(options.language ? options.language : $.defaultLanguage);
-
if (!(options.skipLanguage && lang.match(regexify(options.skipLanguage))))
loadLanguage(pkg, lang, 1);
-
return wrappedSet;
};
-
$.fn.localize = $.localize;
$.localize.data = {};
-
}).call(this);
diff --git a/test/examples/absolute_prefix_path.html b/test/examples/absolute_prefix_path.html
index 7ab02fe..a01d37d 100644
--- a/test/examples/absolute_prefix_path.html
+++ b/test/examples/absolute_prefix_path.html
@@ -1,25 +1,31 @@
-
-
-
-
-
-
- Localize Test
-
-
-
-
-
-
- Ruby image should be round.
-