model-to-view-converters.js 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  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 ViewElement from '../../src/view/element';
  11. import ViewContainerElement from '../../src/view/containerelement';
  12. import ViewAttributeElement from '../../src/view/attributeelement';
  13. import ViewUIElement from '../../src/view/uielement';
  14. import ViewText from '../../src/view/text';
  15. import {
  16. insertElement,
  17. insertUIElement,
  18. changeAttribute,
  19. wrap,
  20. removeUIElement,
  21. highlightElement,
  22. highlightText,
  23. removeHighlight,
  24. createViewElementFromHighlightDescriptor
  25. } from '../../src/conversion/model-to-view-converters';
  26. import EditingController from '../../src/controller/editingcontroller';
  27. describe( 'model-to-view-converters', () => {
  28. let dispatcher, modelDoc, modelRoot, viewRoot, controller, modelRootStart, model;
  29. beforeEach( () => {
  30. model = new Model();
  31. modelDoc = model.document;
  32. modelRoot = modelDoc.createRoot();
  33. controller = new EditingController( model );
  34. viewRoot = controller.view.getRoot();
  35. // Set name of view root the same as dom root.
  36. // This is a mock of attaching view root to dom root.
  37. controller.view.getRoot()._name = 'div';
  38. dispatcher = controller.modelToView;
  39. dispatcher.on( 'insert:paragraph', insertElement( () => new ViewContainerElement( 'p' ) ) );
  40. dispatcher.on( 'attribute:class', changeAttribute() );
  41. modelRootStart = ModelPosition.createAt( modelRoot, 0 );
  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( 'insertText', () => {
  69. it( 'should convert text insertion in model to view text', () => {
  70. model.change( writer => {
  71. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  72. } );
  73. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  74. } );
  75. it( 'should support unicode', () => {
  76. model.change( writer => {
  77. writer.insert( new ModelText( 'நிலைக்கு' ), modelRootStart );
  78. } );
  79. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  80. } );
  81. it( 'should be possible to override it', () => {
  82. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  83. consumable.consume( data.item, 'insert' );
  84. }, { priority: 'high' } );
  85. model.change( writer => {
  86. writer.insert( new ModelText( 'foobar' ), modelRootStart );
  87. } );
  88. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  89. } );
  90. } );
  91. describe( 'insertElement', () => {
  92. it( 'should convert element insertion in model to and map positions for future converting', () => {
  93. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  94. model.change( writer => {
  95. writer.insert( modelElement, modelRootStart );
  96. } );
  97. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  98. } );
  99. it( 'should take view element function generator as a parameter', () => {
  100. const elementGenerator = ( modelItem, consumable ) => {
  101. if ( consumable.consume( modelItem, 'attribute:nice' ) ) {
  102. return new ViewContainerElement( 'div' );
  103. }
  104. // Test if default converter will be fired for paragraph, if `null` is returned and consumable was not consumed.
  105. return null;
  106. };
  107. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ), { priority: 'high' } );
  108. const niceP = new ModelElement( 'paragraph', { nice: true }, new ModelText( 'foo' ) );
  109. const badP = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  110. model.change( writer => {
  111. writer.insert( [ niceP, badP ], modelRootStart );
  112. } );
  113. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  114. } );
  115. } );
  116. describe( 'setAttribute', () => {
  117. it( 'should convert attribute insert/change/remove on a model node', () => {
  118. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  119. model.change( writer => {
  120. writer.insert( modelElement, modelRootStart );
  121. } );
  122. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  123. model.change( writer => {
  124. writer.setAttribute( 'class', 'bar', modelElement );
  125. } );
  126. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  127. model.change( writer => {
  128. writer.removeAttribute( 'class', modelElement );
  129. } );
  130. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  131. } );
  132. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  133. const themeConverter = ( value, data ) => {
  134. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  135. value += ' fix-content';
  136. }
  137. return { key: 'class', value };
  138. };
  139. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  140. dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) );
  141. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  142. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  143. model.change( writer => {
  144. writer.insert( [ modelParagraph, modelDiv ], modelRootStart );
  145. } );
  146. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  147. model.change( writer => {
  148. writer.setAttribute( 'theme', 'awesome', modelParagraph );
  149. } );
  150. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  151. model.change( writer => {
  152. writer.removeAttribute( 'theme', modelParagraph );
  153. } );
  154. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  155. } );
  156. it( 'should be possible to override setAttribute', () => {
  157. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  158. dispatcher.on( 'attribute:class', ( evt, data, consumable ) => {
  159. consumable.consume( data.item, 'attribute:class' );
  160. }, { priority: 'high' } );
  161. model.change( writer => {
  162. writer.insert( modelElement, modelRootStart );
  163. } );
  164. // No attribute set.
  165. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  166. } );
  167. } );
  168. describe( 'wrap', () => {
  169. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  170. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  171. const viewB = new ViewAttributeElement( 'b' );
  172. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  173. model.change( writer => {
  174. writer.insert( modelElement, modelRootStart );
  175. } );
  176. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  177. model.change( writer => {
  178. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  179. } );
  180. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  181. } );
  182. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  183. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  184. const elementGenerator = value => {
  185. if ( value == 'bold' ) {
  186. return new ViewAttributeElement( 'b' );
  187. }
  188. };
  189. dispatcher.on( 'attribute:style', wrap( elementGenerator ) );
  190. model.change( writer => {
  191. writer.insert( modelElement, modelRootStart );
  192. } );
  193. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  194. model.change( writer => {
  195. writer.removeAttribute( 'style', ModelRange.createIn( modelElement ) );
  196. } );
  197. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  198. } );
  199. it( 'should update range on re-wrapping attribute (#475)', () => {
  200. const modelElement = new ModelElement( 'paragraph', null, [
  201. new ModelText( 'x' ),
  202. new ModelText( 'foo', { link: 'http://foo.com' } ),
  203. new ModelText( 'x' )
  204. ] );
  205. const elementGenerator = href => new ViewAttributeElement( 'a', { href } );
  206. dispatcher.on( 'attribute:link', wrap( elementGenerator ) );
  207. model.change( writer => {
  208. writer.insert( modelElement, modelRootStart );
  209. } );
  210. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  211. // Set new attribute on old link but also on non-linked characters.
  212. model.change( writer => {
  213. writer.setAttribute( 'link', 'http://foobar.com', ModelRange.createIn( modelElement ) );
  214. } );
  215. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  216. } );
  217. it( 'should support unicode', () => {
  218. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  219. const viewB = new ViewAttributeElement( 'b' );
  220. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  221. model.change( writer => {
  222. writer.insert( modelElement, modelRootStart );
  223. } );
  224. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  225. model.change( writer => {
  226. writer.removeAttribute( 'bold', ModelRange.createIn( modelElement ) );
  227. } );
  228. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  229. } );
  230. it( 'should be possible to override wrap', () => {
  231. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  232. const viewB = new ViewAttributeElement( 'b' );
  233. dispatcher.on( 'attribute:bold', wrap( viewB ) );
  234. dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => {
  235. consumable.consume( data.item, 'attribute:bold' );
  236. }, { priority: 'high' } );
  237. model.change( writer => {
  238. writer.insert( modelElement, modelRootStart );
  239. } );
  240. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  241. } );
  242. it( 'should not convert and not consume if creator function returned null', () => {
  243. const elementGenerator = () => null;
  244. sinon.spy( dispatcher, 'fire' );
  245. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) );
  246. dispatcher.on( 'attribute:italic', wrap( elementGenerator ) );
  247. dispatcher.on( 'attribute:italic', ( evt, data, consumable ) => {
  248. expect( consumable.test( data.item, 'attribute:italic' ) ).to.be.true;
  249. } );
  250. model.change( writer => {
  251. writer.insert( modelElement, modelRootStart );
  252. } );
  253. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  254. expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true;
  255. } );
  256. } );
  257. describe( 'insertUIElement/removeUIElement', () => {
  258. let modelText, modelElement, range;
  259. beforeEach( () => {
  260. modelText = new ModelText( 'foobar' );
  261. modelElement = new ModelElement( 'paragraph', null, modelText );
  262. model.change( writer => {
  263. writer.insert( modelElement, modelRootStart );
  264. } );
  265. } );
  266. describe( 'collapsed range', () => {
  267. beforeEach( () => {
  268. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  269. } );
  270. it( 'should insert and remove ui element - element as a creator', () => {
  271. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  272. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  273. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  274. model.change( writer => {
  275. writer.setMarker( 'marker', range );
  276. } );
  277. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  278. model.change( writer => {
  279. writer.removeMarker( 'marker' );
  280. } );
  281. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  282. } );
  283. it( 'should insert and remove ui element - function as a creator', () => {
  284. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  285. dispatcher.on( 'addMarker:marker', insertUIElement( () => viewUi ) );
  286. dispatcher.on( 'removeMarker:marker', removeUIElement( () => viewUi ) );
  287. model.change( writer => {
  288. writer.setMarker( 'marker', range );
  289. } );
  290. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  291. model.change( writer => {
  292. writer.removeMarker( 'marker' );
  293. } );
  294. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  295. } );
  296. it( 'should not convert if consumable was consumed', () => {
  297. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  298. sinon.spy( dispatcher, 'fire' );
  299. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  300. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  301. consumable.consume( data.markerRange, 'addMarker:marker' );
  302. }, { priority: 'high' } );
  303. dispatcher.convertMarkerAdd( 'marker', range );
  304. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  305. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  306. } );
  307. it( 'should not convert if creator returned null', () => {
  308. dispatcher.on( 'addMarker:marker', insertUIElement( () => null ) );
  309. dispatcher.on( 'removeMarker:marker', removeUIElement( () => null ) );
  310. model.change( writer => {
  311. writer.setMarker( 'marker', range );
  312. } );
  313. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  314. model.change( writer => {
  315. writer.removeMarker( 'marker' );
  316. } );
  317. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  318. } );
  319. } );
  320. describe( 'non-collapsed range', () => {
  321. beforeEach( () => {
  322. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 5 );
  323. } );
  324. it( 'should insert and remove ui element - element as a creator', () => {
  325. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  326. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  327. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  328. model.change( writer => {
  329. writer.setMarker( 'marker', range );
  330. } );
  331. expect( viewToString( viewRoot ) )
  332. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  333. model.change( writer => {
  334. writer.removeMarker( 'marker' );
  335. } );
  336. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  337. } );
  338. it( 'should insert and remove ui element - function as a creator', () => {
  339. const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } );
  340. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  341. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  342. model.change( writer => {
  343. writer.setMarker( 'marker', range );
  344. } );
  345. expect( viewToString( viewRoot ) )
  346. .to.equal( '<div><p>fo<span class="marker"></span>oba<span class="marker"></span>r</p></div>' );
  347. model.change( writer => {
  348. writer.removeMarker( 'marker' );
  349. } );
  350. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  351. } );
  352. it( 'should insert and remove different opening and ending element', () => {
  353. function creator( data ) {
  354. if ( data.isOpening ) {
  355. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-start': true } );
  356. }
  357. return new ViewUIElement( 'span', { 'class': data.markerName, 'data-end': true } );
  358. }
  359. dispatcher.on( 'addMarker:marker', insertUIElement( creator ) );
  360. dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) );
  361. model.change( writer => {
  362. writer.setMarker( 'marker', range );
  363. } );
  364. expect( viewToString( viewRoot ) ).to.equal(
  365. '<div><p>fo<span class="marker" data-start="true"></span>oba<span class="marker" data-end="true"></span>r</p></div>'
  366. );
  367. model.change( writer => {
  368. writer.removeMarker( 'marker' );
  369. } );
  370. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  371. } );
  372. it( 'should not convert if consumable was consumed', () => {
  373. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  374. sinon.spy( dispatcher, 'fire' );
  375. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  376. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  377. consumable.consume( data.item, 'addMarker:marker' );
  378. }, { priority: 'high' } );
  379. dispatcher.convertMarkerAdd( 'marker', range );
  380. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  381. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  382. } );
  383. } );
  384. } );
  385. // Remove converter is by default already added in `EditingController` instance.
  386. describe( 'remove', () => {
  387. it( 'should remove items from view accordingly to changes in model #1', () => {
  388. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  389. model.change( writer => {
  390. writer.insert( modelElement, modelRootStart );
  391. } );
  392. model.change( writer => {
  393. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  394. } );
  395. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foar</p></div>' );
  396. } );
  397. it( 'should be possible to overwrite', () => {
  398. dispatcher.on( 'remove', evt => evt.stop(), { priority: 'high' } );
  399. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  400. model.change( writer => {
  401. writer.insert( modelElement, modelRootStart );
  402. } );
  403. model.change( writer => {
  404. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  405. } );
  406. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  407. } );
  408. it( 'should support unicode', () => {
  409. const modelElement = new ModelElement( 'paragraph', null, 'நிலைக்கு' );
  410. model.change( writer => {
  411. writer.insert( modelElement, modelRootStart );
  412. } );
  413. model.change( writer => {
  414. writer.remove( ModelRange.createFromParentsAndOffsets( modelElement, 0, modelElement, 6 ) );
  415. } );
  416. expect( viewToString( viewRoot ) ).to.equal( '<div><p>கு</p></div>' );
  417. } );
  418. it( 'should not remove view ui elements that are placed next to removed content', () => {
  419. modelRoot.appendChildren( new ModelText( 'fozbar' ) );
  420. viewRoot.appendChildren( [
  421. new ViewText( 'foz' ),
  422. new ViewUIElement( 'span' ),
  423. new ViewText( 'bar' )
  424. ] );
  425. // Remove 'b'.
  426. model.change( writer => {
  427. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) );
  428. } );
  429. expect( viewToString( viewRoot ) ).to.equal( '<div>foz<span></span>ar</div>' );
  430. // Remove 'z'.
  431. model.change( writer => {
  432. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 3 ) );
  433. } );
  434. expect( viewToString( viewRoot ) ).to.equal( '<div>fo<span></span>ar</div>' );
  435. } );
  436. it( 'should remove correct amount of text when it is split by view ui element', () => {
  437. modelRoot.appendChildren( new ModelText( 'fozbar' ) );
  438. viewRoot.appendChildren( [
  439. new ViewText( 'foz' ),
  440. new ViewUIElement( 'span' ),
  441. new ViewText( 'bar' )
  442. ] );
  443. // Remove 'z<span></span>b'.
  444. model.change( writer => {
  445. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) );
  446. } );
  447. expect( viewToString( viewRoot ) ).to.equal( '<div>foar</div>' );
  448. } );
  449. it( 'should unbind elements', () => {
  450. const modelElement = new ModelElement( 'paragraph' );
  451. model.change( writer => {
  452. writer.insert( modelElement, modelRootStart );
  453. } );
  454. const viewElement = controller.mapper.toViewElement( modelElement );
  455. expect( viewElement ).not.to.be.undefined;
  456. expect( controller.mapper.toModelElement( viewElement ) ).to.equal( modelElement );
  457. model.change( writer => {
  458. writer.remove( modelElement );
  459. } );
  460. expect( controller.mapper.toViewElement( modelElement ) ).to.be.undefined;
  461. expect( controller.mapper.toModelElement( viewElement ) ).to.be.undefined;
  462. } );
  463. it( 'should not break when remove() is used as part of unwrapping', () => {
  464. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  465. const modelWidget = new ModelElement( 'widget', null, modelP );
  466. dispatcher.on( 'insert:widget', insertElement( () => new ViewContainerElement( 'widget' ) ) );
  467. model.change( writer => {
  468. writer.insert( modelWidget, modelRootStart );
  469. } );
  470. expect( viewToString( viewRoot ) ).to.equal( '<div><widget><p>foo</p></widget></div>' );
  471. const viewP = controller.mapper.toViewElement( modelP );
  472. expect( viewP ).not.to.be.undefined;
  473. model.change( writer => {
  474. writer.unwrap( modelWidget );
  475. } );
  476. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p></div>' );
  477. // `modelP` is now bound with newly created view element.
  478. expect( controller.mapper.toViewElement( modelP ) ).not.to.equal( viewP );
  479. // `viewP` is no longer bound with model element.
  480. expect( controller.mapper.toModelElement( viewP ) ).to.be.undefined;
  481. // View element from view root is bound to `modelP`.
  482. expect( controller.mapper.toModelElement( viewRoot.getChild( 0 ) ) ).to.equal( modelP );
  483. } );
  484. it( 'should work correctly if container element after ui element is removed', () => {
  485. // Prepare a model and view structure.
  486. // This is done outside of conversion to put view ui elements inside easily.
  487. const modelP1 = new ModelElement( 'paragraph' );
  488. const modelP2 = new ModelElement( 'paragraph' );
  489. const viewP1 = new ViewContainerElement( 'p' );
  490. const viewUi1 = new ViewUIElement( 'span' );
  491. const viewUi2 = new ViewUIElement( 'span' );
  492. const viewP2 = new ViewContainerElement( 'p' );
  493. modelRoot.appendChildren( [ modelP1, modelP2 ] );
  494. viewRoot.appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] );
  495. controller.mapper.bindElements( modelP1, viewP1 );
  496. controller.mapper.bindElements( modelP2, viewP2 );
  497. // Remove second paragraph element.
  498. model.change( writer => {
  499. writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) );
  500. } );
  501. expect( viewToString( viewRoot ) ).to.equal( '<div><p></p><span></span><span></span></div>' );
  502. } );
  503. it( 'should work correctly if container element after text node is removed', () => {
  504. const modelText = new ModelText( 'foo' );
  505. const modelP = new ModelElement( 'paragraph' );
  506. model.change( writer => {
  507. writer.insert( [ modelText, modelP ], modelRootStart );
  508. } );
  509. model.change( writer => {
  510. writer.remove( modelP );
  511. } );
  512. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  513. } );
  514. } );
  515. describe( 'highlight', () => {
  516. describe( 'on text', () => {
  517. const highlightDescriptor = {
  518. class: 'highlight-class',
  519. priority: 7,
  520. attributes: { title: 'title' }
  521. };
  522. let markerRange;
  523. beforeEach( () => {
  524. const modelElement1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  525. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  526. model.change( writer => {
  527. writer.insert( [ modelElement1, modelElement2 ], modelRootStart );
  528. } );
  529. markerRange = ModelRange.createIn( modelRoot );
  530. } );
  531. it( 'should wrap and unwrap text nodes', () => {
  532. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  533. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  534. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  535. model.change( writer => {
  536. writer.setMarker( 'marker', markerRange );
  537. } );
  538. expect( viewToString( viewRoot ) ).to.equal(
  539. '<div>' +
  540. '<p>' +
  541. '<span class="highlight-class" title="title">foo</span>' +
  542. '</p>' +
  543. '<p>' +
  544. '<span class="highlight-class" title="title">bar</span>' +
  545. '</p>' +
  546. '</div>'
  547. );
  548. model.change( writer => {
  549. writer.removeMarker( 'marker' );
  550. } );
  551. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  552. } );
  553. it( 'should be possible to overwrite', () => {
  554. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  555. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  556. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  557. const newDescriptor = { class: 'override-class' };
  558. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  559. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  560. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  561. model.change( writer => {
  562. writer.setMarker( 'marker', markerRange );
  563. } );
  564. expect( viewToString( viewRoot ) ).to.equal(
  565. '<div>' +
  566. '<p>' +
  567. '<span class="override-class">foo</span>' +
  568. '</p>' +
  569. '<p>' +
  570. '<span class="override-class">bar</span>' +
  571. '</p>' +
  572. '</div>'
  573. );
  574. model.change( writer => {
  575. writer.removeMarker( 'marker' );
  576. } );
  577. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  578. } );
  579. it( 'should do nothing if descriptor is not provided or generating function returns null', () => {
  580. dispatcher.on( 'addMarker:marker', highlightText( () => null ), { priority: 'high' } );
  581. dispatcher.on( 'addMarker:marker', highlightElement( () => null ), { priority: 'high' } );
  582. dispatcher.on( 'removeMarker:marker', removeHighlight( () => null ), { priority: 'high' } );
  583. model.change( writer => {
  584. writer.setMarker( 'marker', markerRange );
  585. } );
  586. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  587. model.change( writer => {
  588. writer.removeMarker( 'marker' );
  589. } );
  590. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo</p><p>bar</p></div>' );
  591. } );
  592. } );
  593. describe( 'on element', () => {
  594. const highlightDescriptor = {
  595. class: 'highlight-class',
  596. priority: 7,
  597. attributes: { title: 'title' },
  598. id: 'customId'
  599. };
  600. let markerRange;
  601. beforeEach( () => {
  602. // Provide converter for div element. View div element will have custom highlight handling.
  603. dispatcher.on( 'insert:div', insertElement( () => {
  604. const viewContainer = new ViewContainerElement( 'div' );
  605. viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  606. element.addClass( descriptor.class );
  607. } );
  608. viewContainer.setCustomProperty( 'removeHighlight', element => {
  609. element.setAttribute( 'class', '' );
  610. } );
  611. return viewContainer;
  612. } ) );
  613. const modelElement = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  614. model.change( writer => {
  615. writer.insert( modelElement, modelRootStart );
  616. } );
  617. markerRange = ModelRange.createOn( modelElement );
  618. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  619. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  620. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  621. } );
  622. it( 'should use addHighlight and removeHighlight on elements and not convert children nodes', () => {
  623. model.change( writer => {
  624. writer.setMarker( 'marker', markerRange );
  625. } );
  626. expect( viewToString( viewRoot ) ).to.equal(
  627. '<div>' +
  628. '<div class="highlight-class">' +
  629. 'foo' +
  630. '</div>' +
  631. '</div>'
  632. );
  633. model.change( writer => {
  634. writer.removeMarker( 'marker' );
  635. } );
  636. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  637. } );
  638. it( 'should be possible to override', () => {
  639. const newDescriptor = { class: 'override-class' };
  640. dispatcher.on( 'addMarker:marker', highlightText( newDescriptor ), { priority: 'high' } );
  641. dispatcher.on( 'addMarker:marker', highlightElement( newDescriptor ), { priority: 'high' } );
  642. dispatcher.on( 'removeMarker:marker', removeHighlight( newDescriptor ), { priority: 'high' } );
  643. model.change( writer => {
  644. writer.setMarker( 'marker', markerRange );
  645. } );
  646. expect( viewToString( viewRoot ) ).to.equal(
  647. '<div>' +
  648. '<div class="override-class">' +
  649. 'foo' +
  650. '</div>' +
  651. '</div>'
  652. );
  653. model.change( writer => {
  654. writer.removeMarker( 'marker' );
  655. } );
  656. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  657. } );
  658. it( 'should use default priority and id if not provided', () => {
  659. const viewDiv = viewRoot.getChild( 0 );
  660. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  661. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  662. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  663. viewDiv.setCustomProperty( 'addHighlight', ( element, descriptor ) => {
  664. expect( descriptor.priority ).to.equal( 10 );
  665. expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' );
  666. } );
  667. viewDiv.setCustomProperty( 'removeHighlight', ( element, id ) => {
  668. expect( id ).to.equal( 'marker:foo-bar-baz' );
  669. } );
  670. model.change( writer => {
  671. writer.setMarker( 'marker2', markerRange );
  672. } );
  673. } );
  674. it( 'should do nothing if descriptor is not provided', () => {
  675. dispatcher.on( 'addMarker:marker2', highlightText( () => null ) );
  676. dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) );
  677. dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) );
  678. model.change( writer => {
  679. writer.setMarker( 'marker2', markerRange );
  680. } );
  681. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  682. model.change( writer => {
  683. writer.removeMarker( 'marker2' );
  684. } );
  685. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  686. } );
  687. } );
  688. } );
  689. describe( 'createViewElementFromHighlightDescriptor()', () => {
  690. it( 'should return attribute element from descriptor object', () => {
  691. const descriptor = {
  692. class: 'foo-class',
  693. attributes: { one: '1', two: '2' },
  694. priority: 7,
  695. };
  696. const element = createViewElementFromHighlightDescriptor( descriptor );
  697. expect( element.is( 'attributeElement' ) ).to.be.true;
  698. expect( element.name ).to.equal( 'span' );
  699. expect( element.priority ).to.equal( 7 );
  700. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  701. for ( const key of Object.keys( descriptor.attributes ) ) {
  702. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  703. }
  704. } );
  705. it( 'should return attribute element from descriptor object - array with classes', () => {
  706. const descriptor = {
  707. class: [ 'foo-class', 'bar-class' ],
  708. attributes: { one: '1', two: '2' },
  709. priority: 7,
  710. };
  711. const element = createViewElementFromHighlightDescriptor( descriptor );
  712. expect( element.is( 'attributeElement' ) ).to.be.true;
  713. expect( element.name ).to.equal( 'span' );
  714. expect( element.priority ).to.equal( 7 );
  715. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  716. expect( element.hasClass( 'bar-class' ) ).to.be.true;
  717. for ( const key of Object.keys( descriptor.attributes ) ) {
  718. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  719. }
  720. } );
  721. it( 'should create element without class', () => {
  722. const descriptor = {
  723. attributes: { one: '1', two: '2' },
  724. priority: 7,
  725. };
  726. const element = createViewElementFromHighlightDescriptor( descriptor );
  727. expect( element.is( 'attributeElement' ) ).to.be.true;
  728. expect( element.name ).to.equal( 'span' );
  729. expect( element.priority ).to.equal( 7 );
  730. for ( const key of Object.keys( descriptor.attributes ) ) {
  731. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  732. }
  733. } );
  734. it( 'should create element without priority', () => {
  735. const descriptor = {
  736. class: 'foo-class',
  737. attributes: { one: '1', two: '2' },
  738. };
  739. const element = createViewElementFromHighlightDescriptor( descriptor );
  740. expect( element.is( 'attributeElement' ) ).to.be.true;
  741. expect( element.name ).to.equal( 'span' );
  742. expect( element.priority ).to.equal( 10 );
  743. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  744. for ( const key of Object.keys( descriptor.attributes ) ) {
  745. expect( element.getAttribute( key ) ).to.equal( descriptor.attributes[ key ] );
  746. }
  747. } );
  748. it( 'should create element without attributes', () => {
  749. const descriptor = {
  750. class: 'foo-class',
  751. priority: 7
  752. };
  753. const element = createViewElementFromHighlightDescriptor( descriptor );
  754. expect( element.is( 'attributeElement' ) ).to.be.true;
  755. expect( element.name ).to.equal( 'span' );
  756. expect( element.priority ).to.equal( 7 );
  757. expect( element.hasClass( 'foo-class' ) ).to.be.true;
  758. } );
  759. it( 'should create similar elements if they are created using same descriptor id', () => {
  760. const a = createViewElementFromHighlightDescriptor( {
  761. id: 'id',
  762. class: 'classA',
  763. priority: 1
  764. } );
  765. const b = createViewElementFromHighlightDescriptor( {
  766. id: 'id',
  767. class: 'classB',
  768. priority: 2
  769. } );
  770. expect( a.isSimilar( b ) ).to.be.true;
  771. } );
  772. it( 'should create non-similar elements if they have different descriptor id', () => {
  773. const a = createViewElementFromHighlightDescriptor( {
  774. id: 'a',
  775. class: 'foo',
  776. priority: 1
  777. } );
  778. const b = createViewElementFromHighlightDescriptor( {
  779. id: 'b',
  780. class: 'foo',
  781. priority: 1
  782. } );
  783. expect( a.isSimilar( b ) ).to.be.false;
  784. } );
  785. } );
  786. } );