model-to-view-converters.js 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001
  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. wrapRange,
  27. unwrapRange,
  28. move,
  29. remove,
  30. removeUIElement,
  31. rename
  32. } from '../../src/conversion/model-to-view-converters';
  33. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  34. describe( 'model-to-view-converters', () => {
  35. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  36. beforeEach( () => {
  37. modelDoc = new ModelDocument();
  38. modelRoot = modelDoc.createRoot();
  39. viewRoot = new ViewContainerElement( 'div' );
  40. mapper = new Mapper();
  41. mapper.bindElements( modelRoot, viewRoot );
  42. dispatcher = new ModelConversionDispatcher( { mapper } );
  43. } );
  44. function viewAttributesToString( item ) {
  45. let result = '';
  46. for ( let key of item.getAttributeKeys() ) {
  47. let value = item.getAttribute( key );
  48. if ( value ) {
  49. result += ' ' + key + '="' + value + '"';
  50. }
  51. }
  52. return result;
  53. }
  54. function viewToString( item ) {
  55. let result = '';
  56. if ( item instanceof ViewText ) {
  57. result = item.data;
  58. } else {
  59. // ViewElement or ViewDocumentFragment.
  60. for ( let child of item.getChildren() ) {
  61. result += viewToString( child );
  62. }
  63. if ( item instanceof ViewElement ) {
  64. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  65. }
  66. }
  67. return result;
  68. }
  69. describe( 'insertText', () => {
  70. it( 'should convert text insertion in model to view text', () => {
  71. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  72. dispatcher.on( 'insert:$text', insertText() );
  73. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  74. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  75. } );
  76. it( 'should support unicode', () => {
  77. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  78. dispatcher.on( 'insert:$text', insertText() );
  79. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  80. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  81. } );
  82. it( 'should be possible to override it', () => {
  83. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  84. dispatcher.on( 'insert:$text', insertText() );
  85. dispatcher.on( 'insert:$text', ( evt, data, consumable ) => {
  86. consumable.consume( data.item, 'insert' );
  87. }, { priority: 'high' } );
  88. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  89. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  90. } );
  91. } );
  92. describe( 'insertElement', () => {
  93. it( 'should convert element insertion in model to and map positions for future converting', () => {
  94. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  95. const viewElement = new ViewContainerElement( 'p' );
  96. modelRoot.appendChildren( modelElement );
  97. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  98. dispatcher.on( 'insert:$text', insertText() );
  99. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  100. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  101. } );
  102. it( 'should take view element function generator as a parameter', () => {
  103. const elementGenerator = ( data, consumable ) => {
  104. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  105. return new ViewContainerElement( 'div' );
  106. } else {
  107. return new ViewContainerElement( 'p' );
  108. }
  109. };
  110. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  111. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  112. modelRoot.appendChildren( [ niceP, badP ] );
  113. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  114. dispatcher.on( 'insert:$text', insertText() );
  115. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  116. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  117. } );
  118. it( 'should not convert and not consume if creator function returned null', () => {
  119. const elementGenerator = () => null;
  120. const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  121. modelRoot.appendChildren( [ modelP ] );
  122. sinon.spy( dispatcher, 'fire' );
  123. dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ) );
  124. dispatcher.on( 'insert:paragraph', ( evt, data, consumable ) => {
  125. expect( consumable.test( data.item, 'insert' ) ).to.be.true;
  126. } );
  127. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  128. expect( viewToString( viewRoot ) ).to.equal( '<div></div>' );
  129. expect( dispatcher.fire.calledWith( 'insert:paragraph' ) ).to.be.true;
  130. } );
  131. } );
  132. describe( 'setAttribute/removeAttribute', () => {
  133. it( 'should convert attribute insert/change/remove on a model node', () => {
  134. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  135. const viewElement = new ViewContainerElement( 'p' );
  136. modelRoot.appendChildren( modelElement );
  137. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  138. dispatcher.on( 'insert:$text', insertText() );
  139. dispatcher.on( 'addAttribute:class', setAttribute() );
  140. dispatcher.on( 'changeAttribute:class', setAttribute() );
  141. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  142. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  143. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  144. modelElement.setAttribute( 'class', 'bar' );
  145. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'foo', 'bar' );
  146. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  147. modelElement.removeAttribute( 'class' );
  148. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  149. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  150. } );
  151. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  152. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  153. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  154. const themeConverter = ( value, key, data ) => {
  155. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  156. value += ' ' + 'fix-content';
  157. }
  158. return { key: 'class', value };
  159. };
  160. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  161. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  162. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  163. dispatcher.on( 'insert:$text', insertText() );
  164. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  165. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  166. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  167. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  168. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  169. modelParagraph.setAttribute( 'theme', 'awesome' );
  170. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'nice', 'awesome' );
  171. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  172. modelParagraph.removeAttribute( 'theme' );
  173. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelParagraph ), 'theme', 'awesome', null );
  174. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  175. } );
  176. it( 'should be possible to override setAttribute', () => {
  177. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  178. const viewElement = new ViewContainerElement( 'p' );
  179. modelRoot.appendChildren( modelElement );
  180. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  181. dispatcher.on( 'insert:$text', insertText() );
  182. dispatcher.on( 'addAttribute:class', setAttribute() );
  183. dispatcher.on( 'addAttribute:class', ( evt, data, consumable ) => {
  184. consumable.consume( data.item, 'addAttribute:class' );
  185. }, { priority: 'high' } );
  186. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  187. // No attribute set.
  188. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  189. } );
  190. it( 'should be possible to override removeAttribute', () => {
  191. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  192. const viewElement = new ViewContainerElement( 'p' );
  193. modelRoot.appendChildren( modelElement );
  194. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  195. dispatcher.on( 'insert:$text', insertText() );
  196. dispatcher.on( 'addAttribute:class', setAttribute() );
  197. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  198. dispatcher.on( 'removeAttribute:class', ( evt, data, consumable ) => {
  199. consumable.consume( data.item, 'removeAttribute:class' );
  200. }, { priority: 'high' } );
  201. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  203. modelElement.removeAttribute( 'class' );
  204. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'bar', null );
  205. // Nothing changed.
  206. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  207. } );
  208. } );
  209. describe( 'wrap/unwrap', () => {
  210. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  211. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  212. const viewP = new ViewContainerElement( 'p' );
  213. const viewB = new ViewAttributeElement( 'b' );
  214. modelRoot.appendChildren( modelElement );
  215. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  216. dispatcher.on( 'insert:$text', insertText() );
  217. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  218. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  219. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  220. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  221. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  222. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  223. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  224. } );
  225. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  226. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  227. const viewP = new ViewContainerElement( 'p' );
  228. const elementGenerator = ( value ) => {
  229. if ( value == 'bold' ) {
  230. return new ViewAttributeElement( 'b' );
  231. }
  232. };
  233. modelRoot.appendChildren( modelElement );
  234. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  235. dispatcher.on( 'insert:$text', insertText() );
  236. dispatcher.on( 'addAttribute:style', wrapItem( elementGenerator ) );
  237. dispatcher.on( 'removeAttribute:style', unwrapItem( elementGenerator ) );
  238. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  239. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  240. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' );
  241. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null );
  242. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  243. } );
  244. it( 'should update range on re-wrapping attribute (#475)', () => {
  245. const modelElement = new ModelElement( 'paragraph', null, [
  246. new ModelText( 'x' ),
  247. new ModelText( 'foo', { link: 'http://foo.com' } ),
  248. new ModelText( 'x' )
  249. ] );
  250. const viewP = new ViewContainerElement( 'p' );
  251. const elementGenerator = ( href ) => new ViewAttributeElement( 'a', { href } );
  252. modelRoot.appendChildren( modelElement );
  253. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  254. dispatcher.on( 'insert:$text', insertText() );
  255. dispatcher.on( 'addAttribute:link', wrapItem( elementGenerator ) );
  256. dispatcher.on( 'changeAttribute:link', wrapItem( elementGenerator ) );
  257. dispatcher.convertInsertion(
  258. ModelRange.createIn( modelRoot )
  259. );
  260. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  261. modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' );
  262. dispatcher.convertAttribute(
  263. 'changeAttribute',
  264. ModelRange.createIn( modelElement ),
  265. 'link',
  266. 'http://foo.com',
  267. 'http://foobar.com'
  268. );
  269. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  270. } );
  271. it( 'should support unicode', () => {
  272. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] );
  273. const viewP = new ViewContainerElement( 'p' );
  274. const viewB = new ViewAttributeElement( 'b' );
  275. modelRoot.appendChildren( modelElement );
  276. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  277. dispatcher.on( 'insert:$text', insertText() );
  278. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  279. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  280. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  281. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  282. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  283. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  284. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  285. } );
  286. it( 'should be possible to override wrap', () => {
  287. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  288. const viewP = new ViewContainerElement( 'p' );
  289. const viewB = new ViewAttributeElement( 'b' );
  290. modelRoot.appendChildren( modelElement );
  291. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  292. dispatcher.on( 'insert:$text', insertText() );
  293. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  294. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  295. consumable.consume( data.item, 'addAttribute:bold' );
  296. }, { priority: 'high' } );
  297. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  298. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  299. } );
  300. it( 'should be possible to override unwrap', () => {
  301. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  302. const viewP = new ViewContainerElement( 'p' );
  303. const viewB = new ViewAttributeElement( 'b' );
  304. modelRoot.appendChildren( modelElement );
  305. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  306. dispatcher.on( 'insert:$text', insertText() );
  307. dispatcher.on( 'addAttribute:bold', wrapItem( viewB ) );
  308. dispatcher.on( 'removeAttribute:bold', unwrapItem( viewB ) );
  309. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  310. consumable.consume( data.item, 'removeAttribute:bold' );
  311. }, { priority: 'high' } );
  312. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  313. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  314. modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' );
  315. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null );
  316. // Nothing changed.
  317. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  318. } );
  319. it( 'should not convert and not consume if creator function returned null', () => {
  320. const elementGenerator = () => null;
  321. const modelText = new ModelText( 'foo', { bold: true } );
  322. modelRoot.appendChildren( [ modelText ] );
  323. sinon.spy( dispatcher, 'fire' );
  324. dispatcher.on( 'insert:$text', insertText() );
  325. dispatcher.on( 'addAttribute:bold', wrapItem( elementGenerator ) );
  326. dispatcher.on( 'removeAttribute:bold', unwrapItem( elementGenerator ) );
  327. dispatcher.on( 'addAttribute:bold', ( evt, data, consumable ) => {
  328. expect( consumable.test( data.item, 'addAttribute:bold' ) ).to.be.true;
  329. } );
  330. dispatcher.on( 'removeAttribute:bold', ( evt, data, consumable ) => {
  331. expect( consumable.test( data.item, 'removeAttribute:bold' ) ).to.be.true;
  332. } );
  333. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  334. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  335. expect( dispatcher.fire.calledWith( 'addAttribute:bold:$text' ) ).to.be.true;
  336. modelText.removeAttribute( 'bold' );
  337. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  338. expect( dispatcher.fire.calledWith( 'removeAttribute:bold:$text' ) ).to.be.true;
  339. } );
  340. } );
  341. describe( 'wrapRange/unwrapRange', () => {
  342. let modelText, range, modelElement;
  343. beforeEach( () => {
  344. modelText = new ModelText( 'foobar' );
  345. modelElement = new ModelElement( 'paragraph', null, modelText );
  346. modelRoot.appendChildren( modelElement );
  347. const viewText = new ViewText( 'foobar' );
  348. const viewElement = new ViewContainerElement( 'p', null, viewText );
  349. viewRoot.appendChildren( viewElement );
  350. mapper.bindElements( modelElement, viewElement );
  351. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 );
  352. } );
  353. it( 'should convert adding/removing of marker into wrapping element in a view', () => {
  354. const viewSpan = new ViewAttributeElement( 'span', { class: 'name' } );
  355. dispatcher.on( 'addMarker:name', wrapRange( viewSpan ) );
  356. dispatcher.on( 'removeMarker:name', unwrapRange( viewSpan ) );
  357. dispatcher.convertMarker( 'addMarker', 'name', range );
  358. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="name">ob</span>ar</p></div>' );
  359. dispatcher.convertMarker( 'removeMarker', 'name', range );
  360. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  361. } );
  362. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  363. const converterCallback = ( data ) => {
  364. const name = data.name.split( ':' )[ 1 ];
  365. return new ViewAttributeElement( 'span', { class: name } );
  366. };
  367. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  368. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  369. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  370. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  371. dispatcher.convertMarker( 'removeMarker', 'name:john', range );
  372. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  373. } );
  374. it( 'should support non-flat markers', () => {
  375. const modelElement2 = new ModelElement( 'paragraph', null, new ModelText( '22' ) );
  376. modelRoot.appendChildren( modelElement2 );
  377. const modelElement3 = new ModelElement( 'paragraph', null, new ModelText( '333' ) );
  378. modelRoot.appendChildren( modelElement3 );
  379. const viewElement2 = new ViewContainerElement( 'p', null, new ViewText( '22' ) );
  380. viewRoot.appendChildren( viewElement2 );
  381. const viewElement3 = new ViewContainerElement( 'p', null, new ViewText( '333' ) );
  382. viewRoot.appendChildren( viewElement3 );
  383. mapper.bindElements( modelElement2, viewElement2 );
  384. mapper.bindElements( modelElement3, viewElement3 );
  385. const range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement3, 1 );
  386. const viewSpan = new ViewAttributeElement( 'span', { class: 'name' } );
  387. dispatcher.on( 'addMarker:name', wrapRange( viewSpan ) );
  388. dispatcher.on( 'removeMarker:name', unwrapRange( viewSpan ) );
  389. dispatcher.convertMarker( 'addMarker', 'name', range );
  390. expect( viewToString( viewRoot ) ).to.equal(
  391. '<div><p>fo<span class="name">obar</span></p><p><span class="name">22</span></p><p><span class="name">3</span>33</p></div>'
  392. );
  393. dispatcher.convertMarker( 'removeMarker', 'name', range );
  394. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><p>22</p><p>333</p></div>' );
  395. } );
  396. it( 'should be possible to override wrapRange', () => {
  397. const converterCallback = ( data ) => {
  398. const name = data.name.split( ':' )[ 1 ];
  399. return new ViewAttributeElement( 'span', { class: name } );
  400. };
  401. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  402. dispatcher.on( 'addMarker:name:john', ( evt, data, consumable ) => {
  403. consumable.consume( data.range, 'addMarker' );
  404. }, { priority: 'high' } );
  405. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  406. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  407. } );
  408. it( 'should be possible to override unwrapRange', () => {
  409. const converterCallback = ( data ) => {
  410. const name = data.name.split( ':' )[ 1 ];
  411. return new ViewAttributeElement( 'span', { class: name } );
  412. };
  413. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  414. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  415. dispatcher.on( 'removeMarker:name:john', ( evt, data, consumable ) => {
  416. consumable.consume( data.range, 'removeMarker' );
  417. }, { priority: 'high' } );
  418. dispatcher.convertMarker( 'addMarker', 'name:john', range );
  419. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  420. dispatcher.convertMarker( 'removeMarker', 'name:john', range );
  421. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="john">ob</span>ar</p></div>' );
  422. } );
  423. it( 'should not convert or consume if view element is not returned by element generating function', () => {
  424. const converterCallback = () => null;
  425. sinon.spy( dispatcher, 'fire' );
  426. dispatcher.on( 'addMarker:name', wrapRange( converterCallback ) );
  427. dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => {
  428. // Check whether value was not consumed from `consumable`.
  429. expect( consumable.test( data.range, 'addMarker' ) ).to.be.true;
  430. } );
  431. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallback ) );
  432. dispatcher.on( 'removeMarker:name', ( evt, data, consumable ) => {
  433. // Check whether value was not consumed from `consumable`.
  434. expect( consumable.test( data.range, 'removeMarker' ) ).to.be.true;
  435. } );
  436. dispatcher.convertMarker( 'addMarker', 'name', range );
  437. expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.true;
  438. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  439. dispatcher.convertMarker( 'removeMarker', 'name', range );
  440. expect( dispatcher.fire.calledWith( 'removeMarker:name' ) ).to.be.true;
  441. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  442. } );
  443. it( 'multiple overlapping non-collapsed markers', () => {
  444. const converterCallbackName = ( data ) => {
  445. const name = data.name.split( ':' )[ 1 ];
  446. const element = new ViewAttributeElement( 'span', { class: name } );
  447. element.priority = name.charCodeAt( 0 );
  448. return element;
  449. };
  450. const converterCallbackSearch = () => new ViewAttributeElement( 'em', { class: 'search' } );
  451. dispatcher.on( 'addMarker:name', wrapRange( converterCallbackName ) );
  452. dispatcher.on( 'removeMarker:name', unwrapRange( converterCallbackName ) );
  453. dispatcher.on( 'addMarker:search', wrapRange( converterCallbackSearch ) );
  454. dispatcher.on( 'removeMarker:search', unwrapRange( converterCallbackSearch ) );
  455. dispatcher.convertMarker( 'addMarker', 'name:a', range );
  456. dispatcher.convertMarker( 'addMarker', 'name:b', range );
  457. dispatcher.convertMarker( 'addMarker', 'search', range );
  458. expect( viewToString( viewRoot ) ).to.equal(
  459. '<div><p>fo<em class="search"><span class="a"><span class="b">ob</span></span></em>ar</p></div>'
  460. );
  461. dispatcher.convertMarker( 'removeMarker', 'name:b', range );
  462. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<em class="search"><span class="a">ob</span></em>ar</p></div>' );
  463. dispatcher.convertMarker( 'removeMarker', 'search', range );
  464. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="a">ob</span>ar</p></div>' );
  465. dispatcher.convertMarker( 'removeMarker', 'name:a', range );
  466. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  467. } );
  468. it( 'multiple overlapping non-collapsed markers intersecting with same priority', () => {
  469. const converterCallbackSearch = () => new ViewAttributeElement( 'em', { class: 'search' } );
  470. dispatcher.on( 'addMarker:search', wrapRange( converterCallbackSearch ) );
  471. dispatcher.on( 'removeMarker:search', unwrapRange( converterCallbackSearch ) );
  472. const range1 = ModelRange.createFromParentsAndOffsets( modelElement, 1, modelElement, 3 );
  473. const range2 = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 );
  474. const range3 = ModelRange.createFromParentsAndOffsets( modelElement, 4, modelElement, 6 );
  475. dispatcher.convertMarker( 'addMarker', 'search', range1 );
  476. dispatcher.convertMarker( 'addMarker', 'search', range2 );
  477. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">oob</em>ar</p></div>' );
  478. dispatcher.convertMarker( 'addMarker', 'search', range3 );
  479. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">oobar</em></p></div>' );
  480. dispatcher.convertMarker( 'removeMarker', 'search', range2 );
  481. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">o</em>ob<em class="search">ar</em></p></div>' );
  482. dispatcher.convertMarker( 'removeMarker', 'search', range3 );
  483. expect( viewToString( viewRoot ) ).to.equal( '<div><p>f<em class="search">o</em>obar</p></div>' );
  484. dispatcher.convertMarker( 'removeMarker', 'search', range1 );
  485. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  486. } );
  487. } );
  488. describe( 'insertUIElement/removeUIElement', () => {
  489. let modelText, range, modelElement;
  490. beforeEach( () => {
  491. modelText = new ModelText( 'foobar' );
  492. modelElement = new ModelElement( 'paragraph', null, modelText );
  493. modelRoot.appendChildren( modelElement );
  494. const viewText = new ViewText( 'foobar' );
  495. const viewElement = new ViewContainerElement( 'p', null, viewText );
  496. viewRoot.appendChildren( viewElement );
  497. mapper.bindElements( modelElement, viewElement );
  498. range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 );
  499. } );
  500. it( 'should insert and remove ui element - element as a creator', () => {
  501. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  502. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  503. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  504. dispatcher.convertMarker( 'addMarker', 'marker', range );
  505. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  506. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  507. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  508. } );
  509. it( 'should insert and remove ui element - function as a creator', () => {
  510. const viewUi = ( data ) => new ViewUIElement( 'span', { 'class': data.name } );
  511. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  512. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  513. dispatcher.convertMarker( 'addMarker', 'marker', range );
  514. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="marker"></span>bar</p></div>' );
  515. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  516. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  517. } );
  518. it( 'should not convert or consume if generator function returned null', () => {
  519. const viewUi = () => null;
  520. sinon.spy( dispatcher, 'fire' );
  521. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  522. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  523. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  524. expect( consumable.test( data.range, 'addMarker' ) ).to.be.true;
  525. } );
  526. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  527. expect( consumable.test( data.range, 'removeMarker' ) ).to.be.true;
  528. } );
  529. dispatcher.convertMarker( 'addMarker', 'marker', range );
  530. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  531. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  532. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  533. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  534. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  535. } );
  536. it( 'should be possible to overwrite', () => {
  537. const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } );
  538. sinon.spy( dispatcher, 'fire' );
  539. dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) );
  540. dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) );
  541. dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => {
  542. consumable.consume( data.range, 'addMarker' );
  543. }, { priority: 'high' } );
  544. dispatcher.on( 'removeMarker:marker', ( evt, data, consumable ) => {
  545. consumable.consume( data.range, 'removeMarker' );
  546. }, { priority: 'high' } );
  547. dispatcher.convertMarker( 'addMarker', 'marker', range );
  548. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  549. expect( dispatcher.fire.calledWith( 'addMarker:marker' ) );
  550. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  551. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  552. expect( dispatcher.fire.calledWith( 'removeMarker:marker' ) );
  553. } );
  554. } );
  555. describe( 'move', () => {
  556. it( 'should move items in view accordingly to changes in model', () => {
  557. const modelDivA = new ModelElement( 'div', null, [
  558. new ModelText( 'foo' ),
  559. new ModelElement( 'image' ),
  560. new ModelText( 'bar' )
  561. ] );
  562. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  563. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  564. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  565. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  566. dispatcher.on( 'insert:$text', insertText() );
  567. dispatcher.on( 'move', move() );
  568. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  569. const removedNodes = modelDivA.removeChildren( 0, 2 );
  570. modelDivB.insertChildren( 0, removedNodes );
  571. dispatcher.convertMove(
  572. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  573. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  574. );
  575. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div><div>foo<img></img>xxyy</div></div>' );
  576. } );
  577. it( 'should not execute if value was already consumed', () => {
  578. const modelDivA = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  579. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  580. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  581. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  582. dispatcher.on( 'insert:$text', insertText() );
  583. dispatcher.on( 'move', move() );
  584. dispatcher.on( 'move', ( evt, data, consumable ) => {
  585. consumable.consume( data.item, 'move' );
  586. }, { priority: 'high' } );
  587. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  588. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  589. const removedNodes = modelDivA.removeChildren( 0, 1 );
  590. modelDivB.insertChildren( 0, removedNodes );
  591. dispatcher.convertMove(
  592. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  593. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 3 )
  594. );
  595. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><div>xxyy</div></div>' );
  596. } );
  597. it( 'should support unicode', () => {
  598. const modelDivA = new ModelElement( 'div', null, 'நிலைக்கு' );
  599. const modelDivB = new ModelElement( 'div' );
  600. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  601. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  602. dispatcher.on( 'insert:$text', insertText() );
  603. dispatcher.on( 'move', move() );
  604. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  605. modelWriter.move(
  606. ModelRange.createFromParentsAndOffsets( modelDivA, 2, modelDivA, 6 ),
  607. ModelPosition.createAt( modelDivB, 'end' )
  608. );
  609. dispatcher.convertMove(
  610. ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
  611. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  612. );
  613. expect( viewToString( viewRoot ) ).to.equal( '<div><div>நிகு</div><div>லைக்</div></div>' );
  614. } );
  615. } );
  616. describe( 'remove', () => {
  617. it( 'should remove items from view accordingly to changes in model', () => {
  618. const modelDiv = new ModelElement( 'div', null, [
  619. new ModelText( 'foo' ),
  620. new ModelElement( 'image' ),
  621. new ModelText( 'bar' )
  622. ] );
  623. modelRoot.appendChildren( modelDiv );
  624. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  625. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  626. dispatcher.on( 'insert:$text', insertText() );
  627. dispatcher.on( 'remove', remove() );
  628. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  629. const removedNodes = modelDiv.removeChildren( 0, 2 );
  630. modelDoc.graveyard.insertChildren( 0, removedNodes );
  631. dispatcher.convertRemove(
  632. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  633. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  634. );
  635. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  636. } );
  637. it( 'should not execute if value was already consumed', () => {
  638. const modelDiv = new ModelElement( 'div', null, new ModelText( 'foo' ) );
  639. modelRoot.appendChildren( modelDiv );
  640. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  641. dispatcher.on( 'insert:$text', insertText() );
  642. dispatcher.on( 'remove', remove() );
  643. dispatcher.on( 'remove', ( evt, data, consumable ) => {
  644. consumable.consume( data.item, 'remove' );
  645. }, { priority: 'high' } );
  646. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  647. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  648. const removedNodes = modelDiv.removeChildren( 0, 1 );
  649. modelDoc.graveyard.insertChildren( 0, removedNodes );
  650. dispatcher.convertRemove(
  651. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  652. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 3 )
  653. );
  654. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div></div>' );
  655. } );
  656. it( 'should support unicode', () => {
  657. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  658. modelRoot.appendChildren( modelDiv );
  659. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  660. dispatcher.on( 'insert:$text', insertText() );
  661. dispatcher.on( 'remove', remove() );
  662. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  663. modelWriter.move(
  664. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  665. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  666. );
  667. dispatcher.convertRemove(
  668. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  669. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  670. );
  671. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  672. } );
  673. } );
  674. describe( 'rename', () => {
  675. const oldName = 'oldName';
  676. const newName = 'newName';
  677. let element, converters;
  678. beforeEach( () => {
  679. converters = {
  680. insertText: insertText(),
  681. insert: insertElement( ( data ) => new ViewContainerElement( data.item.name ) ),
  682. move: move(),
  683. remove: remove(),
  684. rename: rename()
  685. };
  686. sinon.spy( converters, 'insert' );
  687. sinon.spy( converters, 'move' );
  688. sinon.spy( converters, 'remove' );
  689. element = new ModelElement( oldName, null, new ModelText( 'foo' ) );
  690. modelRoot.appendChildren( element );
  691. dispatcher.on( 'insert:$text', converters.insertText );
  692. dispatcher.on( 'insert', converters.insert );
  693. dispatcher.on( 'move', converters.move );
  694. dispatcher.on( 'remove', converters.remove );
  695. dispatcher.on( 'rename', converters.rename );
  696. dispatcher.convertInsertion( ModelRange.createOn( element ) );
  697. element.name = newName;
  698. } );
  699. afterEach( () => {
  700. converters.insert.restore();
  701. converters.move.restore();
  702. converters.remove.restore();
  703. } );
  704. it( 'should enable default rename conversion, that uses already registered callbacks', () => {
  705. const insertCallCount = converters.insert.callCount;
  706. expect( viewRoot.getChild( 0 ).name ).to.equal( 'oldName' );
  707. dispatcher.convertRename( element, oldName );
  708. expect( converters.insert.callCount - insertCallCount ).to.equal( 1 );
  709. expect( converters.move.calledOnce ).to.be.true;
  710. expect( converters.remove.calledOnce ).to.be.true;
  711. expect( viewRoot.getChild( 0 ).name ).to.equal( 'newName' );
  712. expect( viewRoot.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  713. } );
  714. it( 'should not execute if converted value was already consumed', () => {
  715. dispatcher.on( 'rename', ( evt, data, consumable ) => {
  716. consumable.consume( data.element, 'rename' );
  717. }, { priority: 'high' } );
  718. dispatcher.on( 'rename', ( evt, data ) => {
  719. expect( data.fakeElement ).to.be.undefined;
  720. } );
  721. dispatcher.convertRename( element, oldName );
  722. } );
  723. } );
  724. } );