resources: Drop jquery.localize, deprecated in 1.32
authorJames D. Forrester <jforrester@wikimedia.org>
Wed, 29 Aug 2018 23:34:24 +0000 (16:34 -0700)
committerJames D. Forrester <jforrester@wikimedia.org>
Mon, 29 Oct 2018 22:06:06 +0000 (15:06 -0700)
Change-Id: Iaab8637cd336ab47c789ebcf1d0610695555095f

RELEASE-NOTES-1.33
resources/Resources.php
resources/src/jquery/jquery.localize.js [deleted file]
tests/qunit/QUnitTestResources.php
tests/qunit/suites/resources/jquery/jquery.localize.test.js [deleted file]

index 39e288d..ddccef5 100644 (file)
@@ -95,6 +95,8 @@ because of Phabricator reports.
   the FakeAuthTemplate and LoginForm classes are removed, that FakeAuthTemplate
   is no longer passed into LoginSignupSpecialPage->getFieldDefinitions(), and
   that LoginSignupSpecialPage->getBCFieldDefinitions() is removed.
+* The 'jquery.localize' module, deprecated in 1.32, has been removed. Instead,
+  use 'jquery.i18n'.
 * …
 
 === Deprecations in 1.33 ===
index 86315fc..47e2b3f 100644 (file)
@@ -284,10 +284,6 @@ return [
                'dependencies' => 'mediawiki.String',
                'targets' => [ 'desktop', 'mobile' ],
        ],
