buildmodelconverter.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import buildModelConverter from '../../src/conversion/buildmodelconverter';
  6. import ModelDocument from '../../src/model/document';
  7. import ModelElement from '../../src/model/element';
  8. import ModelText from '../../src/model/text';
  9. import ModelRange from '../../src/model/range';
  10. import ModelPosition from '../../src/model/position';
  11. import modelWriter from '../../src/model/writer';
  12. import ViewDocument from '../../src/view/document';
  13. import ViewElement from '../../src/view/element';
  14. import ViewContainerElement from '../../src/view/containerelement';
  15. import ViewAttributeElement from '../../src/view/attributeelement';
  16. import ViewUIElement from '../../src/view/uielement';
  17. import ViewText from '../../src/view/text';
  18. import Mapper from '../../src/conversion/mapper';
  19. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  20. import {
  21. insertText,
  22. move,
  23. remove
  24. } from '../../src/conversion/model-to-view-converters';
  25. import {
  26. convertCollapsedSelection,
  27. clearAttributes
  28. } from '../../src/conversion/model-selection-to-view-converters';
  29. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  30. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  31. function viewAttributesToString( item ) {
  32. let result = '';
  33. for ( let key of item.getAttributeKeys() ) {
  34. let value = item.getAttribute( key );
  35. if ( value ) {
  36. result += ' ' + key + '="' + value + '"';
  37. }
  38. }
  39. return result;
  40. }
  41. function viewToString( item ) {
  42. let result = '';
  43. if ( item instanceof ViewText ) {
  44. result = item.data;
  45. } else {
  46. // ViewElement or ViewDocumentFragment.
  47. for ( let child of item.getChildren() ) {
  48. result += viewToString( child );
  49. }
  50. if ( item instanceof ViewElement ) {
  51. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  52. }
  53. }
  54. return result;
  55. }
  56. describe( 'Model converter builder', () => {
  57. let dispatcher, mapper;
  58. let modelDoc, modelRoot;
  59. let viewDoc, viewRoot, viewSelection;
  60. beforeEach( () => {
  61. modelDoc = new ModelDocument();
  62. modelRoot = modelDoc.createRoot( 'root', 'root' );
  63. viewDoc = new ViewDocument();
  64. viewRoot = viewDoc.createRoot( 'div' );
  65. viewSelection = viewDoc.selection;
  66. mapper = new Mapper();
  67. mapper.bindElements( modelRoot, viewRoot );
  68. dispatcher = new ModelConversionDispatcher( { mapper, viewSelection } );
  69. dispatcher.on( 'insert:$text', insertText() );
  70. dispatcher.on( 'move', move() );
  71. dispatcher.on( 'remove', remove() );
  72. } );
  73. afterEach( () => {
  74. viewDoc.destroy();
  75. } );
  76. describe( 'model element to view element conversion', () => {
  77. it( 'using passed view element name', () => {
  78. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  79. let modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  80. modelRoot.appendChildren( modelElement );
  81. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  82. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  83. } );
  84. it( 'using passed view element', () => {
  85. buildModelConverter().for( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) );
  86. let modelElement = new ModelElement( 'image' );
  87. modelRoot.appendChildren( modelElement );
  88. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  89. expect( viewToString( viewRoot ) ).to.equal( '<div><img></img></div>' );
  90. } );
  91. it( 'using passed creator function', () => {
  92. buildModelConverter().for( dispatcher )
  93. .fromElement( 'header' )
  94. .toElement( ( data ) => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) );
  95. let modelElement = new ModelElement( 'header', { level: 2 }, new ModelText( 'foobar' ) );
  96. modelRoot.appendChildren( modelElement );
  97. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  98. expect( viewToString( viewRoot ) ).to.equal( '<div><h2>foobar</h2></div>' );
  99. } );
  100. } );
  101. describe( 'model attribute to view element conversion', () => {
  102. beforeEach( () => {
  103. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  104. } );
  105. it( 'using passed view element name', () => {
  106. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' );
  107. let modelElement = new ModelText( 'foo', { bold: true } );
  108. modelRoot.appendChildren( modelElement );
  109. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  110. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  111. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' );
  112. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  113. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  114. } );
  115. it( 'using passed view element', () => {
  116. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) );
  117. let modelElement = new ModelText( 'foo', { bold: true } );
  118. modelRoot.appendChildren( modelElement );
  119. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  120. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  121. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' );
  122. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  123. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  124. } );
  125. it( 'using passed creator function', () => {
  126. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  127. let modelElement = new ModelText( 'foo', { italic: 'em' } );
  128. modelRoot.appendChildren( modelElement );
  129. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  130. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  131. modelWriter.setAttribute( ModelRange.createIn( modelRoot ), 'italic', 'i' );
  132. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'em', 'i' );
  133. expect( viewToString( viewRoot ) ).to.equal( '<div><i>foo</i></div>' );
  134. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'italic' );
  135. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'i', null );
  136. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  137. } );
  138. it( 'selection conversion', () => {
  139. // This test requires collapsed range selection converter (breaking attributes) and clearing "artifacts".
  140. dispatcher.on( 'selection', clearAttributes() );
  141. dispatcher.on( 'selection', convertCollapsedSelection() );
  142. // Model converter builder should add selection converter.
  143. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  144. modelRoot.appendChildren( new ModelText( 'foo', { italic: 'em' } ) );
  145. // Set collapsed selection after "f".
  146. const position = new ModelPosition( modelRoot, [ 1 ] );
  147. modelDoc.selection.setRanges( [ new ModelRange( position, position ) ] );
  148. modelDoc.selection._updateAttributes();
  149. // Convert stuff.
  150. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  151. dispatcher.convertSelection( modelDoc.selection, [] );
  152. // Check if view structure is ok.
  153. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  154. // Check if view selection is collapsed after "f" letter.
  155. let ranges = Array.from( viewSelection.getRanges() );
  156. expect( ranges.length ).to.equal( 1 );
  157. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  158. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  159. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  160. // Change selection attribute, convert it.
  161. modelDoc.selection.setAttribute( 'italic', 'i' );
  162. dispatcher.convertSelection( modelDoc.selection, [] );
  163. // Check if view structure has changed.
  164. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><i></i><em>oo</em></div>' );
  165. // Check if view selection is inside new <em> element.
  166. ranges = Array.from( viewSelection.getRanges() );
  167. expect( ranges.length ).to.equal( 1 );
  168. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  169. expect( ranges[ 0 ].start.parent.name ).to.equal( 'i' );
  170. expect( ranges[ 0 ].start.offset ).to.equal( 0 );
  171. // Some more tests checking how selection attributes changes are converted:
  172. modelDoc.selection.removeAttribute( 'italic' );
  173. dispatcher.convertSelection( modelDoc.selection, [] );
  174. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><em>oo</em></div>' );
  175. ranges = Array.from( viewSelection.getRanges() );
  176. expect( ranges[ 0 ].start.parent.name ).to.equal( 'div' );
  177. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  178. modelDoc.selection.setAttribute( 'italic', 'em' );
  179. dispatcher.convertSelection( modelDoc.selection, [] );
  180. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  181. ranges = Array.from( viewSelection.getRanges() );
  182. expect( ranges.length ).to.equal( 1 );
  183. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  184. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  185. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  186. } );
  187. } );
  188. describe( 'model attribute to view attribute conversion', () => {
  189. beforeEach( () => {
  190. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  191. } );
  192. it( 'using default 1-to-1 conversion', () => {
  193. buildModelConverter().for( dispatcher ).fromAttribute( 'class' ).toAttribute();
  194. let modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, new ModelText( 'foobar' ) );
  195. modelRoot.appendChildren( modelElement );
  196. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  197. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="myClass">foobar</p></div>' );
  198. modelElement.setAttribute( 'class', 'newClass' );
  199. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'myClass', 'newClass' );
  200. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="newClass">foobar</p></div>' );
  201. modelElement.removeAttribute( 'class' );
  202. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'newClass', null );
  203. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  204. } );
  205. it( 'using passed attribute key', () => {
  206. buildModelConverter().for( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' );
  207. let modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, new ModelText( 'foobar' ) );
  208. modelRoot.appendChildren( modelElement );
  209. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  210. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="abc">foobar</p></div>' );
  211. modelElement.setAttribute( 'theme', 'xyz' );
  212. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'abc', 'xyz' );
  213. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="xyz">foobar</p></div>' );
  214. modelElement.removeAttribute( 'theme' );
  215. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'xyz', null );
  216. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  217. } );
  218. it( 'using passed attribute key and value', () => {
  219. buildModelConverter().for( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' );
  220. let modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, new ModelText( 'foobar' ) );
  221. modelRoot.appendChildren( modelElement );
  222. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  223. expect( viewToString( viewRoot ) ).to.equal( '<div><p style="background:yellow;">foobar</p></div>' );
  224. modelElement.removeAttribute( 'highlighted' );
  225. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'highlighted', true, null );
  226. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  227. } );
  228. it( 'using passed attribute creator function', () => {
  229. buildModelConverter().for( dispatcher )
  230. .fromAttribute( 'theme' )
  231. .toAttribute( ( value ) => ( { key: 'class', value: value + '-theme' } ) );
  232. let modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  233. modelRoot.appendChildren( modelElement );
  234. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  235. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice-theme">foobar</p></div>' );
  236. modelElement.setAttribute( 'theme', 'good' );
  237. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'nice', 'good' );
  238. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="good-theme">foobar</p></div>' );
  239. modelElement.removeAttribute( 'theme' );
  240. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'good', null );
  241. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  242. } );
  243. } );
  244. describe( 'model marker to view element conversion', () => {
  245. let modelText, modelElement;
  246. beforeEach( () => {
  247. modelText = new ModelText( 'foobar' );
  248. modelElement = new ModelElement( 'paragraph', null, [ modelText ] );
  249. modelRoot.appendChildren( modelElement );
  250. let viewText = new ViewText( 'foobar' );
  251. let viewElement = new ViewContainerElement( 'p', null, [ viewText ] );
  252. viewRoot.appendChildren( viewElement );
  253. mapper.bindElements( modelElement, viewElement );
  254. } );
  255. it( 'using passed view element name', () => {
  256. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'strong' );
  257. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  258. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<strong>ob</strong>ar</p></div>' );
  259. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  260. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  261. } );
  262. it( 'using passed view element', () => {
  263. const viewElement = new ViewAttributeElement( 'span', { class: 'search' } );
  264. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( viewElement );
  265. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  266. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search">ob</span>ar</p></div>' );
  267. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  268. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  269. } );
  270. it( 'using passed creator function', () => {
  271. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( ( data ) => {
  272. const className = 'search search-color-' + data.name.split( ':' )[ 1 ];
  273. return new ViewAttributeElement( 'span', { class: className } );
  274. } );
  275. dispatcher.convertMarker( 'addMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  276. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search search-color-red">ob</span>ar</p></div>' );
  277. dispatcher.convertMarker( 'removeMarker', 'search:blue', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  278. // Nothing should change as we remove a marker with different name, which should generate different view attribute element.
  279. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search search-color-red">ob</span>ar</p></div>' );
  280. dispatcher.convertMarker( 'removeMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  281. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  282. } );
  283. } );
  284. describe( 'model collapsed marker to view element conversion', () => {
  285. let modelText, modelElement;
  286. beforeEach( () => {
  287. modelText = new ModelText( 'foobar' );
  288. modelElement = new ModelElement( 'paragraph', null, [ modelText ] );
  289. modelRoot.appendChildren( modelElement );
  290. let viewText = new ViewText( 'foobar' );
  291. let viewElement = new ViewContainerElement( 'p', null, [ viewText ] );
  292. viewRoot.appendChildren( viewElement );
  293. mapper.bindElements( modelElement, viewElement );
  294. } );
  295. it( 'using passed view element name', () => {
  296. buildModelConverter().for( dispatcher ).fromCollapsedMarker( 'search' ).toElement( 'span' );
  297. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  298. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span></span>bar</p></div>' );
  299. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  300. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  301. } );
  302. it( 'using passed view element', () => {
  303. const viewElement = new ViewUIElement( 'span', { class: 'search' } );
  304. buildModelConverter().for( dispatcher ).fromCollapsedMarker( 'search' ).toElement( viewElement );
  305. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  306. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="search"></span>bar</p></div>' );
  307. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  308. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  309. } );
  310. it( 'using passed creator function', () => {
  311. buildModelConverter().for( dispatcher ).fromCollapsedMarker( 'search' ).toElement( ( data ) => {
  312. const className = 'search search-color-' + data.name.split( ':' )[ 1 ];
  313. return new ViewUIElement( 'span', { class: className } );
  314. } );
  315. dispatcher.convertMarker( 'addMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  316. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foo<span class="search search-color-red"></span>bar</p></div>' );
  317. dispatcher.convertMarker( 'removeMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ) );
  318. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  319. } );
  320. } );
  321. describe( 'withPriority', () => {
  322. it( 'should change default converters priority', () => {
  323. buildModelConverter().for( dispatcher ).fromElement( 'custom' ).toElement( 'custom' );
  324. buildModelConverter().for( dispatcher ).fromElement( 'custom' ).withPriority( 'high' ).toElement( 'other' );
  325. let modelElement = new ModelElement( 'custom', null, new ModelText( 'foobar' ) );
  326. modelRoot.appendChildren( modelElement );
  327. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  328. expect( viewToString( viewRoot ) ).to.equal( '<div><other>foobar</other></div>' );
  329. } );
  330. } );
  331. it( 'should throw when trying to build model element to view attribute converter', () => {
  332. expect( () => {
  333. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true );
  334. } ).to.throw( CKEditorError, /^build-model-converter-non-attribute-to-attribute/ );
  335. } );
  336. } );