buildmodelconverter.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602
  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 Model from '../../src/model/model';
  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 ViewElement from '../../src/view/element';
  12. import ViewContainerElement from '../../src/view/containerelement';
  13. import ViewAttributeElement from '../../src/view/attributeelement';
  14. import ViewUIElement from '../../src/view/uielement';
  15. import ViewText from '../../src/view/text';
  16. import EditingController from '../../src/controller/editingcontroller';
  17. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  18. function viewAttributesToString( item ) {
  19. let result = '';
  20. for ( const key of item.getAttributeKeys() ) {
  21. const value = item.getAttribute( key );
  22. if ( value ) {
  23. result += ' ' + key + '="' + value + '"';
  24. }
  25. }
  26. return result;
  27. }
  28. function viewToString( item ) {
  29. let result = '';
  30. if ( item instanceof ViewText ) {
  31. result = item.data;
  32. } else {
  33. // ViewElement or ViewDocumentFragment.
  34. for ( const child of item.getChildren() ) {
  35. result += viewToString( child );
  36. }
  37. if ( item instanceof ViewElement ) {
  38. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  39. }
  40. }
  41. return result;
  42. }
  43. describe( 'Model converter builder', () => {
  44. let dispatcher, modelDoc, modelRoot, viewRoot, viewSelection, model, controller;
  45. beforeEach( () => {
  46. model = new Model();
  47. modelDoc = model.document;
  48. modelRoot = modelDoc.createRoot();
  49. controller = new EditingController( model );
  50. controller.createRoot( 'div' );
  51. dispatcher = controller.modelToView;
  52. viewRoot = controller.view.getRoot();
  53. viewSelection = controller.view.selection;
  54. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  55. } );
  56. describe( 'model element to view element conversion', () => {
  57. it( 'using passed view element name', () => {
  58. const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  59. model.change( writer => {
  60. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  61. } );
  62. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  63. } );
  64. it( 'using passed view element', () => {
  65. buildModelConverter().for( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) );
  66. const modelElement = new ModelElement( 'image' );
  67. model.change( writer => {
  68. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  69. } );
  70. expect( viewToString( viewRoot ) ).to.equal( '<div><img></img></div>' );
  71. } );
  72. it( 'using passed creator function', () => {
  73. buildModelConverter().for( dispatcher )
  74. .fromElement( 'header' )
  75. .toElement( data => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) );
  76. const modelElement = new ModelElement( 'header', { level: 2 }, new ModelText( 'foobar' ) );
  77. model.change( writer => {
  78. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  79. } );
  80. expect( viewToString( viewRoot ) ).to.equal( '<div><h2>foobar</h2></div>' );
  81. } );
  82. } );
  83. describe( 'model attribute to view element conversion', () => {
  84. it( 'using passed view element name', () => {
  85. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' );
  86. const modelElement = new ModelText( 'foo', { bold: true } );
  87. model.change( writer => {
  88. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  89. } );
  90. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  91. model.change( writer => {
  92. writer.removeAttribute( 'bold', modelElement );
  93. } );
  94. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  95. } );
  96. it( 'using passed view element', () => {
  97. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) );
  98. const modelElement = new ModelText( 'foo', { bold: true } );
  99. model.change( writer => {
  100. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  101. } );
  102. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  103. model.change( writer => {
  104. writer.removeAttribute( 'bold', modelElement );
  105. } );
  106. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  107. } );
  108. it( 'using passed creator function', () => {
  109. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( value => new ViewAttributeElement( value ) );
  110. const modelElement = new ModelText( 'foo', { italic: 'em' } );
  111. model.change( writer => {
  112. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  113. } );
  114. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  115. model.change( writer => {
  116. writer.setAttribute( 'italic', 'i', modelElement );
  117. } );
  118. expect( viewToString( viewRoot ) ).to.equal( '<div><i>foo</i></div>' );
  119. model.change( writer => {
  120. writer.removeAttribute( 'italic', modelElement );
  121. } );
  122. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  123. } );
  124. it( 'selection conversion', () => {
  125. // Model converter builder should add selection converter.
  126. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( value => new ViewAttributeElement( value ) );
  127. model.change( writer => {
  128. writer.insert( new ModelText( 'foo', { italic: 'em' } ), ModelPosition.createAt( modelRoot, 0 ) );
  129. // Set collapsed selection after "f".
  130. const position = new ModelPosition( modelRoot, [ 1 ] );
  131. modelDoc.selection.setRanges( [ new ModelRange( position, position ) ] );
  132. modelDoc.selection._updateAttributes();
  133. } );
  134. // Check if view structure is ok.
  135. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  136. // Check if view selection is collapsed after "f" letter.
  137. let ranges = Array.from( viewSelection.getRanges() );
  138. expect( ranges.length ).to.equal( 1 );
  139. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  140. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  141. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  142. // Change selection attribute, convert it.
  143. model.change( () => {
  144. modelDoc.selection.setAttribute( 'italic', 'i' );
  145. } );
  146. // Check if view structure has changed.
  147. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><i></i><em>oo</em></div>' );
  148. // Check if view selection is inside new <em> element.
  149. ranges = Array.from( viewSelection.getRanges() );
  150. expect( ranges.length ).to.equal( 1 );
  151. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  152. expect( ranges[ 0 ].start.parent.name ).to.equal( 'i' );
  153. expect( ranges[ 0 ].start.offset ).to.equal( 0 );
  154. // Some more tests checking how selection attributes changes are converted:
  155. model.change( () => {
  156. modelDoc.selection.removeAttribute( 'italic' );
  157. } );
  158. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><em>oo</em></div>' );
  159. ranges = Array.from( viewSelection.getRanges() );
  160. expect( ranges[ 0 ].start.parent.name ).to.equal( 'div' );
  161. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  162. model.change( () => {
  163. modelDoc.selection.setAttribute( 'italic', 'em' );
  164. } );
  165. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  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 ).to.be.instanceof( ViewText ); // "foo".
  170. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  171. } );
  172. } );
  173. describe( 'model attribute to view attribute conversion', () => {
  174. it( 'using default 1-to-1 conversion', () => {
  175. buildModelConverter().for( dispatcher ).fromAttribute( 'class' ).toAttribute();
  176. const modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, new ModelText( 'foobar' ) );
  177. model.change( writer => {
  178. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  179. } );
  180. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="myClass">foobar</p></div>' );
  181. model.change( writer => {
  182. writer.setAttribute( 'class', 'newClass', modelElement );
  183. } );
  184. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="newClass">foobar</p></div>' );
  185. model.change( writer => {
  186. writer.removeAttribute( 'class', modelElement );
  187. } );
  188. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  189. } );
  190. it( 'using passed attribute key', () => {
  191. buildModelConverter().for( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' );
  192. const modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, new ModelText( 'foobar' ) );
  193. model.change( writer => {
  194. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  195. } );
  196. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="abc">foobar</p></div>' );
  197. model.change( writer => {
  198. writer.setAttribute( 'theme', 'xyz', modelElement );
  199. } );
  200. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="xyz">foobar</p></div>' );
  201. model.change( writer => {
  202. writer.removeAttribute( 'theme', modelElement );
  203. } );
  204. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  205. } );
  206. it( 'using passed attribute key and value', () => {
  207. buildModelConverter().for( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' );
  208. const modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, new ModelText( 'foobar' ) );
  209. model.change( writer => {
  210. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  211. } );
  212. expect( viewToString( viewRoot ) ).to.equal( '<div><p style="background:yellow;">foobar</p></div>' );
  213. model.change( writer => {
  214. writer.removeAttribute( 'highlighted', modelElement );
  215. } );
  216. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  217. } );
  218. it( 'using passed attribute creator function', () => {
  219. buildModelConverter().for( dispatcher )
  220. .fromAttribute( 'theme' )
  221. .toAttribute( value => ( { key: 'class', value: value + '-theme' } ) );
  222. const modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  223. model.change( writer => {
  224. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  225. } );
  226. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice-theme">foobar</p></div>' );
  227. model.change( writer => {
  228. writer.setAttribute( 'theme', 'good', modelElement );
  229. } );
  230. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="good-theme">foobar</p></div>' );
  231. model.change( writer => {
  232. writer.removeAttribute( 'theme', modelElement );
  233. } );
  234. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  235. } );
  236. } );
  237. describe( 'model marker to highlight converter', () => {
  238. let modelText, modelElement;
  239. beforeEach( () => {
  240. modelText = new ModelText( 'foobar' );
  241. modelElement = new ModelElement( 'paragraph', null, [ modelText ] );
  242. model.change( writer => {
  243. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  244. } );
  245. } );
  246. it( 'using passed highlight descriptor object', () => {
  247. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toHighlight( {
  248. class: 'highlight',
  249. priority: 3,
  250. attributes: { title: 'highlight title' }
  251. } );
  252. model.change( () => {
  253. model.markers.set( 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  254. } );
  255. expect( viewToString( viewRoot ) ).to.equal(
  256. '<div>' +
  257. '<p>' +
  258. 'fo' +
  259. '<span class="highlight" title="highlight title">ob</span>' +
  260. 'ar' +
  261. '</p>' +
  262. '</div>' );
  263. expect( viewRoot.getChild( 0 ).getChild( 1 ).priority ).to.equal( 3 );
  264. model.change( () => {
  265. model.markers.remove( 'search' );
  266. } );
  267. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  268. } );
  269. it( 'using passed highlight descriptor object creator', () => {
  270. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toHighlight( () => ( {
  271. class: 'highlight',
  272. priority: 12,
  273. attributes: { title: 'highlight title' }
  274. } ) );
  275. model.change( () => {
  276. model.markers.set( 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  277. } );
  278. expect( viewToString( viewRoot ) ).to.equal(
  279. '<div>' +
  280. '<p>' +
  281. 'fo' +
  282. '<span class="highlight" title="highlight title">ob</span>' +
  283. 'ar' +
  284. '</p>' +
  285. '</div>' );
  286. expect( viewRoot.getChild( 0 ).getChild( 1 ).priority ).to.equal( 12 );
  287. model.change( () => {
  288. model.markers.remove( 'search' );
  289. } );
  290. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  291. } );
  292. it( 'should do nothing when marker range is collapsed', () => {
  293. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toHighlight( {
  294. class: 'highlight'
  295. } );
  296. model.change( () => {
  297. model.markers.set( 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 ) );
  298. } );
  299. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  300. model.change( () => {
  301. model.markers.remove( 'search' );
  302. } );
  303. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  304. } );
  305. it( 'should create converters with provided priority', () => {
  306. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toHighlight( { class: 'highlight' } );
  307. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).withPriority( 'high' ).toHighlight( { class: 'override' } );
  308. model.change( () => {
  309. model.markers.set( 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  310. } );
  311. expect( viewToString( viewRoot ) ).to.equal(
  312. '<div>' +
  313. '<p>' +
  314. 'fo' +
  315. '<span class="override">ob</span>' +
  316. 'ar' +
  317. '</p>' +
  318. '</div>' );
  319. } );
  320. it( 'should throw if trying to convert from attribute', () => {
  321. expect( () => {
  322. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toHighlight( { class: 'foo' } );
  323. } ).to.throw( CKEditorError, /^build-model-converter-non-marker-to-highlight/ );
  324. } );
  325. it( 'should throw if trying to convert from element', () => {
  326. expect( () => {
  327. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toHighlight( { class: 'foo' } );
  328. } ).to.throw( CKEditorError, /^build-model-converter-non-marker-to-highlight/ );
  329. } );
  330. } );
  331. describe( 'model marker to view element conversion', () => {
  332. let modelText, modelElement, range;
  333. beforeEach( () => {
  334. modelText = new ModelText( 'foobar' );
  335. modelElement = new ModelElement( 'paragraph', null, [ modelText ] );
  336. model.change( writer => {
  337. writer.insert( modelElement, ModelPosition.createAt( modelRoot, 0 ) );
  338. } );
  339. } );
  340. describe( 'collapsed range', () => {
  341. beforeEach( () => {
  342. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 );
  343. } );
  344. it( 'using passed view element name', () => {
  345. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'span' );
  346. model.change( () => {
  347. model.markers.set( 'search', range );
  348. } );
  349. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span></span>obar</p></div>' );
  350. model.change( () => {
  351. model.markers.remove( 'search' );
  352. } );
  353. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  354. } );
  355. it( 'using passed view element', () => {
  356. const viewElement = new ViewUIElement( 'span', { class: 'search' } );
  357. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( viewElement );
  358. model.change( () => {
  359. model.markers.set( 'search', range );
  360. } );
  361. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search"></span>obar</p></div>' );
  362. model.change( () => {
  363. model.markers.remove( 'search' );
  364. } );
  365. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  366. } );
  367. it( 'using passed creator function', () => {
  368. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( data => {
  369. const className = 'search search-color-' + data.markerName.split( ':' )[ 1 ];
  370. return new ViewUIElement( 'span', { class: className } );
  371. } );
  372. model.change( () => {
  373. model.markers.set( 'search:red', range );
  374. } );
  375. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search search-color-red"></span>obar</p></div>' );
  376. model.change( () => {
  377. model.markers.remove( 'search:red' );
  378. } );
  379. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  380. } );
  381. } );
  382. describe( 'non-collapsed range', () => {
  383. beforeEach( () => {
  384. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 );
  385. } );
  386. it( 'using passed view element name', () => {
  387. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'span' );
  388. model.change( () => {
  389. model.markers.set( 'search', range );
  390. } );
  391. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span></span>ob<span></span>ar</p></div>' );
  392. model.change( () => {
  393. model.markers.remove( 'search' );
  394. } );
  395. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  396. } );
  397. it( 'using passed view element', () => {
  398. const viewElement = new ViewUIElement( 'span', { class: 'search' } );
  399. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( viewElement );
  400. model.change( () => {
  401. model.markers.set( 'search', range );
  402. } );
  403. expect( viewToString( viewRoot ) ).to.equal(
  404. '<div><p>fo<span class="search"></span>ob<span class="search"></span>ar</p></div>'
  405. );
  406. model.change( () => {
  407. model.markers.remove( 'search' );
  408. } );
  409. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  410. } );
  411. it( 'using passed creator function', () => {
  412. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( data => {
  413. const className = 'search search-color-' + data.markerName.split( ':' )[ 1 ];
  414. return new ViewUIElement( 'span', { class: className } );
  415. } );
  416. model.change( () => {
  417. model.markers.set( 'search:red', range );
  418. } );
  419. expect( viewToString( viewRoot ) ).to.equal(
  420. '<div><p>fo<span class="search search-color-red"></span>ob<span class="search search-color-red"></span>ar</p></div>'
  421. );
  422. model.change( () => {
  423. model.markers.remove( 'search:red' );
  424. } );
  425. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  426. } );
  427. } );
  428. it( 'should overwrite default priority', () => {
  429. range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 );
  430. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'normal' );
  431. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).withPriority( 'high' ).toElement( 'high' );
  432. model.change( () => {
  433. model.markers.set( 'search', range );
  434. } );
  435. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<high></high>obar</p></div>' );
  436. } );
  437. it( 'should throw when trying to build model element to view attribute converter', () => {
  438. expect( () => {
  439. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true );
  440. } ).to.throw( CKEditorError, /^build-model-converter-non-attribute-to-attribute/ );
  441. } );
  442. } );
  443. } );