advanced-converters.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelDocument from '../../src/model/document';
  6. import ModelDocumentFragment from '../../src/model/documentfragment';
  7. import ModelElement from '../../src/model/element';
  8. import ModelText from '../../src/model/text';
  9. import ModelTextProxy from '../../src/model/textproxy';
  10. import ModelRange from '../../src/model/range';
  11. import ModelPosition from '../../src/model/position';
  12. import ModelWalker from '../../src/model/treewalker';
  13. import modelWriter from '../../src/model/writer';
  14. import ViewElement from '../../src/view/element';
  15. import ViewContainerElement from '../../src/view/containerelement';
  16. import ViewAttributeElement from '../../src/view/attributeelement';
  17. import ViewText from '../../src/view/text';
  18. import viewWriter from '../../src/view/writer';
  19. import ViewPosition from '../../src/view/position';
  20. import ViewRange from '../../src/view/range';
  21. import Mapper from '../../src/conversion/mapper';
  22. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  23. import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher';
  24. import {
  25. insertElement,
  26. insertText,
  27. setAttribute,
  28. removeAttribute,
  29. wrapItem,
  30. unwrapItem,
  31. remove,
  32. eventNameToConsumableType
  33. } from '../../src/conversion/model-to-view-converters';
  34. import { convertToModelFragment, convertText } from '../../src/conversion/view-to-model-converters';
  35. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  36. describe( 'advanced-converters', () => {
  37. let modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher, batch;
  38. beforeEach( () => {
  39. modelDoc = new ModelDocument();
  40. modelRoot = modelDoc.createRoot();
  41. viewRoot = new ViewContainerElement( 'div' );
  42. batch = modelDoc.batch();
  43. mapper = new Mapper();
  44. mapper.bindElements( modelRoot, viewRoot );
  45. modelDispatcher = new ModelConversionDispatcher( modelDoc, { mapper } );
  46. // Schema is mocked up because we don't care about it in those tests.
  47. viewDispatcher = new ViewConversionDispatcher( { schema: { check: () => true } } );
  48. modelDispatcher.on( 'insert:$text', insertText() );
  49. modelDispatcher.on( 'remove', remove() );
  50. viewDispatcher.on( 'text', convertText() );
  51. viewDispatcher.on( 'documentFragment', convertToModelFragment() );
  52. } );
  53. function viewAttributesToString( item ) {
  54. let result = '';
  55. for ( const key of item.getAttributeKeys() ) {
  56. const value = item.getAttribute( key );
  57. if ( value ) {
  58. result += ' ' + key + '="' + value + '"';
  59. }
  60. }
  61. return result;
  62. }
  63. function viewToString( item ) {
  64. let result = '';
  65. if ( item instanceof ViewText ) {
  66. result = item.data;
  67. } else {
  68. // ViewElement or ViewDocumentFragment.
  69. for ( const child of item.getChildren() ) {
  70. result += viewToString( child );
  71. }
  72. if ( item instanceof ViewElement ) {
  73. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  74. }
  75. }
  76. return result;
  77. }
  78. function modelAttributesToString( item ) {
  79. let result = '';
  80. for ( const attr of item.getAttributes() ) {
  81. result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"';
  82. }
  83. return result;
  84. }
  85. function modelToString( item ) {
  86. let result = '';
  87. if ( item instanceof ModelTextProxy ) {
  88. const attributes = modelAttributesToString( item );
  89. result = attributes ? '<$text' + attributes + '>' + item.data + '</$text>' : item.data;
  90. } else {
  91. const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } );
  92. for ( const value of walker ) {
  93. result += modelToString( value.item );
  94. }
  95. if ( item instanceof ModelElement ) {
  96. const attributes = modelAttributesToString( item );
  97. result = '<' + item.name + attributes + '>' + result + '</' + item.name + '>';
  98. }
  99. }
  100. return result;
  101. }
  102. // Converter for custom `image` element that might have a `caption` element inside which changes
  103. // how the image is displayed in the view:
  104. //
  105. // Model:
  106. //
  107. // [image {src="foo.jpg" title="foo"}]
  108. // └─ [caption]
  109. // ├─ f
  110. // ├─ o
  111. // └─ o
  112. //
  113. // [image {src="bar.jpg" title="bar"}]
  114. //
  115. // View:
  116. //
  117. // <figure>
  118. // ├─ <img src="foo.jpg" title="foo" />
  119. // └─ <caption>
  120. // └─ foo
  121. //
  122. // <img src="bar.jpg" title="bar" />
  123. describe( 'image with caption converters', () => {
  124. beforeEach( () => {
  125. const modelImageConverter = function( evt, data, consumable, conversionApi ) {
  126. // First, consume the `image` element.
  127. consumable.consume( data.item, 'insert' );
  128. // Just create normal image element for the view.
  129. // Maybe it will be "decorated" later.
  130. const viewImage = new ViewContainerElement( 'img' );
  131. const insertPosition = conversionApi.mapper.toViewPosition( data.range.start );
  132. // Check if the `image` element has children.
  133. if ( data.item.childCount > 0 ) {
  134. const modelCaption = data.item.getChild( 0 );
  135. // `modelCaption` insertion change is consumed from consumable values.
  136. // It will not be converted by other converters, but it's children (probably some text) will be.
  137. // Through mapping, converters for text will know where to insert contents of `modelCaption`.
  138. if ( consumable.consume( modelCaption, 'insert' ) ) {
  139. const viewCaption = new ViewContainerElement( 'figcaption' );
  140. const viewImageHolder = new ViewContainerElement( 'figure', null, [ viewImage, viewCaption ] );
  141. conversionApi.mapper.bindElements( modelCaption, viewCaption );
  142. conversionApi.mapper.bindElements( data.item, viewImageHolder );
  143. viewWriter.insert( insertPosition, viewImageHolder );
  144. }
  145. } else {
  146. conversionApi.mapper.bindElements( data.item, viewImage );
  147. viewWriter.insert( insertPosition, viewImage );
  148. }
  149. evt.stop();
  150. };
  151. const modelImageAttributesConverter = function( evt, data, consumable, conversionApi ) {
  152. if ( data.item.name != 'image' ) {
  153. return;
  154. }
  155. let viewElement = conversionApi.mapper.toViewElement( data.item );
  156. if ( viewElement.name == 'figure' ) {
  157. viewElement = viewElement.getChild( 0 );
  158. }
  159. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  160. if ( !data.attributeNewValue ) {
  161. viewElement.removeAttribute( data.attributeKey );
  162. } else {
  163. viewElement.setAttribute( data.attributeKey, data.attributeNewValue );
  164. }
  165. evt.stop();
  166. };
  167. const viewFigureConverter = function( evt, data, consumable, conversionApi ) {
  168. if ( consumable.consume( data.input, { name: true } ) ) {
  169. const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable, { batch } );
  170. const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable, { batch } );
  171. modelImage.appendChildren( modelCaption );
  172. data.output = modelImage;
  173. }
  174. };
  175. const viewImageConverter = function( evt, data, consumable ) {
  176. if ( consumable.consume( data.input, { name: true } ) ) {
  177. const modelImage = new ModelElement( 'image' );
  178. for ( const attributeKey of data.input.getAttributeKeys() ) {
  179. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  180. }
  181. data.output = modelImage;
  182. }
  183. };
  184. const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) {
  185. if ( consumable.consume( data.input, { name: true } ) ) {
  186. const modelCaption = new ModelElement( 'caption' );
  187. const children = conversionApi.convertChildren( data.input, consumable, { batch } );
  188. modelCaption.appendChildren( children );
  189. data.output = modelCaption;
  190. }
  191. };
  192. modelDispatcher.on( 'insert:image', modelImageConverter );
  193. modelDispatcher.on( 'addAttribute', modelImageAttributesConverter );
  194. modelDispatcher.on( 'changeAttribute', modelImageAttributesConverter );
  195. modelDispatcher.on( 'removeAttribute', modelImageAttributesConverter );
  196. viewDispatcher.on( 'element:figure', viewFigureConverter );
  197. viewDispatcher.on( 'element:img', viewImageConverter );
  198. viewDispatcher.on( 'element:figcaption', viewFigcaptionConverter );
  199. } );
  200. it( 'should convert model images changes without caption to view', () => {
  201. const modelElement = new ModelElement( 'image', { src: 'bar.jpg', title: 'bar' } );
  202. modelRoot.appendChildren( modelElement );
  203. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  204. expect( viewToString( viewRoot ) ).to.equal( '<div><img src="bar.jpg" title="bar"></img></div>' );
  205. modelElement.setAttribute( 'src', 'new.jpg' );
  206. modelElement.removeAttribute( 'title' );
  207. modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  208. modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null );
  209. expect( viewToString( viewRoot ) ).to.equal( '<div><img src="new.jpg"></img></div>' );
  210. } );
  211. it( 'should convert model images changes with caption to view', () => {
  212. const modelElement = new ModelElement( 'image', { src: 'foo.jpg', title: 'foo' }, [
  213. new ModelElement( 'caption', {}, new ModelText( 'foobar' ) )
  214. ] );
  215. modelRoot.appendChildren( modelElement );
  216. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  217. expect( viewToString( viewRoot ) ).to.equal(
  218. '<div><figure><img src="foo.jpg" title="foo"></img><figcaption>foobar</figcaption></figure></div>'
  219. );
  220. modelElement.setAttribute( 'src', 'new.jpg' );
  221. modelElement.removeAttribute( 'title' );
  222. modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  223. modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null );
  224. expect( viewToString( viewRoot ) ).to.equal(
  225. '<div><figure><img src="new.jpg"></img><figcaption>foobar</figcaption></figure></div>'
  226. );
  227. } );
  228. it( 'should convert view image to model', () => {
  229. const viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } );
  230. const modelElement = viewDispatcher.convert( viewElement, { batch } );
  231. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"></image>' );
  232. } );
  233. it( 'should convert view figure to model', () => {
  234. const viewElement = new ViewContainerElement(
  235. 'figure',
  236. null,
  237. [
  238. new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ),
  239. new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) )
  240. ]
  241. );
  242. const modelElement = viewDispatcher.convert( viewElement, { batch } );
  243. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"><caption>foobar</caption></image>' );
  244. } );
  245. } );
  246. // Converter overwrites default attribute converter for `linkHref` and `linkTitle` attribute is set on `quote` element.
  247. //
  248. // Model:
  249. //
  250. // [quote {linkHref='foo.html' linkTitle='Foo source'}]
  251. // ├─ f
  252. // ├─ o
  253. // └─ o
  254. //
  255. // foo {linkHref='foo.html' linkTitle='Foo title'}
  256. //
  257. // View:
  258. //
  259. // <blockquote>
  260. // ├─ foo
  261. // └─ <a href="foo.html" title="Foo source">
  262. // └─ see source
  263. //
  264. // <a href="foo.html" title="Foo title">
  265. // └─ foo
  266. describe( 'custom attribute handling for given element', () => {
  267. beforeEach( () => {
  268. // NORMAL LINK MODEL TO VIEW CONVERTERS
  269. modelDispatcher.on( 'addAttribute:linkHref', wrapItem( value => new ViewAttributeElement( 'a', { href: value } ) ) );
  270. modelDispatcher.on( 'addAttribute:linkTitle', wrapItem( value => new ViewAttributeElement( 'a', { title: value } ) ) );
  271. const changeLinkAttribute = function( elementCreator ) {
  272. return ( evt, data, consumable, conversionApi ) => {
  273. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  274. const viewRange = conversionApi.mapper.toViewRange( data.range );
  275. const viewOldA = elementCreator( data.attributeOldValue );
  276. const viewNewA = elementCreator( data.attributeNewValue );
  277. viewWriter.unwrap( viewRange, viewOldA, evt.priority );
  278. viewWriter.wrap( viewRange, viewNewA, evt.priority );
  279. evt.stop();
  280. };
  281. };
  282. modelDispatcher.on(
  283. 'changeAttribute:linkHref',
  284. changeLinkAttribute( value => new ViewAttributeElement( 'a', { href: value } ) )
  285. );
  286. modelDispatcher.on(
  287. 'changeAttribute:linkTitle',
  288. changeLinkAttribute( value => new ViewAttributeElement( 'a', { title: value } ) )
  289. );
  290. modelDispatcher.on(
  291. 'removeAttribute:linkHref',
  292. unwrapItem( value => new ViewAttributeElement( 'a', { href: value } ) )
  293. );
  294. modelDispatcher.on(
  295. 'removeAttribute:linkTitle',
  296. unwrapItem( value => new ViewAttributeElement( 'a', { title: value } ) )
  297. );
  298. // NORMAL LINK VIEW TO MODEL CONVERTERS
  299. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  300. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  301. if ( !data.output ) {
  302. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  303. }
  304. for ( const child of data.output ) {
  305. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  306. }
  307. }
  308. } );
  309. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  310. if ( consumable.consume( data.input, { attribute: 'title' } ) ) {
  311. if ( !data.output ) {
  312. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  313. }
  314. for ( const child of data.output ) {
  315. child.setAttribute( 'linkTitle', data.input.getAttribute( 'title' ) );
  316. }
  317. }
  318. } );
  319. // QUOTE MODEL TO VIEW CONVERTERS
  320. modelDispatcher.on( 'insert:quote', ( evt, data, consumable, conversionApi ) => {
  321. consumable.consume( data.item, 'insert' );
  322. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  323. const viewElement = new ViewContainerElement( 'blockquote' );
  324. conversionApi.mapper.bindElements( data.item, viewElement );
  325. viewWriter.insert( viewPosition, viewElement );
  326. if ( consumable.consume( data.item, 'addAttribute:linkHref' ) ) {
  327. const viewA = new ViewAttributeElement(
  328. 'a', { href: data.item.getAttribute( 'linkHref' ) }, new ViewText( 'see source' )
  329. );
  330. if ( consumable.consume( data.item, 'addAttribute:linkTitle' ) ) {
  331. viewA.setAttribute( 'title', data.item.getAttribute( 'linkTitle' ) );
  332. }
  333. viewWriter.insert( new ViewPosition( viewElement, viewElement.childCount ), viewA );
  334. }
  335. evt.stop();
  336. }, { priority: 'high' } );
  337. const modelChangeLinkAttrQuoteConverter = function( evt, data, consumable, conversionApi ) {
  338. const viewKey = data.attributeKey.substr( 4 ).toLowerCase();
  339. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  340. const viewElement = conversionApi.mapper.toViewElement( data.item );
  341. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  342. if ( data.attributeNewValue !== null ) {
  343. viewA.setAttribute( viewKey, data.attributeNewValue );
  344. } else {
  345. viewA.removeAttribute( viewKey );
  346. }
  347. evt.stop();
  348. };
  349. modelDispatcher.on( 'changeAttribute:linkHref:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  350. modelDispatcher.on( 'changeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  351. modelDispatcher.on( 'removeAttribute:linkHref:quote', ( evt, data, consumable, conversionApi ) => {
  352. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  353. const viewElement = conversionApi.mapper.toViewElement( data.item );
  354. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  355. const aIndex = viewA.index;
  356. viewWriter.remove( ViewRange.createFromParentsAndOffsets( viewElement, aIndex, viewElement, aIndex + 1 ) );
  357. evt.stop();
  358. }, { priority: 'high' } );
  359. modelDispatcher.on( 'removeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  360. // QUOTE VIEW TO MODEL CONVERTERS
  361. viewDispatcher.on( 'element:blockquote', ( evt, data, consumable, conversionApi ) => {
  362. if ( consumable.consume( data.input, { name: true } ) ) {
  363. data.output = new ModelElement( 'quote' );
  364. const viewA = data.input.getChild( data.input.childCount - 1 );
  365. // Convert the special "a" first, before converting all children.
  366. if ( viewA instanceof ViewElement && viewA.name == 'a' && consumable.consume( viewA, { name: true } ) ) {
  367. if ( consumable.consume( viewA, { attribute: 'href' } ) ) {
  368. data.output.setAttribute( 'linkHref', viewA.getAttribute( 'href' ) );
  369. }
  370. if ( consumable.consume( viewA, { attribute: 'title' } ) ) {
  371. data.output.setAttribute( 'linkTitle', viewA.getAttribute( 'title' ) );
  372. }
  373. }
  374. const children = conversionApi.convertChildren( data.input, consumable, { batch } );
  375. data.output.appendChildren( children );
  376. }
  377. } );
  378. } );
  379. it( 'should convert model text with linkHref and linkTitle to view', () => {
  380. const modelText = new ModelText( 'foo', { linkHref: 'foo.html', linkTitle: 'Foo title' } );
  381. modelRoot.appendChildren( modelText );
  382. let range = ModelRange.createIn( modelRoot );
  383. modelDispatcher.convertInsertion( range );
  384. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="foo.html" title="Foo title">foo</a></div>' );
  385. // Let's change link's attributes.
  386. modelWriter.setAttribute( range, 'linkHref', 'bar.html' );
  387. modelWriter.setAttribute( range, 'linkTitle', 'Bar title' );
  388. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkHref', 'foo.html', 'bar.html' );
  389. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkTitle', 'Foo title', 'Bar title' );
  390. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">foo</a></div>' );
  391. const removed = modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) );
  392. modelDoc.graveyard.appendChildren( removed );
  393. modelDispatcher.convertRemove(
  394. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  395. ModelRange.createIn( modelDoc.graveyard )
  396. );
  397. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">oo</a></div>' );
  398. range = ModelRange.createIn( modelRoot );
  399. // Let's remove just one attribute.
  400. modelWriter.removeAttribute( range, 'linkTitle' );
  401. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkTitle', 'Bar title', null );
  402. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html">oo</a></div>' );
  403. // Let's remove the other attribute.
  404. modelWriter.removeAttribute( range, 'linkHref' );
  405. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkHref', 'bar.html', null );
  406. expect( viewToString( viewRoot ) ).to.equal( '<div>oo</div>' );
  407. } );
  408. it( 'should convert a view element to model', () => {
  409. const viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) );
  410. const modelText = viewDispatcher.convert( viewElement, { batch } ).getChild( 0 );
  411. expect( modelText ).to.be.instanceof( ModelText );
  412. expect( modelText.data ).to.equal( 'foo' );
  413. expect( modelText.getAttribute( 'linkHref' ) ).to.equal( 'foo.html' );
  414. expect( modelText.getAttribute( 'linkTitle' ) ).to.equal( 'Foo title' );
  415. } );
  416. it( 'should convert quote model element with linkHref and linkTitle attribute to view', () => {
  417. const modelElement = new ModelElement( 'quote', { linkHref: 'foo.html', linkTitle: 'Foo source' }, new ModelText( 'foo' ) );
  418. modelRoot.appendChildren( modelElement );
  419. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  420. let expected = '<div><blockquote>foo<a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  421. expect( viewToString( viewRoot ) ).to.equal( expected );
  422. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  423. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  424. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  425. modelElement.appendChildren( new ModelText( 'bar', { bold: true } ) );
  426. modelDispatcher.convertInsertion( ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 6 ) );
  427. expected = '<div><blockquote>foo<strong>bar</strong><a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  428. expect( viewToString( viewRoot ) ).to.equal( expected );
  429. modelElement.removeAttribute( 'linkTitle' );
  430. modelElement.setAttribute( 'linkHref', 'bar.html' );
  431. modelDispatcher.convertAttribute(
  432. 'removeAttribute',
  433. createRangeOnElementOnly( modelElement ),
  434. 'linkTitle',
  435. 'Foo source',
  436. null
  437. );
  438. modelDispatcher.convertAttribute(
  439. 'changeAttribute',
  440. createRangeOnElementOnly( modelElement ),
  441. 'linkHref',
  442. 'foo.html',
  443. 'bar.html'
  444. );
  445. expected = '<div><blockquote>foo<strong>bar</strong><a href="bar.html">see source</a></blockquote></div>';
  446. expect( viewToString( viewRoot ) ).to.equal( expected );
  447. modelElement.removeAttribute( 'linkHref' );
  448. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'linkHref', 'bar.html', null );
  449. expected = '<div><blockquote>foo<strong>bar</strong></blockquote></div>';
  450. expect( viewToString( viewRoot ) ).to.equal( expected );
  451. } );
  452. it( 'should convert view blockquote with a element to model', () => {
  453. const viewElement = new ViewContainerElement(
  454. 'blockquote',
  455. null,
  456. [
  457. new ViewText( 'foo' ),
  458. new ViewAttributeElement(
  459. 'a',
  460. {
  461. href: 'foo.html',
  462. title: 'Foo source'
  463. },
  464. new ViewText( 'see source' )
  465. )
  466. ]
  467. );
  468. const modelElement = viewDispatcher.convert( viewElement, { batch } );
  469. expect( modelToString( modelElement ) ).to.equal( '<quote linkHref="foo.html" linkTitle="Foo source">foo</quote>' );
  470. } );
  471. } );
  472. // Default view converter for tables that will convert table structure into paragraphs if tables are not supported.
  473. // TRs are supposed to become paragraphs and TDs content should be separated using space.
  474. it( 'default table view to model converter', () => {
  475. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  476. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  477. if ( !data.output ) {
  478. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  479. }
  480. for ( const child of data.output ) {
  481. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  482. }
  483. }
  484. } );
  485. viewDispatcher.on( 'element:tr', ( evt, data, consumable, conversionApi ) => {
  486. if ( consumable.consume( data.input, { name: true } ) ) {
  487. data.output = new ModelElement( 'paragraph' );
  488. const children = conversionApi.convertChildren( data.input, consumable, { batch } );
  489. for ( let i = 1; i < children.childCount; i++ ) {
  490. const child = children.getChild( i );
  491. if ( child instanceof ModelText && child.previousSibling instanceof ModelText ) {
  492. children.insertChildren( i, new ModelText( ' ' ) );
  493. i++;
  494. }
  495. }
  496. data.output.appendChildren( children );
  497. }
  498. } );
  499. viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => {
  500. if ( consumable.consume( data.input, { name: true } ) ) {
  501. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  502. }
  503. } );
  504. viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => {
  505. if ( consumable.consume( data.input, { name: true } ) ) {
  506. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  507. }
  508. } );
  509. const viewTable = new ViewContainerElement( 'table', null, [
  510. new ViewContainerElement( 'tr', null, [
  511. new ViewContainerElement( 'td', null, new ViewText( 'foo' ) ),
  512. new ViewContainerElement( 'td', null, new ViewAttributeElement( 'a', { href: 'bar.html' }, new ViewText( 'bar' ) ) )
  513. ] ),
  514. new ViewContainerElement( 'tr', null, [
  515. new ViewContainerElement( 'td' ),
  516. new ViewContainerElement( 'td', null, new ViewText( 'abc' ) )
  517. ] )
  518. ] );
  519. const model = viewDispatcher.convert( viewTable, { batch } );
  520. const modelFragment = new ModelDocumentFragment( model );
  521. expect( modelToString( modelFragment ) )
  522. .to.equal( '<paragraph>foo <$text linkHref="bar.html">bar</$text></paragraph><paragraph>abc</paragraph>' );
  523. } );
  524. // Model converter that converts any non-converted elements and attributes into view elements and attributes.
  525. // View converter that converts any non-converted elements and attributes into model elements and attributes.
  526. describe( 'universal converter', () => {
  527. beforeEach( () => {
  528. // "Universal" converters
  529. modelDispatcher.on( 'insert', insertElement( data => new ViewContainerElement( data.item.name ) ), { priority: 'lowest' } );
  530. modelDispatcher.on( 'addAttribute', setAttribute(), { priority: 'lowest' } );
  531. modelDispatcher.on( 'changeAttribute', setAttribute(), { priority: 'lowest' } );
  532. modelDispatcher.on( 'removeAttribute', removeAttribute(), { priority: 'lowest' } );
  533. viewDispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  534. if ( consumable.consume( data.input, { name: true } ) ) {
  535. data.output = new ModelElement( data.input.name );
  536. for ( const key of data.input.getAttributeKeys() ) {
  537. if ( consumable.consume( data.input, { attribute: key } ) ) {
  538. data.output.setAttribute( key, data.input.getAttribute( key ) );
  539. }
  540. }
  541. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, { batch } ) );
  542. }
  543. }, { priority: 'lowest' } );
  544. // "Real" converters -- added with higher priority. Should overwrite the "universal" converters.
  545. modelDispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  546. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  547. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  548. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  549. viewDispatcher.on( 'element:img', ( evt, data, consumable ) => {
  550. if ( consumable.consume( data.input, { name: true } ) ) {
  551. const modelImage = new ModelElement( 'image' );
  552. for ( const attributeKey of data.input.getAttributeKeys() ) {
  553. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  554. }
  555. data.output = modelImage;
  556. }
  557. } );
  558. viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => {
  559. if ( consumable.consume( data.input, { name: true } ) ) {
  560. if ( !data.output ) {
  561. data.output = conversionApi.convertChildren( data.input, consumable, { batch } );
  562. }
  563. for ( const child of data.output ) {
  564. child.setAttribute( 'bold', true );
  565. }
  566. }
  567. } );
  568. } );
  569. it( 'should convert model to view', () => {
  570. const modelElement = new ModelElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  571. new ModelElement( 'tr', null, [
  572. new ModelElement( 'td', null, [
  573. new ModelText( 'foo ' ),
  574. new ModelText( 'abc', { bold: true } ),
  575. new ModelText( ' bar' )
  576. ] ),
  577. new ModelElement( 'td', null, [
  578. new ModelElement( 'foo', { foo: 'bar' }, new ModelText( 'bar' ) )
  579. ] )
  580. ] )
  581. ] );
  582. modelRoot.appendChildren( modelElement );
  583. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  584. expect( viewToString( viewRoot ) ).to.equal(
  585. '<div>' +
  586. '<table cellpadding="5" cellspacing="5">' +
  587. '<tr>' +
  588. '<td>foo <strong>abc</strong> bar</td>' +
  589. '<td><foo foo="bar">bar</foo></td>' +
  590. '</tr>' +
  591. '</table>' +
  592. '</div>'
  593. );
  594. } );
  595. it( 'should convert view to model', () => {
  596. const viewElement = new ViewContainerElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  597. new ViewContainerElement( 'tr', null, [
  598. new ViewContainerElement( 'td', null, [
  599. new ViewText( 'foo ' ),
  600. new ViewAttributeElement( 'strong', null, new ViewText( 'abc' ) ),
  601. new ViewText( ' bar' )
  602. ] ),
  603. new ViewContainerElement( 'td', null, new ViewContainerElement( 'foo', { foo: 'bar' }, new ViewText( 'bar' ) ) )
  604. ] )
  605. ] );
  606. const modelElement = viewDispatcher.convert( viewElement, { batch } );
  607. expect( modelToString( modelElement ) ).to.equal(
  608. '<table cellpadding="5" cellspacing="5">' +
  609. '<tr>' +
  610. '<td>foo <$text bold="true">abc</$text> bar</td>' +
  611. '<td><foo foo="bar">bar</foo></td>' +
  612. '</tr>' +
  613. '</table>'
  614. );
  615. } );
  616. } );
  617. } );