mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-16 02:51:50 +00:00
53e4c370ea
Instead, listen to 'select', or to 'transact' on the dm.Document. This commit only fixes uses outside of the dm/ce.Surface ecosystem. ce.Surface still listens to 'change'. ve.init.mw.ViewPageTarget.js: * Rename onSurfaceModelTransact to clearSaveDialogDiff and bind it to the document's transact event instead * Rename onSurfaceModelChange to checkForWikitextWarning and bind it to the surface's transact event. This is needed because the function inspects the surface's selection, which isn't yet in a consistent state when the document's transact event fires ve.ui.MWReferenceDialog.js: * Rename onSurfaceChange to onDocumentTransact and rebind accordingly ve.ce.ProtectedNode.js: * Get rid of onSurfaceModelChange * Instead, bind positionPhantoms to the document's transact event directly, and only bind it while phantoms are visible ve.ui.Context.js: * Rename onChange to onModelSelect and rebind accordingly * Rename afterChange to afterModelSelect * Drop check for undefined selection, no longer needed now that we're listening to a finer-grained event ve.ce.Surface.test.js: * Listen to 'select' instead of 'change' Change-Id: Ifeb1a1fc5427696f2aae5441d4b54dde366793e0
318 lines
8.8 KiB
JavaScript
318 lines
8.8 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable Surface tests.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
QUnit.module( 've.ce.Surface' );
|
|
|
|
/* Tests */
|
|
|
|
ve.test.utils.runSurfaceHandleDeleteTest = function( assert, html, range, operations, expectedData, expectedRange, msg ) {
|
|
var i, args,
|
|
selection,
|
|
deleteArgs = {
|
|
'backspace': [ {}, true ],
|
|
'delete': [ {}, false ],
|
|
'modifiedBackspace': [ { 'ctrlKey': true }, true ],
|
|
'modifiedDelete': [ { 'ctrlKey': true }, false ]
|
|
},
|
|
surface = ve.test.utils.createSurfaceFromHtml( html || ve.dm.example.html ),
|
|
view = surface.getView(),
|
|
model = surface.getModel(),
|
|
data = ve.copy( model.getDocument().getFullData() );
|
|
|
|
// TODO: model.getSelection() should be consistent after it has been
|
|
// changed but appears to behave differently depending on the browser.
|
|
// The selection from the select event is still consistent.
|
|
selection = range;
|
|
model.on( 'select', function( s ) {
|
|
selection = s;
|
|
} );
|
|
|
|
model.change( null, range );
|
|
for ( i = 0; i < operations.length; i++ ) {
|
|
args = deleteArgs[operations[i]];
|
|
view.handleDelete( args[0], args[1] );
|
|
}
|
|
expectedData( data );
|
|
|
|
assert.deepEqualWithDomElements( model.getDocument().getFullData(), data, msg + ': data' );
|
|
assert.deepEqual( selection, expectedRange, msg + ': range' );
|
|
surface.destroy();
|
|
};
|
|
|
|
QUnit.test( 'handleDelete', function ( assert ) {
|
|
var i,
|
|
cases = [
|
|
{
|
|
'range': new ve.Range( 2 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 1 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Character deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 2 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 2, 1 );
|
|
},
|
|
'expectedRange': new ve.Range( 2 ),
|
|
'msg': 'Character deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Selection deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Selection deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 4 ),
|
|
'operations': ['modifiedBackspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Whole word deleted by modified backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1 ),
|
|
'operations': ['modifiedDelete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Whole word deleted by modified delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['delete', 'delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 0, 5 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Empty node deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 41 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function () {},
|
|
'expectedRange': new ve.Range( 39, 41 ),
|
|
'msg': 'Focusable node selected but not deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 39 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function () {},
|
|
'expectedRange': new ve.Range( 39, 41 ),
|
|
'msg': 'Focusable node selected but not deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 39, 41 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 39, 2 );
|
|
},
|
|
'expectedRange': new ve.Range( 39 ),
|
|
'msg': 'Focusable node deleted if selected first'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 2 );
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
ve.test.utils.runSurfaceHandleDeleteTest(
|
|
assert, cases[i].html, cases[i].range, cases[i].operations,
|
|
cases[i].expectedData, cases[i].expectedRange, cases[i].msg
|
|
);
|
|
}
|
|
} );
|
|
|
|
QUnit.test( 'onContentChange', function ( assert ) {
|
|
var i,
|
|
cases = [
|
|
{
|
|
'prevHtml': '<p></p>',
|
|
'prevRange': new ve.Range( 1 ),
|
|
'nextHtml': '<p>A</p>',
|
|
'nextRange': new ve.Range( 2 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 1 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'A' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 3 }
|
|
]
|
|
],
|
|
'msg': 'Simple insertion into empty paragraph'
|
|
},
|
|
{
|
|
'prevHtml': '<p>A</p>',
|
|
'prevRange': new ve.Range( 1, 2 ),
|
|
'nextHtml': '<p>B</p>',
|
|
'nextRange': new ve.Range( 2 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 1 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 4 }
|
|
],
|
|
[
|
|
{ 'type': 'retain', 'length': 2 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [],
|
|
'remove': [ 'A' ]
|
|
},
|
|
{ 'type': 'retain', 'length': 3 }
|
|
]
|
|
],
|
|
'msg': 'Simple replace'
|
|
},
|
|
{
|
|
'prevHtml': '<p><a href="Foo">A</a><a href="Bar">FooX?</a></p>',
|
|
'prevRange': new ve.Range( 5, 6 ),
|
|
'nextHtml': '<p><a href="Foo">A</a><a href="Bar">FooB?</a></p>',
|
|
'nextRange': new ve.Range( 6 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 5 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ ['B', [1]] ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 5 }
|
|
],
|
|
[
|
|
{ 'type': 'retain', 'length': 6 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [],
|
|
'remove': [ ['X', [1]] ]
|
|
},
|
|
{ 'type': 'retain', 'length': 4 }
|
|
]
|
|
],
|
|
'msg': 'Replace into non-zero annotation next to word break'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 2 );
|
|
|
|
function testRunner( prevHtml, prevRange, nextHtml, nextRange, expectedOps, expectedRange, msg ) {
|
|
var txs, i, ops,
|
|
surface = ve.test.utils.createSurfaceFromHtml( prevHtml ),
|
|
view = surface.getView().getDocument().getDocumentNode().children[0],
|
|
prevNode = $( prevHtml )[0],
|
|
nextNode = $( nextHtml )[0],
|
|
prev = {
|
|
'text': ve.ce.getDomText( prevNode ),
|
|
'hash': ve.ce.getDomHash( prevNode ),
|
|
'range': prevRange
|
|
},
|
|
next = {
|
|
'text': ve.ce.getDomText( nextNode ),
|
|
'hash': ve.ce.getDomHash( nextNode ),
|
|
'range': nextRange
|
|
};
|
|
|
|
surface.getView().onContentChange( view, prev, next );
|
|
txs = surface.getModel().getHistory()[0].stack;
|
|
ops = [];
|
|
for ( i = 0; i < txs.length; i++ ) {
|
|
ops.push( txs[i].getOperations() );
|
|
}
|
|
assert.deepEqual( ops, expectedOps, msg + ': operations' );
|
|
assert.deepEqual( surface.getModel().getSelection(), expectedRange, msg + ': range' );
|
|
|
|
surface.destroy();
|
|
}
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
testRunner(
|
|
cases[i].prevHtml, cases[i].prevRange, cases[i].nextHtml, cases[i].nextRange,
|
|
cases[i].expectedOps, cases[i].expectedRange || cases[i].nextRange, cases[i].msg
|
|
);
|
|
}
|
|
|
|
} );
|
|
|
|
/* Methods with return values */
|
|
// TODO: ve.ce.Surface.static.getClipboardHash
|
|
// TODO: ve.ce.Surface#hasSlugAtOffset
|
|
// TODO: ve.ce.Surface#getClickCount
|
|
// TODO: ve.ce.Surface#needsPawn
|
|
// TODO: ve.ce.Surface#getSurface
|
|
// TODO: ve.ce.Surface#getModel
|
|
// TODO: ve.ce.Surface#getDocument
|
|
// TODO: ve.ce.Surface#getFocusedNode
|
|
// TODO: ve.ce.Surface#isRenderingLocked
|
|
// TODO: ve.ce.Surface#getDir
|
|
|
|
/* Methods without return values */
|
|
// TODO: ve.ce.Surface.static.textPattern
|
|
// TODO: ve.ce.Surface#getSelectionRect
|
|
// TODO: ve.ce.Surface#initialize
|
|
// TODO: ve.ce.Surface#enable
|
|
// TODO: ve.ce.Surface#disable
|
|
// TODO: ve.ce.Surface#destroy
|
|
// TODO: ve.ce.Surface#focus
|
|
// TODO: ve.ce.Surface#documentOnFocus
|
|
// TODO: ve.ce.Surface#documentOnBlur
|
|
// TODO: ve.ce.Surface#onDocumentMouseDown
|
|
// TODO: ve.ce.Surface#onDocumentMouseUp
|
|
// TODO: ve.ce.Surface#onDocumentMouseMove
|
|
// TODO: ve.ce.Surface#onDocumentDragOver
|
|
// TODO: ve.ce.Surface#onDocumentDrop
|
|
// TODO: ve.ce.Surface#onDocumentKeyDown
|
|
// TODO: ve.ce.Surface#onDocumentKeyPress
|
|
// TODO: ve.ce.Surface#afterDocumentKeyPress
|
|
// TODO: ve.ce.Surface#onDocumentKeyUp
|
|
// TODO: ve.ce.Surface#onCut
|
|
// TODO: ve.ce.Surface#onCopy
|
|
// TODO: ve.ce.Surface#onPaste
|
|
// TODO: ve.ce.Surface#beforePaste
|
|
// TODO: ve.ce.Surface#afterPaste
|
|
// TODO: ve.ce.Surface#onDocumentCompositionEnd
|
|
// TODO: ve.ce.Surface#onChange
|
|
// TODO: ve.ce.Surface#onSelectionChange
|
|
// TODO: ve.ce.Surface#onLock
|
|
// TODO: ve.ce.Surface#onUnlock
|
|
// TODO: ve.ce.Surface#startRelocation
|
|
// TODO: ve.ce.Surface#endRelocation
|
|
// TODO: ve.ce.Surface#handleLeftOrRightArrowKey
|
|
// TODO: ve.ce.Surface#handleUpOrDownArrowKey
|
|
// TODO: ve.ce.Surface#handleInsertion
|
|
// TODO: ve.ce.Surface#handleEnter
|
|
// TODO: ve.ce.Surface#handleDelete
|
|
// TODO: ve.ce.Surface#showSelection
|
|
// TODO: ve.ce.Surface#replacePhantoms
|
|
// TODO: ve.ce.Surface#replaceHighlight
|
|
// TODO: ve.ce.Surface#getNearestCorrectOffset
|
|
// TODO: ve.ce.Surface#incRenderLock
|
|
// TODO: ve.ce.Surface#decRenderLock
|