model-converter-builder.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  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. 'use strict';
  7. import BuildModelConverterFor from '/ckeditor5/engine/conversion/model-converter-builder.js';
  8. import ModelDocument from '/ckeditor5/engine/model/document.js';
  9. import ModelElement from '/ckeditor5/engine/model/element.js';
  10. import ModelText from '/ckeditor5/engine/model/text.js';
  11. import ModelRange from '/ckeditor5/engine/model/range.js';
  12. import ModelPosition from '/ckeditor5/engine/model/position.js';
  13. import ViewDocument from '/ckeditor5/engine/view/document.js';
  14. import ViewElement from '/ckeditor5/engine/view/element.js';
  15. import ViewContainerElement from '/ckeditor5/engine/view/containerelement.js';
  16. import ViewAttributeElement from '/ckeditor5/engine/view/attributeelement.js';
  17. import ViewText from '/ckeditor5/engine/view/text.js';
  18. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  19. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  20. import {
  21. insertText,
  22. move,
  23. remove
  24. } from '/ckeditor5/engine/conversion/model-to-view-converters.js';
  25. import {
  26. convertCollapsedSelection,
  27. clearAttributes
  28. } from '/ckeditor5/engine/conversion/model-selection-to-view-converters.js';
  29. function viewAttributesToString( item ) {
  30. let result = '';
  31. for ( let key of item.getAttributeKeys() ) {
  32. let value = item.getAttribute( key );
  33. if ( value ) {
  34. result += ' ' + key + '="' + value + '"';
  35. }
  36. }
  37. return result;
  38. }
  39. function viewToString( item ) {
  40. let result = '';
  41. if ( item instanceof ViewText ) {
  42. result = item.data;
  43. } else {
  44. // ViewElement or ViewDocumentFragment.
  45. for ( let child of item.getChildren() ) {
  46. result += viewToString( child );
  47. }
  48. if ( item instanceof ViewElement ) {
  49. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  50. }
  51. }
  52. return result;
  53. }
  54. describe( 'Model converter builder', () => {
  55. let dispatcher, mapper;
  56. let modelDoc, modelRoot;
  57. let viewDoc, viewRoot, viewSelection;
  58. beforeEach( () => {
  59. modelDoc = new ModelDocument();
  60. modelRoot = modelDoc.createRoot( 'root', 'root' );
  61. viewDoc = new ViewDocument();
  62. viewRoot = viewDoc.createRoot( 'div' );
  63. viewSelection = viewDoc.selection;
  64. mapper = new Mapper();
  65. mapper.bindElements( modelRoot, viewRoot );
  66. dispatcher = new ModelConversionDispatcher( { mapper, viewSelection } );
  67. dispatcher.on( 'insert:$text', insertText() );
  68. dispatcher.on( 'move', move() );
  69. dispatcher.on( 'remove', remove() );
  70. } );
  71. describe( 'model element to view element conversion', () => {
  72. it( 'using passed view element name', () => {
  73. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  74. let modelElement = new ModelElement( 'paragraph', null, 'foobar' );
  75. modelRoot.appendChildren( modelElement );
  76. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  77. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  78. } );
  79. it( 'using passed view element', () => {
  80. BuildModelConverterFor( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) );
  81. let modelElement = new ModelElement( 'image' );
  82. modelRoot.appendChildren( modelElement );
  83. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  84. expect( viewToString( viewRoot ) ).to.equal( '<div><img></img></div>' );
  85. } );
  86. it( 'using passed creator function', () => {
  87. BuildModelConverterFor( dispatcher )
  88. .fromElement( 'header' )
  89. .toElement( ( data ) => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) );
  90. let modelElement = new ModelElement( 'header', { level: 2 }, 'foobar' );
  91. modelRoot.appendChildren( modelElement );
  92. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  93. expect( viewToString( viewRoot ) ).to.equal( '<div><h2>foobar</h2></div>' );
  94. } );
  95. } );
  96. describe( 'model attribute to view element conversion', () => {
  97. beforeEach( () => {
  98. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  99. } );
  100. it( 'using passed view element name', () => {
  101. BuildModelConverterFor( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' );
  102. let modelElement = new ModelText( 'foo', { bold: true } );
  103. modelRoot.appendChildren( modelElement );
  104. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  105. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  106. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  107. value.item.removeAttribute( 'bold' );
  108. }
  109. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'bold', true, null );
  110. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  111. } );
  112. it( 'using passed view element', () => {
  113. BuildModelConverterFor( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) );
  114. let modelElement = new ModelText( 'foo', { bold: true } );
  115. modelRoot.appendChildren( modelElement );
  116. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  117. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  118. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  119. value.item.removeAttribute( 'bold' );
  120. }
  121. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'bold', true, null );
  122. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  123. } );
  124. it( 'using passed creator function', () => {
  125. BuildModelConverterFor( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  126. let modelElement = new ModelText( 'foo', { italic: 'em' } );
  127. modelRoot.appendChildren( modelElement );
  128. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  129. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  130. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  131. value.item.setAttribute( 'italic', 'i' );
  132. }
  133. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createFromElement( modelRoot ), 'italic', 'em', 'i' );
  134. expect( viewToString( viewRoot ) ).to.equal( '<div><i>foo</i></div>' );
  135. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  136. value.item.removeAttribute();
  137. }
  138. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'italic', 'i', null );
  139. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  140. } );
  141. it( 'selection conversion', () => {
  142. // This test requires collapsed range selection converter (breaking attributes) and clearing "artifacts".
  143. dispatcher.on( 'selection', clearAttributes() );
  144. dispatcher.on( 'selection', convertCollapsedSelection() );
  145. // Model converter builder should add selection converter.
  146. BuildModelConverterFor( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  147. modelRoot.appendChildren( new ModelText( 'foo', { italic: 'em' } ) );
  148. // Set collapsed selection after "f".
  149. const position = new ModelPosition( modelRoot, [ 1 ] );
  150. modelDoc.selection.setRanges( [ new ModelRange( position, position ) ] );
  151. modelDoc.selection._updateAttributes();
  152. // Convert stuff.
  153. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  154. dispatcher.convertSelection( modelDoc.selection );
  155. // Check if view structure is ok.
  156. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  157. // Check if view selection is collapsed after "f" letter.
  158. let ranges = Array.from( viewSelection.getRanges() );
  159. expect( ranges.length ).to.equal( 1 );
  160. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  161. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  162. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  163. // Change selection attribute, convert it.
  164. modelDoc.selection.setAttribute( 'italic', 'i' );
  165. dispatcher.convertSelection( modelDoc.selection );
  166. // Check if view structure has changed.
  167. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><i></i><em>oo</em></div>' );
  168. // Check if view selection is inside new <em> element.
  169. ranges = Array.from( viewSelection.getRanges() );
  170. expect( ranges.length ).to.equal( 1 );
  171. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  172. expect( ranges[ 0 ].start.parent.name ).to.equal( 'i' );
  173. expect( ranges[ 0 ].start.offset ).to.equal( 0 );
  174. // Some more tests checking how selection attributes changes are converted:
  175. modelDoc.selection.removeAttribute( 'italic' );
  176. dispatcher.convertSelection( modelDoc.selection );
  177. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><em>oo</em></div>' );
  178. ranges = Array.from( viewSelection.getRanges() );
  179. expect( ranges[ 0 ].start.parent.name ).to.equal( 'div' );
  180. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  181. modelDoc.selection.setAttribute( 'italic', 'em' );
  182. dispatcher.convertSelection( modelDoc.selection );
  183. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  184. ranges = Array.from( viewSelection.getRanges() );
  185. expect( ranges.length ).to.equal( 1 );
  186. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  187. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  188. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  189. } );
  190. } );
  191. describe( 'model attribute to view attribute conversion', () => {
  192. beforeEach( () => {
  193. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  194. } );
  195. it( 'using default 1-to-1 conversion', () => {
  196. BuildModelConverterFor( dispatcher ).fromAttribute( 'class' ).toAttribute();
  197. let modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, 'foobar' );
  198. modelRoot.appendChildren( modelElement );
  199. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  200. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="myClass">foobar</p></div>' );
  201. modelElement.setAttribute( 'class', 'newClass' );
  202. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'myClass', 'newClass' );
  203. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="newClass">foobar</p></div>' );
  204. modelElement.removeAttribute( 'class' );
  205. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'newClass', null );
  206. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  207. } );
  208. it( 'using passed attribute key', () => {
  209. BuildModelConverterFor( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' );
  210. let modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, 'foobar' );
  211. modelRoot.appendChildren( modelElement );
  212. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  213. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="abc">foobar</p></div>' );
  214. modelElement.setAttribute( 'theme', 'xyz' );
  215. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'abc', 'xyz' );
  216. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="xyz">foobar</p></div>' );
  217. modelElement.removeAttribute( 'theme' );
  218. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'xyz', null );
  219. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  220. } );
  221. it( 'using passed attribute key and value', () => {
  222. BuildModelConverterFor( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' );
  223. let modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, 'foobar' );
  224. modelRoot.appendChildren( modelElement );
  225. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  226. expect( viewToString( viewRoot ) ).to.equal( '<div><p style="background:yellow;">foobar</p></div>' );
  227. modelElement.removeAttribute( 'highlighted' );
  228. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'highlighted', true, null );
  229. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  230. } );
  231. it( 'using passed attribute creator function', () => {
  232. BuildModelConverterFor( dispatcher )
  233. .fromAttribute( 'theme' )
  234. .toAttribute( ( value ) => ( { key: 'class', value: value + '-theme' } ) );
  235. let modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, 'foobar' );
  236. modelRoot.appendChildren( modelElement );
  237. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  238. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice-theme">foobar</p></div>' );
  239. modelElement.setAttribute( 'theme', 'good' );
  240. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'nice', 'good' );
  241. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="good-theme">foobar</p></div>' );
  242. modelElement.removeAttribute( 'theme' );
  243. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'good', null );
  244. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  245. } );
  246. } );
  247. describe( 'withPriority', () => {
  248. it( 'should change default converters priority', () => {
  249. BuildModelConverterFor( dispatcher ).fromElement( 'custom' ).toElement( 'custom' );
  250. BuildModelConverterFor( dispatcher ).fromElement( 'custom' ).withPriority( 0 ).toElement( 'other' );
  251. let modelElement = new ModelElement( 'custom', null, 'foobar' );
  252. modelRoot.appendChildren( modelElement );
  253. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  254. expect( viewToString( viewRoot ) ).to.equal( '<div><other>foobar</other></div>' );
  255. } );
  256. } );
  257. it( 'should do nothing on model element to view attribute conversion', () => {
  258. BuildModelConverterFor( dispatcher ).fromElement( 'div' ).toElement( 'div' );
  259. // Should do nothing:
  260. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true );
  261. // If above would do something this one would not be fired:
  262. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  263. let modelElement = new ModelElement( 'div', null, new ModelElement( 'paragraph', null, 'foobar' ) );
  264. modelRoot.appendChildren( modelElement );
  265. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  266. expect( viewToString( viewRoot ) ).to.equal( '<div><div><p>foobar</p></div></div>' );
  267. } );
  268. } );