advanced-converters.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  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. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"></image>' );
  231. } );
  232. it( 'should convert view figure to model', () => {
  233. const viewElement = new ViewContainerElement(
  234. 'figure',
  235. null,
  236. [
  237. new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ),
  238. new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) )
  239. ]
  240. );
  241. const modelElement = viewDispatcher.convert( viewElement );
  242. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"><caption>foobar</caption></image>' );
  243. } );
  244. } );
  245. // Converter overwrites default attribute converter for `linkHref` and `linkTitle` attribute is set on `quote` element.
  246. //
  247. // Model:
  248. //
  249. // [quote {linkHref='foo.html' linkTitle='Foo source'}]
  250. // ├─ f
  251. // ├─ o
  252. // └─ o
  253. //
  254. // foo {linkHref='foo.html' linkTitle='Foo title'}
  255. //
  256. // View:
  257. //
  258. // <blockquote>
  259. // ├─ foo
  260. // └─ <a href="foo.html" title="Foo source">
  261. // └─ see source
  262. //
  263. // <a href="foo.html" title="Foo title">
  264. // └─ foo
  265. describe( 'custom attribute handling for given element', () => {
  266. beforeEach( () => {
  267. // NORMAL LINK MODEL TO VIEW CONVERTERS
  268. modelDispatcher.on( 'addAttribute:linkHref', wrapItem( value => new ViewAttributeElement( 'a', { href: value } ) ) );
  269. modelDispatcher.on( 'addAttribute:linkTitle', wrapItem( value => new ViewAttributeElement( 'a', { title: value } ) ) );
  270. const changeLinkAttribute = function( elementCreator ) {
  271. return ( evt, data, consumable, conversionApi ) => {
  272. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  273. const viewRange = conversionApi.mapper.toViewRange( data.range );
  274. const viewOldA = elementCreator( data.attributeOldValue );
  275. const viewNewA = elementCreator( data.attributeNewValue );
  276. viewWriter.unwrap( viewRange, viewOldA, evt.priority );
  277. viewWriter.wrap( viewRange, viewNewA, evt.priority );
  278. evt.stop();
  279. };
  280. };
  281. modelDispatcher.on(
  282. 'changeAttribute:linkHref',
  283. changeLinkAttribute( value => new ViewAttributeElement( 'a', { href: value } ) )
  284. );
  285. modelDispatcher.on(
  286. 'changeAttribute:linkTitle',
  287. changeLinkAttribute( value => new ViewAttributeElement( 'a', { title: value } ) )
  288. );
  289. modelDispatcher.on(
  290. 'removeAttribute:linkHref',
  291. unwrapItem( value => new ViewAttributeElement( 'a', { href: value } ) )
  292. );
  293. modelDispatcher.on(
  294. 'removeAttribute:linkTitle',
  295. unwrapItem( value => new ViewAttributeElement( 'a', { title: value } ) )
  296. );
  297. // NORMAL LINK VIEW TO MODEL CONVERTERS
  298. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  299. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  300. if ( !data.output ) {
  301. data.output = conversionApi.convertChildren( data.input, consumable );
  302. }
  303. for ( const child of data.output ) {
  304. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  305. }
  306. }
  307. } );
  308. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  309. if ( consumable.consume( data.input, { attribute: 'title' } ) ) {
  310. if ( !data.output ) {
  311. data.output = conversionApi.convertChildren( data.input, consumable );
  312. }
  313. for ( const child of data.output ) {
  314. child.setAttribute( 'linkTitle', data.input.getAttribute( 'title' ) );
  315. }
  316. }
  317. } );
  318. // QUOTE MODEL TO VIEW CONVERTERS
  319. modelDispatcher.on( 'insert:quote', ( evt, data, consumable, conversionApi ) => {
  320. consumable.consume( data.item, 'insert' );
  321. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  322. const viewElement = new ViewContainerElement( 'blockquote' );
  323. conversionApi.mapper.bindElements( data.item, viewElement );
  324. viewWriter.insert( viewPosition, viewElement );
  325. if ( consumable.consume( data.item, 'addAttribute:linkHref' ) ) {
  326. const viewA = new ViewAttributeElement(
  327. 'a', { href: data.item.getAttribute( 'linkHref' ) }, new ViewText( 'see source' )
  328. );
  329. if ( consumable.consume( data.item, 'addAttribute:linkTitle' ) ) {
  330. viewA.setAttribute( 'title', data.item.getAttribute( 'linkTitle' ) );
  331. }
  332. viewWriter.insert( new ViewPosition( viewElement, viewElement.childCount ), viewA );
  333. }
  334. evt.stop();
  335. }, { priority: 'high' } );
  336. const modelChangeLinkAttrQuoteConverter = function( evt, data, consumable, conversionApi ) {
  337. const viewKey = data.attributeKey.substr( 4 ).toLowerCase();
  338. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  339. const viewElement = conversionApi.mapper.toViewElement( data.item );
  340. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  341. if ( data.attributeNewValue !== null ) {
  342. viewA.setAttribute( viewKey, data.attributeNewValue );
  343. } else {
  344. viewA.removeAttribute( viewKey );
  345. }
  346. evt.stop();
  347. };
  348. modelDispatcher.on( 'changeAttribute:linkHref:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  349. modelDispatcher.on( 'changeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  350. modelDispatcher.on( 'removeAttribute:linkHref:quote', ( evt, data, consumable, conversionApi ) => {
  351. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  352. const viewElement = conversionApi.mapper.toViewElement( data.item );
  353. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  354. const aIndex = viewA.index;
  355. viewWriter.remove( ViewRange.createFromParentsAndOffsets( viewElement, aIndex, viewElement, aIndex + 1 ) );
  356. evt.stop();
  357. }, { priority: 'high' } );
  358. modelDispatcher.on( 'removeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  359. // QUOTE VIEW TO MODEL CONVERTERS
  360. viewDispatcher.on( 'element:blockquote', ( evt, data, consumable, conversionApi ) => {
  361. if ( consumable.consume( data.input, { name: true } ) ) {
  362. data.output = new ModelElement( 'quote' );
  363. const viewA = data.input.getChild( data.input.childCount - 1 );
  364. // Convert the special "a" first, before converting all children.
  365. if ( viewA instanceof ViewElement && viewA.name == 'a' && consumable.consume( viewA, { name: true } ) ) {
  366. if ( consumable.consume( viewA, { attribute: 'href' } ) ) {
  367. data.output.setAttribute( 'linkHref', viewA.getAttribute( 'href' ) );
  368. }
  369. if ( consumable.consume( viewA, { attribute: 'title' } ) ) {
  370. data.output.setAttribute( 'linkTitle', viewA.getAttribute( 'title' ) );
  371. }
  372. }
  373. const children = conversionApi.convertChildren( data.input, consumable );
  374. data.output.appendChildren( children );
  375. }
  376. } );
  377. } );
  378. it( 'should convert model text with linkHref and linkTitle to view', () => {
  379. const modelText = new ModelText( 'foo', { linkHref: 'foo.html', linkTitle: 'Foo title' } );
  380. modelRoot.appendChildren( modelText );
  381. let range = ModelRange.createIn( modelRoot );
  382. modelDispatcher.convertInsertion( range );
  383. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="foo.html" title="Foo title">foo</a></div>' );
  384. // Let's change link's attributes.
  385. modelWriter.setAttribute( range, 'linkHref', 'bar.html' );
  386. modelWriter.setAttribute( range, 'linkTitle', 'Bar title' );
  387. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkHref', 'foo.html', 'bar.html' );
  388. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkTitle', 'Foo title', 'Bar title' );
  389. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">foo</a></div>' );
  390. const removed = modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) );
  391. modelDoc.graveyard.appendChildren( removed );
  392. modelDispatcher.convertRemove(
  393. ModelPosition.createFromParentAndOffset( modelRoot, 0 ),
  394. ModelRange.createIn( modelDoc.graveyard )
  395. );
  396. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">oo</a></div>' );
  397. range = ModelRange.createIn( modelRoot );
  398. // Let's remove just one attribute.
  399. modelWriter.removeAttribute( range, 'linkTitle' );
  400. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkTitle', 'Bar title', null );
  401. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html">oo</a></div>' );
  402. // Let's remove the other attribute.
  403. modelWriter.removeAttribute( range, 'linkHref' );
  404. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkHref', 'bar.html', null );
  405. expect( viewToString( viewRoot ) ).to.equal( '<div>oo</div>' );
  406. } );
  407. it( 'should convert a view element to model', () => {
  408. const viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) );
  409. const modelText = viewDispatcher.convert( viewElement ).getChild( 0 );
  410. expect( modelText ).to.be.instanceof( ModelText );
  411. expect( modelText.data ).to.equal( 'foo' );
  412. expect( modelText.getAttribute( 'linkHref' ) ).to.equal( 'foo.html' );
  413. expect( modelText.getAttribute( 'linkTitle' ) ).to.equal( 'Foo title' );
  414. } );
  415. it( 'should convert quote model element with linkHref and linkTitle attribute to view', () => {
  416. const modelElement = new ModelElement( 'quote', { linkHref: 'foo.html', linkTitle: 'Foo source' }, new ModelText( 'foo' ) );
  417. modelRoot.appendChildren( modelElement );
  418. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  419. let expected = '<div><blockquote>foo<a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  420. expect( viewToString( viewRoot ) ).to.equal( expected );
  421. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  422. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  423. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  424. modelElement.appendChildren( new ModelText( 'bar', { bold: true } ) );
  425. modelDispatcher.convertInsertion( ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 6 ) );
  426. expected = '<div><blockquote>foo<strong>bar</strong><a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  427. expect( viewToString( viewRoot ) ).to.equal( expected );
  428. modelElement.removeAttribute( 'linkTitle' );
  429. modelElement.setAttribute( 'linkHref', 'bar.html' );
  430. modelDispatcher.convertAttribute(
  431. 'removeAttribute',
  432. createRangeOnElementOnly( modelElement ),
  433. 'linkTitle',
  434. 'Foo source',
  435. null
  436. );
  437. modelDispatcher.convertAttribute(
  438. 'changeAttribute',
  439. createRangeOnElementOnly( modelElement ),
  440. 'linkHref',
  441. 'foo.html',
  442. 'bar.html'
  443. );
  444. expected = '<div><blockquote>foo<strong>bar</strong><a href="bar.html">see source</a></blockquote></div>';
  445. expect( viewToString( viewRoot ) ).to.equal( expected );
  446. modelElement.removeAttribute( 'linkHref' );
  447. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'linkHref', 'bar.html', null );
  448. expected = '<div><blockquote>foo<strong>bar</strong></blockquote></div>';
  449. expect( viewToString( viewRoot ) ).to.equal( expected );
  450. } );
  451. it( 'should convert view blockquote with a element to model', () => {
  452. const viewElement = new ViewContainerElement(
  453. 'blockquote',
  454. null,
  455. [
  456. new ViewText( 'foo' ),
  457. new ViewAttributeElement(
  458. 'a',
  459. {
  460. href: 'foo.html',
  461. title: 'Foo source'
  462. },
  463. new ViewText( 'see source' )
  464. )
  465. ]
  466. );
  467. const modelElement = viewDispatcher.convert( viewElement );
  468. expect( modelToString( modelElement ) ).to.equal( '<quote linkHref="foo.html" linkTitle="Foo source">foo</quote>' );
  469. } );
  470. } );
  471. // Default view converter for tables that will convert table structure into paragraphs if tables are not supported.
  472. // TRs are supposed to become paragraphs and TDs content should be separated using space.
  473. it( 'default table view to model converter', () => {
  474. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  475. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  476. if ( !data.output ) {
  477. data.output = conversionApi.convertChildren( data.input, consumable );
  478. }
  479. for ( const child of data.output ) {
  480. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  481. }
  482. }
  483. } );
  484. viewDispatcher.on( 'element:tr', ( evt, data, consumable, conversionApi ) => {
  485. if ( consumable.consume( data.input, { name: true } ) ) {
  486. data.output = new ModelElement( 'paragraph' );
  487. const children = conversionApi.convertChildren( data.input, consumable );
  488. for ( let i = 1; i < children.childCount; i++ ) {
  489. const child = children.getChild( i );
  490. if ( child instanceof ModelText && child.previousSibling instanceof ModelText ) {
  491. children.insertChildren( i, new ModelText( ' ' ) );
  492. i++;
  493. }
  494. }
  495. data.output.appendChildren( children );
  496. }
  497. } );
  498. viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => {
  499. if ( consumable.consume( data.input, { name: true } ) ) {
  500. data.output = conversionApi.convertChildren( data.input, consumable );
  501. }
  502. } );
  503. viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => {
  504. if ( consumable.consume( data.input, { name: true } ) ) {
  505. data.output = conversionApi.convertChildren( data.input, consumable );
  506. }
  507. } );
  508. const viewTable = new ViewContainerElement( 'table', null, [
  509. new ViewContainerElement( 'tr', null, [
  510. new ViewContainerElement( 'td', null, new ViewText( 'foo' ) ),
  511. new ViewContainerElement( 'td', null, new ViewAttributeElement( 'a', { href: 'bar.html' }, new ViewText( 'bar' ) ) )
  512. ] ),
  513. new ViewContainerElement( 'tr', null, [
  514. new ViewContainerElement( 'td' ),
  515. new ViewContainerElement( 'td', null, new ViewText( 'abc' ) )
  516. ] )
  517. ] );
  518. const model = viewDispatcher.convert( viewTable );
  519. const modelFragment = new ModelDocumentFragment( model );
  520. expect( modelToString( modelFragment ) )
  521. .to.equal( '<paragraph>foo <$text linkHref="bar.html">bar</$text></paragraph><paragraph>abc</paragraph>' );
  522. } );
  523. // Model converter that converts any non-converted elements and attributes into view elements and attributes.
  524. // View converter that converts any non-converted elements and attributes into model elements and attributes.
  525. describe( 'universal converter', () => {
  526. beforeEach( () => {
  527. // "Universal" converters
  528. modelDispatcher.on( 'insert', insertElement( data => new ViewContainerElement( data.item.name ) ), { priority: 'lowest' } );
  529. modelDispatcher.on( 'addAttribute', setAttribute(), { priority: 'lowest' } );
  530. modelDispatcher.on( 'changeAttribute', setAttribute(), { priority: 'lowest' } );
  531. modelDispatcher.on( 'removeAttribute', removeAttribute(), { priority: 'lowest' } );
  532. viewDispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  533. if ( consumable.consume( data.input, { name: true } ) ) {
  534. data.output = new ModelElement( data.input.name );
  535. for ( const key of data.input.getAttributeKeys() ) {
  536. if ( consumable.consume( data.input, { attribute: key } ) ) {
  537. data.output.setAttribute( key, data.input.getAttribute( key ) );
  538. }
  539. }
  540. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) );
  541. }
  542. }, { priority: 'lowest' } );
  543. // "Real" converters -- added with higher priority. Should overwrite the "universal" converters.
  544. modelDispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  545. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  546. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  547. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  548. viewDispatcher.on( 'element:img', ( evt, data, consumable ) => {
  549. if ( consumable.consume( data.input, { name: true } ) ) {
  550. const modelImage = new ModelElement( 'image' );
  551. for ( const attributeKey of data.input.getAttributeKeys() ) {
  552. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  553. }
  554. data.output = modelImage;
  555. }
  556. } );
  557. viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => {
  558. if ( consumable.consume( data.input, { name: true } ) ) {
  559. if ( !data.output ) {
  560. data.output = conversionApi.convertChildren( data.input, consumable );
  561. }
  562. for ( const child of data.output ) {
  563. child.setAttribute( 'bold', true );
  564. }
  565. }
  566. } );
  567. } );
  568. it( 'should convert model to view', () => {
  569. const modelElement = new ModelElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  570. new ModelElement( 'tr', null, [
  571. new ModelElement( 'td', null, [
  572. new ModelText( 'foo ' ),
  573. new ModelText( 'abc', { bold: true } ),
  574. new ModelText( ' bar' )
  575. ] ),
  576. new ModelElement( 'td', null, [
  577. new ModelElement( 'foo', { foo: 'bar' }, new ModelText( 'bar' ) )
  578. ] )
  579. ] )
  580. ] );
  581. modelRoot.appendChildren( modelElement );
  582. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  583. expect( viewToString( viewRoot ) ).to.equal(
  584. '<div>' +
  585. '<table cellpadding="5" cellspacing="5">' +
  586. '<tr>' +
  587. '<td>foo <strong>abc</strong> bar</td>' +
  588. '<td><foo foo="bar">bar</foo></td>' +
  589. '</tr>' +
  590. '</table>' +
  591. '</div>'
  592. );
  593. } );
  594. it( 'should convert view to model', () => {
  595. const viewElement = new ViewContainerElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  596. new ViewContainerElement( 'tr', null, [
  597. new ViewContainerElement( 'td', null, [
  598. new ViewText( 'foo ' ),
  599. new ViewAttributeElement( 'strong', null, new ViewText( 'abc' ) ),
  600. new ViewText( ' bar' )
  601. ] ),
  602. new ViewContainerElement( 'td', null, new ViewContainerElement( 'foo', { foo: 'bar' }, new ViewText( 'bar' ) ) )
  603. ] )
  604. ] );
  605. const modelElement = viewDispatcher.convert( viewElement );
  606. expect( modelToString( modelElement ) ).to.equal(
  607. '<table cellpadding="5" cellspacing="5">' +
  608. '<tr>' +
  609. '<td>foo <$text bold="true">abc</$text> bar</td>' +
  610. '<td><foo foo="bar">bar</foo></td>' +
  611. '</tr>' +
  612. '</table>'
  613. );
  614. } );
  615. } );
  616. } );