advanced-converters.js 28 KB

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