upcasthelpers.js 32 KB

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