wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-15 18:39:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Better name for spec.isParameterKnown() method"

Browse source
This commit is contained in:
jenkins-bot 2021-06-28 10:36:25 +00:00 committed by Gerrit Code Review
parent 426ca299a0 2529d33f51
commit 73c79d74c0
4 changed files with 11 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
View file

@ -167,7 +167,7 @@ ve.dm.MWTemplateModel.prototype.hasParameter = function ( name ) {
} }
// Check if the name is known at all // Check if the name is known at all
if ( !this.spec.isParameterKnown( name ) ) { if ( !this.spec.isKnownParameterOrAlias( name ) ) {
return false; return false;
} }
@ -361,7 +361,7 @@ ve.dm.MWTemplateModel.prototype.serialize = function () {
// …unless they were present before the edit // …unless they were present before the edit
!Object.prototype.hasOwnProperty.call( origParams, name ) && !Object.prototype.hasOwnProperty.call( origParams, name ) &&
// …unless they are required (T276989) // …unless they are required (T276989)
!( spec.isParameterKnown( name ) && spec.isParameterRequired( name ) ) !( spec.isKnownParameterOrAlias( name ) && spec.isParameterRequired( name ) )
) { ) {
continue; continue;
} }

10
modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
View file

@ -178,14 +178,10 @@ ve.dm.MWTemplateSpecModel.prototype.getCanonicalParameterOrder = function () {
}; };
/** /**
* Check if a parameter name is known. * @param {string} name Parameter name or alias
* * @return {boolean}
* Could be a primary name or alias.
*
* @param {string} name Parameter name
* @return {boolean} Parameter name is known
*/ */
ve.dm.MWTemplateSpecModel.prototype.isParameterKnown = function ( name ) { ve.dm.MWTemplateSpecModel.prototype.isKnownParameterOrAlias = function ( name ) {
return this.params[ name ] !== undefined; return this.params[ name ] !== undefined;
}; };

10
modules/ve-mw/tests/dm/models/ve.dm.MWTemplateSpecModel.test.js
View file

@ -30,7 +30,7 @@
assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' ); assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' );
assert.strictEqual( spec.getDescription(), null, 'getDescription' ); assert.strictEqual( spec.getDescription(), null, 'getDescription' );
assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' ); assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' );
assert.strictEqual( spec.isParameterKnown( 'unknown' ), false, 'isParameterKnown' ); assert.strictEqual( spec.isKnownParameterOrAlias( 'unknown' ), false, 'isKnownParameterOrAlias' );
assert.strictEqual( spec.getParameterDefaultValue( 'unknown' ), '', 'getParameterDefaultValue' ); assert.strictEqual( spec.getParameterDefaultValue( 'unknown' ), '', 'getParameterDefaultValue' );
assert.strictEqual( spec.getParameterAutoValue( 'unknown' ), '', 'getParameterAutoValue' ); assert.strictEqual( spec.getParameterAutoValue( 'unknown' ), '', 'getParameterAutoValue' );
assert.deepEqual( spec.getParameterNames(), [], 'getParameterNames' ); assert.deepEqual( spec.getParameterNames(), [], 'getParameterNames' );
@ -45,7 +45,7 @@
assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' ); assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' );
assert.strictEqual( spec.getDescription(), null, 'getDescription' ); assert.strictEqual( spec.getDescription(), null, 'getDescription' );
assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' ); assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' );
assert.strictEqual( spec.isParameterKnown( 'p2' ), true, 'isParameterKnown' ); assert.strictEqual( spec.isKnownParameterOrAlias( 'p2' ), true, 'isKnownParameterOrAlias' );
assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' ); assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' );
assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' ); assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' );
assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' ); assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' );
@ -75,7 +75,7 @@
assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' ); assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' );
assert.strictEqual( spec.getDescription(), null, 'getDescription' ); assert.strictEqual( spec.getDescription(), null, 'getDescription' );
assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' ); assert.deepEqual( spec.getCanonicalParameterOrder(), [], 'getCanonicalParameterOrder' );
assert.strictEqual( spec.isParameterKnown( 'p2' ), true, 'isParameterKnown' ); assert.strictEqual( spec.isKnownParameterOrAlias( 'p2' ), true, 'isKnownParameterOrAlias' );
assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' ); assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' );
assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' ); assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' );
assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' ); assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' );
@ -104,7 +104,7 @@
assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' ); assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' );
assert.strictEqual( spec.getDescription(), undefined, 'getDescription' ); assert.strictEqual( spec.getDescription(), undefined, 'getDescription' );
assert.deepEqual( spec.getCanonicalParameterOrder(), [ 'p2' ], 'getCanonicalParameterOrder' ); assert.deepEqual( spec.getCanonicalParameterOrder(), [ 'p2' ], 'getCanonicalParameterOrder' );
assert.strictEqual( spec.isParameterKnown( 'p2' ), true, 'isParameterKnown' ); assert.strictEqual( spec.isKnownParameterOrAlias( 'p2' ), true, 'isKnownParameterOrAlias' );
assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' ); assert.strictEqual( spec.isParameterAlias( 'p2' ), false, 'isParameterAlias' );
assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' ); assert.strictEqual( spec.getParameterLabel( 'p2' ), 'p2', 'getParameterLabel' );
assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' ); assert.strictEqual( spec.getParameterDescription( 'p2' ), null, 'getParameterDescription' );
@ -153,7 +153,7 @@
assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' ); assert.strictEqual( spec.getLabel(), 'RawTemplateName', 'getLabel' );
assert.strictEqual( spec.getDescription(), 'TemplateDescription', 'getDescription' ); assert.strictEqual( spec.getDescription(), 'TemplateDescription', 'getDescription' );
assert.deepEqual( spec.getCanonicalParameterOrder(), [ 'DummyOrder' ], 'getCanonicalParameterOrder' ); assert.deepEqual( spec.getCanonicalParameterOrder(), [ 'DummyOrder' ], 'getCanonicalParameterOrder' );
assert.strictEqual( spec.isParameterKnown( 'a' ), true, 'isParameterKnown' ); assert.strictEqual( spec.isKnownParameterOrAlias( 'a' ), true, 'isKnownParameterOrAlias' );
assert.strictEqual( spec.isParameterAlias( 'a' ), true, 'isParameterAlias' ); assert.strictEqual( spec.isParameterAlias( 'a' ), true, 'isParameterAlias' );
assert.strictEqual( spec.getParameterLabel( 'a' ), 'ParamLabel', 'getParameterLabel' ); assert.strictEqual( spec.getParameterLabel( 'a' ), 'ParamLabel', 'getParameterLabel' );
assert.strictEqual( spec.getParameterDescription( 'a' ), 'ParamDescription', 'getParameterDescription' ); assert.strictEqual( spec.getParameterDescription( 'a' ), 'ParamDescription', 'getParameterDescription' );

2
modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
View file

@ -89,7 +89,7 @@ ve.ui.MWParameterPlaceholderPage.prototype.onParameterChoose = function ( name )
} }
// Note that every parameter is known after it is added // Note that every parameter is known after it is added
var knownBefore = this.template.getSpec().isParameterKnown( name ), var knownBefore = this.template.getSpec().isKnownParameterOrAlias( name ),
param = new ve.dm.MWParameterModel( this.template, name ); param = new ve.dm.MWParameterModel( this.template, name );
this.addParameterSearch.query.setValue( '' ); this.addParameterSearch.query.setValue( '' );