-       'jquery.localize' => [
-               'scripts' => 'resources/src/jquery/jquery.localize.js',
-               'deprecated' => 'Please use "jquery.i18n" instead.',
-       ],
        'jquery.makeCollapsible' => [
                'dependencies' => [ 'jquery.makeCollapsible.styles' ],
                'scripts' => 'resources/src/jquery/jquery.makeCollapsible.js',
diff --git a/resources/src/jquery/jquery.localize.js b/resources/src/jquery/jquery.localize.js
deleted file mode 100644 (file)
index ab269f0..0000000
+++ /dev/null
@@ -1,180 +0,0 @@
-/**
- * @class jQuery.plugin.localize
- */
-( function () {
-
-       /**
-        * Gets a localized message, using parameters from options if present.
-        *
-        * @ignore
-        * @param {Object} options
-        * @param {string} key
-        * @return {string} Localized message
-        */
-       function msg( options, key ) {
-               var args = options.params[ key ] || [];
-               // Format: mw.msg( key [, p1, p2, ...] )
-               args.unshift( options.prefix + ( options.keys[ key ] || key ) );
-               return mw.msg.apply( mw, args );
-       }
-
-       /**
-        * Localizes a DOM selection by replacing <html:msg /> elements with localized text and adding
-        * localized title and alt attributes to elements with title-msg and alt-msg attributes
-        * respectively.
-        *
-        * Call on a selection of HTML which contains `<html:msg key="message-key" />` elements or elements
-        * with title-msg="message-key", alt-msg="message-key" or placeholder-msg="message-key" attributes.
-        * `<html:msg />` elements will be replaced with localized text, *-msg attributes will be replaced
-        * with attributes that do not have the "-msg" suffix and contain a localized message.
-        *
-        * Example:
-        *
-        *     // Messages: { 'title': 'Awesome', 'desc': 'Cat doing backflip' 'search' contains 'Search' }
-        *     var html = '\
-        *         <p>\
-        *             <html:msg key="title" />\
-        *             <img src="something.jpg" title-msg="title" alt-msg="desc" />\
-        *             <input type="text" placeholder-msg="search" />\
-        *         </p>';
-        *     $( 'body' ).append( $( html ).localize() );
-        *
-        * Appends something like this to the body...
-        *
-        *     <p>
-        *         Awesome
-        *         <img src="something.jpg" title="Awesome" alt="Cat doing backflip" />
-        *         <input type="text" placeholder="Search" />
-        *     </p>
-        *
-        * Arguments can be passed into uses of a message using the params property of the options object
-        * given to .localize(). Multiple messages can be given parameters, because the params property is
-        * an object keyed by the message key to apply the parameters to, each containing an array of
-        * parameters to use. The limitation is that you can not use different parameters to individual uses
-        * of a message in the same selection being localized - they will all recieve the same parameters.
-        *
-        * Example:
-        *
-        *     // Messages: { 'easy-as': 'Easy as $1 $2 $3.' }
-        *     var html = '<p><html:msg key="easy-as" /></p>';
-        *     $( 'body' ).append( $( html ).localize( { 'params': { 'easy-as': ['a', 'b', 'c'] } } ) );
-        *
-        * Appends something like this to the body...
-        *
-        *     <p>Easy as a, b, c</p>
-        *
-        * Raw HTML content can be used, instead of it being escaped as text. To do this, just use the raw
-        * attribute on a msg element.
-        *
-        * Example:
-        *
-        *     // Messages: { 'hello': '<b><i>Hello</i> $1!</b>' }
-        *     var html = '\
-        *         <p>\
-        *             <!-- escaped: --><html:msg key="hello" />\
-        *             <!-- raw: --><html:msg key="hello" raw />\
-        *         </p>';
-        *     $( 'body' ).append( $( html ).localize( { 'params': { 'hello': ['world'] } } ) );
-        *
-        * Appends something like this to the body...
-        *
-        *     <p>
-        *         <!-- escaped: -->&lt;b&gt;&lt;i&gt;Hello&lt;/i&gt; world!&lt;/b&gt;
-        *         <!-- raw: --><b><i>Hello</i> world!</b>
-        *     </p>
-        *
-        * Message keys can also be remapped, allowing the same generic template to be used with a variety
-        * of messages. This is important for improving re-usability of templates.
-        *
-        * Example:
-        *
-        *     // Messages: { 'good-afternoon': 'Good afternoon' }
-        *     var html = '<p><html:msg key="greeting" /></p>';
-        *     $( 'body' ).append( $( html ).localize( { 'keys': { 'greeting': 'good-afternoon' } } ) );
-        *
-        * Appends something like this to the body...
-        *
-        *     <p>Good afternoon</p>
-        *
-        * Message keys can also be prefixed globally, which is handy when writing extensions, where by
-        * convention all messages are prefixed with the extension's name.
-        *
-        * Example:
-        *
-        *     // Messages: { 'teleportation-warning': 'You may not get there all in one piece.' }
-        *     var html = '<p><html:msg key="warning" /></p>';
-        *     $( 'body' ).append( $( html ).localize( { 'prefix': 'teleportation-' } ) );
-        *
-        * Appends something like this to the body...
-        *
-        *     <p>You may not get there all in one piece.</p>
-        *
-        * @param {Object} options Map of options to be used while localizing
-        * @param {string} options.prefix String to prepend to all message keys
-        * @param {Object} options.keys Message key aliases, used for remapping keys to a template
-        * @param {Object} options.params Lists of parameters to use with certain message keys
-        * @return {jQuery}
-        * @chainable
-        */
-       $.fn.localize = function ( options ) {
-               var $target = this,
-                       attributes = [ 'title', 'alt', 'placeholder' ];
-
-               // Extend options
-               options = $.extend( {
-                       prefix: '',
-                       keys: {},
-                       params: {}
-               }, options );
-
-               // Elements
-               // Ok, so here's the story on this selector. In IE 6/7, searching for 'msg' turns up the
-               // 'html:msg', but searching for 'html:msg' doesn't. In later IE and other browsers, searching
-               // for 'html:msg' turns up the 'html:msg', but searching for 'msg' doesn't. So searching for
-               // both 'msg' and 'html:msg' seems to get the job done. This feels pretty icky, though.
-               $target.find( 'msg,html\\:msg' ).each( function () {
-                       var $el = $( this );
-                       // Escape by default
-                       if ( $el.attr( 'raw' ) ) {
-                               $el.html( msg( options, $el.attr( 'key' ) ) );
-                       } else {
-                               $el.text( msg( options, $el.attr( 'key' ) ) );
-                       }
-                       // Remove wrapper
-                       $el.replaceWith( $el.html() );
-               } );
-
-               // Attributes
-               // Note: there's no way to prevent escaping of values being injected into attributes, this is
-               // on purpose, not a design flaw.
-               attributes.forEach( function ( attr ) {
-                       var msgAttr = attr + '-msg';
-                       $target.find( '[' + msgAttr + ']' ).each( function () {
-                               var $el = $( this );
-                               $el.attr( attr, msg( options, $el.attr( msgAttr ) ) ).removeAttr( msgAttr );
-                       } );
-               } );
-
-               // HTML, Text for elements which cannot have children e.g. OPTION
-               $target.find( '[data-msg-text]' ).each( function () {
-                       var $el = $( this );
-                       $el.text( msg( options, $el.attr( 'data-msg-text' ) ) );
-               } );
-
-               $target.find( '[data-msg-html]' ).each( function () {
-                       var $el = $( this );
-                       $el.html( msg( options, $el.attr( 'data-msg-html' ) ) );
-               } );
-
-               return $target;
-       };
-
-       // Let IE know about the msg tag before it's used...
-       document.createElement( 'msg' );
-
-       /**
-        * @class jQuery
-        * @mixins jQuery.plugin.localize
-        */
-
-}() );
index 6c8923d..d6ede4f 100644 (file)
@@ -44,7 +44,6 @@ return [
                        'tests/qunit/suites/resources/jquery/jquery.hidpi.test.js',
                        'tests/qunit/suites/resources/jquery/jquery.highlightText.test.js',
                        'tests/qunit/suites/resources/jquery/jquery.lengthLimit.test.js',
-                       'tests/qunit/suites/resources/jquery/jquery.localize.test.js',
                        'tests/qunit/suites/resources/jquery/jquery.makeCollapsible.test.js',
                        'tests/qunit/suites/resources/jquery/jquery.tabIndex.test.js',
                        'tests/qunit/suites/resources/jquery/jquery.tablesorter.test.js',
@@ -105,7 +104,6 @@ return [
                        'jquery.hidpi',
                        'jquery.highlightText',
                        'jquery.lengthLimit',
-                       'jquery.localize',
                        'jquery.makeCollapsible',
                        'jquery.tabIndex',
                        'jquery.tablesorter',
diff --git a/tests/qunit/suites/resources/jquery/jquery.localize.test.js b/tests/qunit/suites/resources/jquery/jquery.localize.test.js
deleted file mode 100644 (file)
index c88768d..0000000
+++ /dev/null
@@ -1,135 +0,0 @@
-( function () {
-       QUnit.module( 'jquery.localize', QUnit.newMwEnvironment() );
-
-       QUnit.test( 'Handle basic replacements', function ( assert ) {
-               var html, $lc;
-               mw.messages.set( 'basic', 'Basic stuff' );
-
-               // Tag: html:msg
-               html = '<div><span><html:msg key="basic" /></span></div>';
-               $lc = $( html ).localize().find( 'span' );
-
-               assert.strictEqual( $lc.text(), 'Basic stuff', 'Tag: html:msg' );
-
-               // Attribute: title-msg
-               html = '<div><span title-msg="basic"></span></div>';
-               $lc = $( html ).localize().find( 'span' );
-
-               assert.strictEqual( $lc.attr( 'title' ), 'Basic stuff', 'Attribute: title-msg' );
-
-               // Attribute: alt-msg
-               html = '<div><span alt-msg="basic"></span></div>';
-               $lc = $( html ).localize().find( 'span' );
-
-               assert.strictEqual( $lc.attr( 'alt' ), 'Basic stuff', 'Attribute: alt-msg' );
-
-               // Attribute: placeholder-msg
-               html = '<div><input placeholder-msg="basic" /></div>';
-               $lc = $( html ).localize().find( 'input' );
-
-               assert.strictEqual( $lc.attr( 'placeholder' ), 'Basic stuff', 'Attribute: placeholder-msg' );
-       } );
-
-       QUnit.test( 'Proper escaping', function ( assert ) {
-               var html, $lc;
-               mw.messages.set( 'properfoo', '<proper esc="test">' );
-
-               // This is handled by jQuery inside $.fn.localize, just a simple sanity checked
-               // making sure it is actually using text() and attr() (or something with the same effect)
-
-               // Text escaping
-               html = '<div><span><html:msg key="properfoo" /></span></div>';
-               $lc = $( html ).localize().find( 'span' );
-
-               assert.strictEqual( $lc.text(), mw.msg( 'properfoo' ), 'Content is inserted as text, not as html.' );
-
-               // Attribute escaping
-               html = '<div><span title-msg="properfoo"></span></div>';
-               $lc = $( html ).localize().find( 'span' );
-
-               assert.strictEqual( $lc.attr( 'title' ), mw.msg( 'properfoo' ), 'Attributes are not inserted raw.' );
-       } );
-
-       QUnit.test( 'Options', function ( assert ) {
-               var html, $lc, x, sitename = 'Wikipedia';
-               mw.messages.set( {
-                       'foo-lorem': 'Lorem',
-                       'foo-ipsum': 'Ipsum',
-                       'foo-bar-title': 'Read more about bars',
-                       'foo-bar-label': 'The Bars',
-                       'foo-bazz-title': 'Read more about bazz at $1 (last modified: $2)',
-                       'foo-bazz-label': 'The Bazz ($1)',
-                       'foo-welcome': 'Welcome to $1! (last visit: $2)'
-               } );
-
-               // Message key prefix
-               html = '<div><span title-msg="lorem"><html:msg key="ipsum" /></span></div>';
-               $lc = $( html ).localize( {
-                       prefix: 'foo-'
-               } ).find( 'span' );
-
-               assert.strictEqual( $lc.attr( 'title' ), 'Lorem', 'Message key prefix - attr' );
-               assert.strictEqual( $lc.text(), 'Ipsum', 'Message key prefix - text' );
-
-               // Variable keys mapping
-               x = 'bar';
-               html = '<div><span title-msg="title"><html:msg key="label" /></span></div>';
-               $lc = $( html ).localize( {
-                       keys: {
-                               title: 'foo-' + x + '-title',
-                               label: 'foo-' + x + '-label'
-                       }
-               } ).find( 'span' );
-
-               assert.strictEqual( $lc.attr( 'title' ), 'Read more about bars', 'Variable keys mapping - attr' );
-               assert.strictEqual( $lc.text(), 'The Bars', 'Variable keys mapping - text' );
-
-               // Passing parameteters to mw.msg
-               html = '<div><span><html:msg key="foo-welcome" /></span></div>';
-               $lc = $( html ).localize( {
-                       params: {
-                               'foo-welcome': [ sitename, 'yesterday' ]
-                       }
-               } ).find( 'span' );
-
-               assert.strictEqual( $lc.text(), 'Welcome to Wikipedia! (last visit: yesterday)', 'Passing parameteters to mw.msg' );
-
-               // Combination of options prefix, params and keys
-               x = 'bazz';
-               html = '<div><span title-msg="title"><html:msg key="label" /></span></div>';
-               $lc = $( html ).localize( {
-                       prefix: 'foo-',
-                       keys: {
-                               title: x + '-title',
-                               label: x + '-label'
-                       },
-                       params: {
-                               title: [ sitename, '3 minutes ago' ],
-                               label: [ sitename, '3 minutes ago' ]
-
-                       }
-               } ).find( 'span' );
-
-               assert.strictEqual( $lc.text(), 'The Bazz (Wikipedia)', 'Combination of options prefix, params and keys - text' );
-               assert.strictEqual( $lc.attr( 'title' ), 'Read more about bazz at Wikipedia (last modified: 3 minutes ago)', 'Combination of options prefix, params and keys - attr' );
-       } );
-
-       QUnit.test( 'Handle data text', function ( assert ) {
-               var html, $lc;
-               mw.messages.set( 'option-one', 'Item 1' );
-               mw.messages.set( 'option-two', 'Item 2' );
-               html = '<select><option data-msg-text="option-one"></option><option data-msg-text="option-two"></option></select>';
-               $lc = $( html ).localize().find( 'option' );
-               assert.strictEqual( $lc.eq( 0 ).text(), mw.msg( 'option-one' ), 'data-msg-text becomes text of options' );
-               assert.strictEqual( $lc.eq( 1 ).text(), mw.msg( 'option-two' ), 'data-msg-text becomes text of options' );
-       } );
-
-       QUnit.test( 'Handle data html', function ( assert ) {
-               var html, $lc;
-               mw.messages.set( 'html', 'behold... there is a <a>link</a> here!!' );
-               html = '<div><div data-msg-html="html"></div></div>';
-               $lc = $( html ).localize().find( 'a' );
-               assert.strictEqual( $lc.length, 1, 'link is created' );
-               assert.strictEqual( $lc.text(), 'link', 'the link text got added' );
-       } );
-}() );