Merge pull request #7995 from SAPlayer/i18n-extman

dangoor · dangoor · commit 0696a23af135 · 2014-07-21T11:59:40.000-04:00
Support package.json i18n key and show a hint in case the extension is t...
diff --git a/src/extensibility/ExtensionManagerView.js b/src/extensibility/ExtensionManagerView.js
@@ -30,12 +30,10 @@ define(function (require, exports, module) {
     
     var Strings                   = require("strings"),
         StringUtils               = require("utils/StringUtils"),
-        NativeApp                 = require("utils/NativeApp"),
         ExtensionManager          = require("extensibility/ExtensionManager"),
         registry_utils            = require("extensibility/registry_utils"),
         InstallExtensionDialog    = require("extensibility/InstallExtensionDialog"),
-        CommandManager            = require("command/CommandManager"),
-        Commands                  = require("command/Commands"),
+        LocalizationUtils         = require("utils/LocalizationUtils"),
         itemTemplate              = require("text!htmlContent/extension-manager-view-item.html");
     
     /**
@@ -217,6 +215,46 @@ define(function (require, exports, module) {
 
         context.allowInstall = context.isCompatible && !context.isInstalled;
 
+        if (Array.isArray(info.metadata.i18n) && info.metadata.i18n.length > 0) {
+            var lang      = brackets.getLocale(),
+                shortLang = lang.split("-")[0];
+
+            context.translated = true;
+            context.translatedLangs =
+                info.metadata.i18n.map(function (value) {
+                    return { name: LocalizationUtils.getLocalizedLabel(value), locale: value };
+                })
+                .sort(function (lang1, lang2) {
+                    // List users language first
+                    var locales         = [lang1.locale, lang2.locale],
+                        userLangIndex   = locales.indexOf(lang);
+                    if (userLangIndex > -1) {
+                        return userLangIndex;
+                    }
+                    userLangIndex = locales.indexOf(shortLang);
+                    if (userLangIndex > -1) {
+                        return userLangIndex;
+                    }
+
+                    return lang1.name.localeCompare(lang2.name);
+                })
+                .map(function (value) {
+                    return value.name;
+                })
+                .join(", ");
+            context.translatedLangs = StringUtils.format(Strings.EXTENSION_TRANSLATED_LANGS, context.translatedLangs);
+
+            // If the selected language is System Default, match both the short (2-char) language code
+            // and the long one
+            var translatedIntoUserLang =
+                (brackets.isLocaleDefault() && info.metadata.i18n.indexOf(shortLang) > -1) ||
+                info.metadata.i18n.indexOf(lang) > -1;
+            context.extensionTranslated = StringUtils.format(
+                translatedIntoUserLang ? Strings.EXTENSION_TRANSLATED_USER_LANG : Strings.EXTENSION_TRANSLATED_GENERAL,
+                info.metadata.i18n.length
+            );
+        }
+
         var isInstalledInUserFolder = (entry.installInfo && entry.installInfo.locationType === ExtensionManager.LOCATION_USER);
         context.allowRemove = isInstalledInUserFolder;
         context.allowUpdate = context.showUpdateButton && context.isCompatible && context.updateCompatible && isInstalledInUserFolder;
diff --git a/src/extensions/default/DebugCommands/main.js b/src/extensions/default/DebugCommands/main.js
@@ -40,6 +40,7 @@ define(function (require, exports, module) {
         Dialogs                = brackets.getModule("widgets/Dialogs"),
         Strings                = brackets.getModule("strings"),
         PreferencesManager     = brackets.getModule("preferences/PreferencesManager"),
+        LocalizationUtils      = brackets.getModule("utils/LocalizationUtils"),
         ErrorNotification      = require("ErrorNotification"),
         NodeDebugUtils         = require("NodeDebugUtils"),
         PerfDialogTemplate     = require("text!htmlContent/perf-dialog.html"),
@@ -168,16 +169,7 @@ define(function (require, exports, module) {
                     locale = $select.val();
                     $submit.prop("disabled", locale === (curLocale || ""));
                 };
-                
-                // returns the localized label for the given locale
-                // or the locale, if nothing found
-                var getLocalizedLabel = function (locale) {
-                    var key  = "LOCALE_" + locale.toUpperCase().replace("-", "_"),
-                        i18n = Strings[key];
-                    
-                    return i18n === undefined ? locale : i18n;
-                };
-                
+
                 // inspect all children of dirEntry
                 entries.forEach(function (entry) {
                     if (entry.isDirectory) {
@@ -191,12 +183,12 @@ define(function (require, exports, module) {
                                 label += match[2].toUpperCase();
                             }
                             
-                            languages.push({label: getLocalizedLabel(label), language: language});
+                            languages.push({label: LocalizationUtils.getLocalizedLabel(label), language: language});
                         }
                     }
                 });
                 // add English (US), which is the root folder and should be sorted as well
-                languages.push({label: getLocalizedLabel("en"),  language: "en"});
+                languages.push({label: LocalizationUtils.getLocalizedLabel("en"),  language: "en"});
 
                 // sort the languages via their display name
                 languages.sort(function (lang1, lang2) {
diff --git a/src/htmlContent/extension-manager-view-item.html b/src/htmlContent/extension-manager-view-item.html
@@ -41,6 +41,10 @@
             {{/metadata.keywords}}
             </span>
         {{/metadata.keywords.length}}
+        {{#translated}}
+            <br/>
+            <span class="ext-translated" title="{{translatedLangs}}">{{extensionTranslated}}</span>
+        {{/translated}}
     </td>
     <td class="ext-action">
         {{#showInstallButton}}
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
@@ -482,6 +482,9 @@ define({
     "EXTENSION_MORE_INFO"                  : "More info...",
     "EXTENSION_ERROR"                      : "Extension error",
     "EXTENSION_KEYWORDS"                   : "Keywords",
+    "EXTENSION_TRANSLATED_USER_LANG"       : "Translated into {0} languages, including yours",
+    "EXTENSION_TRANSLATED_GENERAL"         : "Translated into {0} languages",
+    "EXTENSION_TRANSLATED_LANGS"           : "This extension has been translated into these languages: {0}",
     "EXTENSION_INSTALLED"                  : "Installed",
     "EXTENSION_UPDATE_INSTALLED"           : "This extension update has been downloaded and will be installed after {APP_NAME} reloads.",
     "EXTENSION_SEARCH_PLACEHOLDER"         : "Search",
diff --git a/src/styles/brackets_patterns_override.less b/src/styles/brackets_patterns_override.less
@@ -975,6 +975,9 @@ a[href^="http"] {
             .ext-keywords {
                 color: @tc-input-placeholder-text;
             }
+            .ext-translated {
+                color: @tc-input-placeholder-text;
+            }
             .muted {
                 color: @tc-input-placeholder-text;
             }
diff --git a/src/utils/LocalizationUtils.js b/src/utils/LocalizationUtils.js
@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2014 Adobe Systems Incorporated. All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+/*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */
+/*global define */
+
+/**
+ *  Utilities functions related to localization/i18n
+ *
+ */
+define(function (require, exports, module) {
+    "use strict";
+
+    var Strings = require("strings");
+
+    /*
+     * Converts a language code to its written name, if possible.
+     * If not possible, the language code is simply returned.
+     *
+     * @param {string} locale   The two-char language code
+     * @return {string} The language's name or the given language code
+     */
+    function getLocalizedLabel(locale) {
+        var key  = "LOCALE_" + locale.toUpperCase().replace("-", "_"),
+            i18n = Strings[key];
+
+        return i18n === undefined ? locale : i18n;
+    }
+
+
+    // Define public API
+    exports.getLocalizedLabel = getLocalizedLabel;
+});
diff --git a/src/utils/StringUtils.js b/src/utils/StringUtils.js
@@ -169,12 +169,12 @@ define(function (require, exports, module) {
     }
     
     /**
-     * Convert number of bytes into human readable format. 
+     * Converts number of bytes into human readable format.
      * If param bytes is negative it returns the number without any changes.
      *
-     * @param number bytes     Number of bytes to convert
-     * @param number precision Number of digits after the decimal separator
-     * @return string
+     * @param {number} bytes     Number of bytes to convert
+     * @param {number} precision Number of digits after the decimal separator
+     * @return {string}
      */
     function prettyPrintBytes(bytes, precision) {
         var kilobyte = 1024,
diff --git a/test/spec/ExtensionManager-test.js b/test/spec/ExtensionManager-test.js
@@ -50,6 +50,7 @@ define(function (require, exports, module) {
         FileSystem                = require("filesystem/FileSystem"),
         Strings                   = require("strings"),
         StringUtils               = require("utils/StringUtils"),
+        LocalizationUtils         = require("utils/LocalizationUtils"),
         mockRegistryText          = require("text!spec/ExtensionManager-test-files/mockRegistry.json"),
         mockRegistryForSearch     = require("text!spec/ExtensionManager-test-files/mockRegistryForSearch.json"),
         mockExtensionList         = require("text!spec/ExtensionManager-test-files/mockExtensionList.json"),
@@ -158,7 +159,6 @@ define(function (require, exports, module) {
         
         describe("ExtensionManager", function () {
             it("should download the extension list from the registry", function () {
-                var registry;
                 runs(function () {
                     waitsForDone(ExtensionManager.downloadRegistry(), "fetching registry");
                 });
@@ -172,7 +172,7 @@ define(function (require, exports, module) {
             });
             
             it("should trigger a registryUpdate event when updating the extension list from the registry", function () {
-                var registry, registryUpdateSpy;
+                var registryUpdateSpy;
                 runs(function () {
                     registryUpdateSpy = jasmine.createSpy();
                     $(ExtensionManager).on("registryUpdate", registryUpdateSpy);
@@ -257,7 +257,6 @@ define(function (require, exports, module) {
             it("should set the title for a legacy extension based on its folder name", function () {
                 mockLoadExtensions();
                 runs(function () {
-                    var mockPath = SpecRunnerUtils.getTestPath("/spec/ExtensionManager-test-files");
                     expect(ExtensionManager.extensions["mock-legacy-extension"].installInfo.metadata.title).toEqual("mock-legacy-extension");
                 });
             });
@@ -267,7 +266,6 @@ define(function (require, exports, module) {
                 runs(function () {
                     expect(ExtensionManager.extensions["mock-extension-1"].installInfo.locationType).toEqual(ExtensionManager.LOCATION_DEFAULT);
                     expect(ExtensionManager.extensions["mock-extension-2"].installInfo.locationType).toEqual(ExtensionManager.LOCATION_DEV);
-                    var mockPath = SpecRunnerUtils.getTestPath("/spec/ExtensionManager-test-files");
                     expect(ExtensionManager.extensions["mock-legacy-extension"].installInfo.locationType).toEqual(ExtensionManager.LOCATION_USER);
                 });
             });
@@ -290,7 +288,6 @@ define(function (require, exports, module) {
                     mockLoadExtensions(["user/mock-legacy-extension"]);
                 });
                 runs(function () {
-                    var mockPath = SpecRunnerUtils.getTestPath("/spec/ExtensionManager-test-files");
                     expect(spy).toHaveBeenCalledWith(jasmine.any(Object), "mock-legacy-extension");
                 });
             });
@@ -708,7 +705,7 @@ define(function (require, exports, module) {
         });
         
         describe("ExtensionManagerView", function () {
-            var testWindow, view, model, fakeLoadDeferred, modelDisposed;
+            var view, model, fakeLoadDeferred, modelDisposed;
             
             // Sets up the view using the normal (mock) ExtensionManager data.
             function setupViewWithMockData(ModelClass) {
@@ -745,6 +742,7 @@ define(function (require, exports, module) {
                     var id = url.match(/fake-repository\.com\/([^\/]+)/)[1];
                     mockLoadExtensions(["user/" + id]);
                 });
+                spyOn(brackets, "getLocale").andReturn("en");
             });
                 
             
@@ -1191,8 +1189,7 @@ define(function (require, exports, module) {
                     mockLoadExtensions(["user/" + id]);
                     setupViewWithMockData(ExtensionManagerViewModel.InstalledViewModel);
                     runs(function () {
-                        var mockPath = SpecRunnerUtils.getTestPath("/spec/ExtensionManager-test-files/user/" + id),
-                            $button = $("button.remove[data-extension-id='" + id + "']", view.$el);
+                        var $button = $("button.remove[data-extension-id='" + id + "']", view.$el);
                         $button.click();
                         expect(ExtensionManager.isMarkedForRemoval(id)).toBe(true);
                     });
@@ -1329,6 +1326,45 @@ define(function (require, exports, module) {
                     });
                 });
 
+                // i18n info
+                it("should show correct i18n info if the extension is translated in user's lang", function () {
+                    var mockInstallInfo = { "mock-extension-4": { installInfo: mockRegistry["mock-extension-4"] } };
+                    mockInstallInfo["mock-extension-4"].installInfo.metadata.i18n = ["zh-cn", "foo", "en"];
+                    ExtensionManager._setExtensions(mockInstallInfo);
+                    setupViewWithMockData(ExtensionManagerViewModel.InstalledViewModel);
+                    runs(function () {
+                        var $extTranslated  = $(".ext-translated", view.$el),
+                            languages       = [LocalizationUtils.getLocalizedLabel("en"), "foo",  LocalizationUtils.getLocalizedLabel("zh-cn")];
+                        expect($extTranslated.length).toBe(1);
+                        expect($extTranslated.text()).toBe(StringUtils.format(Strings.EXTENSION_TRANSLATED_USER_LANG, languages.length));
+                        expect($extTranslated.attr("title")).toBe(StringUtils.format(Strings.EXTENSION_TRANSLATED_LANGS, languages.join(", ")));
+                    });
+                });
+                it("should show correct i18n info if the extension is translated in some other languages", function () {
+                    var mockInstallInfo = { "mock-extension-4": { installInfo: mockRegistry["mock-extension-4"] } };
+                    mockInstallInfo["mock-extension-4"].installInfo.metadata.i18n = ["zh-cn"];
+                    ExtensionManager._setExtensions(mockInstallInfo);
+                    setupViewWithMockData(ExtensionManagerViewModel.InstalledViewModel);
+                    runs(function () {
+                        var $extTranslated  = $(".ext-translated", view.$el),
+                            languages       = [LocalizationUtils.getLocalizedLabel("zh-cn")];
+                        expect($extTranslated.length).toBe(1);
+                        expect($extTranslated.text()).toBe(StringUtils.format(Strings.EXTENSION_TRANSLATED_GENERAL, languages.length));
+                        expect($extTranslated.attr("title")).toBe(StringUtils.format(Strings.EXTENSION_TRANSLATED_LANGS, languages.join(", ")));
+                    });
+                });
+                it("should not show i18n info if the extension isn't translated", function () {
+                    var mockInstallInfo = { "mock-extension-4": { installInfo: mockRegistry["mock-extension-4"] } };
+                    mockInstallInfo["mock-extension-4"].installInfo.metadata.i18n = [];
+                    ExtensionManager._setExtensions(mockInstallInfo);
+                    setupViewWithMockData(ExtensionManagerViewModel.InstalledViewModel);
+                    runs(function () {
+                        var $extTranslated  = $(".ext-translated", view.$el);
+                        expect($extTranslated.length).toBe(0);
+                        expect($extTranslated.attr("title")).toBe(undefined);
+                    });
+                });
+
             });
             
             

Original file line number	Diff line number	Diff line change
`@@ -975,6 +975,9 @@ a[href^="http"] {`
`975`	`975`	`.ext-keywords {`
`976`	`976`	`color: @tc-input-placeholder-text;`
`977`	`977`	`}`
	`978`	`+ .ext-translated {`
	`979`	`+ color: @tc-input-placeholder-text;`
	`980`	`+ }`
`978`	`981`	`.muted {`
`979`	`982`	`color: @tc-input-placeholder-text;`
`980`	`983`	`}`