wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-12-01 17:36:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Visual.../modules/ve-mw/test/dm/ve.dm.Transaction.test.js

189 lines
6.2 KiB
JavaScript
Raw Normal View History

Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
/*!
Consistency in DM MW test naming and comments Move MWConverter to Converter and fix some comments. Change-Id: I8b73d064c890e9cdae61f8118b092e5041febaa5
2014-03-03 14:10:06 +00:00
* VisualEditor DataModel MediaWiki-specific Transaction tests.
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
*
Bump copyright like it's 2014 Change-Id: Ic469ebda2c061dc7da0b4c1625f43a7be55da4fa
2014-01-05 12:05:05 +00:00
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
* @license The MIT License (MIT); see LICENSE.txt
*/
QUnit.module( 've.dm.Transaction' );
build: Update jscs and use new "wikimedia" preset Our coding style has been upstreamed and first released in node-jscs v1.5.0 (grunt-jscs-checker v0.6.0). Change-Id: Ifc0cfc7177946b9d11407f60e38b0177883724c5
2014-06-26 10:41:18 +00:00
// FIXME: Duplicates test runner; should be using a data provider
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
QUnit.test( 'newFromDocumentInsertion with references', function ( assert ) {
var i, j, doc2, tx, actualStoreItems, expectedStoreItems, removalOps, doc,
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
complexDoc = ve.dm.mwExample.createExampleDocument( 'complexInternalData' ),
comment = { 'type': 'alienMeta', 'attributes': { 'domElements': $( '<!-- hello -->' ).get() } },
withReference = [
{ 'type': 'paragraph' },
'B', 'a', 'r',
{ 'type': 'mwReference', 'attributes': {
'mw': {},
'about': '#mwt4',
'listIndex': 0,
'listGroup': 'mwReference/',
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
'listKey': 'auto/0',
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'refGroup': '',
'contentsUsed': true
} },
{ 'type': '/mwReference' },
{ 'type': '/paragraph' },
{ 'type': 'internalList' },
{ 'type': 'internalItem' },
{ 'type': 'paragraph', 'internal': { 'generated': 'wrapper' } },
'B',
'a',
'z',
{ 'type': '/paragraph' },
{ 'type': '/internalItem' },
{ 'type': '/internalList' }
],
cases = [
{
'msg': 'metadata insertion',
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
'doc': 'complexInternalData',
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'offset': 0,
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'range': new ve.Range( 0, 7 ),
'modify': function ( newDoc ) {
newDoc.commit( ve.dm.Transaction.newFromMetadataInsertion(
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
newDoc, 4, 0, [ comment ]
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
) );
},
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'removalOps': [
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
{
'type': 'replace',
'remove': complexDoc.getData( new ve.Range( 0, 7 ) ),
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'insert': [],
'removeMetadata': complexDoc.getMetadata( new ve.Range( 0, 7 ) ),
'insertMetadata': []
},
build: Update jscs and jshint jshint: * Update to grunt-contrib-jshint v0.10.0 (jshint v2.5.0). * Remove coding style options covered by jscs. * Enable new option "freeze" (prohibits changing native prototypes). http://www.jshint.com/blog/new-in-jshint-oct-2013/#option-freeze * Re-order to match http://www.jshint.com/docs/options/ jscs: * Update to grunt-jscs-checker v0.4.4 (jscs v1.4.5). * Format .jscsrc file in a more spacious way and order the properties less arbitrarily (using the jscs's readme order). * Enforce more details of our coding style * Get rid of the unsable "sticky" operator rules which have been deprecated in favour of using other rules instead that are able to enforce this more accurately. - disallowLeftStickedOperators: Remove deprecated rule. * Ternary covered by requireSpacesInConditionalExpression. * Rest covered by requireSpace{Before,After}BinaryOperators. - requireLeftStickedOperators: Remove deprecated rule. * Comma covered by disallowSpaceBeforeBinaryOperators. - requireRightStickedOperators: Remove deprecated rule. * Logical not (!) covered by disallowSpaceAfterPrefixUnaryOperators. See also If46b94ce1, Ib731f11b1 and I0b0cadbc5 in oojs/core. Also: * Update grunt-contrib-watch to latest upstream version. Change log at https://github.com/gruntjs/grunt-contrib-watch/blob/v0.6.1/CHANGELOG#L1-L17 Change-Id: I6c5a34afea8b05a3dca617897c192594df06ca90
2014-05-15 16:12:43 +00:00
{ 'type': 'retain', 'length': 26 }
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
],
'expectedOps': [
{
'type': 'replace',
'remove': [],
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
'insert': complexDoc.getData( new ve.Range( 0, 4 ) )
// Reference gets (unnecessarily) renumbered from auto/0 to auto/1
build: Update jscs and use new "wikimedia" preset Our coding style has been upstreamed and first released in node-jscs v1.5.0 (grunt-jscs-checker v0.6.0). Change-Id: Ifc0cfc7177946b9d11407f60e38b0177883724c5
2014-06-26 10:41:18 +00:00
.concat( [
ve.extendObject( true, {}, complexDoc.data.data[4],
{ 'attributes': { 'listKey': 'auto/1' } }
)
] )
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
.concat( complexDoc.getData( new ve.Range( 5, 7 ) ) ),
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'removeMetadata': [],
'insertMetadata': complexDoc.getMetadata( new ve.Range( 0, 4 ) )
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
.concat( [ [ comment ] ] )
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
.concat( complexDoc.getMetadata( new ve.Range( 5, 7 ) ) )
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
},
{ 'type': 'retain', 'length': 1 },
{
'type': 'replace',
'remove': complexDoc.getData( new ve.Range( 8, 32 ) ),
'insert': complexDoc.getData( new ve.Range( 8, 32 ) ),
'removeMetadata': complexDoc.getMetadata( new ve.Range( 8, 32 ) ),
'insertMetadata': complexDoc.getMetadata( new ve.Range( 8, 32 ) )
},
{ 'type': 'retain', 'length': 1 }
]
},
{
'msg': 'metadata removal',
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
'doc': 'complexInternalData',
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'offset': 24,
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'range': new ve.Range( 24, 31 ),
'modify': function ( newDoc ) {
newDoc.commit( ve.dm.Transaction.newFromMetadataRemoval(
newDoc, 6, new ve.Range( 0, 1 )
) );
},
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'removalOps': [
{ 'type': 'retain', 'length': 24 },
{
'type': 'replace',
'remove': complexDoc.getData( new ve.Range( 24, 31 ) ),
'insert': [],
'removeMetadata': complexDoc.getMetadata( new ve.Range( 24, 31 ) ),
'insertMetadata': []
},
{ 'type': 'retain', 'length': 2 }
],
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'expectedOps': [
{ 'type': 'retain', 'length': 8 },
{
'type': 'replace',
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'remove': complexDoc.getData( new ve.Range( 8, 24 ) )
.concat( complexDoc.getData( new ve.Range( 31, 32 ) ) ),
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'insert': complexDoc.getData( new ve.Range( 8, 32 ) ),
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'removeMetadata': complexDoc.getMetadata( new ve.Range( 8, 24 ) )
.concat( complexDoc.getMetadata( new ve.Range( 31, 32 ) ) ),
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'insertMetadata': complexDoc.getMetadata( new ve.Range( 8, 30 ) )
.concat( [ [] ] )
.concat( complexDoc.getMetadata( new ve.Range( 31, 32 ) ) )
},
{ 'type': 'retain', 'length': 1 }
]
},
{
'msg': 'inserting a brand new document; internal lists are merged and items renumbered',
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
'doc': 'complexInternalData',
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'offset': 7,
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'newDocData': withReference,
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
'removalOps': [],
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
'expectedOps': [
{ 'type': 'retain', 'length': 7 },
{
'type': 'replace',
'remove': [],
'insert': withReference.slice( 0, 4 )
// Renumber listIndex from 0 to 2
Recompute auto-numbered reference listKeys when merging internalLists This fixes some of the problems with pasting references. It's a bit overzealous in that references get renumbered even when replacing, which is unnecessary but doesn't actually have any noticeable effect. Unfortunately, the internal list state depends so much on the converter having run that we now need to add yet another hack, to set the counter to the appropriate value. Change-Id: I3c6514ce600af4f4c037f419554d34b5a5c86a63
2013-11-12 23:34:50 +00:00
// Renumber listKey from auto/0 to auto/1
build: Update jscs and use new "wikimedia" preset Our coding style has been upstreamed and first released in node-jscs v1.5.0 (grunt-jscs-checker v0.6.0). Change-Id: Ifc0cfc7177946b9d11407f60e38b0177883724c5
2014-06-26 10:41:18 +00:00
.concat( [
ve.extendObject( true, {}, withReference[4],
{ 'attributes': { 'listIndex': 2, 'listKey': 'auto/1' } }
)
] )
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
.concat( withReference.slice( 5, 7 ) )
},
{ 'type': 'retain', 'length': 1 },
{
'type': 'replace',
'remove': complexDoc.getData( new ve.Range( 8, 32 ) ),
'insert': complexDoc.getData( new ve.Range( 8, 32 ) )
.concat( withReference.slice( 8, 15 ) ),
'removeMetadata': complexDoc.getMetadata( new ve.Range( 8, 32 ) ),
'insertMetadata': complexDoc.getMetadata( new ve.Range( 8, 32 ) )
.concat( new Array( 7 ) )
},
{ 'type': 'retain', 'length': 1 }
]
}
];
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
QUnit.expect( 3 * cases.length );
for ( i = 0; i < cases.length; i++ ) {
doc = ve.dm.mwExample.createExampleDocument( cases[i].doc );
if ( cases[i].newDocData ) {
doc2 = new ve.dm.Document( cases[i].newDocData );
removalOps = [];
} else if ( cases[i].range ) {
doc2 = doc.cloneFromRange( cases[i].range );
cases[i].modify( doc2 );
tx = ve.dm.Transaction.newFromRemoval( doc, cases[i].range, true );
doc.commit( tx );
removalOps = tx.getOperations();
}
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
assert.deepEqualWithDomElements( removalOps, cases[i].removalOps, cases[i].msg + ': removal' );
tx = ve.dm.Transaction.newFromDocumentInsertion( doc, cases[i].offset, doc2 );
assert.deepEqualWithDomElements( tx.getOperations(), cases[i].expectedOps, cases[i].msg + ': transaction' );
actualStoreItems = [];
expectedStoreItems = cases[i].expectedStoreItems || [];
for ( j = 0; j < expectedStoreItems.length; j++ ) {
actualStoreItems[j] = doc.store.value( doc.store.indexOfHash(
OO.getHash( expectedStoreItems[j] )
) );
Introduce newFromDocumentReplace() transaction builder Replaces newFromNodeReplacement(). newFromNodeReplacement was very simplistic and didn't support metadata or internal list items, so if you had comments or references inside of the data you were editing (reference contents or an image caption), they'd get mangled. With this, you can do: newDoc = doc.getDocumentSlice( node ); // Edit newDoc tx = ve.dm.Transaction.newFromDocumentReplace( doc, node, newDoc ); surface.change( newDoc ); and that takes care of metadata, internal list items, and things like references that reference internal list items. ve.dm.Document.js: * In getDocumentSlice(), store a reference to the original document and the number of items in its InternalList at the time of slicing in the created slice. This is used for reconciliation when the modified slice is injected back into the parent document with newFromDocumentReplace(). ve.dm.InternalList.js: * Add a method for merging in another InternalList. This provides a mapping from old to new InternalList indexes so the linear model data being injected by newFromDocumentReplace() can have its InternalList indexes remapped. ve.dm.Transaction.js: * Replace newFromNodeReplacement() with newFromDocumentReplace() ve.ui.MWMediaEditDialog.js, ve.ui.MWReferenceDialog.js: * Use getDocumentSlice/newFromDocumentReplace for editing captions/refs * Change insertion code path to insert an empty internalItem/caption, then newFromDocumentReplace into that * Add empty internalList to new mini-documents ve/test/dm/ve.dm.Transaction.test.js: * Replace newFromNodeReplacement tests with newFromDocumentReplace tests ve-mw/test/dm/ve.dm.Transaction.test.js (new): * Add tests for newFromDocumentReplace with mwReference nodes ve.dm.mwExample.js: * Add data for newFromDocumentReplace with mwReference tests VisualEditor.hooks.php: * Add new test file Bug: 52102 Change-Id: I4aa980780114b391924f04df588e81c990c32983
2013-09-05 01:05:07 +00:00
}
Add fixUpInsertion to newFromDocumentReplace In order to do this we have to separate out the removal operation from NDFR, so it becomes newFromDocumentInsertion (again, although actually, for the first time). As NFDI is an insertion we can just run fixUpInsertion on the data part of it. In order for the removal operation to be a proper removal we have to allow metadata removal (the default is to merge it). Change-Id: I16d575b61b9796e7e889f2c27cfe02b4a40b7639
2013-09-30 13:25:28 +00:00
assert.deepEqual( actualStoreItems, expectedStoreItems, cases[i].msg + ': store items' );
}
Set up node-jscs, pass it, and configure in local Gruntfile Let's experiment with this via our local Gruntfile. If it works fine we can install it in Jenkins (similar to node-csslint). Verify through $ npm install && npm test; Fixed all outstanding violations. Also: * Added syntaxhighight to ignore. * Added imetests (which contain unformatted JSON) to ignore. * In ve.dm.ModelRegistry#matchTypeRegExps, removed redundant !! cast from the [+!!withFunc] statement which was hitting a bug in node-jscs. All callers to this local private function pass a literal boolean true/false so no need to cast it. * Removed "/* key .. , value */" from ve.setProp, though this wasn't caught by node-jscs, found it when searching for " , ". * Made npm.devDependencies fixed instead of using tilde-ranges. This too often leads to strange bugs or sudden changes. Fixed them at the version they were currently ranging to. Bug: 54218 Change-Id: Ib2630806f3946874c8b01e58cf171df83a28da29
2013-12-06 02:34:44 +00:00
} );
Reference in a new issue Copy permalink