upcasthelpers.js 32 KB

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