model-to-view-converters.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treecontroller */
  6. 'use strict';
  7. import ModelDocument from '/ckeditor5/engine/treemodel/document.js';
  8. import ModelElement from '/ckeditor5/engine/treemodel/element.js';
  9. import ModelText from '/ckeditor5/engine/treemodel/text.js';
  10. import ModelRange from '/ckeditor5/engine/treemodel/range.js';
  11. import ModelPosition from '/ckeditor5/engine/treemodel/position.js';
  12. import ViewElement from '/ckeditor5/engine/treeview/element.js';
  13. import ViewContainerElement from '/ckeditor5/engine/treeview/containerelement.js';
  14. import ViewAttributeElement from '/ckeditor5/engine/treeview/attributeelement.js';
  15. import ViewText from '/ckeditor5/engine/treeview/text.js';
  16. import ViewWriter from '/ckeditor5/engine/treeview/writer.js';
  17. import Mapper from '/ckeditor5/engine/treecontroller/mapper.js';
  18. import ModelConversionDispatcher from '/ckeditor5/engine/treecontroller/modelconversiondispatcher.js';
  19. import {
  20. insertElement,
  21. insertText,
  22. setAttribute,
  23. removeAttribute,
  24. wrap,
  25. unwrap,
  26. move,
  27. remove
  28. } from '/ckeditor5/engine/treecontroller/model-to-view-converters.js';
  29. let dispatcher, modelDoc, modelRoot, mapper, viewRoot, writer;
  30. beforeEach( () => {
  31. modelDoc = new ModelDocument();
  32. modelRoot = modelDoc.createRoot( 'root' );
  33. viewRoot = new ViewContainerElement( 'div' );
  34. mapper = new Mapper();
  35. mapper.bindElements( modelRoot, viewRoot );
  36. writer = new ViewWriter();
  37. dispatcher = new ModelConversionDispatcher( { mapper, writer } );
  38. } );
  39. function viewAttributesToString( item ) {
  40. let result = '';
  41. for ( let key of item.getAttributeKeys() ) {
  42. let value = item.getAttribute( key );
  43. if ( value ) {
  44. result += ' ' + key + '="' + value + '"';
  45. }
  46. }
  47. return result;
  48. }
  49. function viewToString( item ) {
  50. let result = '';
  51. if ( item instanceof ViewText ) {
  52. result = item.data;
  53. } else {
  54. // ViewElement or ViewDocumentFragment.
  55. for ( let child of item.getChildren() ) {
  56. result += viewToString( child );
  57. }
  58. if ( item instanceof ViewElement ) {
  59. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  60. }
  61. }
  62. return result;
  63. }
  64. describe( 'insertText', () => {
  65. it( 'should convert text insertion in model to view text', () => {
  66. modelRoot.appendChildren( 'foobar' );
  67. dispatcher.on( 'insert:$text', insertText() );
  68. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  69. expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
  70. } );
  71. } );
  72. describe( 'insertElement', () => {
  73. it( 'should convert element insertion in model to and map positions for future converting', () => {
  74. const modelElement = new ModelElement( 'paragraph', null, 'foobar' );
  75. const viewElement = new ViewContainerElement( 'p' );
  76. modelRoot.appendChildren( modelElement );
  77. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  78. dispatcher.on( 'insert:$text', insertText() );
  79. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  80. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  81. } );
  82. it( 'should take view element function generator as a parameter', () => {
  83. const elementGenerator = ( data, consumable ) => {
  84. if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
  85. return new ViewContainerElement( 'div' );
  86. } else {
  87. return new ViewContainerElement( 'p' );
  88. }
  89. };
  90. const niceP = new ModelElement( 'myParagraph', { nice: true }, 'foo' );
  91. const badP = new ModelElement( 'myParagraph', null, 'bar' );
  92. modelRoot.appendChildren( [ niceP, badP ] );
  93. dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
  94. dispatcher.on( 'insert:$text', insertText() );
  95. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  96. expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
  97. } );
  98. } );
  99. describe( 'setAttribute/removeAttribute', () => {
  100. it( 'should convert attribute insert/change/remove on a model node', () => {
  101. const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, 'foobar' );
  102. const viewElement = new ViewContainerElement( 'p' );
  103. modelRoot.appendChildren( modelElement );
  104. dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
  105. dispatcher.on( 'insert:$text', insertText() );
  106. dispatcher.on( 'addAttribute:class', setAttribute() );
  107. dispatcher.on( 'changeAttribute:class', setAttribute() );
  108. dispatcher.on( 'removeAttribute:class', removeAttribute() );
  109. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  110. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
  111. modelElement.setAttribute( 'class', 'bar' );
  112. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'foo', 'bar' );
  113. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
  114. modelElement.removeAttribute( 'class' );
  115. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'bar', null );
  116. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  117. } );
  118. it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
  119. const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, 'foobar' );
  120. const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
  121. const themeConverter = ( data ) => {
  122. const key = 'class';
  123. let value = data.attributeNewValue;
  124. if ( value && data.item instanceof ModelElement && data.item.getChildCount() > 0 ) {
  125. value += ' ' + 'fix-content';
  126. }
  127. return { key, value };
  128. };
  129. modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
  130. dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
  131. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  132. dispatcher.on( 'insert:$text', insertText() );
  133. dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
  134. dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
  135. dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
  136. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  137. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
  138. modelParagraph.setAttribute( 'theme', 'awesome' );
  139. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'nice', 'awesome' );
  140. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
  141. modelParagraph.removeAttribute( 'theme' );
  142. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'awesome', null );
  143. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
  144. } );
  145. } );
  146. describe( 'wrap/unwrap', () => {
  147. it( 'should convert insert/remove of attribute in model into wrapping element in a view', () => {
  148. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
  149. const viewP = new ViewContainerElement( 'p' );
  150. const viewB = new ViewAttributeElement( 'b' );
  151. modelRoot.appendChildren( modelElement );
  152. dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
  153. dispatcher.on( 'insert:$text', insertText() );
  154. dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
  155. dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
  156. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  157. expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
  158. for ( let value of ModelRange.createFromElement( modelElement ) ) {
  159. value.item.removeAttribute( 'bold' );
  160. }
  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. for ( let value of ModelRange.createFromElement( modelElement ) ) {
  180. value.item.removeAttribute( 'style' );
  181. }
  182. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'style', 'bold', null );
  183. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  184. } );
  185. } );
  186. describe( 'move', () => {
  187. it( 'should move items in view accordingly to changes in model', () => {
  188. const modelDivA = new ModelElement( 'div', null, [ 'foo', new ModelElement( 'image' ) ] );
  189. const modelDivB = new ModelElement( 'div', null, [ 'xxyy' ] );
  190. modelRoot.appendChildren( [ modelDivA, modelDivB ] );
  191. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  192. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  193. dispatcher.on( 'insert:$text', insertText() );
  194. dispatcher.on( 'move', move() );
  195. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  196. const removedNodes = modelDivA.removeChildren( 2, 2 );
  197. modelDivB.insertChildren( 2, removedNodes );
  198. dispatcher.convertMove(
  199. ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
  200. ModelRange.createFromParentsAndOffsets( modelDivB, 2, modelDivB, 4 )
  201. );
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><div>fo</div><div>xxo<img></img>yy</div></div>' );
  203. } );
  204. } );
  205. describe( 'remove', () => {
  206. it( 'should remove items from view accordingly to changes in model', () => {
  207. const modelDiv = new ModelElement( 'div', null, [ 'foo', new ModelElement( 'image' ) ] );
  208. modelRoot.appendChildren( modelDiv );
  209. dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
  210. dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  211. dispatcher.on( 'insert:$text', insertText() );
  212. dispatcher.on( 'remove', remove() );
  213. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  214. const removedNodes = modelDiv.removeChildren( 2, 2 );
  215. modelDoc.graveyard.insertChildren( 2, removedNodes );
  216. dispatcher.convertRemove(
  217. ModelPosition.createFromParentAndOffset( modelDiv, 2 ),
  218. ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 2 )
  219. );
  220. expect( viewToString( viewRoot ) ).to.equal( '<div><div>fo</div></div>' );
  221. } );
  222. } );