model-to-view-converters.js 49 KB

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