model-selection-to-view-converters.js 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelDocument from '../../src/model/document';
  6. import ModelElement from '../../src/model/element';
  7. import ModelRange from '../../src/model/range';
  8. import ModelPosition from '../../src/model/position';
  9. import ViewDocument from '../../src/view/document';
  10. import ViewContainerElement from '../../src/view/containerelement';
  11. import ViewAttributeElement from '../../src/view/attributeelement';
  12. import ViewUIElement from '../../src/view/uielement';
  13. import { mergeAttributes } from '../../src/view/writer';
  14. import Mapper from '../../src/conversion/mapper';
  15. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  16. import {
  17. convertRangeSelection,
  18. convertCollapsedSelection,
  19. convertSelectionAttribute,
  20. convertSelectionMarker,
  21. clearAttributes,
  22. clearFakeSelection
  23. } from '../../src/conversion/model-selection-to-view-converters';
  24. import {
  25. insertElement,
  26. insertText,
  27. wrapItem,
  28. convertTextsInsideMarker,
  29. convertElementsInsideMarker
  30. } from '../../src/conversion/model-to-view-converters';
  31. import { stringify as stringifyView } from '../../src/dev-utils/view';
  32. import { setData as setModelData } from '../../src/dev-utils/model';
  33. const highlightDescriptor = { class: 'marker', priority: 1 };
  34. describe( 'model-selection-to-view-converters', () => {
  35. let dispatcher, mapper, modelDoc, modelRoot, modelSelection, viewDoc, viewRoot, viewSelection;
  36. beforeEach( () => {
  37. modelDoc = new ModelDocument();
  38. modelRoot = modelDoc.createRoot();
  39. modelSelection = modelDoc.selection;
  40. modelDoc.schema.allow( { name: '$text', inside: '$root' } );
  41. viewDoc = new ViewDocument();
  42. viewRoot = viewDoc.createRoot( 'div' );
  43. viewSelection = viewDoc.selection;
  44. mapper = new Mapper();
  45. mapper.bindElements( modelRoot, viewRoot );
  46. dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } );
  47. dispatcher.on( 'insert:$text', insertText() );
  48. dispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  49. dispatcher.on( 'addMarker:marker', convertTextsInsideMarker( highlightDescriptor ) );
  50. dispatcher.on( 'addMarker:marker', convertElementsInsideMarker( highlightDescriptor ) );
  51. dispatcher.on( 'removeMarker:marker', convertTextsInsideMarker( highlightDescriptor ) );
  52. dispatcher.on( 'removeMarker:marker', convertElementsInsideMarker( highlightDescriptor ) );
  53. // Default selection converters.
  54. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  55. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  56. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  57. } );
  58. afterEach( () => {
  59. viewDoc.destroy();
  60. } );
  61. describe( 'default converters', () => {
  62. beforeEach( () => {
  63. // Selection converters for selection attributes.
  64. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'strong' ) ) );
  65. dispatcher.on( 'selectionAttribute:italic', convertSelectionAttribute( new ViewAttributeElement( 'em' ) ) );
  66. dispatcher.on( 'selectionMarker:marker', convertSelectionMarker( highlightDescriptor ) );
  67. } );
  68. describe( 'range selection', () => {
  69. it( 'in same container', () => {
  70. test(
  71. [ 1, 4 ],
  72. 'foobar',
  73. 'f{oob}ar'
  74. );
  75. } );
  76. it( 'in same container with unicode characters', () => {
  77. test(
  78. [ 2, 6 ],
  79. 'நிலைக்கு',
  80. 'நி{லைக்}கு'
  81. );
  82. } );
  83. it( 'in same container, over attribute', () => {
  84. test(
  85. [ 1, 5 ],
  86. 'fo<$text bold="true">ob</$text>ar',
  87. 'f{o<strong>ob</strong>a}r'
  88. );
  89. } );
  90. it( 'in same container, next to attribute', () => {
  91. test(
  92. [ 1, 2 ],
  93. 'fo<$text bold="true">ob</$text>ar',
  94. 'f{o}<strong>ob</strong>ar'
  95. );
  96. } );
  97. it( 'in same attribute', () => {
  98. test(
  99. [ 2, 4 ],
  100. 'f<$text bold="true">ooba</$text>r',
  101. 'f<strong>o{ob}a</strong>r'
  102. );
  103. } );
  104. it( 'in same attribute, selection same as attribute', () => {
  105. test(
  106. [ 2, 4 ],
  107. 'fo<$text bold="true">ob</$text>ar',
  108. 'fo{<strong>ob</strong>}ar'
  109. );
  110. } );
  111. it( 'starts in text node, ends in attribute #1', () => {
  112. test(
  113. [ 1, 3 ],
  114. 'fo<$text bold="true">ob</$text>ar',
  115. 'f{o<strong>o}b</strong>ar'
  116. );
  117. } );
  118. it( 'starts in text node, ends in attribute #2', () => {
  119. test(
  120. [ 1, 4 ],
  121. 'fo<$text bold="true">ob</$text>ar',
  122. 'f{o<strong>ob</strong>}ar'
  123. );
  124. } );
  125. it( 'starts in attribute, ends in text node', () => {
  126. test(
  127. [ 3, 5 ],
  128. 'fo<$text bold="true">ob</$text>ar',
  129. 'fo<strong>o{b</strong>a}r'
  130. );
  131. } );
  132. it( 'consumes consumable values properly', () => {
  133. // Add callback that will fire before default ones.
  134. // This should prevent default callback doing anything.
  135. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  136. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  137. }, { priority: 'high' } );
  138. // Similar test case as the first in this suite.
  139. test(
  140. [ 1, 4 ],
  141. 'foobar',
  142. 'foobar' // No selection in view.
  143. );
  144. } );
  145. it( 'should convert backward selection', () => {
  146. test(
  147. [ 1, 3, 'backward' ],
  148. 'foobar',
  149. 'f{oo}bar'
  150. );
  151. expect( viewSelection.focus.offset ).to.equal( 1 );
  152. } );
  153. } );
  154. describe( 'collapsed selection', () => {
  155. it( 'in container', () => {
  156. test(
  157. [ 1, 1 ],
  158. 'foobar',
  159. 'f{}oobar'
  160. );
  161. } );
  162. it( 'in attribute', () => {
  163. test(
  164. [ 3, 3 ],
  165. 'f<$text bold="true">ooba</$text>r',
  166. 'f<strong>oo{}ba</strong>r'
  167. );
  168. } );
  169. it( 'in container with extra attributes', () => {
  170. test(
  171. [ 1, 1 ],
  172. 'foobar',
  173. 'f<em>[]</em>oobar',
  174. { italic: true }
  175. );
  176. } );
  177. it( 'in attribute with extra attributes', () => {
  178. test(
  179. [ 3, 3 ],
  180. 'f<$text bold="true">ooba</$text>r',
  181. 'f<strong>oo</strong><em><strong>[]</strong></em><strong>ba</strong>r',
  182. { italic: true }
  183. );
  184. } );
  185. it( 'in attribute and marker', () => {
  186. setModelData( modelDoc, 'fo<$text bold="true">ob</$text>ar' );
  187. const marker = modelDoc.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  188. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  189. // Update selection attributes according to model.
  190. modelSelection.refreshAttributes();
  191. // Remove view children manually (without firing additional conversion).
  192. viewRoot.removeChildren( 0, viewRoot.childCount );
  193. // Convert model to view.
  194. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  195. dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() );
  196. const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) );
  197. dispatcher.convertSelection( modelSelection, markers );
  198. // Stringify view and check if it is same as expected.
  199. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  200. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  201. );
  202. } );
  203. it( 'in attribute and marker - no attribute', () => {
  204. setModelData( modelDoc, 'fo<$text bold="true">ob</$text>ar' );
  205. const marker = modelDoc.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  206. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  207. // Update selection attributes according to model.
  208. modelSelection.refreshAttributes();
  209. modelSelection.removeAttribute( 'bold' );
  210. // Remove view children manually (without firing additional conversion).
  211. viewRoot.removeChildren( 0, viewRoot.childCount );
  212. // Convert model to view.
  213. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  214. dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() );
  215. const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) );
  216. dispatcher.convertSelection( modelSelection, markers );
  217. // Stringify view and check if it is same as expected.
  218. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  219. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  220. } );
  221. it( 'in marker - using highlight descriptor creator', () => {
  222. dispatcher.on( 'selectionMarker:marker2', convertSelectionMarker(
  223. data => ( { 'class': data.markerName } )
  224. ) );
  225. setModelData( modelDoc, 'foobar' );
  226. const marker = modelDoc.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  227. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  228. // Remove view children manually (without firing additional conversion).
  229. viewRoot.removeChildren( 0, viewRoot.childCount );
  230. // Convert model to view.
  231. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  232. dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() );
  233. const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) );
  234. dispatcher.convertSelection( modelSelection, markers );
  235. // Stringify view and check if it is same as expected.
  236. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  237. .to.equal( '<div>foo<span class="marker2">[]</span>bar</div>' );
  238. } );
  239. it( 'should do nothing if creator return null', () => {
  240. dispatcher.on( 'selectionMarker:marker3', convertSelectionMarker( () => {
  241. } ) );
  242. setModelData( modelDoc, 'foobar' );
  243. const marker = modelDoc.markers.set( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  244. modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] );
  245. // Remove view children manually (without firing additional conversion).
  246. viewRoot.removeChildren( 0, viewRoot.childCount );
  247. // Convert model to view.
  248. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  249. dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() );
  250. const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) );
  251. dispatcher.convertSelection( modelSelection, markers );
  252. // Stringify view and check if it is same as expected.
  253. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  254. .to.equal( '<div>foo{}bar</div>' );
  255. } );
  256. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  257. it( 'selection with attribute before ui element - no non-ui children', () => {
  258. setModelData( modelDoc, '' );
  259. // Add two ui elements to view.
  260. viewRoot.appendChildren( [
  261. new ViewUIElement( 'span' ),
  262. new ViewUIElement( 'span' )
  263. ] );
  264. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 0 ] ) ) ] );
  265. modelSelection.setAttribute( 'bold', true );
  266. // Convert model to view.
  267. dispatcher.convertSelection( modelSelection, [] );
  268. // Stringify view and check if it is same as expected.
  269. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  270. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  271. } );
  272. // #1072.
  273. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  274. setModelData( modelDoc, 'x' );
  275. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  276. modelSelection.setAttribute( 'bold', true );
  277. // Convert model to view.
  278. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  279. // Add ui element to view.
  280. const uiElement = new ViewUIElement( 'span' );
  281. viewRoot.insertChildren( 1, uiElement );
  282. dispatcher.convertSelection( modelSelection, [] );
  283. // Stringify view and check if it is same as expected.
  284. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  285. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  286. } );
  287. // #1072.
  288. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  289. setModelData( modelDoc, '<$text bold="true">x</$text>y' );
  290. modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] );
  291. modelSelection.setAttribute( 'bold', true );
  292. // Convert model to view.
  293. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  294. // Add ui element to view.
  295. const uiElement = new ViewUIElement( 'span' );
  296. viewRoot.insertChildren( 1, uiElement );
  297. dispatcher.convertSelection( modelSelection, [] );
  298. // Stringify view and check if it is same as expected.
  299. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  300. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  301. } );
  302. it( 'consumes consumable values properly', () => {
  303. // Add callbacks that will fire before default ones.
  304. // This should prevent default callbacks doing anything.
  305. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  306. expect( consumable.consume( data.selection, 'selection' ) ).to.be.true;
  307. }, { priority: 'high' } );
  308. dispatcher.on( 'selectionAttribute:bold', ( evt, data, consumable ) => {
  309. expect( consumable.consume( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  310. }, { priority: 'high' } );
  311. // Similar test case as above.
  312. test(
  313. [ 3, 3 ],
  314. 'f<$text bold="true">ooba</$text>r',
  315. 'f<strong>ooba</strong>r' // No selection in view.
  316. );
  317. } );
  318. } );
  319. } );
  320. describe( 'clean-up', () => {
  321. describe( 'convertRangeSelection', () => {
  322. it( 'should remove all ranges before adding new range', () => {
  323. test(
  324. [ 0, 2 ],
  325. 'foobar',
  326. '{fo}obar'
  327. );
  328. test(
  329. [ 3, 5 ],
  330. 'foobar',
  331. 'foo{ba}r'
  332. );
  333. expect( viewSelection.rangeCount ).to.equal( 1 );
  334. } );
  335. } );
  336. describe( 'convertCollapsedSelection', () => {
  337. it( 'should remove all ranges before adding new range', () => {
  338. test(
  339. [ 2, 2 ],
  340. 'foobar',
  341. 'fo{}obar'
  342. );
  343. test(
  344. [ 3, 3 ],
  345. 'foobar',
  346. 'foo{}bar'
  347. );
  348. expect( viewSelection.rangeCount ).to.equal( 1 );
  349. } );
  350. } );
  351. describe( 'clearAttributes', () => {
  352. it( 'should remove all ranges before adding new range', () => {
  353. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'b' ) ) );
  354. dispatcher.on( 'addAttribute:style', wrapItem( new ViewAttributeElement( 'b' ) ) );
  355. test(
  356. [ 3, 3 ],
  357. 'foobar',
  358. 'foo<b>[]</b>bar',
  359. { bold: 'true' }
  360. );
  361. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  362. modelDoc.selection.setRanges( [ modelRange ] );
  363. dispatcher.convertSelection( modelDoc.selection, [] );
  364. expect( viewSelection.rangeCount ).to.equal( 1 );
  365. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  366. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  367. } );
  368. it( 'should do nothing if the attribute element had been already removed', () => {
  369. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( new ViewAttributeElement( 'b' ) ) );
  370. dispatcher.on( 'addAttribute:style', wrapItem( new ViewAttributeElement( 'b' ) ) );
  371. test(
  372. [ 3, 3 ],
  373. 'foobar',
  374. 'foo<b>[]</b>bar',
  375. { bold: 'true' }
  376. );
  377. // Remove <b></b> manually.
  378. mergeAttributes( viewSelection.getFirstPosition() );
  379. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  380. modelDoc.selection.setRanges( [ modelRange ] );
  381. dispatcher.convertSelection( modelDoc.selection, [] );
  382. expect( viewSelection.rangeCount ).to.equal( 1 );
  383. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  384. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  385. } );
  386. } );
  387. describe( 'clearFakeSelection', () => {
  388. it( 'should clear fake selection', () => {
  389. dispatcher.on( 'selection', clearFakeSelection() );
  390. viewSelection.setFake( true );
  391. dispatcher.convertSelection( modelSelection, [] );
  392. expect( viewSelection.isFake ).to.be.false;
  393. } );
  394. } );
  395. } );
  396. describe( 'using element creator for attributes conversion', () => {
  397. beforeEach( () => {
  398. function themeElementCreator( themeValue ) {
  399. if ( themeValue == 'important' ) {
  400. return new ViewAttributeElement( 'strong', { style: 'text-transform:uppercase;' } );
  401. } else if ( themeValue == 'gold' ) {
  402. return new ViewAttributeElement( 'span', { style: 'color:yellow;' } );
  403. }
  404. }
  405. dispatcher.on( 'selectionAttribute:theme', convertSelectionAttribute( themeElementCreator ) );
  406. dispatcher.on( 'addAttribute:theme', wrapItem( themeElementCreator ) );
  407. dispatcher.on( 'selectionAttribute:italic', convertSelectionAttribute( new ViewAttributeElement( 'em' ) ) );
  408. } );
  409. describe( 'range selection', () => {
  410. it( 'in same container, over attribute', () => {
  411. test(
  412. [ 1, 5 ],
  413. 'fo<$text theme="gold">ob</$text>ar',
  414. 'f{o<span style="color:yellow;">ob</span>a}r'
  415. );
  416. } );
  417. it( 'in same attribute', () => {
  418. test(
  419. [ 2, 4 ],
  420. 'f<$text theme="gold">ooba</$text>r',
  421. 'f<span style="color:yellow;">o{ob}a</span>r'
  422. );
  423. } );
  424. it( 'in same attribute, selection same as attribute', () => {
  425. test(
  426. [ 2, 4 ],
  427. 'fo<$text theme="important">ob</$text>ar',
  428. 'fo{<strong style="text-transform:uppercase;">ob</strong>}ar'
  429. );
  430. } );
  431. it( 'starts in attribute, ends in text node', () => {
  432. test(
  433. [ 3, 5 ],
  434. 'fo<$text theme="important">ob</$text>ar',
  435. 'fo<strong style="text-transform:uppercase;">o{b</strong>a}r'
  436. );
  437. } );
  438. } );
  439. describe( 'collapsed selection', () => {
  440. it( 'in attribute', () => {
  441. test(
  442. [ 3, 3 ],
  443. 'f<$text theme="gold">ooba</$text>r',
  444. 'f<span style="color:yellow;">oo{}ba</span>r'
  445. );
  446. } );
  447. it( 'in container with theme attribute', () => {
  448. test(
  449. [ 1, 1 ],
  450. 'foobar',
  451. 'f<strong style="text-transform:uppercase;">[]</strong>oobar',
  452. { theme: 'important' }
  453. );
  454. } );
  455. it( 'in theme attribute with extra attributes #1', () => {
  456. test(
  457. [ 3, 3 ],
  458. 'f<$text theme="gold">ooba</$text>r',
  459. 'f<span style="color:yellow;">oo</span>' +
  460. '<em><span style="color:yellow;">[]</span></em>' +
  461. '<span style="color:yellow;">ba</span>r',
  462. { italic: true }
  463. );
  464. } );
  465. it( 'in theme attribute with extra attributes #2', () => {
  466. // In contrary to test above, we don't have strong + span on the selection.
  467. // This is because strong and span are both created by the same attribute.
  468. // Since style="important" overwrites style="gold" on selection, we have only strong element.
  469. // In example above, selection has both style and italic attribute.
  470. test(
  471. [ 3, 3 ],
  472. 'f<$text theme="gold">ooba</$text>r',
  473. 'f<span style="color:yellow;">oo</span>' +
  474. '<strong style="text-transform:uppercase;">[]</strong>' +
  475. '<span style="color:yellow;">ba</span>r',
  476. { theme: 'important' }
  477. );
  478. } );
  479. it( 'convertSelectionAttribute should do nothing if creator return null', () => {
  480. dispatcher.on( 'selectionAttribute:bold', convertSelectionAttribute( () => {
  481. } ) );
  482. test(
  483. [ 3, 3 ],
  484. 'foobar',
  485. 'foo{}bar',
  486. { bold: 'true' }
  487. );
  488. } );
  489. } );
  490. } );
  491. describe( 'table cell selection converter', () => {
  492. beforeEach( () => {
  493. modelDoc.schema.registerItem( 'table' );
  494. modelDoc.schema.registerItem( 'tr' );
  495. modelDoc.schema.registerItem( 'td' );
  496. modelDoc.schema.allow( { name: 'table', inside: '$root' } );
  497. modelDoc.schema.allow( { name: 'tr', inside: 'table' } );
  498. modelDoc.schema.allow( { name: 'td', inside: 'tr' } );
  499. modelDoc.schema.allow( { name: '$text', inside: 'td' } );
  500. // "Universal" converter to convert table structure.
  501. const tableConverter = insertElement( data => new ViewContainerElement( data.item.name ) );
  502. dispatcher.on( 'insert:table', tableConverter );
  503. dispatcher.on( 'insert:tr', tableConverter );
  504. dispatcher.on( 'insert:td', tableConverter );
  505. // Special converter for table cells.
  506. dispatcher.on( 'selection', ( evt, data, consumable, conversionApi ) => {
  507. const selection = data.selection;
  508. if ( !consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  509. return;
  510. }
  511. for ( const range of selection.getRanges() ) {
  512. const node = range.start.nodeAfter;
  513. if ( node == range.end.nodeBefore && node instanceof ModelElement && node.name == 'td' ) {
  514. consumable.consume( selection, 'selection' );
  515. const viewNode = conversionApi.mapper.toViewElement( node );
  516. viewNode.addClass( 'selected' );
  517. }
  518. }
  519. } );
  520. } );
  521. it( 'should not be used to convert selection that is not on table cell', () => {
  522. test(
  523. [ 1, 5 ],
  524. 'f{o<$text bold="true">ob</$text>a}r',
  525. 'f{o<strong>ob</strong>a}r'
  526. );
  527. } );
  528. it( 'should add a class to the selected table cell', () => {
  529. test(
  530. // table tr#0 |td#0, table tr#0 td#0|
  531. [ [ 0, 0, 0 ], [ 0, 0, 1 ] ],
  532. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  533. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  534. );
  535. } );
  536. it( 'should not be used if selection contains more than just a table cell', () => {
  537. test(
  538. // table tr td#1, table tr#2
  539. [ [ 0, 0, 0, 1 ], [ 0, 0, 2 ] ],
  540. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  541. '<table><tr><td>f{oo</td><td>bar</td>]</tr></table>'
  542. );
  543. } );
  544. } );
  545. // Tests if the selection got correctly converted.
  546. // Because `setData` might use selection converters itself to set the selection, we can't use it
  547. // to set the selection (because then we would test converters using converters).
  548. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  549. // that are offsets or paths of selection positions in root element.
  550. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  551. // Parse passed `modelInput` string and set it as current model.
  552. setModelData( modelDoc, modelInput );
  553. // Manually set selection ranges using passed `selectionPaths`.
  554. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  555. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  556. const startPos = new ModelPosition( modelRoot, startPath );
  557. const endPos = new ModelPosition( modelRoot, endPath );
  558. const isBackward = selectionPaths[ 2 ] === 'backward';
  559. modelSelection.setRanges( [ new ModelRange( startPos, endPos ) ], isBackward );
  560. // Update selection attributes according to model.
  561. modelSelection.refreshAttributes();
  562. // And add or remove passed attributes.
  563. for ( const key in selectionAttributes ) {
  564. const value = selectionAttributes[ key ];
  565. if ( value ) {
  566. modelSelection.setAttribute( key, value );
  567. } else {
  568. modelSelection.removeAttribute( key );
  569. }
  570. }
  571. // Remove view children manually (without firing additional conversion).
  572. viewRoot.removeChildren( 0, viewRoot.childCount );
  573. // Convert model to view.
  574. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  575. dispatcher.convertSelection( modelSelection, [] );
  576. // Stringify view and check if it is same as expected.
  577. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  578. }
  579. } );