Merge lp:~adiroiban/launchpad/bug-561586 into lp:launchpad

[Adi Roiban]

Move translation javascript files to lib/lp/translations/javascript.

= Bug 561586 =

Rosetta javascript files should be moved from lib/canonical to lib/lp

== Proposed fix ==

Move javascript files to lib/lp

== Pre-implementation notes ==

None yet.

== Implementation details ==

rockstar suggested on #launchpad-dev to use "var namespace = Y.namespace" for YUI namespace, so I have changed this in all rosetta js files.

After a chat with mars on #launchpad-dev we agreed that it is best to have all javascript inclusion statements in base-layout-macros, rather than putting them in other templates.

I have split the translations.js file into importqueue.js and languages.js.

== Tests ==

The affected code is covered by Windmill tests.

== Demo and Q/A ==

To test the languages filtering in serieslanguage tables, log in with a user that has preferred languages (for admin you will need to add them).
Go to https://translations.launchpad.dev/ubuntu/hoary/ and the table should be filter with the preferred languages. Clicking "Show all languages" should show all languages.

To test the import queue you will need to first add a file in the import queue:
Login as admin and go to
https://translations.launchpad.dev/ubuntu/hoary/+source/evolution/+pots/man/es/+upload
Upload any .po file (you can rename any text file to .po)
The file should be listed an https://translations.launchpad.dev/ubuntu/hoary/+imports
Click the "Needs review"
A popup choose should appear.

= Make lint =

I was not able to run "make lint" on this branch as it is hanging after XmlLint.

[Edwin Grubbs (edwin-grubbs)]

Hi Adi,

This branch looks good.

merge-approved

-Edwin

review: Approve (code)

=== modified file 'lib/lp/app/templates/base-layout-macros.pt'
--- lib/lp/app/templates/base-layout-macros.pt	2010-04-22 17:18:29 +0000
+++ lib/lp/app/templates/base-layout-macros.pt	2010-05-18 20:48:32 +0000
@@ -222,6 +222,10 @@
             tal:attributes="src string:${lp_js}/registry/team.js"></script>
 
     <script type="text/javascript"
+            tal:attributes="src string:${lp_js}/translations/importqueue.js"></script>
+    <script type="text/javascript"
+            tal:attributes="src string:${lp_js}/translations/languages.js"></script>
+    <script type="text/javascript"
             tal:attributes="src string:${lp_js}/translations/pofile.js"></script>
 
   </tal:devmode>

=== added directory 'lib/lp/translations/javascript'
=== renamed file 'lib/canonical/launchpad/javascript/translations/translations.js' => 'lib/lp/translations/javascript/importqueue.js'
--- lib/canonical/launchpad/javascript/translations/translations.js	2009-12-17 16:48:18 +0000
+++ lib/lp/translations/javascript/importqueue.js	2010-05-18 20:48:32 +0000
@@ -1,13 +1,13 @@
 /* Copyright 2009 Canonical Ltd.  This software is licensed under the
  * GNU Affero General Public License version 3 (see the file LICENSE).
  *
- * @module TranslationImportQueue
+ * @module lp.translations.importqueue
  * @requires oop, event, node, widget, plugin, overlay,lazr.choiceedit
  */
 
