buildmodelconverter.js 23 KB

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