upcastdispatcher.js 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import UpcastDispatcher from '../../src/conversion/upcastdispatcher';
  6. import ViewContainerElement from '../../src/view/containerelement';
  7. import ViewElement from '../../src/view/element';
  8. import ViewDocumentFragment from '../../src/view/documentfragment';
  9. import ViewText from '../../src/view/text';
  10. import ViewDocument from '../../src/view/document';
  11. import Model from '../../src/model/model';
  12. import ModelText from '../../src/model/text';
  13. import ModelTextProxy from '../../src/model/textproxy';
  14. import ModelElement from '../../src/model/element';
  15. import ModelDocumentFragment from '../../src/model/documentfragment';
  16. import ModelPosition from '../../src/model/position';
  17. import ModelRange from '../../src/model/range';
  18. import ModelWriter from '../../src/model/writer';
  19. import first from '@ckeditor/ckeditor5-utils/src/first';
  20. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  21. import { StylesProcessor } from '../../src/view/stylesmap';
  22. describe( 'UpcastDispatcher', () => {
  23. let model, viewDocument;
  24. beforeEach( () => {
  25. model = new Model();
  26. viewDocument = new ViewDocument( new StylesProcessor() );
  27. } );
  28. describe( 'constructor()', () => {
  29. it( 'should create UpcastDispatcher with passed api', () => {
  30. const apiObj = {};
  31. const dispatcher = new UpcastDispatcher( { apiObj } );
  32. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  33. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  34. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  35. expect( dispatcher.conversionApi ).to.have.property( 'splitToAllowedParent' ).that.is.instanceof( Function );
  36. } );
  37. it( 'should not crash if no additional api is passed', () => {
  38. const dispatcher = new UpcastDispatcher();
  39. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  40. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  41. expect( dispatcher.conversionApi ).to.have.property( 'splitToAllowedParent' ).that.is.instanceof( Function );
  42. } );
  43. } );
  44. describe( 'convert()', () => {
  45. let dispatcher;
  46. beforeEach( () => {
  47. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  48. } );
  49. it( 'should create api for a conversion process', () => {
  50. const viewElement = new ViewContainerElement( viewDocument, 'p', null, new ViewText( viewDocument, 'foobar' ) );
  51. // To be sure that both converters was called.
  52. const spy = sinon.spy();
  53. // To check that the same writer instance.
  54. let writer;
  55. // Conversion process properties should be undefined/empty before conversion.
  56. expect( dispatcher.conversionApi.writer ).to.not.ok;
  57. expect( dispatcher.conversionApi.store ).to.not.ok;
  58. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  59. // Check conversion api params.
  60. expect( conversionApi.writer ).to.instanceof( ModelWriter );
  61. expect( conversionApi.store ).to.deep.equal( {} );
  62. // Remember writer to check in next converter that is exactly the same instance (the same undo step).
  63. writer = conversionApi.writer;
  64. // Add some data to conversion storage to verify them in next converter.
  65. conversionApi.store.foo = 'bar';
  66. // Convert children - this will call second converter.
  67. conversionApi.convertChildren( data.viewItem, data.modelCursor );
  68. spy();
  69. } );
  70. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  71. // The same writer is used in converters during one conversion.
  72. expect( conversionApi.writer ).to.equal( writer );
  73. // Data set by previous converter are remembered.
  74. expect( conversionApi.store ).to.deep.equal( { foo: 'bar' } );
  75. spy();
  76. } );
  77. model.change( writer => dispatcher.convert( viewElement, writer ) );
  78. // To be sure that both converters was called.
  79. sinon.assert.calledTwice( spy );
  80. // Conversion process properties should be cleared after conversion.
  81. expect( dispatcher.conversionApi.writer ).to.not.ok;
  82. expect( dispatcher.conversionApi.store ).to.not.ok;
  83. } );
  84. it( 'should fire viewCleanup event on converted view part', () => {
  85. sinon.spy( dispatcher, 'fire' );
  86. const viewP = new ViewContainerElement( viewDocument, 'p' );
  87. model.change( writer => dispatcher.convert( viewP, writer ) );
  88. expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true;
  89. } );
  90. it( 'should fire proper events', () => {
  91. const viewText = new ViewText( viewDocument, 'foobar' );
  92. const viewElement = new ViewContainerElement( viewDocument, 'p', null, viewText );
  93. const viewFragment = new ViewDocumentFragment( viewDocument, viewElement );
  94. sinon.spy( dispatcher, 'fire' );
  95. model.change( writer => {
  96. dispatcher.convert( viewText, writer );
  97. dispatcher.convert( viewElement, writer );
  98. dispatcher.convert( viewFragment, writer );
  99. } );
  100. expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true;
  101. expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true;
  102. expect( dispatcher.fire.calledWith( 'documentFragment' ) ).to.be.true;
  103. } );
  104. it( 'should convert ViewText', () => {
  105. const spy = sinon.spy();
  106. const viewText = new ViewText( viewDocument, 'foobar' );
  107. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  108. // Check if this method has been fired.
  109. spy();
  110. // Check correctness of passed parameters.
  111. expect( evt.name ).to.equal( 'text' );
  112. expect( data.viewItem ).to.equal( viewText );
  113. expect( data.modelCursor ).to.instanceof( ModelPosition );
  114. // Check whether consumable has appropriate value to consume.
  115. expect( conversionApi.consumable.consume( data.viewItem ) ).to.be.true;
  116. // Check whether conversionApi of `dispatcher` has been passed.
  117. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  118. const text = conversionApi.writer.createText( data.viewItem.data );
  119. conversionApi.writer.insert( text, data.modelCursor );
  120. // Set conversion result to `modelRange` property of `data`.
  121. // Later we will check if it was returned by `convert` method.
  122. data.modelRange = ModelRange._createOn( text );
  123. } );
  124. const conversionResult = model.change( writer => dispatcher.convert( viewText, writer ) );
  125. // Check conversion result.
  126. // Result should be wrapped in document fragment.
  127. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  128. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foobar' );
  129. expect( spy.calledOnce ).to.be.true;
  130. } );
  131. it( 'should convert ViewContainerElement', () => {
  132. const spy = sinon.spy();
  133. const viewElement = new ViewContainerElement( viewDocument, 'p', { attrKey: 'attrValue' } );
  134. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  135. // Check if this method has been fired.
  136. spy();
  137. // Check correctness of passed parameters.
  138. expect( evt.name ).to.equal( 'element:p' );
  139. expect( data.viewItem ).to.equal( viewElement );
  140. expect( data.modelCursor ).to.instanceof( ModelPosition );
  141. // Check whether consumable has appropriate value to consume.
  142. expect( conversionApi.consumable.consume( data.viewItem, { name: true } ) ).to.be.true;
  143. expect( conversionApi.consumable.consume( data.viewItem, { attribute: 'attrKey' } ) ).to.be.true;
  144. // Check whether conversionApi of `dispatcher` has been passed.
  145. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  146. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  147. conversionApi.writer.insert( paragraph, data.modelCursor );
  148. // Set conversion result to `modelRange` property of `data`.
  149. // Later we will check if it was returned by `convert` method.
  150. data.modelRange = ModelRange._createOn( paragraph );
  151. } );
  152. // Use `additionalData` parameter to check if it was passed to the event.
  153. const conversionResult = model.change( writer => dispatcher.convert( viewElement, writer ) );
  154. // Check conversion result.
  155. // Result should be wrapped in document fragment.
  156. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  157. expect( conversionResult.getChild( 0 ).name ).to.equal( 'paragraph' );
  158. expect( spy.calledOnce ).to.be.true;
  159. } );
  160. it( 'should convert ViewDocumentFragment', () => {
  161. const spy = sinon.spy();
  162. const viewFragment = new ViewDocumentFragment( viewDocument );
  163. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  164. // Check if this method has been fired.
  165. spy();
  166. // Check correctness of passed parameters.
  167. expect( evt.name ).to.equal( 'documentFragment' );
  168. expect( data.viewItem ).to.equal( viewFragment );
  169. expect( data.modelCursor ).to.instanceof( ModelPosition );
  170. // Check whether consumable has appropriate value to consume.
  171. expect( conversionApi.consumable.consume( data.viewItem ) ).to.be.true;
  172. // Check whether conversionApi of `dispatcher` has been passed.
  173. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  174. const text = conversionApi.writer.createText( 'foo' );
  175. conversionApi.writer.insert( text, data.modelCursor );
  176. // Set conversion result to `modelRange` property of `data`.
  177. // Later we will check if it was returned by `convert` method.
  178. data.modelRange = ModelRange._createOn( text );
  179. } );
  180. const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) );
  181. // Check conversion result.
  182. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  183. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foo' );
  184. expect( spy.calledOnce ).to.be.true;
  185. } );
  186. it( 'should remove empty elements that was created as a result of split', () => {
  187. const viewElement = new ViewElement( viewDocument, 'div', null, [
  188. new ViewElement( viewDocument, 'p', null, [
  189. new ViewElement( viewDocument, 'img' )
  190. ] )
  191. ] );
  192. model.schema.register( 'div', { allowIn: '$root' } );
  193. model.schema.register( 'p', { allowIn: 'div' } );
  194. model.schema.register( 'image', { allowIn: '$root' } );
  195. dispatcher.on( 'element:img', ( evt, data, conversionApi ) => {
  196. const writer = conversionApi.writer;
  197. const modelElement = writer.createElement( 'image' );
  198. const splitResult = conversionApi.splitToAllowedParent( modelElement, data.modelCursor );
  199. writer.insert( modelElement, splitResult.position );
  200. data.modelRange = writer.createRangeOn( modelElement );
  201. data.modelCursor = writer.createPositionAt( splitResult.cursorParent, 0 );
  202. // Prevent below converter to fire.
  203. evt.stop();
  204. }, { priority: 'high' } );
  205. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  206. const writer = conversionApi.writer;
  207. const modelElement = writer.createElement( data.viewItem.name );
  208. writer.insert( modelElement, data.modelCursor );
  209. const result = conversionApi.convertChildren( data.viewItem, modelElement );
  210. data.modelRange = writer.createRange(
  211. writer.createPositionBefore( modelElement ),
  212. conversionApi.writer.createPositionAfter( result.modelCursor.parent )
  213. );
  214. data.modelCursor = data.modelRange.end;
  215. } );
  216. const result = model.change( writer => dispatcher.convert( viewElement, writer ) );
  217. // After splits `div` and `p` are empty so they should be removed.
  218. expect( result.childCount ).to.equal( 1 );
  219. expect( result.getChild( 0 ).name ).to.equal( 'image' );
  220. } );
  221. it( 'should extract temporary markers elements from converter element and create static markers list', () => {
  222. const viewFragment = new ViewDocumentFragment( viewDocument );
  223. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  224. // Create model fragment.
  225. const fragment = new ModelDocumentFragment( [
  226. new ModelText( 'fo' ),
  227. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  228. new ModelText( 'o' ),
  229. new ModelElement( '$marker', { 'data-name': 'marker2' } ),
  230. new ModelText( 'b' ),
  231. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  232. new ModelText( 'ar' )
  233. ] );
  234. // Insert to conversion tree.
  235. conversionApi.writer.insert( fragment, data.modelCursor );
  236. // Create range on this fragment as a conversion result.
  237. data.modelRange = ModelRange._createIn( data.modelCursor.parent );
  238. } );
  239. const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) );
  240. expect( conversionResult.markers.size ).to.equal( 2 );
  241. const marker1 = conversionResult.markers.get( 'marker1' );
  242. const marker2 = conversionResult.markers.get( 'marker2' );
  243. expect( marker1.start.path ).to.deep.equal( [ 2 ] );
  244. expect( marker1.end.path ).to.deep.equal( [ 4 ] );
  245. expect( marker2.start.path ).to.deep.equal( marker2.end.path ).to.deep.equal( [ 3 ] );
  246. } );
  247. it( 'should convert according to given context', () => {
  248. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  249. const spy = sinon.spy();
  250. const viewElement = new ViewContainerElement( viewDocument, 'third' );
  251. let checkChildResult;
  252. model.schema.register( 'first', {
  253. allowIn: '$root'
  254. } );
  255. model.schema.register( 'second', {
  256. allowIn: 'first'
  257. } );
  258. model.schema.register( 'third', {
  259. allowIn: 'second',
  260. disallowIn: 'first'
  261. } );
  262. dispatcher.on( 'element:third', ( evt, data, conversionApi ) => {
  263. spy();
  264. checkChildResult = conversionApi.schema.checkChild( data.modelCursor, 'third' );
  265. } );
  266. // Default context $root.
  267. model.change( writer => dispatcher.convert( viewElement, writer ) );
  268. sinon.assert.calledOnce( spy );
  269. expect( checkChildResult ).to.false;
  270. // SchemaDefinition as context.
  271. model.change( writer => dispatcher.convert( viewElement, writer, [ 'first' ] ) );
  272. sinon.assert.calledTwice( spy );
  273. expect( checkChildResult ).to.false;
  274. // Position as context.
  275. const fragment = new ModelDocumentFragment( [
  276. new ModelElement( 'first', { foo: 'bar' }, [
  277. new ModelElement( 'second', null )
  278. ] )
  279. ] );
  280. model.change( writer => dispatcher.convert( viewElement, writer, new ModelPosition( fragment, [ 0, 0, 0 ] ) ) );
  281. sinon.assert.calledThrice( spy );
  282. expect( checkChildResult ).to.true;
  283. } );
  284. } );
  285. describe( 'conversionApi', () => {
  286. let spy, spyP, spyText, viewP, viewText, modelP, modelText, rootMock, dispatcher,
  287. spyNull, spyArray, viewDiv, viewNull, viewArray;
  288. beforeEach( () => {
  289. spy = sinon.spy();
  290. spyP = sinon.spy();
  291. spyText = sinon.spy();
  292. viewP = new ViewContainerElement( viewDocument, 'p' );
  293. viewText = new ViewText( viewDocument, 'foobar' );
  294. modelP = new ModelElement( 'paragraph' );
  295. modelText = new ModelText( 'foobar' );
  296. // Put nodes to documentFragment, this will mock root element and makes possible to create range on them.
  297. rootMock = new ModelDocumentFragment( [ modelP, modelText ] );
  298. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  299. dispatcher.on( 'element:p', ( evt, data ) => {
  300. spyP();
  301. data.modelRange = ModelRange._createOn( modelP );
  302. data.modelCursor = data.modelRange.end;
  303. } );
  304. dispatcher.on( 'text', ( evt, data ) => {
  305. spyText();
  306. data.modelRange = ModelRange._createOn( modelText );
  307. data.modelCursor = data.modelRange.end;
  308. } );
  309. spyNull = sinon.spy();
  310. spyArray = sinon.spy();
  311. viewDiv = new ViewContainerElement( viewDocument, 'div' ); // Will not be recognized and not converted.
  312. viewNull = new ViewContainerElement( viewDocument, 'null' ); // Will return `null` in `data.modelRange` upon conversion.
  313. viewArray = new ViewContainerElement( viewDocument, 'array' ); // Will return an array in `data.modelRange` upon conversion.
  314. dispatcher.on( 'element:null', ( evt, data ) => {
  315. spyNull();
  316. data.modelRange = null;
  317. } );
  318. dispatcher.on( 'element:array', ( evt, data ) => {
  319. spyArray();
  320. data.modelRange = [ new ModelText( 'foo' ) ];
  321. } );
  322. } );
  323. describe( 'convertItem()', () => {
  324. it( 'should call proper converter and return correct data', () => {
  325. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  326. spy();
  327. const pResult = conversionApi.convertItem( viewP, data.modelCursor );
  328. expect( pResult.modelRange ).instanceof( ModelRange );
  329. expect( pResult.modelRange.start.path ).to.deep.equal( [ 0 ] );
  330. expect( pResult.modelRange.end.path ).to.deep.equal( [ 1 ] );
  331. expect( first( pResult.modelRange.getItems() ) ).to.equal( modelP );
  332. expect( pResult.modelCursor ).to.instanceof( ModelPosition );
  333. expect( pResult.modelCursor.path ).to.deep.equal( [ 1 ] );
  334. const textResult = conversionApi.convertItem( viewText, data.modelCursor );
  335. expect( textResult.modelRange ).instanceof( ModelRange );
  336. expect( textResult.modelRange.start.path ).to.deep.equal( [ 1 ] );
  337. expect( textResult.modelRange.end.path ).to.deep.equal( [ 7 ] );
  338. expect( first( textResult.modelRange.getItems() ) ).to.instanceof( ModelTextProxy );
  339. expect( first( textResult.modelRange.getItems() ).data ).to.equal( 'foobar' );
  340. expect( textResult.modelCursor ).to.instanceof( ModelPosition );
  341. expect( textResult.modelCursor.path ).to.deep.equal( [ 7 ] );
  342. } );
  343. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  344. expect( spy.calledOnce ).to.be.true;
  345. expect( spyP.calledOnce ).to.be.true;
  346. expect( spyText.calledOnce ).to.be.true;
  347. } );
  348. it( 'should do nothing if element was not converted', () => {
  349. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  350. spy();
  351. expect( conversionApi.convertItem( viewDiv, data.modelCursor ).modelRange ).to.equal( null );
  352. expect( conversionApi.convertItem( viewNull, data.modelCursor ).modelRange ).to.equal( null );
  353. } );
  354. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  355. expect( spy.calledOnce ).to.be.true;
  356. expect( spyNull.calledOnce ).to.be.true;
  357. } );
  358. it( 'should throw an error if element was incorrectly converted', () => {
  359. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  360. spy();
  361. conversionApi.convertItem( viewArray, data.modelCursor );
  362. } );
  363. expectToThrowCKEditorError( () => {
  364. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  365. }, /^view-conversion-dispatcher-incorrect-result/, model );
  366. expect( spy.calledOnce ).to.be.true;
  367. expect( spyArray.calledOnce ).to.be.true;
  368. } );
  369. } );
  370. describe( 'convertChildren()', () => {
  371. it( 'should fire conversion for all children of passed view element and return conversion results ' +
  372. 'wrapped in document fragment (using modelCursor)', () => {
  373. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  374. spy();
  375. const modelCursor = ModelPosition._createAt( rootMock, 0 );
  376. const result = conversionApi.convertChildren( data.viewItem, modelCursor );
  377. expect( result.modelRange ).to.be.instanceof( ModelRange );
  378. expect( result.modelRange.start.path ).to.deep.equal( [ 0 ] );
  379. expect( result.modelRange.end.path ).to.deep.equal( [ 7 ] );
  380. expect( Array.from( result.modelRange.getItems() ) ).to.length( 2 );
  381. expect( Array.from( result.modelRange.getItems() )[ 0 ] ).to.equal( modelP );
  382. expect( Array.from( result.modelRange.getItems() )[ 1 ] ).to.instanceof( ModelTextProxy );
  383. expect( Array.from( result.modelRange.getItems() )[ 1 ].data ).to.equal( 'foobar' );
  384. expect( result.modelCursor ).instanceof( ModelPosition );
  385. expect( result.modelCursor.path ).to.deep.equal( [ 7 ] );
  386. } );
  387. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument, [ viewP, viewText ] ), writer ) );
  388. expect( spy.calledOnce ).to.be.true;
  389. expect( spyP.calledOnce ).to.be.true;
  390. expect( spyText.calledOnce ).to.be.true;
  391. } );
  392. it( 'should fire conversion for all children of passed view element and return conversion results ' +
  393. 'wrapped in document fragment (using model element)', () => {
  394. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  395. spy();
  396. const result = conversionApi.convertChildren( data.viewItem, rootMock );
  397. expect( result.modelRange ).to.be.instanceof( ModelRange );
  398. expect( result.modelRange.start.path ).to.deep.equal( [ 0 ] );
  399. expect( result.modelRange.end.path ).to.deep.equal( [ 7 ] );
  400. expect( Array.from( result.modelRange.getItems() ) ).to.length( 2 );
  401. expect( Array.from( result.modelRange.getItems() )[ 0 ] ).to.equal( modelP );
  402. expect( Array.from( result.modelRange.getItems() )[ 1 ] ).to.instanceof( ModelTextProxy );
  403. expect( Array.from( result.modelRange.getItems() )[ 1 ].data ).to.equal( 'foobar' );
  404. expect( result.modelCursor ).instanceof( ModelPosition );
  405. expect( result.modelCursor.path ).to.deep.equal( [ 7 ] );
  406. } );
  407. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument, [ viewP, viewText ] ), writer ) );
  408. expect( spy.calledOnce ).to.be.true;
  409. expect( spyP.calledOnce ).to.be.true;
  410. expect( spyText.calledOnce ).to.be.true;
  411. } );
  412. } );
  413. describe( 'splitToAllowedParent()', () => {
  414. beforeEach( () => {
  415. model.schema.register( 'paragraph', {
  416. allowIn: '$root'
  417. } );
  418. } );
  419. it( 'should return current position if element is allowed on this position', () => {
  420. const spy = sinon.spy();
  421. model.schema.register( 'span', {
  422. allowIn: 'paragraph'
  423. } );
  424. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  425. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  426. const span = conversionApi.writer.createElement( 'span' );
  427. const position = ModelPosition._createAt( paragraph, 0 );
  428. const result = conversionApi.splitToAllowedParent( span, position );
  429. expect( result ).to.deep.equal( { position } );
  430. spy();
  431. } );
  432. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  433. sinon.assert.calledOnce( spy );
  434. } );
  435. it( 'should split position to allowed ancestor if element is allowed in one of ancestors', () => {
  436. const spy = sinon.spy();
  437. model.schema.register( 'section', {
  438. allowIn: '$root'
  439. } );
  440. model.schema.register( 'span', {
  441. allowIn: 'paragraph'
  442. } );
  443. model.schema.extend( 'paragraph', {
  444. allowIn: 'section'
  445. } );
  446. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  447. const section = conversionApi.writer.createElement( 'section' );
  448. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  449. const span = conversionApi.writer.createElement( 'span' );
  450. conversionApi.writer.insert( paragraph, section );
  451. conversionApi.writer.insert( span, paragraph );
  452. const position = ModelPosition._createAt( span, 0 );
  453. const paragraph2 = conversionApi.writer.createElement( 'paragraph' );
  454. const result = conversionApi.splitToAllowedParent( paragraph2, position );
  455. expect( result ).to.deep.equal( {
  456. position: ModelPosition._createAfter( paragraph ),
  457. cursorParent: paragraph.parent.getChild( 1 ).getChild( 0 )
  458. } );
  459. spy();
  460. } );
  461. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  462. sinon.assert.calledOnce( spy );
  463. } );
  464. it(
  465. 'should auto-paragraph an element if it is not allowed at the insertion position' +
  466. 'but would be inserted if auto-paragraphed',
  467. () => {
  468. const spy = sinon.spy();
  469. model.schema.register( 'section', {
  470. allowIn: '$root'
  471. } );
  472. model.schema.register( 'span', {
  473. allowIn: 'paragraph'
  474. } );
  475. model.schema.extend( 'paragraph', {
  476. allowIn: 'section'
  477. } );
  478. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  479. const section = conversionApi.writer.createElement( 'section' );
  480. const position = ModelPosition._createAt( section, 0 );
  481. const span = conversionApi.writer.createElement( 'span' );
  482. const result = conversionApi.splitToAllowedParent( span, position );
  483. expect( section.getChild( 0 ).name ).to.equal( 'paragraph' );
  484. expect( result ).to.deep.equal( {
  485. position: ModelPosition._createAt( section.getChild( 0 ), 0 )
  486. } );
  487. spy();
  488. } );
  489. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  490. sinon.assert.calledOnce( spy );
  491. }
  492. );
  493. it( 'should return null if element is not allowed in position and any of ancestors', () => {
  494. const spy = sinon.spy();
  495. model.schema.register( 'span' );
  496. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  497. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  498. const span = conversionApi.writer.createElement( 'span' );
  499. const position = ModelPosition._createAt( paragraph, 0 );
  500. const result = conversionApi.splitToAllowedParent( span, position );
  501. expect( result ).to.null;
  502. spy();
  503. } );
  504. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  505. sinon.assert.calledOnce( spy );
  506. } );
  507. it( 'should return null if element is not allowed in position and any of ancestors but is allowed in context tree', () => {
  508. const spy = sinon.spy();
  509. model.schema.register( 'div', {
  510. allowIn: '$root'
  511. } );
  512. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  513. const code = conversionApi.writer.createElement( 'div' );
  514. const result = conversionApi.splitToAllowedParent( code, data.modelCursor );
  515. expect( result ).to.null;
  516. spy();
  517. } );
  518. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer, [ '$root', 'paragraph' ] ) );
  519. sinon.assert.calledOnce( spy );
  520. } );
  521. } );
  522. describe( 'getSplitParts()', () => {
  523. it( 'should return an array containing only passed element if the element has not been split', () => {
  524. model.schema.register( 'paragraph', { allowIn: '$root' } );
  525. const spy = sinon.spy();
  526. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  527. const modelElement = conversionApi.writer.createElement( 'paragraph' );
  528. const parts = conversionApi.getSplitParts( modelElement );
  529. expect( parts ).to.deep.equal( [ modelElement ] );
  530. spy();
  531. // Overwrite converters specified in `beforeEach`.
  532. evt.stop();
  533. }, { priority: 'high' } );
  534. const viewElement = new ViewElement( viewDocument, 'p' );
  535. model.change( writer => dispatcher.convert( viewElement, writer ) );
  536. expect( spy.called ).to.be.true;
  537. } );
  538. it( 'should return all parts of the split element', () => {
  539. model.schema.register( 'paragraph', { allowIn: '$root' } );
  540. model.schema.register( 'text', { allowIn: 'paragraph' } );
  541. model.schema.register( 'image', { allowIn: '$root' } );
  542. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  543. const modelText = conversionApi.writer.createText( data.viewItem.data );
  544. conversionApi.writer.insert( modelText, data.modelCursor );
  545. data.modelRange = conversionApi.writer.createRangeOn( modelText );
  546. data.modelCursor = data.modelRange.end;
  547. // Overwrite converters specified in `beforeEach`.
  548. evt.stop();
  549. }, { priority: 'high' } );
  550. dispatcher.on( 'element:image', ( evt, data, conversionApi ) => {
  551. const modelElement = conversionApi.writer.createElement( 'image' );
  552. const splitResult = conversionApi.splitToAllowedParent( modelElement, data.modelCursor );
  553. conversionApi.writer.insert( modelElement, splitResult.position );
  554. data.modelRange = conversionApi.writer.createRangeOn( modelElement );
  555. data.modelCursor = conversionApi.writer.createPositionAt( splitResult.cursorParent, 0 );
  556. // Overwrite converters specified in `beforeEach`.
  557. evt.stop();
  558. }, { priority: 'high' } );
  559. const spy = sinon.spy();
  560. dispatcher.on( 'element:p', ( evt, data, conversionApi ) => {
  561. const modelElement = conversionApi.writer.createElement( 'paragraph' );
  562. conversionApi.writer.insert( modelElement, data.modelCursor );
  563. conversionApi.convertChildren( data.viewItem, modelElement );
  564. const parts = conversionApi.getSplitParts( modelElement );
  565. expect( parts.length ).to.equal( 3 );
  566. expect( parts[ 0 ].getChild( 0 ).data ).to.equal( 'foo' );
  567. expect( parts[ 1 ].getChild( 0 ).data ).to.equal( 'bar' );
  568. expect( parts[ 2 ].getChild( 0 ).data ).to.equal( 'xyz' );
  569. expect( parts[ 0 ] ).to.equal( modelElement );
  570. spy();
  571. // Overwrite converters specified in `beforeEach`.
  572. evt.stop();
  573. }, { priority: 'high' } );
  574. const viewElement = new ViewElement( viewDocument, 'p', null, [
  575. new ViewText( viewDocument, 'foo' ),
  576. new ViewElement( viewDocument, 'image' ),
  577. new ViewText( viewDocument, 'bar' ),
  578. new ViewElement( viewDocument, 'image' ),
  579. new ViewText( viewDocument, 'xyz' )
  580. ] );
  581. model.change( writer => dispatcher.convert( viewElement, writer, [ '$root' ] ) );
  582. expect( spy.called ).to.be.true;
  583. } );
  584. } );
  585. describe( 'safeInsert()', () => {
  586. beforeEach( () => {
  587. model.schema.register( 'paragraph', {
  588. allowIn: '$root'
  589. } );
  590. } );
  591. it( 'should return true when element was inserted on given position', done => {
  592. model.schema.register( 'span', {
  593. allowIn: 'paragraph'
  594. } );
  595. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  596. const span = conversionApi.writer.createElement( 'span' );
  597. const position = conversionApi.writer.createPositionAt( modelP, 0 );
  598. const wasInserted = conversionApi.safeInsert( span, position );
  599. expect( wasInserted ).to.be.true;
  600. expect( rootMock.getNodeByPath( [ 0, 0 ] ) ).to.equal( span );
  601. done();
  602. } );
  603. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  604. } );
  605. it( 'should return true on split to allowed ancestor if element is allowed in one of the ancestors', done => {
  606. model.schema.register( 'section', {
  607. allowIn: '$root'
  608. } );
  609. model.schema.register( 'span', {
  610. allowIn: 'paragraph'
  611. } );
  612. model.schema.extend( 'paragraph', {
  613. allowIn: 'section'
  614. } );
  615. // Insert "section > paragraph > span".
  616. model.change( writer => {
  617. const section = writer.createElement( 'section' );
  618. const paragraph = writer.createElement( 'paragraph' );
  619. const span = writer.createElement( 'span' );
  620. writer.insert( section, writer.createPositionAt( rootMock, 0 ) );
  621. writer.insert( paragraph, writer.createPositionAt( section, 0 ) );
  622. writer.insert( span, writer.createPositionAt( paragraph, 0 ) );
  623. } );
  624. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  625. // Insert "paragraph" in "section > paragraph > span".
  626. const span = rootMock.getNodeByPath( [ 0, 0, 0 ] );
  627. const position = conversionApi.writer.createPositionAt( span, 0 );
  628. const paragraph2 = conversionApi.writer.createElement( 'paragraph' );
  629. const wasInserted = conversionApi.safeInsert( paragraph2, position );
  630. expect( wasInserted ).to.be.true;
  631. const section = rootMock.getNodeByPath( [ 0 ] );
  632. // The "paragraph" should be split to 2 and 1 inserted paragraph.
  633. expect( section.childCount ).to.equal( 3 );
  634. expect( section.getChild( 1 ) ).to.equal( paragraph2 );
  635. done();
  636. } );
  637. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  638. } );
  639. it( 'should return false if element is not allowed in position and any of ancestors', done => {
  640. model.schema.register( 'span' );
  641. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  642. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  643. const span = conversionApi.writer.createElement( 'span' );
  644. const position = conversionApi.writer.createPositionAt( paragraph, 0 );
  645. const wasInserted = conversionApi.safeInsert( span, position );
  646. expect( wasInserted ).to.be.false;
  647. done();
  648. } );
  649. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  650. } );
  651. it( 'should return false if element is not allowed in position and any of ancestors but is allowed in context tree', done => {
  652. model.schema.register( 'div', {
  653. allowIn: '$root'
  654. } );
  655. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  656. const code = conversionApi.writer.createElement( 'div' );
  657. const wasInserted = conversionApi.safeInsert( code, data.modelCursor );
  658. expect( wasInserted ).to.be.false;
  659. done();
  660. } );
  661. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer, [ '$root', 'paragraph' ] ) );
  662. } );
  663. } );
  664. describe( 'updateConversionResult()', () => {
  665. beforeEach( () => {
  666. model.schema.register( 'paragraph', {
  667. allowIn: '$root'
  668. } );
  669. } );
  670. it( 'should update the modelCursor and modelRange in data when element was inserted on given position', done => {
  671. model.schema.register( 'span', {
  672. allowIn: 'paragraph'
  673. } );
  674. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  675. const span = conversionApi.writer.createElement( 'span' );
  676. const position = conversionApi.writer.createPositionAt( modelP, 0 );
  677. conversionApi.safeInsert( span, position );
  678. conversionApi.updateConversionResult( span, data );
  679. const expectedPosition = conversionApi.writer.createPositionAfter( span );
  680. expect( data.modelCursor.isEqual( expectedPosition ) ).to.be.true;
  681. const expectedRange = conversionApi.writer.createRangeOn( span );
  682. expect( data.modelRange.isEqual( expectedRange ) ).to.be.true;
  683. done();
  684. } );
  685. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  686. } );
  687. it( 'should update the modelCursor and modelRange in data when split to allowed ancestor occurred', done => {
  688. model.schema.register( 'section', {
  689. allowIn: '$root'
  690. } );
  691. model.schema.register( 'span', {
  692. allowIn: 'paragraph'
  693. } );
  694. model.schema.extend( 'paragraph', {
  695. allowIn: 'section'
  696. } );
  697. // Insert "section > paragraph > span".
  698. model.change( writer => {
  699. const section = writer.createElement( 'section' );
  700. const paragraph = writer.createElement( 'paragraph' );
  701. const span = writer.createElement( 'span' );
  702. writer.insert( section, writer.createPositionAt( rootMock, 0 ) );
  703. writer.insert( paragraph, writer.createPositionAt( section, 0 ) );
  704. writer.insert( span, writer.createPositionAt( paragraph, 0 ) );
  705. } );
  706. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  707. // Insert "paragraph" in "section > paragraph > span".
  708. const span = rootMock.getNodeByPath( [ 0, 0, 0 ] );
  709. const position = conversionApi.writer.createPositionAt( span, 0 );
  710. const paragraph2 = conversionApi.writer.createElement( 'paragraph' );
  711. conversionApi.safeInsert( paragraph2, position );
  712. conversionApi.updateConversionResult( paragraph2, data );
  713. const expectedPosition = conversionApi.writer.createPositionAt( rootMock.getNodeByPath( [ 0, 2, 0 ] ), 0 );
  714. expect( data.modelCursor.isEqual( expectedPosition ) ).to.be.true;
  715. const expectedRange = conversionApi.writer.createRangeOn( paragraph2 );
  716. expect( data.modelRange.isEqual( expectedRange ) ).to.be.true;
  717. done();
  718. } );
  719. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  720. } );
  721. it( 'should not update the modelRange if it was already set on data (complex converter case - e.g. list)', done => {
  722. model.schema.register( 'span', {
  723. allowIn: 'paragraph'
  724. } );
  725. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  726. const span = conversionApi.writer.createElement( 'span' );
  727. const position = conversionApi.writer.createPositionAt( modelP, 0 );
  728. conversionApi.safeInsert( span, position );
  729. const start = conversionApi.writer.createPositionAt( span, 0 );
  730. const end = conversionApi.writer.createPositionAt( span, 1 );
  731. data.modelRange = conversionApi.writer.createRange( start, end );
  732. conversionApi.updateConversionResult( span, data );
  733. const expectedRange = conversionApi.writer.createRange( start, end );
  734. expect( data.modelRange.isEqual( expectedRange ) ).to.be.true;
  735. // Model cursor will be equal to range end - no split occurred.
  736. expect( data.modelCursor.isEqual( end ) ).to.be.true;
  737. done();
  738. } );
  739. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  740. } );
  741. } );
  742. } );
  743. } );