-YUI.add('translations', function(Y) {
+YUI.add('lp.translations.importqueue', function(Y) {
 
-var translations = Y.namespace('translations');
+var namespace = Y.namespace('lp.translations.importqueue');
 
 /**
  * HTML for the "this entry has error output" icon.  This does not include the
@@ -30,7 +30,7 @@
  */
 var compose_button = function(shown) {
     return base_button +
-        (shown ? 
+        (shown ?
             '<span class="treeExpanded sprite"></span>' :
             '<span class="treeCollapsed sprite"></span>');
 };
@@ -40,8 +40,8 @@
  * rendering) with one in the given state.
  *
  * This removes the entire old button and replaces it with a new one.  That's
- * one sure-fire way of getting rid of the old one's click-event handler, which
- * is otherwise a brittle procedure and at the same time hard to test.
+ * one sure-fire way of getting rid of the old one's click-event handler,
+ * which is otherwise a brittle procedure and at the same time hard to test.
  */
 var alter_button = function(button, shown) {
     var button_field = button.get('parentNode');
@@ -165,15 +165,10 @@
     button_markers.on('click', show_output);
 };
 
-var toggle_node_visibility = function(node, index, list) {
-  node.toggleClass('unseen');
-  node.toggleClass('seen');
-};
-
 /**
  * Set up the import queue page.
  */
-translations.initialize_import_queue_page = function (Y) {
+namespace.initialize_import_queue_page = function (Y) {
     // Show spinner while patching up the page, pre-fetchig the image.
     var spinner_loader = Y.all('#spinner-loader');
     spinner_loader.set('innerHTML', '<img src="/@@/spinner" alt="" />');
@@ -188,37 +183,6 @@
     spinner_loader.set('innerHTML', '');
 };
 
-
-/**
- * Set up the initial visibility for languages in a serieslanguages table.
- */
-translations.initialize_languages_table = function(Y) {
-    Y.all('.not-preferred-language').each(function(node, index, list) {
-        node.addClass('unseen');
-    });
-    Y.all('.preferred-language').each(function(node, index, list) {
-        node.addClass('seen');
-    });
-};
-
-
-/**
- * Toggle visibility for languages in a serieslanguages table.
- */
-translations.toggle_languages_visibility = function(e) {
-    e.preventDefault();
-    Y.all('.not-preferred-language').each(toggle_node_visibility);
-    var toggle_button = e.currentTarget;
-    if (toggle_button.hasClass('all-languages-visible')) {
-      toggle_button.setContent('View all languages');
-      toggle_button.removeClass('all-languages-visible');
-    } else {
-      toggle_button.setContent('View only preferred languages');
-      toggle_button.addClass('all-languages-visible');
-    }
-};
-
-
 }, "0.1", {
     // "oop" and "event" are required to fix known bugs in YUI, which
     // are apparently fixed in a later version.

=== added file 'lib/lp/translations/javascript/languages.js'
--- lib/lp/translations/javascript/languages.js	1970-01-01 00:00:00 +0000
+++ lib/lp/translations/javascript/languages.js	2010-05-18 20:48:32 +0000
@@ -0,0 +1,48 @@
+/* Copyright 2010 Canonical Ltd.  This software is licensed under the
+ * GNU Affero General Public License version 3 (see the file LICENSE).
+ *
+ * @module lp.translations.languages
+ * @requires node
+ */
+
+YUI.add('lp.translations.languages', function(Y) {
+
+var namespace = Y.namespace('lp.translations.languages');
+
+var toggle_node_visibility = function(node, index, list) {
+  node.toggleClass('unseen');
+  node.toggleClass('seen');
+};
+
+/**
+ * Set up the initial visibility for languages in a serieslanguages table.
+ */
+namespace.initialize_languages_table = function(Y) {
+    Y.all('.not-preferred-language').each(function(node, index, list) {
+        node.addClass('unseen');
+    });
+    Y.all('.preferred-language').each(function(node, index, list) {
+        node.addClass('seen');
+    });
+};
+
+
+/**
+ * Toggle visibility for languages in a serieslanguages table.
+ */
+namespace.toggle_languages_visibility = function(e) {
+    e.preventDefault();
+    Y.all('.not-preferred-language').each(toggle_node_visibility);
+    var toggle_button = e.currentTarget;
+    if (toggle_button.hasClass('all-languages-visible')) {
+      toggle_button.setContent('View all languages');
+      toggle_button.removeClass('all-languages-visible');
+    } else {
+      toggle_button.setContent('View only preferred languages');
+      toggle_button.addClass('all-languages-visible');
+    }
+};
+
+
+}, "0.1", {"requires": ["node"]});
+

=== renamed file 'lib/canonical/launchpad/javascript/translations/pofile.js' => 'lib/lp/translations/javascript/pofile.js'
--- lib/canonical/launchpad/javascript/translations/pofile.js	2010-04-23 16:09:20 +0000
+++ lib/lp/translations/javascript/pofile.js	2010-05-18 20:48:32 +0000
@@ -1,13 +1,12 @@
 /** Copyright (c) 2009, Canonical Ltd. All rights reserved.
  *
- * @module lp.pofile
+ * @module lp.translations.pofile
  * @requires anim, cookie, event-key, event, node
  */
 
-YUI.add('lp.pofile', function(Y) {
+YUI.add('lp.translations.pofile', function(Y) {
 
-Y.log('loading lp.pofile');
-var self = Y.namespace('lp.pofile');
+var namespace = Y.namespace('lp.translations.pofile');
 
 /**
  * Function to disable/enable all suggestions as they are marked/unmarked
@@ -515,7 +514,7 @@
 /*
  * Initialize Javascript code for a POFile +translate page.
  */
-self.initializePOFile = function(e) {
+namespace.initializePOFile = function(e) {
     try {
       updateNotificationBox();
     } catch (e) {
@@ -528,7 +527,7 @@
 /*
  * Initialize Javascript code for a TranslationMessage +translate page.
  */
-self.initializeTranslationMessage = function(e) {
+namespace.initializeTranslationMessage = function(e) {
 
     try {
         var fields = translations_order.split(' ');

=== modified file 'lib/lp/translations/templates/pofile-translate.pt'
--- lib/lp/translations/templates/pofile-translate.pt	2010-03-23 00:22:40 +0000
+++ lib/lp/translations/templates/pofile-translate.pt	2010-05-18 20:48:32 +0000
@@ -17,8 +17,8 @@
     <script type="text/javascript">
       registerLaunchpadFunction(insertAllExpansionButtons);
 
-      LPS.use('lp.pofile', function(Y) {
-        Y.on('domready', Y.lp.pofile.initializePOFile);
+      LPS.use('lp.translations.pofile', function(Y) {
+        Y.on('domready', Y.lp.translations.pofile.initializePOFile);
       });
 
     </script>
@@ -98,7 +98,7 @@
         </div>
 
       <!--  Navigation -->
-      <metal:nav-pofile-subpages 
+      <metal:nav-pofile-subpages
         use-macro="context/@@+translations-macros/nav-pofile-subpages" />
 
         <!-- View filter and suggestions from alternative language. -->
@@ -234,7 +234,7 @@
         <tal:status replace="structure context/@@+access" />
         <tal:contributors replace="structure context/@@+contributors" />
       </tal:havepluralforms>
-      <metal:pofile-js-footer 
+      <metal:pofile-js-footer
         use-macro="context/@@+translations-macros/pofile-js-footer" />
     </div>
   </body>

=== modified file 'lib/lp/translations/templates/translation-import-queue-macros.pt'
--- lib/lp/translations/templates/translation-import-queue-macros.pt	2010-02-11 20:52:20 +0000
+++ lib/lp/translations/templates/translation-import-queue-macros.pt	2010-05-18 20:48:32 +0000
@@ -11,16 +11,11 @@
 <body>
   <metal:translation-import-queue define-macro="translation-import-queue-content">
       <script type="text/javascript" tal:content="view/choice_confs_js" />
-      <script
-        type="text/javascript"
-        tal:condition="devmode"
-        tal:attributes="src string:${icingroot}/build/translations/translations.js">
-      </script>
 
       <script type="text/javascript">
-          LPS.use( 'translations', 'event', function(Y) {
+          LPS.use('lp.translations.importqueue', 'event', function(Y) {
               Y.on('domready', function(e) {
-                  Y.translations.initialize_import_queue_page(Y);
+                  Y.lp.translations.importqueue.initialize_import_queue_page(Y);
               });
           });
       </script>
@@ -132,7 +127,7 @@
                 </tr>
                 <tr class="discreet secondary">
                   <td colspan="3">
-                    Uploaded by 
+                    Uploaded by
                     <a tal:replace="structure entry/importer/fmt:link">
                       Mark Shuttleworth
                     </a>
@@ -150,7 +145,7 @@
                   <td colspan="3">
                     <span style="margin-right: 0.5em"
                           tal:condition="entry/import_into/title|nothing" >
-                      Will be imported into 
+                      Will be imported into
                       <a tal:content="entry/import_into/title"
                          tal:attributes="href entry/import_into/fmt:url"
                          >Foo</a>

=== modified file 'lib/lp/translations/templates/translationmessage-translate.pt'
--- lib/lp/translations/templates/translationmessage-translate.pt	2010-03-23 00:22:40 +0000
+++ lib/lp/translations/templates/translationmessage-translate.pt	2010-05-18 20:48:32 +0000
@@ -14,8 +14,8 @@
     }
     </style>
     <script type="text/javascript">
-      LPS.use('node', 'lp.pofile', function(Y) {
-        Y.on('domready', Y.lp.pofile.initializeTranslationMessage);
+      LPS.use('lp.translations.pofile', function(Y) {
+        Y.on('domready', Y.lp.translations.pofile.initializeTranslationMessage);
       });
     </script>
     </div>
@@ -25,7 +25,7 @@
       <tal:havepluralforms condition="view/has_plural_form_information">
 
       <!--  Navigation -->
-      <metal:nav-pofile-subpages 
+      <metal:nav-pofile-subpages
         use-macro="context/@@+translations-macros/nav-pofile-subpages" />
 
         <!-- Alternative suggestions. -->
@@ -86,7 +86,7 @@
           replace="structure view/batchnav/@@+navigation-links-lower" />
       <tal:status replace="structure context/pofile/@@+access" />
       </tal:havepluralforms>
-      <metal:pofile-js-footer 
+      <metal:pofile-js-footer
         use-macro="context/@@+translations-macros/pofile-js-footer" />
     </div>
 

=== modified file 'lib/lp/translations/templates/translations-macros.pt'
--- lib/lp/translations/templates/translations-macros.pt	2010-03-24 18:36:55 +0000
+++ lib/lp/translations/templates/translations-macros.pt	2010-05-18 20:48:32 +0000
@@ -152,14 +152,13 @@
 
 <metal:languages-table-js define-macro="languages-table-js">
       <script type="text/javascript">
-      LPS.use("node", "translations", function(Y) {
+      LPS.use('lp.translations.languages', 'event', function(Y) {
           Y.on("click", function(e) {
-            Y.translations.toggle_languages_visibility(e);
+            Y.lp.translations.languages.toggle_languages_visibility(e);
           }, "#toggle-languages-visibility");
-      });
-      LPS.use( 'translations', 'event', function(Y) {
+
           Y.on('domready', function(e) {
-              Y.translations.initialize_languages_table(Y);
+              Y.lp.translations.languages.initialize_languages_table(Y);
           });
       });
       </script>

=== modified file 'utilities/lp-deps.py'
--- utilities/lp-deps.py	2010-04-29 15:21:05 +0000
+++ utilities/lp-deps.py	2010-05-18 20:48:32 +0000
@@ -21,6 +21,7 @@
 JS_DIRSET = [
     (os.path.join('lib', 'lp', 'code', 'javascript'), 'code'),
     (os.path.join('lib', 'lp', 'registry', 'javascript'), 'registry'),
+    (os.path.join('lib', 'lp', 'translations', 'javascript'), 'translations'),
     ]
 ICING_ROOT = os.path.join(TOP, 'lib', 'canonical', 'launchpad', 'icing')
 ICING_BUILD = os.path.join(ICING_ROOT, 'build')