From 35970fb460060cab9a3984030241987a86146f09 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Fri, 18 Oct 2013 19:02:59 +0200 Subject: [PATCH] Rename mw.util.wikiGetlink to getUrl Old name still works, but is deprecated. The new one has the nice property of being the same as a function defined on mw.Title which does the same thing. Replaced all occurences throughout the codebase. Bug: 55764 Change-Id: I8704a6620ece44d374e199c05464b8a553e12e74 --- RELEASE-NOTES-1.23 | 2 ++ resources/mediawiki.page/mediawiki.page.watch.ajax.js | 2 +- resources/mediawiki/mediawiki.Title.js | 4 ++-- resources/mediawiki/mediawiki.jqueryMsg.js | 2 +- resources/mediawiki/mediawiki.util.js | 9 ++++++++- .../suites/resources/mediawiki/mediawiki.Title.test.js | 2 +- .../resources/mediawiki/mediawiki.jqueryMsg.test.js | 4 ++-- .../qunit/suites/resources/mediawiki/mediawiki.test.js | 2 +- .../suites/resources/mediawiki/mediawiki.util.test.js | 10 +++++----- 9 files changed, 23 insertions(+), 14 deletions(-) diff --git a/RELEASE-NOTES-1.23 b/RELEASE-NOTES-1.23 index efb0805671..74a5905e28 100644 --- a/RELEASE-NOTES-1.23 +++ b/RELEASE-NOTES-1.23 @@ -48,6 +48,8 @@ changes to languages because of Bugzilla reports. === Other changes in 1.23 === * The global variable $wgArticle has been removed after a lengthy deprecation +* mediawiki.util: mw.util.wikiGetlink has been renamed to getUrl. (The old name still + works, but is deprecated.) == Compatibility == diff --git a/resources/mediawiki.page/mediawiki.page.watch.ajax.js b/resources/mediawiki.page/mediawiki.page.watch.ajax.js index 545cd072d3..e9afa4a2e4 100644 --- a/resources/mediawiki.page/mediawiki.page.watch.ajax.js +++ b/resources/mediawiki.page/mediawiki.page.watch.ajax.js @@ -161,7 +161,7 @@ cleanTitle = title.replace( /_/g, ' ' ); link = mw.html.element( 'a', { - href: mw.util.wikiGetlink( title ), + href: mw.util.getUrl( title ), title: cleanTitle }, cleanTitle ); diff --git a/resources/mediawiki/mediawiki.Title.js b/resources/mediawiki/mediawiki.Title.js index 4a6456678b..dde5abff68 100644 --- a/resources/mediawiki/mediawiki.Title.js +++ b/resources/mediawiki/mediawiki.Title.js @@ -549,11 +549,11 @@ /** * Get the URL to this title * - * @see mw.util#wikiGetlink + * @see mw.util#getUrl * @return {string} */ getUrl: function () { - return mw.util.wikiGetlink( this.toString() ); + return mw.util.getUrl( this.toString() ); }, /** diff --git a/resources/mediawiki/mediawiki.jqueryMsg.js b/resources/mediawiki/mediawiki.jqueryMsg.js index b634917742..70b9be932d 100644 --- a/resources/mediawiki/mediawiki.jqueryMsg.js +++ b/resources/mediawiki/mediawiki.jqueryMsg.js @@ -946,7 +946,7 @@ var page, anchor, url; page = nodes[0]; - url = mw.util.wikiGetlink( page ); + url = mw.util.getUrl( page ); // [[Some Page]] or [[Namespace:Some Page]] if ( nodes.length === 1 ) { diff --git a/resources/mediawiki/mediawiki.util.js b/resources/mediawiki/mediawiki.util.js index 4334a9fbf2..259f1c8d7e 100644 --- a/resources/mediawiki/mediawiki.util.js +++ b/resources/mediawiki/mediawiki.util.js @@ -168,7 +168,7 @@ * e.g. { action: 'edit' }. Optional. * @return {string} Location for a page with name of `str` or boolean false on error. */ - wikiGetlink: function ( str, params ) { + getUrl: function ( str, params ) { var url = mw.config.get( 'wgArticlePath' ).replace( '$1', util.wikiUrlencode( typeof str === 'string' ? str : mw.config.get( 'wgPageName' ) ) ); if ( params && !$.isEmptyObject( params ) ) { @@ -612,6 +612,13 @@ } }; + /** + * @method wikiGetlink + * @inheritdoc #getUrl + * @deprecated since 1.23 Use #getUrl instead. + */ + mw.log.deprecate( util, 'wikiGetlink', util.getUrl, 'Use mw.util.getUrl instead.' ); + mw.util = util; }( mediaWiki, jQuery ) ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js index 13c0efcd80..f0bb0fccc6 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.Title.test.js @@ -324,7 +324,7 @@ mw.config.set( 'wgArticlePath', '/wiki/$1' ); title = new mw.Title( 'Foobar' ); - assert.equal( title.getUrl(), '/wiki/Foobar', 'Basic functionally, toString passing to wikiGetlink' ); + assert.equal( title.getUrl(), '/wiki/Foobar', 'Basic functionally, getUrl uses mw.util.getUrl' ); title = new mw.Title( 'John Doe', 3 ); assert.equal( title.getUrl(), '/wiki/User_talk:John_Doe', 'Escaping in title and namespace for urls' ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js index e0e823d479..be362e22de 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js @@ -585,7 +585,7 @@ QUnit.test( 'HTML', 26, function ( assert ) { assert.htmlEqual( formatParse( 'jquerymsg-italics-with-link' ), - 'An italicized wiki-link', + 'An italicized wiki-link', 'Italics with link inside in parse mode' ); @@ -625,7 +625,7 @@ QUnit.test( 'HTML', 26, function ( assert ) { mw.messages.set( 'jquerymsg-script-link-msg', '' ); assert.htmlEqual( formatParse( 'jquerymsg-script-link-msg' ), - '<script>bar</script>', + '<script>bar</script>', 'Script tag text is escaped because that element is not allowed, but link inside is still HTML' ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.test.js index 502b55b7bd..bd4d1d210e 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.test.js @@ -258,7 +258,7 @@ ); assert.htmlEqual( mw.message( 'mediawiki-italics-with-link' ).parse(), - 'An italicized wiki-link', + 'An italicized wiki-link', 'Italics with link inside in parse mode' ); diff --git a/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js b/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js index 08adb9388e..2be80445f0 100644 --- a/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js +++ b/tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js @@ -17,22 +17,22 @@ assert.equal( mw.util.wikiUrlencode( 'Test:A & B/Here' ), 'Test:A_%26_B/Here' ); } ); - QUnit.test( 'wikiGetlink', 4, function ( assert ) { + QUnit.test( 'getUrl', 4, function ( assert ) { // Not part of startUp module mw.config.set( 'wgArticlePath', '/wiki/$1' ); mw.config.set( 'wgPageName', 'Foobar' ); - var href = mw.util.wikiGetlink( 'Sandbox' ); + var href = mw.util.getUrl( 'Sandbox' ); assert.equal( href, '/wiki/Sandbox', 'Simple title; Get link for "Sandbox"' ); - href = mw.util.wikiGetlink( 'Foo:Sandbox ? 5+5=10 ! (test)/subpage' ); + href = mw.util.getUrl( 'Foo:Sandbox ? 5+5=10 ! (test)/subpage' ); assert.equal( href, '/wiki/Foo:Sandbox_%3F_5%2B5%3D10_%21_%28test%29/subpage', 'Advanced title; Get link for "Foo:Sandbox ? 5+5=10 ! (test)/subpage"' ); - href = mw.util.wikiGetlink(); + href = mw.util.getUrl(); assert.equal( href, '/wiki/Foobar', 'Default title; Get link for current page ("Foobar")' ); - href = mw.util.wikiGetlink( 'Sandbox', { action: 'edit' } ); + href = mw.util.getUrl( 'Sandbox', { action: 'edit' } ); assert.equal( href, '/wiki/Sandbox?action=edit', 'Simple title with query string; Get link for "Sandbox" with action=edit' ); } ); -- 2.20.1