8
0

model-to-view-converters.js 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelDocument from '../../src/model/document';
  6. import ModelElement from '../../src/model/element';
  7. import ModelText from '../../src/model/text';
  8. import ModelRange from '../../src/model/range';
  9. import ModelPosition from '../../src/model/position';
  10. import modelWriter from '../../src/model/writer';
  11. import ViewElement from '../../src/view/element';
  12. import ViewContainerElement from '../../src/view/containerelement';
  13. import ViewAttributeElement from '../../src/view/attributeelement';
  14. import ViewUIElement from '../../src/view/uielement';
  15. import ViewText from '../../src/view/text';
  16. import Mapper from '../../src/conversion/mapper';
  17. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  18. import {
  19. insertElement,
  20. insertText,
  21. insertUIElement,
  22. setAttribute,
  23. removeAttribute,
  24. wrapItem,
  25. unwrapItem,
  26. remove,
  27. removeUIElement,
  28. highlightText,
  29. highlightElement,
  30. highlightDescriptorToAttributeElement
  31. } from '../../src/conversion/model-to-view-converters';
  32. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  33. describe( 'model-to-view-converters', () => {
  34. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  35. beforeEach( () => {
  36. modelDoc = new ModelDocument();
  37. modelRoot = modelDoc.createRoot();
  38. viewRoot = new ViewContainerElement( 'div' );
  39. mapper = new Mapper();
  40. mapper.bindElements( modelRoot, viewRoot );
  41. dispatcher = new ModelConversionDispatcher( modelDoc, { mapper } );
  42. } );
  43. function viewAttributesToString( item ) {
  44. let result = '';
  45. for ( const key of item.getAttributeKeys() ) {
  46. const value = item.getAttribute( key );
  47. if ( value ) {
  48. result += ' ' + key + '="' + value + '"';
  49. }
  50. }
  51. return result;
  52. }
  53. function viewToString( item ) {
  54. let result = '';
  55. if ( item instanceof ViewText ) {
  56. result = item.data;
  57. } else {
  58. // ViewElement or ViewDocumentFragment.
  59. for ( const child of item.getChildren() ) {
  60. result += viewToString( child );
  61. }
  62. if ( item instanceof ViewElement ) {
  63. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  64. }
  65. }
  66. return result;
  67. }
  68. describe( 'highlightText()', () => {
  69. let modelElement1, modelElement2, markerRange;
  70. const highlightDescriptor = {
  71. class: 'highlight-class',
  72. priority: 7,
  73. attributes: { title: 'title' }
  74. };
  75. beforeEach( () => {
  76. const modelText1 = new ModelText( 'foo' );
  77. modelElement1 = new ModelElement( 'paragraph', null, modelText1 );
  78. const modelText2 = new ModelText( 'bar' );
  79. modelElement2 = new ModelElement( 'paragraph', null, modelText2 );
  80. modelRoot.appendChildren( modelElement1 );
  81. modelRoot.appendChildren( modelElement2 );
  82. dispatcher.on( 'insert:paragraph', insertElement( () => new ViewContainerElement( 'p' ) ) );
  83. dispatcher.on( 'insert:$text', insertText() );
  84. markerRange = ModelRange.createIn( modelRoot );
  85. } );
  86. it( 'should wrap and unwrap text nodes', () => {
  87. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  88. dispatcher.on( 'removeMarker:marker', highlightText( highlightDescriptor ) );
  89. dispatcher.convertInsertion( markerRange );
  90. modelDoc.markers.set( 'marker', markerRange );
  91. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  92. expect( viewToString( viewRoot ) ).to.equal(
  93. '<div>' +
  94. '<p>' +
  95. '<span class="highlight-class" title="title">foo</span>' +
  96. '</p>' +
  97. '<p>' +
  98. '<span class="highlight-class" title="title">bar</span>' +
  99. '</p>' +
  100. '</div>'
  101. );
  102. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  103. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  104. } );
  105. it( 'should not convert marker on elements already consumed', () => {
  106. const newDescriptor = { class: 'override-class' };
  107. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  108. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  109. dispatcher.on( 'removeMarker:marker', highlightText( highlightDescriptor ) );
  110. dispatcher.on( 'removeMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  111. dispatcher.convertInsertion( markerRange );
  112. modelDoc.markers.set( 'marker', markerRange );
  113. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  114. expect( viewToString( viewRoot ) ).to.equal(
  115. '<div>' +
  116. '<p>' +
  117. '<span class="override-class">foo</span>' +
  118. '</p>' +
  119. '<p>' +
  120. '<span class="override-class">bar</span>' +
  121. '</p>' +
  122. '</div>'
  123. );
  124. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  125. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  126. } );
  127. it( 'should do nothing if descriptor is not provided', () => {
  128. dispatcher.on( 'addMarker:marker', highlightText( () => null ) );
  129. dispatcher.on( 'removeMarker:marker', highlightText( () => null ) );
  130. dispatcher.convertInsertion( markerRange );
  131. modelDoc.markers.set( 'marker', markerRange );
  132. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  133. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  134. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  135. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  136. } );
  137. } );
  138. describe( 'highlightElement()', () => {
  139. let modelElement1, modelElement2, markerRange;
  140. const highlightDescriptor = {
  141. class: 'highlight-class',
  142. priority: 7,
  143. attributes: { title: 'title' }
  144. };
  145. beforeEach( () => {
  146. const modelText1 = new ModelText( 'foo' );
  147. modelElement1 = new ModelElement( 'paragraph', null, modelText1 );
  148. const modelText2 = new ModelText( 'bar' );
  149. modelElement2 = new ModelElement( 'paragraph', null, modelText2 );
  150. modelRoot.appendChildren( modelElement1 );
  151. modelRoot.appendChildren( modelElement2 );
  152. dispatcher.on( 'insert:paragraph', insertElement( () => new ViewContainerElement( 'p' ) ) );
  153. dispatcher.on( 'insert:$text', insertText() );
  154. markerRange = ModelRange.createIn( modelRoot );
  155. } );
  156. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  157. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  158. dispatcher.on( 'removeMarker:marker', highlightElement( highlightDescriptor ) );
  159. dispatcher.on( 'insert:paragraph', insertElement( data => {
  160. // Use special converter only for first paragraph.
  161. if ( data.item == modelElement2 ) {
  162. return;
  163. }
  164. const viewContainer = new ViewContainerElement( 'p' );
  165. viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  166. element.addClass( 'highlight-own-class' );
  167. expect( descriptor ).to.equal( highlightDescriptor );
  168. } );
  169. viewContainer.setCustomProperty( 'removeHighlight', ( element, descriptor ) => {
  170. element.removeClass( 'highlight-own-class' );
  171. expect( descriptor ).to.equal( highlightDescriptor );
  172. } );
  173. return viewContainer;
  174. } ), { priority: 'high' } );
  175. dispatcher.convertInsertion( markerRange );
  176. modelDoc.markers.set( 'marker', markerRange );
  177. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  178. expect( viewToString( viewRoot ) ).to.equal(
  179. '<div>' +
  180. '<p class="highlight-own-class">' +
  181. 'foo' +
  182. '</p>' +
  183. '<p>' +
  184. 'bar' +
  185. '</p>' +
  186. '</div>'
  187. );
  188. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  189. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  190. } );
  191. it( 'should not convert marker on elements already consumed', () => {
  192. const newDescriptor = { class: 'override-class' };
  193. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  194. dispatcher.on( 'removeMarker:marker', highlightElement( highlightDescriptor ) );
  195. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  196. dispatcher.on( 'removeMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  197. dispatcher.on( 'insert:paragraph', insertElement( () => {
  198. const element = new ViewContainerElement( 'p' );
  199. element.setCustomProperty( 'addHighlight', ( element, data ) => element.addClass( data.class ) );
  200. element.setCustomProperty( 'removeHighlight', ( element, data ) => element.removeClass( data.class ) );
  201. return element;
  202. } ), { priority: 'high' } );
  203. dispatcher.convertInsertion( markerRange );
  204. modelDoc.markers.set( 'marker', markerRange );
  205. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  206. expect( viewToString( viewRoot ) ).to.equal(
  207. '<div>' +
  208. '<p class="override-class">' +
  209. 'foo' +
  210. '</p>' +
  211. '<p class="override-class">' +
  212. 'bar' +
  213. '</p>' +
  214. '</div>'
  215. );
  216. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  217. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  218. } );
  219. it( 'should do nothing if descriptor is not provided', () => {
  220. dispatcher.on( 'addMarker:marker', highlightElement( () => null ) );
  221. dispatcher.on( 'removeMarker:marker', highlightElement( () => null ) );
  222. dispatcher.convertInsertion( markerRange );
  223. modelDoc.markers.set( 'marker', markerRange );
  224. dispatcher.convertMarker( 'addMarker', 'marker', markerRange );
  225. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  226. dispatcher.convertMarker( 'removeMarker', 'marker', markerRange );
  227. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  228. } );
  229. } );
  230. describe( 'insertText', () => {
  231. it( 'should convert text insertion in model to view text', () => {
  232. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  233. dispatcher.on( 'insert:$text', insertText() );
  234. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  235. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  236. } );
  237. it( 'should support unicode', () => {
  238. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  239. dispatcher.on( 'insert:$text', insertText() );
  240. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  241. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  242. } );
  243. it( 'should be possible to override it', () => {
  244. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  245. dispatcher.on( 'insert:$text', insertText() );
  246. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  247. consumable.consume( data.item, 'insert' );
  248. }, { priority: 'high' } );
  249. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  250. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  251. } );
  252. } );
  253. describe( 'insertElement', () => {
  254. it( 'should convert element insertion in model to and map positions for future converting', () => {
  255. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  256. const viewElement = new ViewContainerElement( 'p' );
  257. modelRoot.appendChildren( modelElement );
  258. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  259. dispatcher.on( 'insert:$text', insertText() );
  260. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  261. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  262. } );
  263. it( 'should take view element function generator as a parameter', () => {
  264. const elementGenerator = ( data, consumable ) => {
  265. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  266. return new ViewContainerElement( 'div' );
  267. } else {
  268. return new ViewContainerElement( 'p' );
  269. }
  270. };
  271. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  272. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  273. modelRoot.appendChildren( [ niceP, badP ] );
  274. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  275. dispatcher.on( 'insert:$text', insertText() );
  276. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  277. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  278. } );
  279. it( 'should not convert and not consume if creator function returned null', () => {
  280. const elementGenerator = () => null;
  281. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  282. modelRoot.appendChildren( [ modelP ] );
  283. sinon.spy( dispatcher, 'fire' );
  284. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ) );
  285. dispatcher.on( 'insert:paragraph', ( evt, data, consumable ) => {
  286. expect( consumable.test( data.item, 'insert' ) ).to.be.true;
  287. } );
  288. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  289. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  290. expect( dispatcher.fire.calledWith( 'insert:paragraph' ) ).to.be.true;
  291. } );
  292. } );
  293. describe( 'setAttribute/removeAttribute', () => {
  294. it( 'should convert attribute insert/change/remove on a model node', () => {
  295. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  296. const viewElement = new ViewContainerElement( 'p' );
  297. modelRoot.appendChildren( modelElement );
  298. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  299. dispatcher.on( 'insert:$text', insertText() );
  300. dispatcher.on( 'addAttribute:class', setAttribute() );
  301. dispatcher.on( 'changeAttribute:class', setAttribute() );
  302. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  303. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  304. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  305. modelElement.setAttribute( 'class', 'bar' );
  306. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  307. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  308. modelElement.removeAttribute( 'class' );
  309. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  310. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  311. } );
  312. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  313. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  314. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  315. const themeConverter = ( value, key, data ) => {
  316. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  317. value += ' fix-content';
  318. }
  319. return { key: 'class', value };
  320. };
  321. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  322. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  323. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  324. dispatcher.on( 'insert:$text', insertText() );
  325. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  326. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  327. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  328. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  329. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  330. modelParagraph.setAttribute( 'theme', 'awesome' );
  331. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  332. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  333. modelParagraph.removeAttribute( 'theme' );
  334. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  335. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  336. } );
  337. it( 'should be possible to override setAttribute', () => {
  338. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  339. const viewElement = new ViewContainerElement( 'p' );
  340. modelRoot.appendChildren( modelElement );
  341. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  342. dispatcher.on( 'insert:$text', insertText() );
  343. dispatcher.on( 'addAttribute:class', setAttribute() );
  344. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  345. consumable.consume( data.item, 'addAttribute:class' );
  346. }, { priority: 'high' } );
  347. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  348. // No attribute set.
  349. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  350. } );
  351. it( 'should be possible to override removeAttribute', () => {
  352. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  353. const viewElement = new ViewContainerElement( 'p' );
  354. modelRoot.appendChildren( modelElement );
  355. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  356. dispatcher.on( 'insert:$text', insertText() );
  357. dispatcher.on( 'addAttribute:class', setAttribute() );
  358. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  359. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  360. consumable.consume( data.item, 'removeAttribute:class' );
  361. }, { priority: 'high' } );
  362. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  363. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  364. modelElement.removeAttribute( 'class' );
  365. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  366. // Nothing changed.
  367. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  368. } );
  369. } );
  370. describe( 'wrap/unwrap', () => {
  371. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  372. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  373. const viewP = new ViewContainerElement( 'p' );
  374. const viewB = new ViewAttributeElement( 'b' );
  375. modelRoot.appendChildren( modelElement );
  376. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  377. dispatcher.on( 'insert:$text', insertText() );
  378. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  379. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  380. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  381. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  382. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  383. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  384. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  385. } );
  386. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  387. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  388. const viewP = new ViewContainerElement( 'p' );
  389. const elementGenerator = value => {
  390. if ( value == 'bold' ) {
  391. return new ViewAttributeElement( 'b' );
  392. }
  393. };
  394. modelRoot.appendChildren( modelElement );
  395. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  396. dispatcher.on( 'insert:$text', insertText() );
  397. dispatcher.on( 'addAttribute:style', wrapItem( elementGenerator ) );
  398. dispatcher.on( 'removeAttribute:style', unwrapItem( elementGenerator ) );
  399. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  400. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  401. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  402. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  403. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  404. } );
  405. it( 'should update range on re-wrapping attribute (#475)', () => {
  406. const modelElement = new ModelElement( 'paragraph', null, [
  407. new ModelText( 'x' ),
  408. new ModelText( 'foo', { link: 'http://foo.com' } ),
  409. new ModelText( 'x' )
  410. ] );
  411. const viewP = new ViewContainerElement( 'p' );
  412. const elementGenerator = href => new ViewAttributeElement( 'a', { href } );
  413. modelRoot.appendChildren( modelElement );
  414. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  415. dispatcher.on( 'insert:$text', insertText() );
  416. dispatcher.on( 'addAttribute:link', wrapItem( elementGenerator ) );
  417. dispatcher.on( 'changeAttribute:link', wrapItem( elementGenerator ) );
  418. dispatcher.convertInsertion(
  419. ModelRange.createIn( modelRoot )
  420. );
  421. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  422. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  423. dispatcher.convertAttribute(
  424. 'changeAttribute',
  425. ModelRange.createIn( modelElement ),
  426. 'link',
  427. 'http://foo.com',
  428. 'http://foobar.com'
  429. );
  430. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  431. } );
  432. it( 'should support unicode', () => {
  433. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  434. const viewP = new ViewContainerElement( 'p' );
  435. const viewB = new ViewAttributeElement( 'b' );
  436. modelRoot.appendChildren( modelElement );
  437. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  438. dispatcher.on( 'insert:$text', insertText() );
  439. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  440. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  441. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  442. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  443. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  444. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  445. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  446. } );
  447. it( 'should be possible to override wrap', () => {
  448. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  449. const viewP = new ViewContainerElement( 'p' );
  450. const viewB = new ViewAttributeElement( 'b' );
  451. modelRoot.appendChildren( modelElement );
  452. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  453. dispatcher.on( 'insert:$text', insertText() );
  454. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  455. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  456. consumable.consume( data.item, 'addAttribute:bold' );
  457. }, { priority: 'high' } );
  458. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  459. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  460. } );
  461. it( 'should be possible to override unwrap', () => {
  462. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  463. const viewP = new ViewContainerElement( 'p' );
  464. const viewB = new ViewAttributeElement( 'b' );
  465. modelRoot.appendChildren( modelElement );
  466. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  467. dispatcher.on( 'insert:$text', insertText() );
  468. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  469. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  470. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  471. consumable.consume( data.item, 'removeAttribute:bold' );
  472. }, { priority: 'high' } );
  473. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  474. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  475. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  476. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  477. // Nothing changed.
  478. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  479. } );
  480. it( 'should not convert and not consume if creator function returned null', () => {
  481. const elementGenerator = () => null;
  482. const modelText = new ModelText( 'foo', { bold: true } );
  483. modelRoot.appendChildren( [ modelText ] );
  484. sinon.spy( dispatcher, 'fire' );
  485. dispatcher.on( 'insert:$text', insertText() );
  486. dispatcher.on( 'addAttribute:bold', wrapItem( elementGenerator ) );
  487. dispatcher.on( 'removeAttribute:bold', unwrapItem( elementGenerator ) );
  488. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  489. expect( consumable.test( data.item, 'addAttribute:bold' ) ).to.be.true;
  490. } );
  491. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  492. expect( consumable.test( data.item, 'removeAttribute:bold' ) ).to.be.true;
  493. } );
  494. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  495. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  496. expect( dispatcher.fire.calledWith( 'addAttribute:bold:$text' ) ).to.be.true;
  497. modelText.removeAttribute( 'bold' );
  498. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  499. expect( dispatcher.fire.calledWith( 'removeAttribute:bold:$text' ) ).to.be.true;
  500. } );
  501. } );
  502. describe( 'insertUIElement/removeUIElement', () => {
  503. let modelText, range, modelElement;
  504. beforeEach( () => {
  505. modelText = new ModelText( 'foobar' );
  506. modelElement = new ModelElement( 'paragraph', null, modelText );
  507. modelRoot.appendChildren( modelElement );
  508. const viewText = new ViewText( 'foobar' );
  509. const viewElement = new ViewContainerElement( 'p', null, viewText );
  510. viewRoot.appendChildren( viewElement );
  511. mapper.bindElements( modelElement, viewElement );
  512. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  513. } );
  514. it( 'should insert and remove ui element - element as a creator', () => {
  515. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  516. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  517. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  518. dispatcher.convertMarker( 'addMarker', 'marker', range );
  519. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  520. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  521. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  522. } );
  523. it( 'should insert and remove ui element - function as a creator', () => {
  524. const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } );
  525. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  526. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  527. dispatcher.convertMarker( 'addMarker', 'marker', range );
  528. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  529. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  530. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  531. } );
  532. it( 'should not convert or consume if generator function returned null', () => {
  533. const viewUi = () => null;
  534. sinon.spy( dispatcher, 'fire' );
  535. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  536. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  537. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  538. expect( consumable.test( data.markerRange, 'addMarker:marker' ) ).to.be.true;
  539. } );
  540. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  541. expect( consumable.test( data.markerRange, 'removeMarker:marker' ) ).to.be.true;
  542. } );
  543. dispatcher.convertMarker( 'addMarker', 'marker', range );
  544. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  545. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  546. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  547. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  548. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  549. } );
  550. it( 'should be possible to overwrite', () => {
  551. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  552. sinon.spy( dispatcher, 'fire' );
  553. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  554. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  555. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  556. consumable.consume( data.markerRange, 'addMarker:marker' );
  557. }, { priority: 'high' } );
  558. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  559. consumable.consume( data.markerRange, 'removeMarker:marker' );
  560. }, { priority: 'high' } );
  561. dispatcher.convertMarker( 'addMarker', 'marker', range );
  562. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  563. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  564. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  565. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  566. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  567. } );
  568. it( 'should not convert or consume if generator function returned null', () => {
  569. const viewUi = () => null;
  570. sinon.spy( dispatcher, 'fire' );
  571. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  572. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  573. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  574. expect( consumable.test( data.markerRange, 'addMarker:marker' ) ).to.be.true;
  575. } );
  576. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  577. expect( consumable.test( data.markerRange, 'removeMarker:marker' ) ).to.be.true;
  578. } );
  579. dispatcher.convertMarker( 'addMarker', 'marker', range );
  580. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  581. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  582. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  583. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  584. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  585. } );
  586. it( 'should be possible to overwrite', () => {
  587. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  588. sinon.spy( dispatcher, 'fire' );
  589. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  590. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  591. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  592. consumable.consume( data.markerRange, 'addMarker:marker' );
  593. }, { priority: 'high' } );
  594. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  595. consumable.consume( data.markerRange, 'removeMarker:marker' );
  596. }, { priority: 'high' } );
  597. dispatcher.convertMarker( 'addMarker', 'marker', range );
  598. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  599. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  600. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  601. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  602. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  603. } );
  604. describe( 'non-collapsed range', () => {
  605. beforeEach( () => {
  606. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  607. } );
  608. it( 'should insert and remove ui element - element as a creator', () => {
  609. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  610. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  611. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  612. dispatcher.convertMarker( 'addMarker', 'marker', range );
  613. expect( viewToString( viewRoot ) )
  614. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  615. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  616. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  617. } );
  618. it( 'should insert and remove ui element - function as a creator', () => {
  619. const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } );
  620. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  621. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  622. dispatcher.convertMarker( 'addMarker', 'marker', range );
  623. expect( viewToString( viewRoot ) )
  624. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  625. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  626. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  627. } );
  628. it( 'should insert and remove different opening and ending element', () => {
  629. function creator( data ) {
  630. if ( data.isOpening ) {
  631. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  632. }
  633. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  634. }
  635. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  636. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  637. dispatcher.convertMarker( 'addMarker', 'marker', range );
  638. expect( viewToString( viewRoot ) ).to.equal(
  639. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  640. );
  641. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  642. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  643. } );
  644. it( 'should be possible to overwrite', () => {
  645. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  646. sinon.spy( dispatcher, 'fire' );
  647. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  648. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  649. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  650. consumable.consume( data.item, 'addMarker:marker' );
  651. }, { priority: 'high' } );
  652. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  653. consumable.consume( data.item, 'removeMarker:marker' );
  654. }, { priority: 'high' } );
  655. dispatcher.convertMarker( 'addMarker', 'marker', range );
  656. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  657. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  658. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  659. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  660. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  661. } );
  662. } );
  663. } );
  664. describe( 'remove', () => {
  665. it( 'should remove items from view accordingly to changes in model #1', () => {
  666. const modelDiv = new ModelElement( 'div', null, [
  667. new ModelText( 'foo' ),
  668. new ModelElement( 'image' ),
  669. new ModelText( 'bar' )
  670. ] );
  671. modelRoot.appendChildren( modelDiv );
  672. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  673. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  674. dispatcher.on( 'insert:$text', insertText() );
  675. dispatcher.on( 'remove', remove() );
  676. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  677. const removedNodes = modelDiv.removeChildren( 0, 2 );
  678. modelDoc.graveyard.insertChildren( 0, removedNodes );
  679. dispatcher.convertRemove(
  680. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  681. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  682. );
  683. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  684. } );
  685. it( 'should not execute if value was already consumed', () => {
  686. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  687. modelRoot.appendChildren( modelDiv );
  688. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  689. dispatcher.on( 'insert:$text', insertText() );
  690. dispatcher.on( 'remove', remove() );
  691. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  692. consumable.consume( data.item, 'remove' );
  693. }, { priority: 'high' } );
  694. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  695. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  696. const removedNodes = modelDiv.removeChildren( 0, 1 );
  697. modelDoc.graveyard.insertChildren( 0, removedNodes );
  698. dispatcher.convertRemove(
  699. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  700. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  701. );
  702. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  703. } );
  704. it( 'should support unicode', () => {
  705. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  706. modelRoot.appendChildren( modelDiv );
  707. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  708. dispatcher.on( 'insert:$text', insertText() );
  709. dispatcher.on( 'remove', remove() );
  710. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  711. modelWriter.move(
  712. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  713. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  714. );
  715. dispatcher.convertRemove(
  716. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  717. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  718. );
  719. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  720. } );
  721. it( 'should not remove view ui elements that are placed next to removed content', () => {
  722. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  723. viewRoot.appendChildren( [
  724. new ViewText( 'foo' ),
  725. new ViewUIElement( 'span' ),
  726. new ViewText( 'bar' )
  727. ] );
  728. dispatcher.on( 'remove', remove() );
  729. // Remove 'b'.
  730. modelWriter.move(
  731. ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ),
  732. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  733. );
  734. dispatcher.convertRemove(
  735. ModelPosition.createFromParentAndOffset( modelRoot, 3 ),
  736. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  737. );
  738. expect( viewToString( viewRoot ) ).to.equal( '<div>foo<span></span>ar</div>' );
  739. } );
  740. it( 'should remove correct amount of text when it is split by view ui element', () => {
  741. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  742. viewRoot.appendChildren( [
  743. new ViewText( 'foo' ),
  744. new ViewUIElement( 'span' ),
  745. new ViewText( 'bar' )
  746. ] );
  747. dispatcher.on( 'remove', remove() );
  748. // Remove 'o<span></span>b'.
  749. modelWriter.move(
  750. ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ),
  751. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  752. );
  753. dispatcher.convertRemove(
  754. ModelPosition.createFromParentAndOffset( modelRoot, 2 ),
  755. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 2 )
  756. );
  757. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  758. } );
  759. it( 'should not unbind element that has not been moved to graveyard', () => {
  760. const modelElement = new ModelElement( 'paragraph' );
  761. const viewElement = new ViewContainerElement( 'p' );
  762. modelRoot.appendChildren( [ modelElement, new ModelText( 'b' ) ] );
  763. viewRoot.appendChildren( [ viewElement, new ViewText( 'b' ) ] );
  764. mapper.bindElements( modelElement, viewElement );
  765. dispatcher.on( 'remove', remove() );
  766. // Move <a></a> after "b". Can be e.g. a part of an unwrap delta (move + remove).
  767. modelWriter.move(
  768. ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ),
  769. ModelPosition.createAt( modelRoot, 'end' )
  770. );
  771. dispatcher.convertRemove(
  772. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  773. ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 )
  774. );
  775. expect( viewToString( viewRoot ) ).to.equal( '<div>b</div>' );
  776. expect( mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  777. expect( mapper.toViewElement( modelElement ) ).to.equal( viewElement );
  778. } );
  779. it( 'should unbind elements if model element was moved to graveyard', () => {
  780. const modelElement = new ModelElement( 'paragraph' );
  781. const viewElement = new ViewContainerElement( 'p' );
  782. modelRoot.appendChildren( [ modelElement, new ModelText( 'b' ) ] );
  783. viewRoot.appendChildren( [ viewElement, new ViewText( 'b' ) ] );
  784. mapper.bindElements( modelElement, viewElement );
  785. dispatcher.on( 'remove', remove() );
  786. // Move <a></a> to graveyard.
  787. modelWriter.move(
  788. ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ),
  789. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  790. );
  791. dispatcher.convertRemove(
  792. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  793. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  794. );
  795. expect( viewToString( viewRoot ) ).to.equal( '<div>b</div>' );
  796. expect( mapper.toModelElement( viewElement ) ).to.be.undefined;
  797. expect( mapper.toViewElement( modelElement ) ).to.be.undefined;
  798. } );
  799. // TODO move to conversion/integration.js one day.
  800. it( 'should not break when remove() is used as part of unwrapping', () => {
  801. // The whole process looks like this:
  802. // <w><a></a></w> => <a></a><w><a></a></w> => <a></a><w></w> => <a></a>
  803. // The <a> is duplicated for a while in the view.
  804. const modelAElement = new ModelElement( 'a' );
  805. const modelWElement = new ModelElement( 'w' );
  806. const viewAElement = new ViewContainerElement( 'a' );
  807. const viewA2Element = new ViewContainerElement( 'a2' );
  808. const viewWElement = new ViewContainerElement( 'w' );
  809. modelRoot.appendChildren( modelWElement );
  810. viewRoot.appendChildren( viewWElement );
  811. modelWElement.appendChildren( modelAElement );
  812. viewWElement.appendChildren( viewAElement );
  813. mapper.bindElements( modelWElement, viewWElement );
  814. mapper.bindElements( modelAElement, viewAElement );
  815. dispatcher.on( 'remove', remove() );
  816. dispatcher.on( 'insert', insertElement( () => viewA2Element ) );
  817. modelDoc.on( 'change', ( evt, type, changes ) => {
  818. dispatcher.convertChange( type, changes );
  819. } );
  820. modelDoc.batch().unwrap( modelWElement );
  821. expect( viewToString( viewRoot ) ).to.equal( '<div><a2></a2></div>' );
  822. expect( mapper.toModelElement( viewA2Element ) ).to.equal( modelAElement );
  823. expect( mapper.toViewElement( modelAElement ) ).to.equal( viewA2Element );
  824. // This is a bit unfortunate, but we think we can live with this.
  825. // The viewAElement is not in the tree and there's a high chance that all reference to it are gone.
  826. expect( mapper.toModelElement( viewAElement ) ).to.equal( modelAElement );
  827. expect( mapper.toModelElement( viewWElement ) ).to.be.undefined;
  828. expect( mapper.toViewElement( modelWElement ) ).to.be.undefined;
  829. } );
  830. it( 'should work correctly if container element after ui element is removed', () => {
  831. const modelP1 = new ModelElement( 'paragraph' );
  832. const modelP2 = new ModelElement( 'paragraph' );
  833. const viewP1 = new ViewContainerElement( 'p' );
  834. const viewUi1 = new ViewUIElement( 'span' );
  835. const viewUi2 = new ViewUIElement( 'span' );
  836. const viewP2 = new ViewContainerElement( 'p' );
  837. modelRoot.appendChildren( [ modelP1, modelP2 ] );
  838. viewRoot.appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  839. mapper.bindElements( modelP1, viewP1 );
  840. mapper.bindElements( modelP2, viewP2 );
  841. dispatcher.on( 'remove', remove() );
  842. modelWriter.move(
  843. ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ),
  844. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  845. );
  846. dispatcher.convertRemove(
  847. ModelPosition.createFromParentAndOffset( modelRoot, 1 ),
  848. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  849. );
  850. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  851. } );
  852. it( 'should work correctly if container element after text node is removed', () => {
  853. const modelText = new ModelText( 'foo' );
  854. const modelP = new ModelElement( 'paragraph' );
  855. const viewText = new ViewText( 'foo' );
  856. const viewP = new ViewContainerElement( 'p' );
  857. modelRoot.appendChildren( [ modelText, modelP ] );
  858. viewRoot.appendChildren( [ viewText, viewP ] );
  859. mapper.bindElements( modelP, viewP );
  860. dispatcher.on( 'remove', remove() );
  861. modelWriter.move(
  862. ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ),
  863. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  864. );
  865. dispatcher.convertRemove(
  866. ModelPosition.createFromParentAndOffset( modelRoot, 3 ),
  867. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 1 )
  868. );
  869. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  870. } );
  871. } );
  872. describe( 'highlightDescriptorToAttributeElement()', () => {
  873. it( 'should return attribute element from descriptor object', () => {
  874. const descriptor = {
  875. class: 'foo-class',
  876. attributes: { one: 1, two: 2 },
  877. priority: 7,
  878. };
  879. const element = highlightDescriptorToAttributeElement( descriptor );
  880. expect( element.is( 'attributeElement' ) ).to.be.true;
  881. expect( element.name ).to.equal( 'span' );
  882. expect( element.priority ).to.equal( 7 );
  883. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  884. for ( const key of Object.keys( descriptor.attributes ) ) {
  885. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  886. }
  887. } );
  888. it( 'should return attribute element from descriptor object - array with classes', () => {
  889. const descriptor = {
  890. class: [ 'foo-class', 'bar-class' ],
  891. attributes: { one: 1, two: 2 },
  892. priority: 7,
  893. };
  894. const element = highlightDescriptorToAttributeElement( descriptor );
  895. expect( element.is( 'attributeElement' ) ).to.be.true;
  896. expect( element.name ).to.equal( 'span' );
  897. expect( element.priority ).to.equal( 7 );
  898. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  899. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  900. for ( const key of Object.keys( descriptor.attributes ) ) {
  901. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  902. }
  903. } );
  904. it( 'should create element without class', () => {
  905. const descriptor = {
  906. attributes: { one: 1, two: 2 },
  907. priority: 7,
  908. };
  909. const element = highlightDescriptorToAttributeElement( descriptor );
  910. expect( element.is( 'attributeElement' ) ).to.be.true;
  911. expect( element.name ).to.equal( 'span' );
  912. expect( element.priority ).to.equal( 7 );
  913. for ( const key of Object.keys( descriptor.attributes ) ) {
  914. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  915. }
  916. } );
  917. it( 'should create element without priority', () => {
  918. const descriptor = {
  919. class: 'foo-class',
  920. attributes: { one: 1, two: 2 },
  921. };
  922. const element = highlightDescriptorToAttributeElement( descriptor );
  923. expect( element.is( 'attributeElement' ) ).to.be.true;
  924. expect( element.name ).to.equal( 'span' );
  925. expect( element.priority ).to.equal( 10 );
  926. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  927. for ( const key of Object.keys( descriptor.attributes ) ) {
  928. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  929. }
  930. } );
  931. it( 'should create element without attributes', () => {
  932. const descriptor = {
  933. class: 'foo-class',
  934. priority: 7
  935. };
  936. const element = highlightDescriptorToAttributeElement( descriptor );
  937. expect( element.is( 'attributeElement' ) ).to.be.true;
  938. expect( element.name ).to.equal( 'span' );
  939. expect( element.priority ).to.equal( 7 );
  940. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  941. } );
  942. } );
  943. } );