upcasthelpers.js 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import UpcastDispatcher from '../../src/conversion/upcastdispatcher';
  6. import ViewContainerElement from '../../src/view/containerelement';
  7. import ViewDocumentFragment from '../../src/view/documentfragment';
  8. import ViewText from '../../src/view/text';
  9. import ViewUIElement from '../../src/view/uielement';
  10. import ViewAttributeElement from '../../src/view/attributeelement';
  11. import Model from '../../src/model/model';
  12. import ModelDocumentFragment from '../../src/model/documentfragment';
  13. import ModelElement from '../../src/model/element';
  14. import ModelText from '../../src/model/text';
  15. import ModelRange from '../../src/model/range';
  16. import ModelPosition from '../../src/model/position';
  17. import UpcastHelpers, { convertToModelFragment, convertText, convertSelectionChange } from '../../src/conversion/upcasthelpers';
  18. import { getData as modelGetData, setData as modelSetData, stringify } from '../../src/dev-utils/model';
  19. import View from '../../src/view/view';
  20. import createViewRoot from '../view/_utils/createroot';
  21. import { setData as viewSetData } from '../../src/dev-utils/view';
  22. import Mapper from '../../src/conversion/mapper';
  23. import ViewSelection from '../../src/view/selection';
  24. import ViewRange from '../../src/view/range';
  25. describe( 'UpcastHelpers', () => {
  26. let upcastDispatcher, model, schema, upcastHelpers;
  27. beforeEach( () => {
  28. model = new Model();
  29. schema = model.schema;
  30. schema.extend( '$text', {
  31. allowIn: '$root',
  32. allowAttributes: [ 'bold', 'attribA', 'attribB' ]
  33. } );
  34. schema.register( 'paragraph', {
  35. inheritAllFrom: '$block'
  36. } );
  37. upcastDispatcher = new UpcastDispatcher( { schema } );
  38. upcastDispatcher.on( 'text', convertText() );
  39. upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } );
  40. upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } );
  41. upcastHelpers = new UpcastHelpers( [ upcastDispatcher ] );
  42. } );
  43. describe( '.elementToElement()', () => {
  44. it( 'should be chainable', () => {
  45. expect( upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } ) ).to.equal( upcastHelpers );
  46. } );
  47. it( 'config.view is a string', () => {
  48. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  49. expectResult( new ViewContainerElement( 'p' ), '<paragraph></paragraph>' );
  50. } );
  51. it( 'can be overwritten using converterPriority', () => {
  52. schema.register( 'p', {
  53. inheritAllFrom: '$block'
  54. } );
  55. upcastHelpers.elementToElement( { view: 'p', model: 'p' } );
  56. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph', converterPriority: 'high' } );
  57. expectResult( new ViewContainerElement( 'p' ), '<paragraph></paragraph>' );
  58. } );
  59. it( 'config.view is an object', () => {
  60. schema.register( 'fancyParagraph', {
  61. inheritAllFrom: '$block'
  62. } );
  63. upcastHelpers.elementToElement( {
  64. view: {
  65. name: 'p',
  66. classes: 'fancy'
  67. },
  68. model: 'fancyParagraph'
  69. } );
  70. expectResult( new ViewContainerElement( 'p', { class: 'fancy' } ), '<fancyParagraph></fancyParagraph>' );
  71. expectResult( new ViewContainerElement( 'p' ), '' );
  72. } );
  73. it( 'config.model is a function', () => {
  74. schema.register( 'heading', {
  75. inheritAllFrom: '$block',
  76. allowAttributes: [ 'level' ]
  77. } );
  78. upcastHelpers.elementToElement( {
  79. view: {
  80. name: 'p',
  81. classes: 'heading'
  82. },
  83. model: ( viewElement, modelWriter ) => {
  84. return modelWriter.createElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } );
  85. }
  86. } );
  87. expectResult( new ViewContainerElement( 'p', { class: 'heading', 'data-level': 2 } ), '<heading level="2"></heading>' );
  88. expectResult( new ViewContainerElement( 'p', { 'data-level': 2 } ), '' );
  89. } );
  90. it( 'config.view is not set - should fire conversion for every element', () => {
  91. upcastHelpers.elementToElement( {
  92. model: 'paragraph'
  93. } );
  94. expectResult( new ViewContainerElement( 'p' ), '<paragraph></paragraph>' );
  95. expectResult( new ViewContainerElement( 'foo' ), '<paragraph></paragraph>' );
  96. } );
  97. it( 'should fire conversion of the element children', () => {
  98. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  99. expectResult( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), '<paragraph>foo</paragraph>' );
  100. } );
  101. it( 'should not insert a model element if it is not allowed by schema', () => {
  102. upcastHelpers.elementToElement( { view: 'h2', model: 'heading' } );
  103. expectResult( new ViewContainerElement( 'h2' ), '' );
  104. } );
  105. it( 'should auto-break elements', () => {
  106. schema.register( 'heading', {
  107. inheritAllFrom: '$block'
  108. } );
  109. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  110. upcastHelpers.elementToElement( { view: 'h2', model: 'heading' } );
  111. expectResult(
  112. new ViewContainerElement( 'p', null, [
  113. new ViewText( 'Foo' ),
  114. new ViewContainerElement( 'h2', null, new ViewText( 'Xyz' ) ),
  115. new ViewText( 'Bar' )
  116. ] ),
  117. '<paragraph>Foo</paragraph><heading>Xyz</heading><paragraph>Bar</paragraph>'
  118. );
  119. } );
  120. it( 'should not do anything if returned model element is null', () => {
  121. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  122. upcastHelpers.elementToElement( { view: 'p', model: () => null, converterPriority: 'high' } );
  123. expectResult( new ViewContainerElement( 'p' ), '<paragraph></paragraph>' );
  124. } );
  125. } );
  126. describe( '.elementToAttribute()', () => {
  127. it( 'should be chainable', () => {
  128. expect( upcastHelpers.elementToAttribute( { view: 'strong', model: 'bold' } ) ).to.equal( upcastHelpers );
  129. } );
  130. it( 'config.view is string', () => {
  131. upcastHelpers.elementToAttribute( { view: 'strong', model: 'bold' } );
  132. expectResult(
  133. new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ),
  134. '<$text bold="true">foo</$text>'
  135. );
  136. } );
  137. it( 'can be overwritten using converterPriority', () => {
  138. upcastHelpers.elementToAttribute( { view: 'strong', model: 'strong' } );
  139. upcastHelpers.elementToAttribute( { view: 'strong', model: 'bold', converterPriority: 'high' } );
  140. expectResult(
  141. new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ),
  142. '<$text bold="true">foo</$text>'
  143. );
  144. } );
  145. it( 'config.view is an object', () => {
  146. upcastHelpers.elementToAttribute( {
  147. view: {
  148. name: 'span',
  149. classes: 'bold'
  150. },
  151. model: 'bold'
  152. } );
  153. expectResult(
  154. new ViewAttributeElement( 'span', { class: 'bold' }, new ViewText( 'foo' ) ),
  155. '<$text bold="true">foo</$text>'
  156. );
  157. expectResult( new ViewAttributeElement( 'span', {}, new ViewText( 'foo' ) ), 'foo' );
  158. } );
  159. it( 'model attribute value is given', () => {
  160. schema.extend( '$text', {
  161. allowAttributes: [ 'styled' ]
  162. } );
  163. upcastHelpers.elementToAttribute( {
  164. view: {
  165. name: 'span',
  166. classes: [ 'styled', 'styled-dark' ]
  167. },
  168. model: {
  169. key: 'styled',
  170. value: 'dark'
  171. }
  172. } );
  173. expectResult(
  174. new ViewAttributeElement( 'span', { class: 'styled styled-dark' }, new ViewText( 'foo' ) ),
  175. '<$text styled="dark">foo</$text>'
  176. );
  177. expectResult( new ViewAttributeElement( 'span', {}, new ViewText( 'foo' ) ), 'foo' );
  178. } );
  179. it( 'model attribute value is a function', () => {
  180. schema.extend( '$text', {
  181. allowAttributes: [ 'fontSize' ]
  182. } );
  183. upcastHelpers.elementToAttribute( {
  184. view: {
  185. name: 'span',
  186. styles: {
  187. 'font-size': /[\s\S]+/
  188. }
  189. },
  190. model: {
  191. key: 'fontSize',
  192. value: viewElement => {
  193. const fontSize = viewElement.getStyle( 'font-size' );
  194. const value = fontSize.substr( 0, fontSize.length - 2 );
  195. if ( value <= 10 ) {
  196. return 'small';
  197. } else if ( value > 12 ) {
  198. return 'big';
  199. }
  200. return null;
  201. }
  202. }
  203. } );
  204. expectResult(
  205. new ViewAttributeElement( 'span', { style: 'font-size:9px' }, new ViewText( 'foo' ) ),
  206. '<$text fontSize="small">foo</$text>'
  207. );
  208. expectResult(
  209. new ViewAttributeElement( 'span', { style: 'font-size:12px' }, new ViewText( 'foo' ) ),
  210. 'foo'
  211. );
  212. expectResult(
  213. new ViewAttributeElement( 'span', { style: 'font-size:14px' }, new ViewText( 'foo' ) ),
  214. '<$text fontSize="big">foo</$text>'
  215. );
  216. } );
  217. it( 'should not set an attribute if it is not allowed by schema', () => {
  218. upcastHelpers.elementToAttribute( { view: 'em', model: 'italic' } );
  219. expectResult(
  220. new ViewAttributeElement( 'em', null, new ViewText( 'foo' ) ),
  221. 'foo'
  222. );
  223. } );
  224. it( 'should not do anything if returned model attribute is null', () => {
  225. upcastHelpers.elementToAttribute( { view: 'strong', model: 'bold' } );
  226. upcastHelpers.elementToAttribute( {
  227. view: 'strong',
  228. model: {
  229. key: 'bold',
  230. value: () => null
  231. },
  232. converterPriority: 'high'
  233. } );
  234. expectResult(
  235. new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ),
  236. '<$text bold="true">foo</$text>'
  237. );
  238. } );
  239. it( 'should allow two converters to convert attributes on the same element', () => {
  240. upcastHelpers.elementToAttribute( {
  241. model: 'attribA',
  242. view: { name: 'span', classes: 'attrib-a' }
  243. } );
  244. upcastHelpers.elementToAttribute( {
  245. model: 'attribB',
  246. view: { name: 'span', styles: { color: 'attrib-b' } }
  247. } );
  248. expectResult(
  249. new ViewAttributeElement( 'span', { class: 'attrib-a', style: 'color:attrib-b;' }, new ViewText( 'foo' ) ),
  250. '<$text attribA="true" attribB="true">foo</$text>'
  251. );
  252. } );
  253. it( 'should consume element only when only is name specified', () => {
  254. upcastHelpers.elementToAttribute( {
  255. model: 'bold',
  256. view: { name: 'strong' }
  257. } );
  258. upcastHelpers.elementToAttribute( {
  259. model: 'attribA',
  260. view: { name: 'strong' }
  261. } );
  262. upcastHelpers.elementToAttribute( {
  263. model: 'attribB',
  264. view: { name: 'strong', classes: 'foo' }
  265. } );
  266. expectResult(
  267. new ViewAttributeElement( 'strong', { class: 'foo' }, new ViewText( 'foo' ) ),
  268. '<$text attribB="true" bold="true">foo</$text>'
  269. );
  270. } );
  271. // #1443.
  272. it( 'should set attributes on the element\'s children', () => {
  273. upcastHelpers.elementToAttribute( {
  274. model: 'bold',
  275. view: { name: 'strong' }
  276. } );
  277. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  278. expectResult(
  279. new ViewAttributeElement(
  280. 'strong',
  281. null,
  282. new ViewContainerElement( 'p', null, new ViewText( 'Foo' ) )
  283. ),
  284. '<paragraph><$text bold="true">Foo</$text></paragraph>'
  285. );
  286. } );
  287. } );
  288. describe( '.attributeToAttribute()', () => {
  289. beforeEach( () => {
  290. upcastHelpers.elementToElement( { view: 'img', model: 'image' } );
  291. schema.register( 'image', {
  292. inheritAllFrom: '$block'
  293. } );
  294. } );
  295. it( 'should be chainable', () => {
  296. expect( upcastHelpers.attributeToAttribute( { view: 'src', model: 'source' } ) ).to.equal( upcastHelpers );
  297. } );
  298. it( 'config.view is a string', () => {
  299. schema.extend( 'image', {
  300. allowAttributes: [ 'source' ]
  301. } );
  302. upcastHelpers.attributeToAttribute( { view: 'src', model: 'source' } );
  303. expectResult(
  304. new ViewAttributeElement( 'img', { src: 'foo.jpg' } ),
  305. '<image source="foo.jpg"></image>'
  306. );
  307. } );
  308. it( 'config.view has only key set', () => {
  309. schema.extend( 'image', {
  310. allowAttributes: [ 'source' ]
  311. } );
  312. upcastHelpers.attributeToAttribute( { view: { key: 'src' }, model: 'source' } );
  313. expectResult(
  314. new ViewAttributeElement( 'img', { src: 'foo.jpg' } ),
  315. '<image source="foo.jpg"></image>'
  316. );
  317. } );
  318. it( 'config.view has only key and name set', () => {
  319. schema.extend( 'image', {
  320. allowAttributes: [ 'source' ]
  321. } );
  322. upcastHelpers.attributeToAttribute( { view: { name: 'img', key: 'src' }, model: { name: 'image', key: 'source' } } );
  323. expectResult(
  324. new ViewAttributeElement( 'img', { src: 'foo.jpg' } ),
  325. '<image source="foo.jpg"></image>'
  326. );
  327. } );
  328. it( 'can be overwritten using converterPriority', () => {
  329. schema.extend( 'image', {
  330. allowAttributes: [ 'src', 'source' ]
  331. } );
  332. upcastHelpers.attributeToAttribute( { view: { key: 'src' }, model: 'src' } );
  333. upcastHelpers.attributeToAttribute( { view: { key: 'src' }, model: 'source', converterPriority: 'normal' } );
  334. expectResult(
  335. new ViewAttributeElement( 'img', { src: 'foo.jpg' } ),
  336. '<image source="foo.jpg"></image>'
  337. );
  338. } );
  339. it( 'config.view has value set', () => {
  340. schema.extend( 'image', {
  341. allowAttributes: [ 'styled' ]
  342. } );
  343. upcastHelpers.attributeToAttribute( {
  344. view: {
  345. key: 'data-style',
  346. value: /[\s\S]*/
  347. },
  348. model: 'styled'
  349. } );
  350. expectResult(
  351. new ViewAttributeElement( 'img', { 'data-style': 'dark' } ),
  352. '<image styled="dark"></image>'
  353. );
  354. } );
  355. it( 'model attribute value is a string', () => {
  356. schema.extend( 'image', {
  357. allowAttributes: [ 'styled' ]
  358. } );
  359. upcastHelpers.attributeToAttribute( {
  360. view: {
  361. name: 'img',
  362. key: 'class',
  363. value: 'styled-dark'
  364. },
  365. model: {
  366. key: 'styled',
  367. value: 'dark'
  368. }
  369. } );
  370. upcastHelpers.elementToElement( { view: 'p', model: 'paragraph' } );
  371. expectResult(
  372. new ViewContainerElement( 'img', { class: 'styled-dark' } ),
  373. '<image styled="dark"></image>'
  374. );
  375. expectResult(
  376. new ViewContainerElement( 'img', { class: 'styled-xxx' } ),
  377. '<image></image>'
  378. );
  379. expectResult(
  380. new ViewContainerElement( 'p', { class: 'styled-dark' } ),
  381. '<paragraph></paragraph>'
  382. );
  383. } );
  384. it( 'model attribute value is a function', () => {
  385. schema.extend( 'image', {
  386. allowAttributes: [ 'styled' ]
  387. } );
  388. upcastHelpers.attributeToAttribute( {
  389. view: {
  390. key: 'class',
  391. value: /styled-[\S]+/
  392. },
  393. model: {
  394. key: 'styled',
  395. value: viewElement => {
  396. const regexp = /styled-([\S]+)/;
  397. const match = viewElement.getAttribute( 'class' ).match( regexp );
  398. return match[ 1 ];
  399. }
  400. }
  401. } );
  402. expectResult(
  403. new ViewAttributeElement( 'img', { 'class': 'styled-dark' } ),
  404. '<image styled="dark"></image>'
  405. );
  406. } );
  407. it( 'should not set an attribute if it is not allowed by schema', () => {
  408. upcastHelpers.attributeToAttribute( { view: 'src', model: 'source' } );
  409. expectResult(
  410. new ViewAttributeElement( 'img', { src: 'foo.jpg' } ),
  411. '<image></image>'
  412. );
  413. } );
  414. it( 'should not do anything if returned model attribute is null', () => {
  415. schema.extend( 'image', {
  416. allowAttributes: [ 'styled' ]
  417. } );
  418. upcastHelpers.attributeToAttribute( {
  419. view: {
  420. key: 'class',
  421. value: 'styled'
  422. },
  423. model: {
  424. key: 'styled',
  425. value: true
  426. }
  427. } );
  428. upcastHelpers.attributeToAttribute( {
  429. view: {
  430. key: 'class',
  431. value: 'styled'
  432. },
  433. model: {
  434. key: 'styled',
  435. value: () => null
  436. }
  437. } );
  438. expectResult(
  439. new ViewAttributeElement( 'img', { class: 'styled' } ),
  440. '<image styled="true"></image>'
  441. );
  442. } );
  443. // #1443.
  444. it( 'should not set attributes on the element\'s children', () => {
  445. schema.register( 'div', {
  446. inheritAllFrom: '$root',
  447. allowWhere: '$block',
  448. isLimit: true,
  449. allowAttributes: [ 'border', 'shade' ]
  450. } );
  451. upcastHelpers.elementToElement( { view: 'div', model: 'div' } );
  452. upcastHelpers.attributeToAttribute( { view: { key: 'class', value: 'shade' }, model: 'shade' } );
  453. upcastHelpers.attributeToAttribute( { view: { key: 'class', value: 'border' }, model: 'border' } );
  454. expectResult(
  455. new ViewContainerElement(
  456. 'div',
  457. { class: 'border' },
  458. new ViewContainerElement( 'div', { class: 'shade' } )
  459. ),
  460. '<div border="border"><div shade="shade"></div></div>'
  461. );
  462. } );
  463. } );
  464. describe( '.elementToMarker()', () => {
  465. it( 'should be chainable', () => {
  466. expect( upcastHelpers.elementToMarker( { view: 'marker-search', model: 'search' } ) ).to.equal( upcastHelpers );
  467. } );
  468. it( 'config.view is a string', () => {
  469. upcastHelpers.elementToMarker( { view: 'marker-search', model: 'search' } );
  470. const frag = new ViewDocumentFragment( [
  471. new ViewText( 'fo' ),
  472. new ViewUIElement( 'marker-search' ),
  473. new ViewText( 'oba' ),
  474. new ViewUIElement( 'marker-search' ),
  475. new ViewText( 'r' )
  476. ] );
  477. const marker = { name: 'search', start: [ 2 ], end: [ 5 ] };
  478. expectResult( frag, 'foobar', marker );
  479. } );
  480. it( 'can be overwritten using converterPriority', () => {
  481. upcastHelpers.elementToMarker( { view: 'marker-search', model: 'search-result' } );
  482. upcastHelpers.elementToMarker( { view: 'marker-search', model: 'search', converterPriority: 'high' } );
  483. const frag = new ViewDocumentFragment( [
  484. new ViewText( 'fo' ),
  485. new ViewUIElement( 'marker-search' ),
  486. new ViewText( 'oba' ),
  487. new ViewUIElement( 'marker-search' ),
  488. new ViewText( 'r' )
  489. ] );
  490. const marker = { name: 'search', start: [ 2 ], end: [ 5 ] };
  491. expectResult( frag, 'foobar', marker );
  492. } );
  493. it( 'config.view is an object', () => {
  494. upcastHelpers.elementToMarker( {
  495. view: {
  496. name: 'span',
  497. 'data-marker': 'search'
  498. },
  499. model: 'search'
  500. } );
  501. const frag = new ViewDocumentFragment( [
  502. new ViewText( 'f' ),
  503. new ViewUIElement( 'span', { 'data-marker': 'search' } ),
  504. new ViewText( 'oob' ),
  505. new ViewUIElement( 'span', { 'data-marker': 'search' } ),
  506. new ViewText( 'ar' )
  507. ] );
  508. const marker = { name: 'search', start: [ 1 ], end: [ 4 ] };
  509. expectResult( frag, 'foobar', marker );
  510. } );
  511. it( 'config.model is a function', () => {
  512. upcastHelpers.elementToMarker( {
  513. view: 'comment',
  514. model: viewElement => 'comment:' + viewElement.getAttribute( 'data-comment-id' )
  515. } );
  516. const frag = new ViewDocumentFragment( [
  517. new ViewText( 'foo' ),
  518. new ViewUIElement( 'comment', { 'data-comment-id': 4 } ),
  519. new ViewText( 'b' ),
  520. new ViewUIElement( 'comment', { 'data-comment-id': 4 } ),
  521. new ViewText( 'ar' )
  522. ] );
  523. const marker = { name: 'comment:4', start: [ 3 ], end: [ 4 ] };
  524. expectResult( frag, 'foobar', marker );
  525. } );
  526. it( 'marker is in a block element', () => {
  527. upcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
  528. upcastHelpers.elementToMarker( { view: 'marker-search', model: 'search' } );
  529. const element = new ViewContainerElement( 'p', null, [
  530. new ViewText( 'fo' ),
  531. new ViewUIElement( 'marker-search' ),
  532. new ViewText( 'oba' ),
  533. new ViewUIElement( 'marker-search' ),
  534. new ViewText( 'r' )
  535. ] );
  536. const marker = { name: 'search', start: [ 0, 2 ], end: [ 0, 5 ] };
  537. expectResult( element, '<paragraph>foobar</paragraph>', marker );
  538. } );
  539. } );
  540. function expectResult( viewToConvert, modelString, marker ) {
  541. const conversionResult = model.change( writer => upcastDispatcher.convert( viewToConvert, writer ) );
  542. if ( marker ) {
  543. expect( conversionResult.markers.has( marker.name ) ).to.be.true;
  544. const convertedMarker = conversionResult.markers.get( marker.name );
  545. expect( convertedMarker.start.path ).to.deep.equal( marker.start );
  546. expect( convertedMarker.end.path ).to.deep.equal( marker.end );
  547. }
  548. expect( stringify( conversionResult ) ).to.equal( modelString );
  549. }
  550. } );
  551. describe( 'upcast-converters', () => {
  552. let dispatcher, schema, context, model;
  553. beforeEach( () => {
  554. model = new Model();
  555. schema = model.schema;
  556. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  557. schema.extend( '$text', { allowIn: '$root' } );
  558. context = [ '$root' ];
  559. dispatcher = new UpcastDispatcher( { schema } );
  560. } );
  561. describe( 'convertText()', () => {
  562. it( 'should return converter converting ViewText to ModelText', () => {
  563. const viewText = new ViewText( 'foobar' );
  564. dispatcher.on( 'text', convertText() );
  565. const conversionResult = model.change( writer => dispatcher.convert( viewText, writer ) );
  566. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  567. expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText );
  568. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foobar' );
  569. } );
  570. it( 'should not convert already consumed texts', () => {
  571. const viewText = new ViewText( 'foofuckbafuckr' );
  572. // Default converter for elements. Returns just converted children. Added with lowest priority.
  573. dispatcher.on( 'text', convertText(), { priority: 'lowest' } );
  574. // Added with normal priority. Should make the above converter not fire.
  575. dispatcher.on( 'text', ( evt, data, conversionApi ) => {
  576. if ( conversionApi.consumable.consume( data.viewItem ) ) {
  577. const text = conversionApi.writer.createText( data.viewItem.data.replace( /fuck/gi, '****' ) );
  578. conversionApi.writer.insert( text, data.modelCursor );
  579. data.modelRange = ModelRange._createFromPositionAndShift( data.modelCursor, text.offsetSize );
  580. data.modelCursor = data.modelRange.end;
  581. }
  582. } );
  583. const conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) );
  584. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  585. expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText );
  586. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foo****ba****r' );
  587. } );
  588. it( 'should not convert text if it is wrong with schema', () => {
  589. schema.addChildCheck( ( ctx, childDef ) => {
  590. if ( childDef.name == '$text' && ctx.endsWith( '$root' ) ) {
  591. return false;
  592. }
  593. } );
  594. const viewText = new ViewText( 'foobar' );
  595. dispatcher.on( 'text', convertText() );
  596. let conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) );
  597. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  598. expect( conversionResult.childCount ).to.equal( 0 );
  599. conversionResult = model.change( writer => dispatcher.convert( viewText, writer, [ '$block' ] ) );
  600. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  601. expect( conversionResult.childCount ).to.equal( 1 );
  602. expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText );
  603. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foobar' );
  604. } );
  605. it( 'should support unicode', () => {
  606. const viewText = new ViewText( 'நிலைக்கு' );
  607. dispatcher.on( 'text', convertText() );
  608. const conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) );
  609. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  610. expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText );
  611. expect( conversionResult.getChild( 0 ).data ).to.equal( 'நிலைக்கு' );
  612. } );
  613. } );
  614. describe( 'convertToModelFragment()', () => {
  615. it( 'should return converter converting whole ViewDocumentFragment to ModelDocumentFragment', () => {
  616. const viewFragment = new ViewDocumentFragment( [
  617. new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ),
  618. new ViewText( 'bar' )
  619. ] );
  620. // To get any meaningful results we have to actually convert something.
  621. dispatcher.on( 'text', convertText() );
  622. // This way P element won't be converted per-se but will fire converting it's children.
  623. dispatcher.on( 'element', convertToModelFragment() );
  624. dispatcher.on( 'documentFragment', convertToModelFragment() );
  625. const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer, context ) );
  626. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  627. expect( conversionResult.maxOffset ).to.equal( 6 );
  628. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foobar' );
  629. } );
  630. it( 'should not convert already consumed (converted) changes', () => {
  631. const viewP = new ViewContainerElement( 'p', null, new ViewText( 'foo' ) );
  632. // To get any meaningful results we have to actually convert something.
  633. dispatcher.on( 'text', convertText() );
  634. // Default converter for elements. Returns just converted children. Added with lowest priority.
  635. dispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } );
  636. // Added with normal priority. Should make the above converter not fire.
  637. dispatcher.on( 'element:p', ( evt, data, conversionApi ) => {
  638. if ( conversionApi.consumable.consume( data.viewItem, { name: true } ) ) {
  639. const paragraph = conversionApi.writer.createElement( 'paragraph' );
  640. conversionApi.writer.insert( paragraph, data.modelCursor );
  641. conversionApi.convertChildren( data.viewItem, ModelPosition._createAt( paragraph, 0 ) );
  642. data.modelRange = ModelRange._createOn( paragraph );
  643. data.modelCursor = data.modelRange.end;
  644. }
  645. } );
  646. const conversionResult = model.change( writer => dispatcher.convert( viewP, writer, context ) );
  647. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  648. expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelElement );
  649. expect( conversionResult.getChild( 0 ).name ).to.equal( 'paragraph' );
  650. expect( conversionResult.getChild( 0 ).maxOffset ).to.equal( 3 );
  651. expect( conversionResult.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' );
  652. } );
  653. it( 'should forward correct modelCursor', () => {
  654. const spy = sinon.spy();
  655. const view = new ViewDocumentFragment( [
  656. new ViewContainerElement( 'div', null, [ new ViewText( 'abc' ), new ViewContainerElement( 'foo' ) ] ),
  657. new ViewContainerElement( 'bar' )
  658. ] );
  659. const position = ModelPosition._createAt( new ModelElement( 'element' ), 0 );
  660. dispatcher.on( 'documentFragment', convertToModelFragment() );
  661. dispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } );
  662. dispatcher.on( 'element:foo', ( evt, data ) => {
  663. // Be sure that current cursor is not the same as custom.
  664. expect( data.modelCursor ).to.not.equal( position );
  665. // Set custom cursor as a result of docFrag last child conversion.
  666. // This cursor should be forwarded by a documentFragment converter.
  667. data.modelCursor = position;
  668. // Be sure that callback was fired.
  669. spy();
  670. } );
  671. dispatcher.on( 'element:bar', ( evt, data ) => {
  672. expect( data.modelCursor ).to.equal( position );
  673. spy();
  674. } );
  675. model.change( writer => dispatcher.convert( view, writer ) );
  676. sinon.assert.calledTwice( spy );
  677. } );
  678. } );
  679. describe( 'convertSelectionChange()', () => {
  680. let model, view, viewDocument, mapper, convertSelection, modelRoot, viewRoot;
  681. beforeEach( () => {
  682. model = new Model();
  683. modelRoot = model.document.createRoot();
  684. model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  685. modelSetData( model, '<paragraph>foo</paragraph><paragraph>bar</paragraph>' );
  686. view = new View();
  687. viewDocument = view.document;
  688. viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  689. viewSetData( view, '<p>foo</p><p>bar</p>' );
  690. mapper = new Mapper();
  691. mapper.bindElements( modelRoot, viewRoot );
  692. mapper.bindElements( modelRoot.getChild( 0 ), viewRoot.getChild( 0 ) );
  693. mapper.bindElements( modelRoot.getChild( 1 ), viewRoot.getChild( 1 ) );
  694. convertSelection = convertSelectionChange( model, mapper );
  695. } );
  696. afterEach( () => {
  697. view.destroy();
  698. } );
  699. it( 'should convert collapsed selection', () => {
  700. const viewSelection = new ViewSelection();
  701. viewSelection.setTo( ViewRange._createFromParentsAndOffsets(
  702. viewRoot.getChild( 0 ).getChild( 0 ), 1, viewRoot.getChild( 0 ).getChild( 0 ), 1 ) );
  703. convertSelection( null, { newSelection: viewSelection } );
  704. expect( modelGetData( model ) ).to.equals( '<paragraph>f[]oo</paragraph><paragraph>bar</paragraph>' );
  705. expect( modelGetData( model ) ).to.equal( '<paragraph>f[]oo</paragraph><paragraph>bar</paragraph>' );
  706. } );
  707. it( 'should support unicode', () => {
  708. modelSetData( model, '<paragraph>நிலைக்கு</paragraph>' );
  709. viewSetData( view, '<p>நிலைக்கு</p>' );
  710. // Re-bind elements that were just re-set.
  711. mapper.bindElements( modelRoot.getChild( 0 ), viewRoot.getChild( 0 ) );
  712. const viewSelection = new ViewSelection( [
  713. ViewRange._createFromParentsAndOffsets( viewRoot.getChild( 0 ).getChild( 0 ), 2, viewRoot.getChild( 0 ).getChild( 0 ), 6 )
  714. ] );
  715. convertSelection( null, { newSelection: viewSelection } );
  716. expect( modelGetData( model ) ).to.equal( '<paragraph>நி[லைக்]கு</paragraph>' );
  717. } );
  718. it( 'should convert multi ranges selection', () => {
  719. const viewSelection = new ViewSelection( [
  720. ViewRange._createFromParentsAndOffsets(
  721. viewRoot.getChild( 0 ).getChild( 0 ), 1, viewRoot.getChild( 0 ).getChild( 0 ), 2 ),
  722. ViewRange._createFromParentsAndOffsets(
  723. viewRoot.getChild( 1 ).getChild( 0 ), 1, viewRoot.getChild( 1 ).getChild( 0 ), 2 )
  724. ] );
  725. convertSelection( null, { newSelection: viewSelection } );
  726. expect( modelGetData( model ) ).to.equal(
  727. '<paragraph>f[o]o</paragraph><paragraph>b[a]r</paragraph>' );
  728. const ranges = Array.from( model.document.selection.getRanges() );
  729. expect( ranges.length ).to.equal( 2 );
  730. expect( ranges[ 0 ].start.parent ).to.equal( modelRoot.getChild( 0 ) );
  731. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  732. expect( ranges[ 0 ].end.parent ).to.equal( modelRoot.getChild( 0 ) );
  733. expect( ranges[ 0 ].end.offset ).to.equal( 2 );
  734. expect( ranges[ 1 ].start.parent ).to.equal( modelRoot.getChild( 1 ) );
  735. expect( ranges[ 1 ].start.offset ).to.equal( 1 );
  736. expect( ranges[ 1 ].end.parent ).to.equal( modelRoot.getChild( 1 ) );
  737. expect( ranges[ 1 ].end.offset ).to.equal( 2 );
  738. } );
  739. it( 'should convert reverse selection', () => {
  740. const viewSelection = new ViewSelection( [
  741. ViewRange._createFromParentsAndOffsets(
  742. viewRoot.getChild( 0 ).getChild( 0 ), 1, viewRoot.getChild( 0 ).getChild( 0 ), 2 ),
  743. ViewRange._createFromParentsAndOffsets(
  744. viewRoot.getChild( 1 ).getChild( 0 ), 1, viewRoot.getChild( 1 ).getChild( 0 ), 2 )
  745. ], { backward: true } );
  746. convertSelection( null, { newSelection: viewSelection } );
  747. expect( modelGetData( model ) ).to.equal( '<paragraph>f[o]o</paragraph><paragraph>b[a]r</paragraph>' );
  748. expect( model.document.selection.isBackward ).to.true;
  749. } );
  750. it( 'should not enqueue changes if selection has not changed', () => {
  751. const viewSelection = new ViewSelection( [
  752. ViewRange._createFromParentsAndOffsets(
  753. viewRoot.getChild( 0 ).getChild( 0 ), 1, viewRoot.getChild( 0 ).getChild( 0 ), 1 )
  754. ] );
  755. convertSelection( null, { newSelection: viewSelection } );
  756. const spy = sinon.spy();
  757. model.on( 'change', spy );
  758. convertSelection( null, { newSelection: viewSelection } );
  759. expect( spy.called ).to.be.false;
  760. } );
  761. } );
  762. } );