upcastdispatcher.js 26 KB

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