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

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