buildmodelconverter.js 23 KB

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