8
0

downcast-selection-converters.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  6. import View from '../../src/view/view';
  7. import ViewUIElement from '../../src/view/uielement';
  8. import Mapper from '../../src/conversion/mapper';
  9. import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
  10. import {
  11. convertRangeSelection,
  12. convertCollapsedSelection,
  13. clearAttributes,
  14. } from '../../src/conversion/downcast-selection-converters';
  15. import DowncastHelpers, { insertText } from '../../src/conversion/downcasthelpers';
  16. import createViewRoot from '../view/_utils/createroot';
  17. import { stringify as stringifyView } from '../../src/dev-utils/view';
  18. import { setData as setModelData } from '../../src/dev-utils/model';
  19. describe( 'downcast-selection-converters', () => {
  20. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
  21. beforeEach( () => {
  22. model = new Model();
  23. modelDoc = model.document;
  24. modelRoot = modelDoc.createRoot();
  25. docSelection = modelDoc.selection;
  26. model.schema.extend( '$text', { allowIn: '$root' } );
  27. view = new View();
  28. viewDoc = view.document;
  29. viewRoot = createViewRoot( viewDoc );
  30. viewSelection = viewDoc.selection;
  31. mapper = new Mapper();
  32. mapper.bindElements( modelRoot, viewRoot );
  33. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  34. dispatcher.on( 'insert:$text', insertText() );
  35. downcastHelpers = new DowncastHelpers( dispatcher );
  36. downcastHelpers.attributeToElement( { model: 'bold', view: 'strong' } );
  37. downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
  38. // Default selection converters.
  39. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  40. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  41. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  42. } );
  43. afterEach( () => {
  44. view.destroy();
  45. } );
  46. describe( 'default converters', () => {
  47. describe( 'range selection', () => {
  48. it( 'in same container', () => {
  49. test(
  50. [ 1, 4 ],
  51. 'foobar',
  52. 'f{oob}ar'
  53. );
  54. } );
  55. it( 'in same container with unicode characters', () => {
  56. test(
  57. [ 2, 6 ],
  58. 'நிலைக்கு',
  59. 'நி{லைக்}கு'
  60. );
  61. } );
  62. it( 'in same container, over attribute', () => {
  63. test(
  64. [ 1, 5 ],
  65. 'fo<$text bold="true">ob</$text>ar',
  66. 'f{o<strong>ob</strong>a}r'
  67. );
  68. } );
  69. it( 'in same container, next to attribute', () => {
  70. test(
  71. [ 1, 2 ],
  72. 'fo<$text bold="true">ob</$text>ar',
  73. 'f{o}<strong>ob</strong>ar'
  74. );
  75. } );
  76. it( 'in same attribute', () => {
  77. test(
  78. [ 2, 4 ],
  79. 'f<$text bold="true">ooba</$text>r',
  80. 'f<strong>o{ob}a</strong>r'
  81. );
  82. } );
  83. it( 'in same attribute, selection same as attribute', () => {
  84. test(
  85. [ 2, 4 ],
  86. 'fo<$text bold="true">ob</$text>ar',
  87. 'fo{<strong>ob</strong>}ar'
  88. );
  89. } );
  90. it( 'starts in text node, ends in attribute #1', () => {
  91. test(
  92. [ 1, 3 ],
  93. 'fo<$text bold="true">ob</$text>ar',
  94. 'f{o<strong>o}b</strong>ar'
  95. );
  96. } );
  97. it( 'starts in text node, ends in attribute #2', () => {
  98. test(
  99. [ 1, 4 ],
  100. 'fo<$text bold="true">ob</$text>ar',
  101. 'f{o<strong>ob</strong>}ar'
  102. );
  103. } );
  104. it( 'starts in attribute, ends in text node', () => {
  105. test(
  106. [ 3, 5 ],
  107. 'fo<$text bold="true">ob</$text>ar',
  108. 'fo<strong>o{b</strong>a}r'
  109. );
  110. } );
  111. it( 'consumes consumable values properly', () => {
  112. // Add callback that will fire before default ones.
  113. // This should prevent default callback doing anything.
  114. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  115. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  116. }, { priority: 'high' } );
  117. // Similar test case as the first in this suite.
  118. test(
  119. [ 1, 4 ],
  120. 'foobar',
  121. 'foobar' // No selection in view.
  122. );
  123. } );
  124. it( 'should convert backward selection', () => {
  125. test(
  126. [ 1, 3, 'backward' ],
  127. 'foobar',
  128. 'f{oo}bar'
  129. );
  130. expect( viewSelection.focus.offset ).to.equal( 1 );
  131. } );
  132. } );
  133. describe( 'collapsed selection', () => {
  134. let marker;
  135. it( 'in container', () => {
  136. test(
  137. [ 1, 1 ],
  138. 'foobar',
  139. 'f{}oobar'
  140. );
  141. } );
  142. it( 'in attribute', () => {
  143. test(
  144. [ 3, 3 ],
  145. 'f<$text bold="true">ooba</$text>r',
  146. 'f<strong>oo{}ba</strong>r'
  147. );
  148. } );
  149. it( 'in attribute and marker', () => {
  150. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  151. model.change( writer => {
  152. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  153. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  154. writer.setSelection( modelRoot, 3 );
  155. } );
  156. // Remove view children manually (without firing additional conversion).
  157. viewRoot._removeChildren( 0, viewRoot.childCount );
  158. // Convert model to view.
  159. view.change( writer => {
  160. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  161. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  162. dispatcher.convertSelection( docSelection, model.markers, writer );
  163. } );
  164. // Stringify view and check if it is same as expected.
  165. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  166. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  167. );
  168. } );
  169. it( 'in attribute and marker - no attribute', () => {
  170. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  171. model.change( writer => {
  172. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  173. marker = writer.addMarker( 'marker', { range, usingOperation: false } );
  174. writer.setSelection( modelRoot, 3 );
  175. writer.removeSelectionAttribute( 'bold' );
  176. } );
  177. // Remove view children manually (without firing additional conversion).
  178. viewRoot._removeChildren( 0, viewRoot.childCount );
  179. // Convert model to view.
  180. view.change( writer => {
  181. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  182. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  183. dispatcher.convertSelection( docSelection, model.markers, writer );
  184. } );
  185. // Stringify view and check if it is same as expected.
  186. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  187. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  188. } );
  189. it( 'in marker - using highlight descriptor creator', () => {
  190. downcastHelpers.markerToHighlight( {
  191. model: 'marker2',
  192. view: data => ( { classes: data.markerName } )
  193. } );
  194. setModelData( model, 'foobar' );
  195. model.change( writer => {
  196. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  197. marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
  198. writer.setSelection( modelRoot, 3 );
  199. } );
  200. // Remove view children manually (without firing additional conversion).
  201. viewRoot._removeChildren( 0, viewRoot.childCount );
  202. // Convert model to view.
  203. view.change( writer => {
  204. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  205. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  206. dispatcher.convertSelection( docSelection, model.markers, writer );
  207. } );
  208. // Stringify view and check if it is same as expected.
  209. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  210. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  211. } );
  212. it( 'should do nothing if creator return null', () => {
  213. downcastHelpers.markerToHighlight( {
  214. model: 'marker3',
  215. view: () => null
  216. } );
  217. setModelData( model, 'foobar' );
  218. model.change( writer => {
  219. const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
  220. marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
  221. writer.setSelection( modelRoot, 3 );
  222. } );
  223. // Remove view children manually (without firing additional conversion).
  224. viewRoot._removeChildren( 0, viewRoot.childCount );
  225. // Convert model to view.
  226. view.change( writer => {
  227. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  228. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  229. dispatcher.convertSelection( docSelection, model.markers, writer );
  230. } );
  231. // Stringify view and check if it is same as expected.
  232. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  233. .to.equal( '<div>foo{}bar</div>' );
  234. } );
  235. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  236. it( 'selection with attribute before ui element - no non-ui children', () => {
  237. setModelData( model, '' );
  238. // Add two ui elements to view.
  239. viewRoot._appendChild( [
  240. new ViewUIElement( 'span' ),
  241. new ViewUIElement( 'span' )
  242. ] );
  243. model.change( writer => {
  244. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
  245. writer.setSelectionAttribute( 'bold', true );
  246. } );
  247. // Convert model to view.
  248. view.change( writer => {
  249. dispatcher.convertSelection( docSelection, model.markers, writer );
  250. } );
  251. // Stringify view and check if it is same as expected.
  252. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  253. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  254. } );
  255. // #1072.
  256. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  257. setModelData( model, 'x' );
  258. model.change( writer => {
  259. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  260. writer.setSelectionAttribute( 'bold', true );
  261. } );
  262. // Convert model to view.
  263. view.change( writer => {
  264. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  265. // Add ui element to view.
  266. const uiElement = new ViewUIElement( 'span' );
  267. viewRoot._insertChild( 1, uiElement );
  268. dispatcher.convertSelection( docSelection, model.markers, writer );
  269. } );
  270. // Stringify view and check if it is same as expected.
  271. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  272. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  273. } );
  274. // #1072.
  275. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  276. setModelData( model, '<$text bold="true">x</$text>y' );
  277. model.change( writer => {
  278. writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
  279. writer.setSelectionAttribute( 'bold', true );
  280. } );
  281. // Convert model to view.
  282. view.change( writer => {
  283. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  284. // Add ui element to view.
  285. const uiElement = new ViewUIElement( 'span' );
  286. viewRoot._insertChild( 1, uiElement, writer );
  287. dispatcher.convertSelection( docSelection, model.markers, writer );
  288. } );
  289. // Stringify view and check if it is same as expected.
  290. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  291. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  292. } );
  293. it( 'consumes consumable values properly', () => {
  294. // Add callbacks that will fire before default ones.
  295. // This should prevent default callbacks doing anything.
  296. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  297. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  298. }, { priority: 'high' } );
  299. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  300. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  301. }, { priority: 'high' } );
  302. // Similar test case as above.
  303. test(
  304. [ 3, 3 ],
  305. 'f<$text bold="true">ooba</$text>r',
  306. 'foobar' // No selection in view and no attribute.
  307. );
  308. } );
  309. } );
  310. } );
  311. describe( 'clean-up', () => {
  312. describe( 'convertRangeSelection', () => {
  313. it( 'should remove all ranges before adding new range', () => {
  314. test(
  315. [ 0, 2 ],
  316. 'foobar',
  317. '{fo}obar'
  318. );
  319. test(
  320. [ 3, 5 ],
  321. 'foobar',
  322. 'foo{ba}r'
  323. );
  324. expect( viewSelection.rangeCount ).to.equal( 1 );
  325. } );
  326. } );
  327. describe( 'convertCollapsedSelection', () => {
  328. it( 'should remove all ranges before adding new range', () => {
  329. test(
  330. [ 2, 2 ],
  331. 'foobar',
  332. 'fo{}obar'
  333. );
  334. test(
  335. [ 3, 3 ],
  336. 'foobar',
  337. 'foo{}bar'
  338. );
  339. expect( viewSelection.rangeCount ).to.equal( 1 );
  340. } );
  341. } );
  342. describe( 'clearAttributes', () => {
  343. it( 'should remove all ranges before adding new range', () => {
  344. test(
  345. [ 3, 3 ],
  346. 'foobar',
  347. 'foo<strong>[]</strong>bar',
  348. { bold: 'true' }
  349. );
  350. view.change( writer => {
  351. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  352. model.change( writer => {
  353. writer.setSelection( modelRange );
  354. } );
  355. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  356. } );
  357. expect( viewSelection.rangeCount ).to.equal( 1 );
  358. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  359. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  360. } );
  361. it( 'should do nothing if the attribute element had been already removed', () => {
  362. test(
  363. [ 3, 3 ],
  364. 'foobar',
  365. 'foo<strong>[]</strong>bar',
  366. { bold: 'true' }
  367. );
  368. view.change( writer => {
  369. // Remove <strong></strong> manually.
  370. writer.mergeAttributes( viewSelection.getFirstPosition() );
  371. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  372. model.change( writer => {
  373. writer.setSelection( modelRange );
  374. } );
  375. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  376. } );
  377. expect( viewSelection.rangeCount ).to.equal( 1 );
  378. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  379. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  380. } );
  381. it( 'should clear fake selection', () => {
  382. const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
  383. view.change( writer => {
  384. writer.setSelection( modelRange, { fake: true } );
  385. dispatcher.convertSelection( docSelection, model.markers, writer );
  386. } );
  387. expect( viewSelection.isFake ).to.be.false;
  388. } );
  389. } );
  390. } );
  391. describe( 'table cell selection converter', () => {
  392. beforeEach( () => {
  393. model.schema.register( 'table', { isLimit: true } );
  394. model.schema.register( 'tr', { isLimit: true } );
  395. model.schema.register( 'td', { isLimit: true } );
  396. model.schema.extend( 'table', { allowIn: '$root' } );
  397. model.schema.extend( 'tr', { allowIn: 'table' } );
  398. model.schema.extend( 'td', { allowIn: 'tr' } );
  399. model.schema.extend( '$text', { allowIn: 'td' } );
  400. const downcastHelpers = new DowncastHelpers( dispatcher );
  401. // "Universal" converter to convert table structure.
  402. downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
  403. downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
  404. downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
  405. // Special converter for table cells.
  406. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  407. const selection = data.selection;
  408. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  409. return;
  410. }
  411. for ( const range of selection.getRanges() ) {
  412. const node = range.start.parent;
  413. if ( !!node && node.is( 'td' ) ) {
  414. conversionApi.consumable.consume( selection, 'selection' );
  415. const viewNode = conversionApi.mapper.toViewElement( node );
  416. conversionApi.writer.addClass( 'selected', viewNode );
  417. }
  418. }
  419. }, { priority: 'high' } );
  420. } );
  421. it( 'should not be used to convert selection that is not on table cell', () => {
  422. test(
  423. [ 1, 5 ],
  424. 'f{o<$text bold="true">ob</$text>a}r',
  425. 'f{o<strong>ob</strong>a}r'
  426. );
  427. } );
  428. it( 'should add a class to the selected table cell', () => {
  429. test(
  430. // table tr#0 td#0 [foo, table tr#0 td#0 bar]
  431. [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
  432. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  433. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  434. );
  435. } );
  436. it( 'should not be used if selection contains more than just a table cell', () => {
  437. test(
  438. // table tr td#1 f{oo bar, table tr#2 bar]
  439. [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
  440. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  441. '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
  442. );
  443. } );
  444. } );
  445. // Tests if the selection got correctly converted.
  446. // Because `setData` might use selection converters itself to set the selection, we can't use it
  447. // to set the selection (because then we would test converters using converters).
  448. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  449. // that are offsets or paths of selection positions in root element.
  450. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  451. // Parse passed `modelInput` string and set it as current model.
  452. setModelData( model, modelInput );
  453. // Manually set selection ranges using passed `selectionPaths`.
  454. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  455. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  456. const startPos = model.createPositionFromPath( modelRoot, startPath );
  457. const endPos = model.createPositionFromPath( modelRoot, endPath );
  458. const isBackward = selectionPaths[ 2 ] === 'backward';
  459. model.change( writer => {
  460. writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
  461. // And add or remove passed attributes.
  462. for ( const key in selectionAttributes ) {
  463. const value = selectionAttributes[ key ];
  464. if ( value ) {
  465. writer.setSelectionAttribute( key, value );
  466. } else {
  467. writer.removeSelectionAttribute( key );
  468. }
  469. }
  470. } );
  471. // Remove view children manually (without firing additional conversion).
  472. viewRoot._removeChildren( 0, viewRoot.childCount );
  473. // Convert model to view.
  474. view.change( writer => {
  475. dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
  476. dispatcher.convertSelection( docSelection, model.markers, writer );
  477. } );
  478. // Stringify view and check if it is same as expected.
  479. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  480. }
  481. } );