8
0

model-to-view-converters.js 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ModelDocument from 'ckeditor5/engine/model/document.js';
  7. import ModelElement from 'ckeditor5/engine/model/element.js';
  8. import ModelText from 'ckeditor5/engine/model/text.js';
  9. import ModelRange from 'ckeditor5/engine/model/range.js';
  10. import ModelPosition from 'ckeditor5/engine/model/position.js';
  11. import modelWriter from 'ckeditor5/engine/model/writer.js';
  12. import ViewElement from 'ckeditor5/engine/view/element.js';
  13. import ViewContainerElement from 'ckeditor5/engine/view/containerelement.js';
  14. import ViewAttributeElement from 'ckeditor5/engine/view/attributeelement.js';
  15. import ViewText from 'ckeditor5/engine/view/text.js';
  16. import Mapper from 'ckeditor5/engine/conversion/mapper.js';
  17. import ModelConversionDispatcher from 'ckeditor5/engine/conversion/modelconversiondispatcher.js';
  18. import {
  19. insertElement,
  20. insertText,
  21. setAttribute,
  22. removeAttribute,
  23. wrap,
  24. unwrap,
  25. move,
  26. remove,
  27. rename
  28. } from 'ckeditor5/engine/conversion/model-to-view-converters.js';
  29. import { createRangeOnElementOnly } from 'tests/engine/model/_utils/utils.js';
  30. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  31. beforeEach( () => {
  32. modelDoc = new ModelDocument();
  33. modelRoot = modelDoc.createRoot();
  34. viewRoot = new ViewContainerElement( 'div' );
  35. mapper = new Mapper();
  36. mapper.bindElements( modelRoot, viewRoot );
  37. dispatcher = new ModelConversionDispatcher( { mapper } );
  38. } );
  39. function viewAttributesToString( item ) {
  40. let result = '';
  41. for ( let key of item.getAttributeKeys() ) {
  42. let value = item.getAttribute( key );
  43. if ( value ) {
  44. result += ' ' + key + '="' + value + '"';
  45. }
  46. }
  47. return result;
  48. }
  49. function viewToString( item ) {
  50. let result = '';
  51. if ( item instanceof ViewText ) {
  52. result = item.data;
  53. } else {
  54. // ViewElement or ViewDocumentFragment.
  55. for ( let child of item.getChildren() ) {
  56. result += viewToString( child );
  57. }
  58. if ( item instanceof ViewElement ) {
  59. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  60. }
  61. }
  62. return result;
  63. }
  64. describe( 'insertText', () => {
  65. it( 'should convert text insertion in model to view text', () => {
  66. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  67. dispatcher.on( 'insert:$text', insertText() );
  68. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  69. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  70. } );
  71. it( 'should support unicode', () => {
  72. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  73. dispatcher.on( 'insert:$text', insertText() );
  74. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  75. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  76. } );
  77. it( 'should be possible to override it', () => {
  78. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  79. dispatcher.on( 'insert:$text', insertText() );
  80. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  81. consumable.consume( data.item, 'insert' );
  82. }, { priority: 'high' } );
  83. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  84. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  85. } );
  86. } );
  87. describe( 'insertElement', () => {
  88. it( 'should convert element insertion in model to and map positions for future converting', () => {
  89. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  90. const viewElement = new ViewContainerElement( 'p' );
  91. modelRoot.appendChildren( modelElement );
  92. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  93. dispatcher.on( 'insert:$text', insertText() );
  94. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  95. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  96. } );
  97. it( 'should take view element function generator as a parameter', () => {
  98. const elementGenerator = ( data, consumable ) => {
  99. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  100. return new ViewContainerElement( 'div' );
  101. } else {
  102. return new ViewContainerElement( 'p' );
  103. }
  104. };
  105. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  106. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  107. modelRoot.appendChildren( [ niceP, badP ] );
  108. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  109. dispatcher.on( 'insert:$text', insertText() );
  110. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  111. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  112. } );
  113. } );
  114. describe( 'setAttribute/removeAttribute', () => {
  115. it( 'should convert attribute insert/change/remove on a model node', () => {
  116. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  117. const viewElement = new ViewContainerElement( 'p' );
  118. modelRoot.appendChildren( modelElement );
  119. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  120. dispatcher.on( 'insert:$text', insertText() );
  121. dispatcher.on( 'addAttribute:class', setAttribute() );
  122. dispatcher.on( 'changeAttribute:class', setAttribute() );
  123. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  124. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  125. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  126. modelElement.setAttribute( 'class', 'bar' );
  127. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  128. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  129. modelElement.removeAttribute( 'class' );
  130. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  131. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  132. } );
  133. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  134. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  135. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  136. const themeConverter = ( value, key, data ) => {
  137. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  138. value += ' ' + 'fix-content';
  139. }
  140. return { key: 'class', value };
  141. };
  142. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  143. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  144. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  145. dispatcher.on( 'insert:$text', insertText() );
  146. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  147. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  148. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  149. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  150. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  151. modelParagraph.setAttribute( 'theme', 'awesome' );
  152. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  153. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  154. modelParagraph.removeAttribute( 'theme' );
  155. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  156. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  157. } );
  158. it( 'should be possible to override setAttribute', () => {
  159. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  160. const viewElement = new ViewContainerElement( 'p' );
  161. modelRoot.appendChildren( modelElement );
  162. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  163. dispatcher.on( 'insert:$text', insertText() );
  164. dispatcher.on( 'addAttribute:class', setAttribute() );
  165. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  166. consumable.consume( data.item, 'addAttribute:class' );
  167. }, { priority: 'high' } );
  168. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  169. // No attribute set.
  170. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  171. } );
  172. it( 'should be possible to override removeAttribute', () => {
  173. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  174. const viewElement = new ViewContainerElement( 'p' );
  175. modelRoot.appendChildren( modelElement );
  176. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  177. dispatcher.on( 'insert:$text', insertText() );
  178. dispatcher.on( 'addAttribute:class', setAttribute() );
  179. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  180. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  181. consumable.consume( data.item, 'removeAttribute:class' );
  182. }, { priority: 'high' } );
  183. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  184. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  185. modelElement.removeAttribute( 'class' );
  186. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  187. // Nothing changed.
  188. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  189. } );
  190. } );
  191. describe( 'wrap/unwrap', () => {
  192. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  193. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  194. const viewP = new ViewContainerElement( 'p' );
  195. const viewB = new ViewAttributeElement( 'b' );
  196. modelRoot.appendChildren( modelElement );
  197. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  198. dispatcher.on( 'insert:$text', insertText() );
  199. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  200. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  201. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  203. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  204. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  205. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  206. } );
  207. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  208. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  209. const viewP = new ViewContainerElement( 'p' );
  210. const elementGenerator = ( value ) => {
  211. if ( value == 'bold' ) {
  212. return new ViewAttributeElement( 'b' );
  213. }
  214. };
  215. modelRoot.appendChildren( modelElement );
  216. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  217. dispatcher.on( 'insert:$text', insertText() );
  218. dispatcher.on( 'addAttribute:style', wrap( elementGenerator ) );
  219. dispatcher.on( 'removeAttribute:style', unwrap( elementGenerator ) );
  220. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  221. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  222. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  223. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  224. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  225. } );
  226. it( 'should update range on re-wrapping attribute (#475)', () => {
  227. const modelElement = new ModelElement( 'paragraph', null, [
  228. new ModelText( 'x' ),
  229. new ModelText( 'foo', { link: 'http://foo.com' } ),
  230. new ModelText( 'x' )
  231. ] );
  232. const viewP = new ViewContainerElement( 'p' );
  233. const elementGenerator = ( href ) => new ViewAttributeElement( 'a', { href } );
  234. modelRoot.appendChildren( modelElement );
  235. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  236. dispatcher.on( 'insert:$text', insertText() );
  237. dispatcher.on( 'addAttribute:link', wrap( elementGenerator ) );
  238. dispatcher.on( 'changeAttribute:link', wrap( elementGenerator ) );
  239. dispatcher.convertInsertion(
  240. ModelRange.createIn( modelRoot )
  241. );
  242. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  243. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  244. dispatcher.convertAttribute(
  245. 'changeAttribute',
  246. ModelRange.createIn( modelElement ),
  247. 'link',
  248. 'http://foo.com',
  249. 'http://foobar.com'
  250. );
  251. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  252. } );
  253. it( 'should support unicode', () => {
  254. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  255. const viewP = new ViewContainerElement( 'p' );
  256. const viewB = new ViewAttributeElement( 'b' );
  257. modelRoot.appendChildren( modelElement );
  258. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  259. dispatcher.on( 'insert:$text', insertText() );
  260. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  261. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  262. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  263. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  264. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  265. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  266. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  267. } );
  268. it( 'should be possible to override wrap', () => {
  269. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  270. const viewP = new ViewContainerElement( 'p' );
  271. const viewB = new ViewAttributeElement( 'b' );
  272. modelRoot.appendChildren( modelElement );
  273. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  274. dispatcher.on( 'insert:$text', insertText() );
  275. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  276. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  277. consumable.consume( data.item, 'addAttribute:bold' );
  278. }, { priority: 'high' } );
  279. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  280. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  281. } );
  282. it( 'should be possible to override unwrap', () => {
  283. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  284. const viewP = new ViewContainerElement( 'p' );
  285. const viewB = new ViewAttributeElement( 'b' );
  286. modelRoot.appendChildren( modelElement );
  287. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  288. dispatcher.on( 'insert:$text', insertText() );
  289. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  290. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  291. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  292. consumable.consume( data.item, 'removeAttribute:bold' );
  293. }, { priority: 'high' } );
  294. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  295. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  296. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  297. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  298. // Nothing changed.
  299. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  300. } );
  301. } );
  302. describe( 'move', () => {
  303. it( 'should move items in view accordingly to changes in model', () => {
  304. const modelDivA = new ModelElement( 'div', null, [
  305. new ModelText( 'foo' ),
  306. new ModelElement( 'image' ),
  307. new ModelText( 'bar' )
  308. ] );
  309. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  310. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  311. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  312. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  313. dispatcher.on( 'insert:$text', insertText() );
  314. dispatcher.on( 'move', move() );
  315. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  316. const removedNodes = modelDivA.removeChildren( 0, 2 );
  317. modelDivB.insertChildren( 0, removedNodes );
  318. dispatcher.convertMove(
  319. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  320. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  321. );
  322. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div><div>foo<img></img>xxyy</div></div>' );
  323. } );
  324. it( 'should not execute if value was already consumed', () => {
  325. const modelDivA = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  326. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  327. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  328. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  329. dispatcher.on( 'insert:$text', insertText() );
  330. dispatcher.on( 'move', move() );
  331. dispatcher.on( 'move', ( evt, data, consumable ) => {
  332. consumable.consume( data.item, 'move' );
  333. }, { priority: 'high' } );
  334. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  335. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  336. const removedNodes = modelDivA.removeChildren( 0, 1 );
  337. modelDivB.insertChildren( 0, removedNodes );
  338. dispatcher.convertMove(
  339. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  340. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 3 )
  341. );
  342. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  343. } );
  344. it( 'should support unicode', () => {
  345. const modelDivA = new ModelElement( 'div', null, 'நிலைக்கு' );
  346. const modelDivB = new ModelElement( 'div' );
  347. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  348. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  349. dispatcher.on( 'insert:$text', insertText() );
  350. dispatcher.on( 'move', move() );
  351. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  352. modelWriter.move(
  353. ModelRange.createFromParentsAndOffsets( modelDivA, 2, modelDivA, 6 ),
  354. ModelPosition.createAt( modelDivB, 'end' )
  355. );
  356. dispatcher.convertMove(
  357. ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
  358. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  359. );
  360. expect( viewToString( viewRoot ) ).to.equal( '<div><div>நிகு</div><div>லைக்</div></div>' );
  361. } );
  362. } );
  363. describe( 'remove', () => {
  364. it( 'should remove items from view accordingly to changes in model', () => {
  365. const modelDiv = new ModelElement( 'div', null, [
  366. new ModelText( 'foo' ),
  367. new ModelElement( 'image' ),
  368. new ModelText( 'bar' )
  369. ] );
  370. modelRoot.appendChildren( modelDiv );
  371. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  372. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  373. dispatcher.on( 'insert:$text', insertText() );
  374. dispatcher.on( 'remove', remove() );
  375. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  376. const removedNodes = modelDiv.removeChildren( 0, 2 );
  377. modelDoc.graveyard.insertChildren( 0, removedNodes );
  378. dispatcher.convertRemove(
  379. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  380. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  381. );
  382. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  383. } );
  384. it( 'should not execute if value was already consumed', () => {
  385. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  386. modelRoot.appendChildren( modelDiv );
  387. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  388. dispatcher.on( 'insert:$text', insertText() );
  389. dispatcher.on( 'remove', remove() );
  390. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  391. consumable.consume( data.item, 'remove' );
  392. }, { priority: 'high' } );
  393. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  394. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  395. const removedNodes = modelDiv.removeChildren( 0, 1 );
  396. modelDoc.graveyard.insertChildren( 0, removedNodes );
  397. dispatcher.convertRemove(
  398. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  399. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  400. );
  401. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  402. } );
  403. it( 'should support unicode', () => {
  404. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  405. modelRoot.appendChildren( modelDiv );
  406. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  407. dispatcher.on( 'insert:$text', insertText() );
  408. dispatcher.on( 'remove', remove() );
  409. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  410. modelWriter.move(
  411. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  412. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  413. );
  414. dispatcher.convertRemove(
  415. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  416. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  417. );
  418. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  419. } );
  420. } );
  421. describe( 'rename', () => {
  422. const oldName = 'oldName';
  423. const newName = 'newName';
  424. let element, converters;
  425. beforeEach( () => {
  426. converters = {
  427. insertText: insertText(),
  428. insert: insertElement( ( data ) => new ViewContainerElement( data.item.name ) ),
  429. move: move(),
  430. remove: remove(),
  431. rename: rename()
  432. };
  433. sinon.spy( converters, 'insert' );
  434. sinon.spy( converters, 'move' );
  435. sinon.spy( converters, 'remove' );
  436. element = new ModelElement( oldName, null, new ModelText( 'foo' ) );
  437. modelRoot.appendChildren( element );
  438. dispatcher.on( 'insert:$text', converters.insertText );
  439. dispatcher.on( 'insert', converters.insert );
  440. dispatcher.on( 'move', converters.move );
  441. dispatcher.on( 'remove', converters.remove );
  442. dispatcher.on( 'rename', converters.rename );
  443. dispatcher.convertInsertion( ModelRange.createOn( element ) );
  444. element.name = newName;
  445. } );
  446. afterEach( () => {
  447. converters.insert.restore();
  448. converters.move.restore();
  449. converters.remove.restore();
  450. } );
  451. it( 'should enable default rename conversion, that uses already registered callbacks', () => {
  452. const insertCallCount = converters.insert.callCount;
  453. expect( viewRoot.getChild( 0 ).name ).to.equal( 'oldName' );
  454. dispatcher.convertRename( element, oldName );
  455. expect( converters.insert.callCount - insertCallCount ).to.equal( 1 );
  456. expect( converters.move.calledOnce ).to.be.true;
  457. expect( converters.remove.calledOnce ).to.be.true;
  458. expect( viewRoot.getChild( 0 ).name ).to.equal( 'newName' );
  459. expect( viewRoot.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  460. } );
  461. it( 'should not execute if converted value was already consumed', () => {
  462. dispatcher.on( 'rename', ( evt, data, consumable ) => {
  463. consumable.consume( data.element, 'rename' );
  464. }, { priority: 'high' } );
  465. dispatcher.on( 'rename', ( evt, data ) => {
  466. expect( data.fakeElement ).to.be.undefined;
  467. } );
  468. dispatcher.convertRename( element, oldName );
  469. } );
  470. } );