8
0

model-to-view-converters.js 49 KB

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