upcastdispatcher.js 23 KB

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