model-to-view-converters.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ModelDocument from '/ckeditor5/engine/model/document.js';
  7. import ModelElement from '/ckeditor5/engine/model/element.js';
  8. import ModelText from '/ckeditor5/engine/model/text.js';
  9. import ModelRange from '/ckeditor5/engine/model/range.js';
  10. import ModelPosition from '/ckeditor5/engine/model/position.js';
  11. import modelWriter from '/ckeditor5/engine/model/writer.js';
  12. import ViewElement from '/ckeditor5/engine/view/element.js';
  13. import ViewContainerElement from '/ckeditor5/engine/view/containerelement.js';
  14. import ViewAttributeElement from '/ckeditor5/engine/view/attributeelement.js';
  15. import ViewText from '/ckeditor5/engine/view/text.js';
  16. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  17. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  18. import {
  19. insertElement,
  20. insertText,
  21. setAttribute,
  22. removeAttribute,
  23. wrap,
  24. unwrap,
  25. move,
  26. remove
  27. } from '/ckeditor5/engine/conversion/model-to-view-converters.js';
  28. let dispatcher, modelDoc, modelRoot, mapper, viewRoot;
  29. beforeEach( () => {
  30. modelDoc = new ModelDocument();
  31. modelRoot = modelDoc.createRoot();
  32. viewRoot = new ViewContainerElement( 'div' );
  33. mapper = new Mapper();
  34. mapper.bindElements( modelRoot, viewRoot );
  35. dispatcher = new ModelConversionDispatcher( { mapper } );
  36. } );
  37. function viewAttributesToString( item ) {
  38. let result = '';
  39. for ( let key of item.getAttributeKeys() ) {
  40. let value = item.getAttribute( key );
  41. if ( value ) {
  42. result += ' ' + key + '="' + value + '"';
  43. }
  44. }
  45. return result;
  46. }
  47. function viewToString( item ) {
  48. let result = '';
  49. if ( item instanceof ViewText ) {
  50. result = item.data;
  51. } else {
  52. // ViewElement or ViewDocumentFragment.
  53. for ( let child of item.getChildren() ) {
  54. result += viewToString( child );
  55. }
  56. if ( item instanceof ViewElement ) {
  57. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  58. }
  59. }
  60. return result;
  61. }
  62. describe( 'insertText', () => {
  63. it( 'should convert text insertion in model to view text', () => {
  64. modelRoot.appendChildren( new ModelText( 'foobar' ) );
  65. dispatcher.on( 'insert:$text', insertText() );
  66. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  67. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  68. } );
  69. it( 'should support unicode', () => {
  70. modelRoot.appendChildren( new ModelText( 'நிலைக்கு' ) );
  71. dispatcher.on( 'insert:$text', insertText() );
  72. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  73. expect( viewToString( viewRoot ) ).to.equal( '<div>நிலைக்கு</div>' );
  74. } );
  75. } );
  76. describe( 'insertElement', () => {
  77. it( 'should convert element insertion in model to and map positions for future converting', () => {
  78. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  79. const viewElement = new ViewContainerElement( 'p' );
  80. modelRoot.appendChildren( modelElement );
  81. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  82. dispatcher.on( 'insert:$text', insertText() );
  83. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  84. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  85. } );
  86. it( 'should take view element function generator as a parameter', () => {
  87. const elementGenerator = ( data, consumable ) => {
  88. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  89. return new ViewContainerElement( 'div' );
  90. } else {
  91. return new ViewContainerElement( 'p' );
  92. }
  93. };
  94. const niceP = new ModelElement( 'myParagraph', { nice: true }, new ModelText( 'foo' ) );
  95. const badP = new ModelElement( 'myParagraph', null, new ModelText( 'bar' ) );
  96. modelRoot.appendChildren( [ niceP, badP ] );
  97. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  98. dispatcher.on( 'insert:$text', insertText() );
  99. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  100. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  101. } );
  102. } );
  103. describe( 'setAttribute/removeAttribute', () => {
  104. it( 'should convert attribute insert/change/remove on a model node', () => {
  105. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) );
  106. const viewElement = new ViewContainerElement( 'p' );
  107. modelRoot.appendChildren( modelElement );
  108. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  109. dispatcher.on( 'insert:$text', insertText() );
  110. dispatcher.on( 'addAttribute:class', setAttribute() );
  111. dispatcher.on( 'changeAttribute:class', setAttribute() );
  112. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  113. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  114. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  115. modelElement.setAttribute( 'class', 'bar' );
  116. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'foo', 'bar' );
  117. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  118. modelElement.removeAttribute( 'class' );
  119. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'bar', null );
  120. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  121. } );
  122. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  123. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  124. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  125. const themeConverter = ( value, key, data ) => {
  126. if ( data.item instanceof ModelElement && data.item.childCount > 0 ) {
  127. value += ' ' + 'fix-content';
  128. }
  129. return { key: 'class', value };
  130. };
  131. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  132. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  133. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  134. dispatcher.on( 'insert:$text', insertText() );
  135. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  136. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  137. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  138. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  139. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  140. modelParagraph.setAttribute( 'theme', 'awesome' );
  141. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'nice', 'awesome' );
  142. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  143. modelParagraph.removeAttribute( 'theme' );
  144. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'awesome', null );
  145. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  146. } );
  147. } );
  148. describe( 'wrap/unwrap', () => {
  149. it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => {
  150. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  151. const viewP = new ViewContainerElement( 'p' );
  152. const viewB = new ViewAttributeElement( 'b' );
  153. modelRoot.appendChildren( modelElement );
  154. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  155. dispatcher.on( 'insert:$text', insertText() );
  156. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  157. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  158. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  159. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  160. modelWriter.removeAttribute( ModelRange.createFromElement( modelElement ), 'bold' );
  161. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'bold', true, null );
  162. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  163. } );
  164. it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
  165. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
  166. const viewP = new ViewContainerElement( 'p' );
  167. const elementGenerator = ( value ) => {
  168. if ( value == 'bold' ) {
  169. return new ViewAttributeElement( 'b' );
  170. }
  171. };
  172. modelRoot.appendChildren( modelElement );
  173. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  174. dispatcher.on( 'insert:$text', insertText() );
  175. dispatcher.on( 'addAttribute:style', wrap( elementGenerator ) );
  176. dispatcher.on( 'removeAttribute:style', unwrap( elementGenerator ) );
  177. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  178. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  179. modelWriter.removeAttribute( ModelRange.createFromElement( modelElement ), 'style' );
  180. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'style', 'bold', null );
  181. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  182. } );
  183. it( 'should update range on re-wrapping attribute (#475)', () => {
  184. const modelElement = new ModelElement( 'paragraph', null, [
  185. new ModelText( 'x' ),
  186. new ModelText( 'foo', { link: 'http://foo.com' } ),
  187. new ModelText( 'x' )
  188. ] );
  189. const viewP = new ViewContainerElement( 'p' );
  190. const elementGenerator = ( href ) => new ViewAttributeElement( 'a', { href } );
  191. modelRoot.appendChildren( modelElement );
  192. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  193. dispatcher.on( 'insert:$text', insertText() );
  194. dispatcher.on( 'addAttribute:link', wrap( elementGenerator ) );
  195. dispatcher.on( 'changeAttribute:link', wrap( elementGenerator ) );
  196. dispatcher.convertInsert(
  197. ModelRange.createFromElement( modelRoot )
  198. );
  199. expect( viewToString( viewRoot ) ).to.equal( '<div><p>x<a href="http://foo.com">foo</a>x</p></div>' );
  200. modelWriter.setAttribute( ModelRange.createFromElement( modelElement ), 'link', 'http://foobar.com' );
  201. dispatcher.convertAttribute(
  202. 'changeAttribute',
  203. ModelRange.createFromElement( modelElement ),
  204. 'link',
  205. 'http://foo.com',
  206. 'http://foobar.com'
  207. );
  208. expect( viewToString( viewRoot ) ).to.equal( '<div><p><a href="http://foobar.com">xfoox</a></p></div>' );
  209. } );
  210. it( 'should support unicode', () => {
  211. const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { 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', wrap( viewB ) );
  218. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  219. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  220. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நி<b>லைக்</b>கு</p></div>' );
  221. modelWriter.removeAttribute( ModelRange.createFromElement( modelElement ), 'bold' );
  222. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'bold', true, null );
  223. expect( viewToString( viewRoot ) ).to.equal( '<div><p>நிலைக்கு</p></div>' );
  224. } );
  225. } );
  226. describe( 'move', () => {
  227. it( 'should move items in view accordingly to changes in model', () => {
  228. const modelDivA = new ModelElement( 'div', null, [
  229. new ModelText( 'foo' ),
  230. new ModelElement( 'image' ),
  231. new ModelText( 'bar' )
  232. ] );
  233. const modelDivB = new ModelElement( 'div', null, new ModelText( 'xxyy' ) );
  234. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  235. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  236. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  237. dispatcher.on( 'insert:$text', insertText() );
  238. dispatcher.on( 'move', move() );
  239. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  240. const removedNodes = modelDivA.removeChildren( 0, 2 );
  241. modelDivB.insertChildren( 0, removedNodes );
  242. dispatcher.convertMove(
  243. ModelPosition.createFromParentAndOffset( modelDivA, 0 ),
  244. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  245. );
  246. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div><div>foo<img></img>xxyy</div></div>' );
  247. } );
  248. it( 'should support unicode', () => {
  249. const modelDivA = new ModelElement( 'div', null, 'நிலைக்கு' );
  250. const modelDivB = new ModelElement( 'div' );
  251. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  252. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  253. dispatcher.on( 'insert:$text', insertText() );
  254. dispatcher.on( 'move', move() );
  255. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  256. modelWriter.move(
  257. ModelRange.createFromParentsAndOffsets( modelDivA, 2, modelDivA, 6 ),
  258. ModelPosition.createAt( modelDivB, 'end' )
  259. );
  260. dispatcher.convertMove(
  261. ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
  262. ModelRange.createFromParentsAndOffsets( modelDivB, 0, modelDivB, 4 )
  263. );
  264. expect( viewToString( viewRoot ) ).to.equal( '<div><div>நிகு</div><div>லைக்</div></div>' );
  265. } );
  266. } );
  267. describe( 'remove', () => {
  268. it( 'should remove items from view accordingly to changes in model', () => {
  269. const modelDiv = new ModelElement( 'div', null, [
  270. new ModelText( 'foo' ),
  271. new ModelElement( 'image' ),
  272. new ModelText( 'bar' )
  273. ] );
  274. modelRoot.appendChildren( modelDiv );
  275. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  276. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  277. dispatcher.on( 'insert:$text', insertText() );
  278. dispatcher.on( 'remove', remove() );
  279. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  280. const removedNodes = modelDiv.removeChildren( 0, 2 );
  281. modelDoc.graveyard.insertChildren( 0, removedNodes );
  282. dispatcher.convertRemove(
  283. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  284. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 4 )
  285. );
  286. expect( viewToString( viewRoot ) ).to.equal( '<div><div>bar</div></div>' );
  287. } );
  288. it( 'should support unicode', () => {
  289. const modelDiv = new ModelElement( 'div', null, 'நிலைக்கு' );
  290. modelRoot.appendChildren( modelDiv );
  291. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  292. dispatcher.on( 'insert:$text', insertText() );
  293. dispatcher.on( 'remove', remove() );
  294. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  295. modelWriter.move(
  296. ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ),
  297. ModelPosition.createAt( modelDoc.graveyard, 'end' )
  298. );
  299. dispatcher.convertRemove(
  300. ModelPosition.createFromParentAndOffset( modelDiv, 0 ),
  301. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 6 )
  302. );
  303. expect( viewToString( viewRoot ) ).to.equal( '<div><div>கு</div></div>' );
  304. } );
  305. } );