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