8
0

upcastdispatcher.js 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714
  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. describe( 'UpcastDispatcher', () => {
  22. let model, viewDocument;
  23. beforeEach( () => {
  24. model = new Model();
  25. viewDocument = new ViewDocument();
  26. } );
  27. describe( 'constructor()', () => {
  28. it( 'should create UpcastDispatcher with passed api', () => {
  29. const apiObj = {};
  30. const dispatcher = new UpcastDispatcher( { apiObj } );
  31. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  32. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  33. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  34. expect( dispatcher.conversionApi ).to.have.property( 'splitToAllowedParent' ).that.is.instanceof( Function );
  35. } );
  36. it( 'should not crash if no additional api is passed', () => {
  37. const dispatcher = new UpcastDispatcher();
  38. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  39. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  40. expect( dispatcher.conversionApi ).to.have.property( 'splitToAllowedParent' ).that.is.instanceof( Function );
  41. } );
  42. } );
  43. describe( 'convert()', () => {
  44. let dispatcher;
  45. beforeEach( () => {
  46. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  47. } );
  48. it( 'should create api for a conversion process', () => {
  49. const viewElement = new ViewContainerElement( viewDocument, 'p', null, new ViewText( viewDocument, 'foobar' ) );
  50. // To be sure that both converters was called.
  51. const spy = sinon.spy();
  52. // To check that the same writer instance.
  53. let writer;
  54. // Conversion process properties should be undefined/empty before conversion.
  55. expect( dispatcher.conversionApi.writer ).to.not.ok;
  56. expect( dispatcher.conversionApi.store ).to.not.ok;
  57. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  58. // Check conversion api params.
  59. expect( conversionApi.writer ).to.instanceof( ModelWriter );
  60. expect( conversionApi.store ).to.deep.equal( {} );
  61. // Remember writer to check in next converter that is exactly the same instance (the same undo step).
  62. writer = conversionApi.writer;
  63. // Add some data to conversion storage to verify them in next converter.
  64. conversionApi.store.foo = 'bar';
  65. // Convert children - this will call second converter.
  66. conversionApi.convertChildren( data.viewItem, data.modelCursor );
  67. spy();
  68. } );
  69. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  70. // The same writer is used in converters during one conversion.
  71. expect( conversionApi.writer ).to.equal( writer );
  72. // Data set by previous converter are remembered.
  73. expect( conversionApi.store ).to.deep.equal( { foo: 'bar' } );
  74. spy();
  75. } );
  76. model.change( writer => dispatcher.convert( viewElement, writer ) );
  77. // To be sure that both converters was called.
  78. sinon.assert.calledTwice( spy );
  79. // Conversion process properties should be cleared after conversion.
  80. expect( dispatcher.conversionApi.writer ).to.not.ok;
  81. expect( dispatcher.conversionApi.store ).to.not.ok;
  82. } );
  83. it( 'should fire viewCleanup event on converted view part', () => {
  84. sinon.spy( dispatcher, 'fire' );
  85. const viewP = new ViewContainerElement( viewDocument, 'p' );
  86. model.change( writer => dispatcher.convert( viewP, writer ) );
  87. expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true;
  88. } );
  89. it( 'should fire proper events', () => {
  90. const viewText = new ViewText( viewDocument, 'foobar' );
  91. const viewElement = new ViewContainerElement( viewDocument, 'p', null, viewText );
  92. const viewFragment = new ViewDocumentFragment( viewDocument, viewElement );
  93. sinon.spy( dispatcher, 'fire' );
  94. model.change( writer => {
  95. dispatcher.convert( viewText, writer );
  96. dispatcher.convert( viewElement, writer );
  97. dispatcher.convert( viewFragment, writer );
  98. } );
  99. expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true;
  100. expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true;
  101. expect( dispatcher.fire.calledWith( 'documentFragment' ) ).to.be.true;
  102. } );
  103. it( 'should convert ViewText', () => {
  104. const spy = sinon.spy();
  105. const viewText = new ViewText( viewDocument, 'foobar' );
  106. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  107. // Check if this method has been fired.
  108. spy();
  109. // Check correctness of passed parameters.
  110. expect( evt.name ).to.equal( 'text' );
  111. expect( data.viewItem ).to.equal( viewText );
  112. expect( data.modelCursor ).to.instanceof( ModelPosition );
  113. // Check whether consumable has appropriate value to consume.
  114. expect( conversionApi.consumable.consume( data.viewItem ) ).to.be.true;
  115. // Check whether conversionApi of `dispatcher` has been passed.
  116. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  117. const text = conversionApi.writer.createText( data.viewItem.data );
  118. conversionApi.writer.insert( text, data.modelCursor );
  119. // Set conversion result to `modelRange` property of `data`.
  120. // Later we will check if it was returned by `convert` method.
  121. data.modelRange = ModelRange._createOn( text );
  122. } );
  123. const conversionResult = model.change( writer => dispatcher.convert( viewText, writer ) );
  124. // Check conversion result.
  125. // Result should be wrapped in document fragment.
  126. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  127. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foobar' );
  128. expect( spy.calledOnce ).to.be.true;
  129. } );
  130. it( 'should convert ViewContainerElement', () => {
  131. const spy = sinon.spy();
  132. const viewElement = new ViewContainerElement( viewDocument, 'p', { attrKey: 'attrValue' } );
  133. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  134. // Check if this method has been fired.
  135. spy();
  136. // Check correctness of passed parameters.
  137. expect( evt.name ).to.equal( 'element:p' );
  138. expect( data.viewItem ).to.equal( viewElement );
  139. expect( data.modelCursor ).to.instanceof( ModelPosition );
  140. // Check whether consumable has appropriate value to consume.
  141. expect( conversionApi.consumable.consume( data.viewItem, { name: true } ) ).to.be.true;
  142. expect( conversionApi.consumable.consume( data.viewItem, { attribute: 'attrKey' } ) ).to.be.true;
  143. // Check whether conversionApi of `dispatcher` has been passed.
  144. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  145. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  146. conversionApi.writer.insert( paragraph, data.modelCursor );
  147. // Set conversion result to `modelRange` property of `data`.
  148. // Later we will check if it was returned by `convert` method.
  149. data.modelRange = ModelRange._createOn( paragraph );
  150. } );
  151. // Use `additionalData` parameter to check if it was passed to the event.
  152. const conversionResult = model.change( writer => dispatcher.convert( viewElement, writer ) );
  153. // Check conversion result.
  154. // Result should be wrapped in document fragment.
  155. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  156. expect( conversionResult.getChild( 0 ).name ).to.equal( 'paragraph' );
  157. expect( spy.calledOnce ).to.be.true;
  158. } );
  159. it( 'should convert ViewDocumentFragment', () => {
  160. const spy = sinon.spy();
  161. const viewFragment = new ViewDocumentFragment( viewDocument );
  162. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  163. // Check if this method has been fired.
  164. spy();
  165. // Check correctness of passed parameters.
  166. expect( evt.name ).to.equal( 'documentFragment' );
  167. expect( data.viewItem ).to.equal( viewFragment );
  168. expect( data.modelCursor ).to.instanceof( ModelPosition );
  169. // Check whether consumable has appropriate value to consume.
  170. expect( conversionApi.consumable.consume( data.viewItem ) ).to.be.true;
  171. // Check whether conversionApi of `dispatcher` has been passed.
  172. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  173. const text = conversionApi.writer.createText( 'foo' );
  174. conversionApi.writer.insert( text, data.modelCursor );
  175. // Set conversion result to `modelRange` property of `data`.
  176. // Later we will check if it was returned by `convert` method.
  177. data.modelRange = ModelRange._createOn( text );
  178. } );
  179. const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) );
  180. // Check conversion result.
  181. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  182. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foo' );
  183. expect( spy.calledOnce ).to.be.true;
  184. } );
  185. it( 'should remove empty elements that was created as a result of split', () => {
  186. const viewElement = new ViewElement( viewDocument, 'div', null, [
  187. new ViewElement( viewDocument, 'p', null, [
  188. new ViewElement( viewDocument, 'img' )
  189. ] )
  190. ] );
  191. model.schema.register( 'div', { allowIn: '$root' } );
  192. model.schema.register( 'p', { allowIn: 'div' } );
  193. model.schema.register( 'image', { allowIn: '$root' } );
  194. dispatcher.on( 'element:img', ( evt, data, conversionApi ) => {
  195. const writer = conversionApi.writer;
  196. const modelElement = writer.createElement( 'image' );
  197. const splitResult = conversionApi.splitToAllowedParent( modelElement, data.modelCursor );
  198. writer.insert( modelElement, splitResult.position );
  199. data.modelRange = writer.createRangeOn( modelElement );
  200. data.modelCursor = writer.createPositionAt( splitResult.cursorParent, 0 );
  201. // Prevent below converter to fire.
  202. evt.stop();
  203. }, { priority: 'high' } );
  204. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  205. const writer = conversionApi.writer;
  206. const modelElement = writer.createElement( data.viewItem.name );
  207. writer.insert( modelElement, data.modelCursor );
  208. const result = conversionApi.convertChildren( data.viewItem, writer.createPositionAt( modelElement, 0 ) );
  209. data.modelRange = writer.createRange(
  210. writer.createPositionBefore( modelElement ),
  211. conversionApi.writer.createPositionAfter( result.modelCursor.parent )
  212. );
  213. data.modelCursor = data.modelRange.end;
  214. } );
  215. const result = model.change( writer => dispatcher.convert( viewElement, writer ) );
  216. // After splits `div` and `p` are empty so they should be removed.
  217. expect( result.childCount ).to.equal( 1 );
  218. expect( result.getChild( 0 ).name ).to.equal( 'image' );
  219. } );
  220. it( 'should extract temporary markers elements from converter element and create static markers list', () => {
  221. const viewFragment = new ViewDocumentFragment( viewDocument );
  222. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  223. // Create model fragment.
  224. const fragment = new ModelDocumentFragment( [
  225. new ModelText( 'fo' ),
  226. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  227. new ModelText( 'o' ),
  228. new ModelElement( '$marker', { 'data-name': 'marker2' } ),
  229. new ModelText( 'b' ),
  230. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  231. new ModelText( 'ar' ),
  232. ] );
  233. // Insert to conversion tree.
  234. conversionApi.writer.insert( fragment, data.modelCursor );
  235. // Create range on this fragment as a conversion result.
  236. data.modelRange = ModelRange._createIn( data.modelCursor.parent );
  237. } );
  238. const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) );
  239. expect( conversionResult.markers.size ).to.equal( 2 );
  240. const marker1 = conversionResult.markers.get( 'marker1' );
  241. const marker2 = conversionResult.markers.get( 'marker2' );
  242. expect( marker1.start.path ).to.deep.equal( [ 2 ] );
  243. expect( marker1.end.path ).to.deep.equal( [ 4 ] );
  244. expect( marker2.start.path ).to.deep.equal( marker2.end.path ).to.deep.equal( [ 3 ] );
  245. } );
  246. it( 'should convert according to given context', () => {
  247. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  248. const spy = sinon.spy();
  249. const viewElement = new ViewContainerElement( viewDocument, 'third' );
  250. let checkChildResult;
  251. model.schema.register( 'first', {
  252. allowIn: '$root'
  253. } );
  254. model.schema.register( 'second', {
  255. allowIn: 'first'
  256. } );
  257. model.schema.register( 'third', {
  258. allowIn: 'second',
  259. disallowIn: 'first'
  260. } );
  261. dispatcher.on( 'element:third', ( evt, data, conversionApi ) => {
  262. spy();
  263. checkChildResult = conversionApi.schema.checkChild( data.modelCursor, 'third' );
  264. } );
  265. // Default context $root.
  266. model.change( writer => dispatcher.convert( viewElement, writer ) );
  267. sinon.assert.calledOnce( spy );
  268. expect( checkChildResult ).to.false;
  269. // SchemaDefinition as context.
  270. model.change( writer => dispatcher.convert( viewElement, writer, [ 'first' ] ) );
  271. sinon.assert.calledTwice( spy );
  272. expect( checkChildResult ).to.false;
  273. // Position as context.
  274. const fragment = new ModelDocumentFragment( [
  275. new ModelElement( 'first', { foo: 'bar' }, [
  276. new ModelElement( 'second', null )
  277. ] )
  278. ] );
  279. model.change( writer => dispatcher.convert( viewElement, writer, new ModelPosition( fragment, [ 0, 0, 0 ] ) ) );
  280. sinon.assert.calledThrice( spy );
  281. expect( checkChildResult ).to.true;
  282. } );
  283. } );
  284. describe( 'conversionApi', () => {
  285. let spy, spyP, spyText, viewP, viewText, modelP, modelText, rootMock, dispatcher,
  286. spyNull, spyArray, viewDiv, viewNull, viewArray;
  287. beforeEach( () => {
  288. spy = sinon.spy();
  289. spyP = sinon.spy();
  290. spyText = sinon.spy();
  291. viewP = new ViewContainerElement( viewDocument, 'p' );
  292. viewText = new ViewText( viewDocument, 'foobar' );
  293. modelP = new ModelElement( 'paragraph' );
  294. modelText = new ModelText( 'foobar' );
  295. // Put nodes to documentFragment, this will mock root element and makes possible to create range on them.
  296. rootMock = new ModelDocumentFragment( [ modelP, modelText ] );
  297. dispatcher = new UpcastDispatcher( { schema: model.schema } );
  298. dispatcher.on( 'element:p', ( evt, data ) => {
  299. spyP();
  300. data.modelRange = ModelRange._createOn( modelP );
  301. data.modelCursor = data.modelRange.end;
  302. } );
  303. dispatcher.on( 'text', ( evt, data ) => {
  304. spyText();
  305. data.modelRange = ModelRange._createOn( modelText );
  306. data.modelCursor = data.modelRange.end;
  307. } );
  308. spyNull = sinon.spy();
  309. spyArray = sinon.spy();
  310. viewDiv = new ViewContainerElement( viewDocument, 'div' ); // Will not be recognized and not converted.
  311. viewNull = new ViewContainerElement( viewDocument, 'null' ); // Will return `null` in `data.modelRange` upon conversion.
  312. viewArray = new ViewContainerElement( viewDocument, 'array' ); // Will return an array in `data.modelRange` upon conversion.
  313. dispatcher.on( 'element:null', ( evt, data ) => {
  314. spyNull();
  315. data.modelRange = null;
  316. } );
  317. dispatcher.on( 'element:array', ( evt, data ) => {
  318. spyArray();
  319. data.modelRange = [ new ModelText( 'foo' ) ];
  320. } );
  321. } );
  322. describe( 'convertItem()', () => {
  323. it( 'should call proper converter and return correct data', () => {
  324. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  325. spy();
  326. const pResult = conversionApi.convertItem( viewP, data.modelCursor );
  327. expect( pResult.modelRange ).instanceof( ModelRange );
  328. expect( pResult.modelRange.start.path ).to.deep.equal( [ 0 ] );
  329. expect( pResult.modelRange.end.path ).to.deep.equal( [ 1 ] );
  330. expect( first( pResult.modelRange.getItems() ) ).to.equal( modelP );
  331. expect( pResult.modelCursor ).to.instanceof( ModelPosition );
  332. expect( pResult.modelCursor.path ).to.deep.equal( [ 1 ] );
  333. const textResult = conversionApi.convertItem( viewText, data.modelCursor );
  334. expect( textResult.modelRange ).instanceof( ModelRange );
  335. expect( textResult.modelRange.start.path ).to.deep.equal( [ 1 ] );
  336. expect( textResult.modelRange.end.path ).to.deep.equal( [ 7 ] );
  337. expect( first( textResult.modelRange.getItems() ) ).to.instanceof( ModelTextProxy );
  338. expect( first( textResult.modelRange.getItems() ).data ).to.equal( 'foobar' );
  339. expect( textResult.modelCursor ).to.instanceof( ModelPosition );
  340. expect( textResult.modelCursor.path ).to.deep.equal( [ 7 ] );
  341. } );
  342. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  343. expect( spy.calledOnce ).to.be.true;
  344. expect( spyP.calledOnce ).to.be.true;
  345. expect( spyText.calledOnce ).to.be.true;
  346. } );
  347. it( 'should do nothing if element was not converted', () => {
  348. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  349. spy();
  350. expect( conversionApi.convertItem( viewDiv, data.modelCursor ).modelRange ).to.equal( null );
  351. expect( conversionApi.convertItem( viewNull, data.modelCursor ).modelRange ).to.equal( null );
  352. } );
  353. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  354. expect( spy.calledOnce ).to.be.true;
  355. expect( spyNull.calledOnce ).to.be.true;
  356. } );
  357. it( 'should throw an error if element was incorrectly converted', () => {
  358. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  359. spy();
  360. conversionApi.convertItem( viewArray, data.modelCursor );
  361. } );
  362. expectToThrowCKEditorError( () => {
  363. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  364. }, /^view-conversion-dispatcher-incorrect-result/, model );
  365. expect( spy.calledOnce ).to.be.true;
  366. expect( spyArray.calledOnce ).to.be.true;
  367. } );
  368. } );
  369. describe( 'convertChildren()', () => {
  370. it( 'should fire conversion for all children of passed element and return conversion results ' +
  371. 'wrapped in document fragment', () => {
  372. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  373. spy();
  374. const result = conversionApi.convertChildren( data.viewItem, ModelPosition._createAt( rootMock, 0 ) );
  375. expect( result.modelRange ).to.be.instanceof( ModelRange );
  376. expect( result.modelRange.start.path ).to.deep.equal( [ 0 ] );
  377. expect( result.modelRange.end.path ).to.deep.equal( [ 7 ] );
  378. expect( Array.from( result.modelRange.getItems() ) ).to.length( 2 );
  379. expect( Array.from( result.modelRange.getItems() )[ 0 ] ).to.equal( modelP );
  380. expect( Array.from( result.modelRange.getItems() )[ 1 ] ).to.instanceof( ModelTextProxy );
  381. expect( Array.from( result.modelRange.getItems() )[ 1 ].data ).to.equal( 'foobar' );
  382. expect( result.modelCursor ).instanceof( ModelPosition );
  383. expect( result.modelCursor.path ).to.deep.equal( [ 7 ] );
  384. } );
  385. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument, [ viewP, viewText ] ), writer ) );
  386. expect( spy.calledOnce ).to.be.true;
  387. expect( spyP.calledOnce ).to.be.true;
  388. expect( spyText.calledOnce ).to.be.true;
  389. } );
  390. } );
  391. describe( 'splitToAllowedParent()', () => {
  392. beforeEach( () => {
  393. model.schema.register( 'paragraph', {
  394. allowIn: '$root'
  395. } );
  396. } );
  397. it( 'should return current position if element is allowed on this position', () => {
  398. const spy = sinon.spy();
  399. model.schema.register( 'span', {
  400. allowIn: 'paragraph'
  401. } );
  402. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  403. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  404. const span = conversionApi.writer.createElement( 'span' );
  405. const position = ModelPosition._createAt( paragraph, 0 );
  406. const result = conversionApi.splitToAllowedParent( span, position );
  407. expect( result ).to.deep.equal( { position } );
  408. spy();
  409. } );
  410. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  411. sinon.assert.calledOnce( spy );
  412. } );
  413. it( 'should split position to allowed ancestor if element is allowed in one of ancestors', () => {
  414. const spy = sinon.spy();
  415. model.schema.register( 'section', {
  416. allowIn: '$root'
  417. } );
  418. model.schema.register( 'span', {
  419. allowIn: 'paragraph'
  420. } );
  421. model.schema.extend( 'paragraph', {
  422. allowIn: 'section'
  423. } );
  424. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  425. const section = conversionApi.writer.createElement( 'section' );
  426. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  427. const span = conversionApi.writer.createElement( 'span' );
  428. conversionApi.writer.insert( paragraph, section );
  429. conversionApi.writer.insert( span, paragraph );
  430. const position = ModelPosition._createAt( span, 0 );
  431. const paragraph2 = conversionApi.writer.createElement( 'paragraph' );
  432. const result = conversionApi.splitToAllowedParent( paragraph2, position );
  433. expect( result ).to.deep.equal( {
  434. position: ModelPosition._createAfter( paragraph ),
  435. cursorParent: paragraph.parent.getChild( 1 ).getChild( 0 )
  436. } );
  437. spy();
  438. } );
  439. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  440. sinon.assert.calledOnce( spy );
  441. } );
  442. it( 'should return null if element is not allowed in position and any of ancestors', () => {
  443. const spy = sinon.spy();
  444. model.schema.register( 'span' );
  445. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  446. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  447. const span = conversionApi.writer.createElement( 'span' );
  448. const position = ModelPosition._createAt( paragraph, 0 );
  449. const result = conversionApi.splitToAllowedParent( span, position );
  450. expect( result ).to.null;
  451. spy();
  452. } );
  453. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer ) );
  454. sinon.assert.calledOnce( spy );
  455. } );
  456. it( 'should return null if element is not allowed in position and any of ancestors but is allowed in context tree', () => {
  457. const spy = sinon.spy();
  458. model.schema.register( 'div', {
  459. allowIn: '$root',
  460. } );
  461. dispatcher.on( 'documentFragment', ( evt, data, conversionApi ) => {
  462. const code = conversionApi.writer.createElement( 'div' );
  463. const result = conversionApi.splitToAllowedParent( code, data.modelCursor );
  464. expect( result ).to.null;
  465. spy();
  466. } );
  467. model.change( writer => dispatcher.convert( new ViewDocumentFragment( viewDocument ), writer, [ '$root', 'paragraph' ] ) );
  468. sinon.assert.calledOnce( spy );
  469. } );
  470. } );
  471. describe( 'getSplitParts()', () => {
  472. it( 'should return an array containing only passed element if the element has not been split', () => {
  473. model.schema.register( 'paragraph', { allowIn: '$root' } );
  474. const spy = sinon.spy();
  475. dispatcher.on( 'element', ( evt, data, conversionApi ) => {
  476. const modelElement = conversionApi.writer.createElement( 'paragraph' );
  477. const parts = conversionApi.getSplitParts( modelElement );
  478. expect( parts ).to.deep.equal( [ modelElement ] );
  479. spy();
  480. // Overwrite converters specified in `beforeEach`.
  481. evt.stop();
  482. }, { priority: 'high' } );
  483. const viewElement = new ViewElement( viewDocument, 'p' );
  484. model.change( writer => dispatcher.convert( viewElement, writer ) );
  485. expect( spy.called ).to.be.true;
  486. } );
  487. it( 'should return all parts of the split element', () => {
  488. model.schema.register( 'paragraph', { allowIn: '$root' } );
  489. model.schema.register( 'text', { allowIn: 'paragraph' } );
  490. model.schema.register( 'image', { allowIn: '$root' } );
  491. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  492. const modelText = conversionApi.writer.createText( data.viewItem.data );
  493. conversionApi.writer.insert( modelText, data.modelCursor );
  494. data.modelRange = conversionApi.writer.createRangeOn( modelText );
  495. data.modelCursor = data.modelRange.end;
  496. // Overwrite converters specified in `beforeEach`.
  497. evt.stop();
  498. }, { priority: 'high' } );
  499. dispatcher.on( 'element:image', ( evt, data, conversionApi ) => {
  500. const modelElement = conversionApi.writer.createElement( 'image' );
  501. const splitResult = conversionApi.splitToAllowedParent( modelElement, data.modelCursor );
  502. conversionApi.writer.insert( modelElement, splitResult.position );
  503. data.modelRange = conversionApi.writer.createRangeOn( modelElement );
  504. data.modelCursor = conversionApi.writer.createPositionAt( splitResult.cursorParent, 0 );
  505. // Overwrite converters specified in `beforeEach`.
  506. evt.stop();
  507. }, { priority: 'high' } );
  508. const spy = sinon.spy();
  509. dispatcher.on( 'element:p', ( evt, data, conversionApi ) => {
  510. const modelElement = conversionApi.writer.createElement( 'paragraph' );
  511. conversionApi.writer.insert( modelElement, data.modelCursor );
  512. conversionApi.convertChildren( data.viewItem, conversionApi.writer.createPositionAt( modelElement, 0 ) );
  513. const parts = conversionApi.getSplitParts( modelElement );
  514. expect( parts.length ).to.equal( 3 );
  515. expect( parts[ 0 ].getChild( 0 ).data ).to.equal( 'foo' );
  516. expect( parts[ 1 ].getChild( 0 ).data ).to.equal( 'bar' );
  517. expect( parts[ 2 ].getChild( 0 ).data ).to.equal( 'xyz' );
  518. expect( parts[ 0 ] ).to.equal( modelElement );
  519. spy();
  520. // Overwrite converters specified in `beforeEach`.
  521. evt.stop();
  522. }, { priority: 'high' } );
  523. const viewElement = new ViewElement( viewDocument, 'p', null, [
  524. new ViewText( viewDocument, 'foo' ),
  525. new ViewElement( viewDocument, 'image' ),
  526. new ViewText( viewDocument, 'bar' ),
  527. new ViewElement( viewDocument, 'image' ),
  528. new ViewText( viewDocument, 'xyz' )
  529. ] );
  530. model.change( writer => dispatcher.convert( viewElement, writer, [ '$root' ] ) );
  531. expect( spy.called ).to.be.true;
  532. } );
  533. } );
  534. } );
  535. } );