upcasthelpers.js 32 KB

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