mediawiki-extensions-Visual.../modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
Trevor Parscal 0c3ca665d2 Retain original param names and ignore leading/trailing whitespace
Objectives:

* Trim leading or trailing whitespace that parsoid may have left on
  parameter names
* Preserve the original name for round-tripping cleanliness
* Ignore leading or trailing whitespace when entering new parameter names
  in the parameter search widget
* Consider aliases when listing suggested parameters

Changes:

ve.ui.MWParameterSearchWidget.js
* Use hasParameter method instead of using indexOf - uses map lookup
  internally, which is much faster, and also take aliases into account
* Trim query input value to prevent leading or trailing whitespace from
  being considered when filtering known or creating unknown parameters
* Take aliases into account when showing filtered results

ve.dm.MWTransclusionModel.js
* Use original name when round-tripping

ve.dm.MWTemplateParameterModel.js
* Store original name for round tripping, and trim the original name for
  other uses
* Add getOriginalName method

ve.dm.MWTemplateModel.js
* Add hasParameter method, which currently just does a map lookup, but can
  do other processing in the future

ve.dm.MWTemplateSpecModel.js
* Add isParameterKnown method

Bug: 50715
Bug: 50717
Change-Id: I36a5e93ca8938ac3401a6e274647597704700468
2013-07-10 15:34:36 -07:00

197 lines
4.3 KiB
JavaScript

/*!
* VisualEditor DataModel MWTemplateModel class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki template model.
*
* @class
* @extends ve.dm.MWTransclusionPartModel
*
* @constructor
* @param {ve.dm.MWTransclusionModel} transclusion Transclusion
* @param {Object} target Template target
* @param {string} target.wt Original wikitext of target
* @param {string} [target.href] Hypertext reference to target
*/
ve.dm.MWTemplateModel = function VeDmMWTemplateModel( transclusion, target ) {
// Parent constructor
ve.dm.MWTransclusionPartModel.call( this, transclusion );
// Properties
this.target = target;
this.title = ( target.href && target.href.replace( /^(\.\.?\/)*/, '' ) ) || null;
this.sequence = null;
this.params = {};
this.spec = new ve.dm.MWTemplateSpecModel( this );
};
/* Inheritance */
ve.inheritClass( ve.dm.MWTemplateModel, ve.dm.MWTransclusionPartModel );
/* Events */
/**
* @event add
* @param {ve.dm.MWTemplateParameterModel} param Added param
*/
/**
* @event remove
* @param {ve.dm.MWTemplateParameterModel} param Removed param
*/
/* Methods */
/**
* Get template target.
*
* @method
* @returns {Object} Template target
*/
ve.dm.MWTemplateModel.prototype.getTarget = function () {
return this.target;
};
/**
* Get template title.
*
* @method
* @returns {string|null} Template title, if available
*/
ve.dm.MWTemplateModel.prototype.getTitle = function () {
return this.title;
};
/**
* Get template specification.
*
* @method
* @returns {ve.dm.MWTemplateSpecModel} Template specification
*/
ve.dm.MWTemplateModel.prototype.getSpec = function () {
return this.spec;
};
/**
* Get all params.
*
* @method
* @returns {Object.<string,ve.dm.MWTemplateParameterModel>} Parameters keyed by name
*/
ve.dm.MWTemplateModel.prototype.getParameters = function () {
return this.params;
};
/**
* Get a parameter.
*
* @method
* @param {string} name Parameter name
* @returns {ve.dm.MWTemplateParameterModel} Parameter
*/
ve.dm.MWTemplateModel.prototype.getParameter = function ( name ) {
return this.params[name];
};
/**
* Check if a parameter exists.
*
* @method
* @param {string} name Parameter name
* @returns {boolean} Parameter exists
*/
ve.dm.MWTemplateModel.prototype.hasParameter = function ( name ) {
var i, len, origin, names;
// Check if name (which may be an alias) is present in the template
if ( this.params[name] ) {
return true;
}
// Check if the name is known at all
if ( this.spec.isParameterKnown( name ) ) {
origin = this.spec.getParameterOrigin( name );
// Check for origin name (may be the same as name)
if ( this.params[origin] ) {
return true;
}
// Check for other aliases (may include name)
names = this.spec.getParameterAliases( origin );
for ( i = 0, len = names.length; i < len; i++ ) {
if ( this.params[names[i]] ) {
return true;
}
}
}
return false;
};
/**
* Get ordered list of parameter names.
*
* Numeric names, whether strings or real numbers, are placed at the begining, followed by
* alphabetically sorted names.
*
* @method
* @returns {string[]} List of parameter names
*/
ve.dm.MWTemplateModel.prototype.getParameterNames = function () {
if ( !this.sequence ) {
this.sequence = ve.getObjectKeys( this.params ).sort( function ( a, b ) {
var aIsNaN = isNaN( a ),
bIsNaN = isNaN( b );
if ( aIsNaN && bIsNaN ) {
// Two strings
return a < b ? -1 : a === b ? 0 : 1;
}
if ( aIsNaN ) {
// A is a string
return 1;
}
if ( bIsNaN ) {
// B is a string
return -1;
}
// Two numbers
return a - b;
} );
}
return this.sequence;
};
/**
* Add a parameter to template.
*
* @method
* @param {ve.dm.MWTemplateParameterModel} param Parameter to add
* @emits add
*/
ve.dm.MWTemplateModel.prototype.addParameter = function ( param ) {
var name = param.getName();
this.sequence = null;
this.params[name] = param;
this.spec.fill();
this.emit( 'add', param );
};
/**
* Remove parameter from template.
*
* @method
* @param {ve.dm.MWTemplateParameterModel} param Parameter to remove
* @emits remove
*/
ve.dm.MWTemplateModel.prototype.removeParameter = function ( param ) {
if ( param ) {
this.sequence = null;
delete this.params[param.getName()];
this.emit( 'remove', param );
}
};