model-to-view-converters.js 15 KB

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