Page MenuHomeWickedGov Phorge
Files F4133851

ve.dm.InternalList.test.js
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

ve.dm.InternalList.test.js
View Options

'use strict';
/*!
* VisualEditor DataModel Cite-specific InternalList tests.
*
* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
* @license MIT
*/
QUnit.module( 've.dm.InternalList (Cite)', ve.test.utils.newMwEnvironment() );
/**
* @param {QUnit.assert} assert
* @param {Object.<string,ve.dm.InternalListNodeGroup>} actual
* @param {Object.<string,Object.<string,ve.dm.Node[]>>} expected
* @param {string} message
*/
function equalNodeGroups( assert, actual, expected, message ) {
// How groups are ordered doesn't matter as long as they all appear
assert.deepEqual( Object.keys( actual ).sort(), Object.keys( expected ), message );
for ( const group in expected ) {
assert.deepEqual( actual[ group ].keyedNodes, expected[ group ], message );
}
}
/* Tests */
QUnit.test( 'addNode/removeNode', ( assert ) => {
const doc = ve.dm.citeExample.createExampleDocument( 'references' );
let newInternalList = new ve.dm.InternalList( doc );
const referenceNodes = [
doc.getDocumentNode().children[ 0 ].children[ 0 ],
doc.getDocumentNode().children[ 1 ].children[ 1 ],
doc.getDocumentNode().children[ 1 ].children[ 3 ],
doc.getDocumentNode().children[ 1 ].children[ 5 ],
doc.getDocumentNode().children[ 2 ].children[ 0 ],
doc.getDocumentNode().children[ 2 ].children[ 1 ]
];
const expectedNodes = {
'mwReference/': {
'auto/0': [ referenceNodes[ 0 ] ],
'literal/bar': [ referenceNodes[ 1 ], referenceNodes[ 3 ] ],
'literal/:3': [ referenceNodes[ 2 ] ],
'auto/1': [ referenceNodes[ 4 ] ]
},
'mwReference/foo': {
'auto/2': [ referenceNodes[ 5 ] ]
}
};
equalNodeGroups( assert,
doc.internalList.getNodeGroups(),
expectedNodes,
'Document construction populates internal list correctly'
);
referenceNodes.forEach( ( n ) => {
newInternalList.addNode( n.registeredListGroup, n.registeredListKey, n.registeredListIndex, n );
} );
newInternalList.onTransact();
equalNodeGroups( assert,
newInternalList.getNodeGroups(),
expectedNodes,
'Nodes added in order'
);
newInternalList = new ve.dm.InternalList( doc );
referenceNodes.slice().reverse().forEach( ( n ) => {
newInternalList.addNode( n.registeredListGroup, n.registeredListKey, n.registeredListIndex, n );
} );
newInternalList.onTransact();
equalNodeGroups( assert,
newInternalList.getNodeGroups(),
expectedNodes,
'Nodes added in reverse order'
);
assert.deepEqual(
newInternalList.getNodeGroup( 'mwReference/' ).indexOrder,
[ 0, 1, 2, 3 ],
'Nodes appear in original order despite being added in reverse order'
);
const firstUse = referenceNodes[ 1 ];
newInternalList.removeNode( firstUse.registeredListGroup, firstUse.registeredListKey,
firstUse.registeredListIndex, firstUse );
newInternalList.onTransact();
assert.deepEqual(
newInternalList.getNodeGroup( 'mwReference/' ).indexOrder,
[ 0, 2, 1, 3 ],
'Keys re-ordered after one item of key removed'
);
const lastUse = referenceNodes[ 3 ];
newInternalList.removeNode( lastUse.registeredListGroup, lastUse.registeredListKey,
lastUse.registeredListIndex, lastUse );
newInternalList.onTransact();
assert.deepEqual(
Object.keys( newInternalList.getNodeGroup( 'mwReference/' ).keyedNodes ),
[ 'auto/1', 'literal/:3', 'auto/0' ],
'Keys truncated after last item of key removed'
);
// Remove all remaining nodes
[
referenceNodes[ 0 ],
referenceNodes[ 5 ],
referenceNodes[ 4 ],
referenceNodes[ 2 ]
].forEach( ( n ) => {
newInternalList.removeNode( n.registeredListGroup, n.registeredListKey, n.registeredListIndex, n );
} );
newInternalList.onTransact();
assert.deepEqual(
newInternalList.getNodeGroup( 'mwReference/' ).keyedNodes,
{},
'All nodes removed'
);
assert.deepEqual(
newInternalList.getNodeGroup( 'mwReference/foo' ).keyedNodes,
{},
'All nodes removed'
);
} );
QUnit.test( 'getItemInsertion', ( assert ) => {
const doc = ve.dm.citeExample.createExampleDocument( 'references' );
const internalList = doc.getInternalList();
let insertion = internalList.getItemInsertion( 'mwReference/', 'literal/foo', [] );
const index = internalList.getItemNodeCount();
assert.strictEqual( insertion.index, index, 'Insertion creates a new reference' );
assert.deepEqual(
insertion.transaction.getOperations(),
[
{ type: 'retain', length: 91 },
{
type: 'replace',
remove: [],
insert: [
{ type: 'internalItem' },
{ type: '/internalItem' }
]
},
{ type: 'retain', length: 1 }
],
'New reference operations match' );
insertion = internalList.getItemInsertion( 'mwReference/', 'literal/foo', [] );
assert.strictEqual( insertion.index, index, 'Insertion with duplicate key reuses old index' );
assert.strictEqual( insertion.transaction, null, 'Insertion with duplicate key has null transaction' );
} );
QUnit.test( 'getUniqueListKey', ( assert ) => {
const doc = ve.dm.citeExample.createExampleDocument( 'references' );
const internalList = doc.getInternalList();
let generatedName;
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/0', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:0', '0 maps to 0' );
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/1', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:1', '1 maps to 1' );
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/2', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:2', '2 maps to 2' );
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/3', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:4', '3 maps to 4 (because a literal :3 is present)' );
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/4', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:5', '4 maps to 5' );
generatedName = internalList.getUniqueListKey( 'mwReference/', 'auto/0', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:0', 'Reusing a key reuses the name' );
generatedName = internalList.getUniqueListKey( 'mwReference/foo', 'auto/4', 'literal/:' );
assert.strictEqual( generatedName, 'literal/:0', 'Different groups are treated separately' );
} );

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 12:21 (3 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3b/6f/f19a3f578c7caa156909ec8ac4dc
Default Alt Text
ve.dm.InternalList.test.js (6 KB)

Event Timeline