bryce/mediawiki-extensions-UniversalLanguageSelector
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Compact links: Execute the compact strategies on need basis"

Browse Source
This commit is contained in:
jenkins-bot
2016-07-11 09:07:31 +00:00
committed by Gerrit Code Review
parent fe7e221363 d109bddf20
commit 29cc89398a
1 changed files with 312 additions and 300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
resources/js/ext.uls.compactlinks.js
View File

@@ -21,22 +21,18 @@
'use strict';
var DEFAULT_LIST_SIZE = 9;
/**
* For the given array, remove duplicates
* Concatenate two arrays, remove duplicates
*
* @param {Array} originalArray
* @return {Array} de-duplicated array
* @param {Array} a First array
* @param {Array} b Second array
* @return {Array} Resulting array
*/
function unique( originalArray ) {
var uniqueArray = [];
$.each( originalArray, function ( i, v ) {
if ( $.inArray( v, uniqueArray ) === -1 ) {
uniqueArray.push( v );
}
} );
return uniqueArray;
function concatWithoutDuplicates( a, b ) {
return a.concat( b.filter( function ( item ) {
return a.indexOf( item ) < 0;
} ) );
}
/**
@@ -53,11 +49,10 @@
this.listSize = 0;
}
CompactInterlanguageList.prototype = {
/**
* Initialize the plugin
*/
init: function () {
CompactInterlanguageList.prototype.init = function () {
var self = this,
max = this.options.max || DEFAULT_LIST_SIZE;
@@ -78,12 +73,12 @@
self.render();
self.listen();
} );
},
};
/**
* Render the compacted interlanguage list and triggers
*/
render: function () {
CompactInterlanguageList.prototype.render = function () {
var language;
for ( language in this.compactList ) {
@@ -91,14 +86,14 @@
}
this.addTrigger();
},
};
/**
* Attaches the actual selector to the trigger.
*
* @param {jQuery} $trigger Element to use as trigger.
*/
createSelector: function ( $trigger ) {
CompactInterlanguageList.prototype.createSelector = function ( $trigger ) {
var languages,
self = this,
dir = $( 'html' ).prop( 'dir' ),
@@ -175,12 +170,12 @@
// Show common languages
quickList: self.getCommonLanguages( languages )
} );
},
};
/**
* Bind to event handlers and listen for events
*/
listen: function () {
CompactInterlanguageList.prototype.listen = function () {
var self = this;
this.$trigger.one( 'click', function () {
@@ -190,14 +185,14 @@
self.$trigger.click();
} );
} );
},
};
/**
* Get the compacted interlanguage list as associative array
*
* @return {Object}
*/
getCompactList: function () {
CompactInterlanguageList.prototype.getCompactList = function () {
var language, languages, compactLanguages, i,
compactedList = {};
@@ -213,7 +208,34 @@
}
return compactedList;
},
};
/**
* Get compacting strategies.
* The items will be executed in the given order till the required
* compact size is achieved. Each item should be an array and should
* take the whole language list as argument.
*
* @return {Function[]} Array of comacting functions
*/
CompactInterlanguageList.prototype.getCompactStrategies = function () {
return [
// Add user-defined assistant languages on wikis with Translate extension.
filterByAssistantLanguages,
// Add previously selected languages.
// Previous languages are always the better suggestion
// because the user has explicitly chosen them.
filterByPreviousLanguages,
// Add all common languages to the beginning of array.
// These are the most probable languages predicted by ULS.
this.getCommonLanguages,
// Some global fallbacks to avoid showing languages in the beginning of the alphabet
getExtraCommonLanguages,
// Finally add the whole languages array too.
// We will remove duplicates and cut down to required size.
this.finalFallback
];
};
/**
* Compact a given array of languages
@@ -221,37 +243,24 @@
* @param {Array} languages
* @return {Array} Compacted array
*/
compact: function ( languages ) {
var compactLanguages = [];
CompactInterlanguageList.prototype.compact = function ( languages ) {
var i, strategies,
compactLanguages = [];
compactLanguages = compactLanguages.concat(
// Add user-defined assistant languages on wikis with Translate extension.
this.filterByAssistantLanguages( languages ),
// Add previously selected languages.
// Previous languages are always the better suggestion
// because the user has explicitly chosen them.
this.filterByPreviousLanguages( languages ),
// Add all common languages to the beginning of array.
// These are the most probable languages predicted by ULS.
this.getCommonLanguages( languages ),
// Some global fallbacks to avoid showing languages in the beginning of the alphabet
this.getExtraCommonLanguages( languages ),
// Finally add the whole languages array too.
// We will remove duplicates and cut down to required size.
languages
strategies = this.getCompactStrategies();
for ( i = 0; i < strategies.length; i++ ) {
compactLanguages = concatWithoutDuplicates(
compactLanguages, strategies[ i ].call( this, languages )
);
// Remove duplicates
compactLanguages = unique( compactLanguages );
// Cut to compact size and sort
compactLanguages = compactLanguages.slice( 0, this.compactSize ).sort();
if ( compactLanguages.length >= this.compactSize ) {
// We have more than enough items. Stop here.
compactLanguages = compactLanguages.slice( 0, this.compactSize );
break;
}
}
return compactLanguages;
},
};
/**
* Filter the language list by previous languages.
@@ -260,13 +269,13 @@
*
* @return {Array} List of language codes supported by the article
*/
filterByPreviousLanguages: function ( languages ) {
function filterByPreviousLanguages( languages ) {
var previousLanguages = mw.uls.getPreviousLanguages();
return $.grep( previousLanguages, function ( language ) {
return $.inArray( language, languages ) >= 0;
} );
},
}
/**
* Filter the language list by common languages.
@@ -274,13 +283,13 @@
*
* @return {Array} List of language codes supported by the article
*/
filterByCommonLanguages: function ( languages ) {
function filterByCommonLanguages( languages ) {
var commonLanguages = mw.uls.getFrequentLanguageList();
return $.grep( commonLanguages, function ( language ) {
return $.inArray( language, languages ) >= 0;
} );
},
}
/**
* Filter the language list by globally common languages, i.e.
@@ -288,7 +297,7 @@
*
* @return {Array} List of language codes supported by the article
*/
getExtraCommonLanguages: function ( languages ) {
function getExtraCommonLanguages( languages ) {
var commonLanguages = [ 'zh', 'en', 'hi', 'ur', 'es', 'ar', 'ru', 'id', 'ms', 'pt',
'fr', 'de', 'bn', 'ja', 'pnb', 'pa', 'jv', 'te', 'ta', 'ko', 'mr', 'tr', 'vi',
'it', 'fa', 'sv', 'nl', 'pl' ];
@@ -296,7 +305,7 @@
return $.grep( commonLanguages, function ( language ) {
return $.inArray( language, languages ) >= 0;
} );
},
}
/**
* Filter the language list by Translate's assistant languages.
@@ -304,7 +313,7 @@
*
* @return {Array} List of those language codes which are supported by article
*/
filterByAssistantLanguages: function ( languages ) {
function filterByAssistantLanguages( languages ) {
var assistantLanguages = mw.user.options.get( 'translate-editlangs' );
if ( assistantLanguages && assistantLanguages !== 'default' ) {
@@ -314,7 +323,7 @@
}
return [];
},
}
/**
* Find out the existing languages supported
@@ -322,7 +331,7 @@
*
* @return {Object} List of existing language codes and their hrefs
*/
getInterlanguageList: function () {
CompactInterlanguageList.prototype.getInterlanguageList = function () {
var interlanguageList = {};
this.$interlanguageList.find( 'li.interlanguage-link > a' ).each( function () {
@@ -338,32 +347,36 @@
} );
return interlanguageList;
},
};
/**
* Get common languages - the most probable languages predicted by ULS.
*
* @param {Array} languages Array of all languages.
*/
getCommonLanguages: function ( languages ) {
CompactInterlanguageList.prototype.getCommonLanguages = function ( languages ) {
if ( this.commonInterlanguageList === null ) {
this.commonInterlanguageList = this.filterByCommonLanguages( languages );
this.commonInterlanguageList = filterByCommonLanguages( languages );
}
return this.commonInterlanguageList;
},
};
CompactInterlanguageList.prototype.finalFallback = function ( languages ) {
return languages;
};
/**
* Hide the original interlanguage list
*/
hideOriginal: function () {
CompactInterlanguageList.prototype.hideOriginal = function () {
this.$interlanguageList.find( '.interlanguage-link' ).css( 'display', 'none' );
},
};
/**
* Add the trigger at the bottom of the language list
*/
addTrigger: function () {
CompactInterlanguageList.prototype.addTrigger = function () {
var $trigger;
$trigger = $( '<button>' )
@@ -376,7 +389,6 @@
this.$interlanguageList.append( $trigger );
this.$trigger = $trigger;
}
};
$( document ).ready( function () {