upcasthelpers.js 32 KB

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