8
0

advanced-converters.js 28 KB

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