advanced-converters.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  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 ModelWriter from '../../src/model/writer';
  13. import Batch from '../../src/model/batch';
  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 model, modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher, modelWriter;
  38. beforeEach( () => {
  39. model = new Model();
  40. modelDoc = model.document;
  41. modelRoot = modelDoc.createRoot();
  42. viewRoot = new ViewContainerElement( 'div' );
  43. mapper = new Mapper();
  44. mapper.bindElements( modelRoot, viewRoot );
  45. modelDispatcher = new ModelConversionDispatcher( model, { mapper } );
  46. // Schema is mocked up because we don't care about it in those tests.
  47. viewDispatcher = new ViewConversionDispatcher( model, { schema: { check: () => true } } );
  48. modelDispatcher.on( 'insert:$text', insertText() );
  49. modelDispatcher.on( 'remove', remove() );
  50. viewDispatcher.on( 'text', convertText() );
  51. viewDispatcher.on( 'documentFragment', convertToModelFragment() );
  52. // We need to create a model writer to modify model tree in tests.
  53. modelWriter = new ModelWriter( model, new Batch() );
  54. } );
  55. function viewAttributesToString( item ) {
  56. let result = '';
  57. for ( const key of item.getAttributeKeys() ) {
  58. const value = item.getAttribute( key );
  59. if ( value ) {
  60. result += ' ' + key + '="' + value + '"';
  61. }
  62. }
  63. return result;
  64. }
  65. function viewToString( item ) {
  66. let result = '';
  67. if ( item instanceof ViewText ) {
  68. result = item.data;
  69. } else {
  70. // ViewElement or ViewDocumentFragment.
  71. for ( const child of item.getChildren() ) {
  72. result += viewToString( child );
  73. }
  74. if ( item instanceof ViewElement ) {
  75. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  76. }
  77. }
  78. return result;
  79. }
  80. function modelAttributesToString( item ) {
  81. let result = '';
  82. for ( const attr of item.getAttributes() ) {
  83. result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"';
  84. }
  85. return result;
  86. }
  87. function modelToString( item ) {
  88. let result = '';
  89. if ( item instanceof ModelTextProxy ) {
  90. const attributes = modelAttributesToString( item );
  91. result = attributes ? '<$text' + attributes + '>' + item.data + '</$text>' : item.data;
  92. } else {
  93. const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } );
  94. for ( const value of walker ) {
  95. result += modelToString( value.item );
  96. }
  97. if ( item instanceof ModelElement ) {
  98. const attributes = modelAttributesToString( item );
  99. result = '<' + item.name + attributes + '>' + result + '</' + item.name + '>';
  100. }
  101. }
  102. return result;
  103. }
  104. // Converter for custom `image` element that might have a `caption` element inside which changes
  105. // how the image is displayed in the view:
  106. //
  107. // Model:
  108. //
  109. // [image {src="foo.jpg" title="foo"}]
  110. // └─ [caption]
  111. // ├─ f
  112. // ├─ o
  113. // └─ o
  114. //
  115. // [image {src="bar.jpg" title="bar"}]
  116. //
  117. // View:
  118. //
  119. // <figure>
  120. // ├─ <img src="foo.jpg" title="foo" />
  121. // └─ <caption>
  122. // └─ foo
  123. //
  124. // <img src="bar.jpg" title="bar" />
  125. describe( 'image with caption converters', () => {
  126. beforeEach( () => {
  127. const modelImageConverter = function( evt, data, consumable, conversionApi ) {
  128. // First, consume the `image` element.
  129. consumable.consume( data.item, 'insert' );
  130. // Just create normal image element for the view.
  131. // Maybe it will be "decorated" later.
  132. const viewImage = new ViewContainerElement( 'img' );
  133. const insertPosition = conversionApi.mapper.toViewPosition( data.range.start );
  134. // Check if the `image` element has children.
  135. if ( data.item.childCount > 0 ) {
  136. const modelCaption = data.item.getChild( 0 );
  137. // `modelCaption` insertion change is consumed from consumable values.
  138. // It will not be converted by other converters, but it's children (probably some text) will be.
  139. // Through mapping, converters for text will know where to insert contents of `modelCaption`.
  140. if ( consumable.consume( modelCaption, 'insert' ) ) {
  141. const viewCaption = new ViewContainerElement( 'figcaption' );
  142. const viewImageHolder = new ViewContainerElement( 'figure', null, [ viewImage, viewCaption ] );
  143. conversionApi.mapper.bindElements( modelCaption, viewCaption );
  144. conversionApi.mapper.bindElements( data.item, viewImageHolder );
  145. viewWriter.insert( insertPosition, viewImageHolder );
  146. }
  147. } else {
  148. conversionApi.mapper.bindElements( data.item, viewImage );
  149. viewWriter.insert( insertPosition, viewImage );
  150. }
  151. evt.stop();
  152. };
  153. const modelImageAttributesConverter = function( evt, data, consumable, conversionApi ) {
  154. if ( data.item.name != 'image' ) {
  155. return;
  156. }
  157. let viewElement = conversionApi.mapper.toViewElement( data.item );
  158. if ( viewElement.name == 'figure' ) {
  159. viewElement = viewElement.getChild( 0 );
  160. }
  161. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  162. if ( !data.attributeNewValue ) {
  163. viewElement.removeAttribute( data.attributeKey );
  164. } else {
  165. viewElement.setAttribute( data.attributeKey, data.attributeNewValue );
  166. }
  167. evt.stop();
  168. };
  169. const viewFigureConverter = function( evt, data, consumable, conversionApi ) {
  170. if ( consumable.consume( data.input, { name: true } ) ) {
  171. const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable );
  172. const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable );
  173. modelImage.appendChildren( modelCaption );
  174. data.output = modelImage;
  175. }
  176. };
  177. const viewImageConverter = function( evt, data, consumable, conversionApi ) {
  178. if ( consumable.consume( data.input, { name: true } ) ) {
  179. data.output = conversionApi.writer.createElement( 'image', data.input.getAttributes() );
  180. }
  181. };
  182. const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) {
  183. if ( consumable.consume( data.input, { name: true } ) ) {
  184. const modelCaption = conversionApi.writer.createElement( 'caption' );
  185. const children = conversionApi.convertChildren( data.input, consumable );
  186. conversionApi.writer.append( children, modelCaption );
  187. data.output = modelCaption;
  188. }
  189. };
  190. modelDispatcher.on( 'insert:image', modelImageConverter );
  191. modelDispatcher.on( 'addAttribute', modelImageAttributesConverter );
  192. modelDispatcher.on( 'changeAttribute', modelImageAttributesConverter );
  193. modelDispatcher.on( 'removeAttribute', modelImageAttributesConverter );
  194. viewDispatcher.on( 'element:figure', viewFigureConverter );
  195. viewDispatcher.on( 'element:img', viewImageConverter );
  196. viewDispatcher.on( 'element:figcaption', viewFigcaptionConverter );
  197. } );
  198. it( 'should convert model images changes without caption to view', () => {
  199. const modelElement = new ModelElement( 'image', { src: 'bar.jpg', title: 'bar' } );
  200. modelRoot.appendChildren( modelElement );
  201. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><img src="bar.jpg" title="bar"></img></div>' );
  203. modelElement.setAttribute( 'src', 'new.jpg' );
  204. modelElement.removeAttribute( 'title' );
  205. modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  206. modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null );
  207. expect( viewToString( viewRoot ) ).to.equal( '<div><img src="new.jpg"></img></div>' );
  208. } );
  209. it( 'should convert model images changes with caption to view', () => {
  210. const modelElement = new ModelElement( 'image', { src: 'foo.jpg', title: 'foo' }, [
  211. new ModelElement( 'caption', {}, new ModelText( 'foobar' ) )
  212. ] );
  213. modelRoot.appendChildren( [ modelElement ] );
  214. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  215. expect( viewToString( viewRoot ) ).to.equal(
  216. '<div><figure><img src="foo.jpg" title="foo"></img><figcaption>foobar</figcaption></figure></div>'
  217. );
  218. modelElement.setAttribute( 'src', 'new.jpg' );
  219. modelElement.removeAttribute( 'title' );
  220. modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  221. modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null );
  222. expect( viewToString( viewRoot ) ).to.equal(
  223. '<div><figure><img src="new.jpg"></img><figcaption>foobar</figcaption></figure></div>'
  224. );
  225. } );
  226. it( 'should convert view image to model', () => {
  227. const viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } );
  228. const modelElement = viewDispatcher.convert( viewElement );
  229. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"></image>' );
  230. } );
  231. it( 'should convert view figure to model', () => {
  232. const viewElement = new ViewContainerElement(
  233. 'figure',
  234. null,
  235. [
  236. new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ),
  237. new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) )
  238. ]
  239. );
  240. const modelElement = viewDispatcher.convert( viewElement );
  241. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"><caption>foobar</caption></image>' );
  242. } );
  243. } );
  244. // Converter overwrites default attribute converter for `linkHref` and `linkTitle` attribute is set on `quote` element.
  245. //
  246. // Model:
  247. //
  248. // [quote {linkHref='foo.html' linkTitle='Foo source'}]
  249. // ├─ f
  250. // ├─ o
  251. // └─ o
  252. //
  253. // foo {linkHref='foo.html' linkTitle='Foo title'}
  254. //
  255. // View:
  256. //
  257. // <blockquote>
  258. // ├─ foo
  259. // └─ <a href="foo.html" title="Foo source">
  260. // └─ see source
  261. //
  262. // <a href="foo.html" title="Foo title">
  263. // └─ foo
  264. describe( 'custom attribute handling for given element', () => {
  265. beforeEach( () => {
  266. // NORMAL LINK MODEL TO VIEW CONVERTERS
  267. modelDispatcher.on( 'addAttribute:linkHref', wrapItem( value => new ViewAttributeElement( 'a', { href: value } ) ) );
  268. modelDispatcher.on( 'addAttribute:linkTitle', wrapItem( value => new ViewAttributeElement( 'a', { title: value } ) ) );
  269. const changeLinkAttribute = function( elementCreator ) {
  270. return ( evt, data, consumable, conversionApi ) => {
  271. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  272. const viewRange = conversionApi.mapper.toViewRange( data.range );
  273. const viewOldA = elementCreator( data.attributeOldValue );
  274. const viewNewA = elementCreator( data.attributeNewValue );
  275. viewWriter.unwrap( viewRange, viewOldA, evt.priority );
  276. viewWriter.wrap( viewRange, viewNewA, evt.priority );
  277. evt.stop();
  278. };
  279. };
  280. modelDispatcher.on(
  281. 'changeAttribute:linkHref',
  282. changeLinkAttribute( value => new ViewAttributeElement( 'a', { href: value } ) )
  283. );
  284. modelDispatcher.on(
  285. 'changeAttribute:linkTitle',
  286. changeLinkAttribute( value => new ViewAttributeElement( 'a', { title: value } ) )
  287. );
  288. modelDispatcher.on(
  289. 'removeAttribute:linkHref',
  290. unwrapItem( value => new ViewAttributeElement( 'a', { href: value } ) )
  291. );
  292. modelDispatcher.on(
  293. 'removeAttribute:linkTitle',
  294. unwrapItem( value => new ViewAttributeElement( 'a', { title: value } ) )
  295. );
  296. // NORMAL LINK VIEW TO MODEL CONVERTERS
  297. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  298. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  299. if ( !data.output ) {
  300. data.output = conversionApi.convertChildren( data.input, consumable );
  301. }
  302. for ( const child of data.output ) {
  303. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  304. }
  305. }
  306. } );
  307. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  308. if ( consumable.consume( data.input, { attribute: 'title' } ) ) {
  309. if ( !data.output ) {
  310. data.output = conversionApi.convertChildren( data.input, consumable );
  311. }
  312. for ( const child of data.output ) {
  313. child.setAttribute( 'linkTitle', data.input.getAttribute( 'title' ) );
  314. }
  315. }
  316. } );
  317. // QUOTE MODEL TO VIEW CONVERTERS
  318. modelDispatcher.on( 'insert:quote', ( evt, data, consumable, conversionApi ) => {
  319. consumable.consume( data.item, 'insert' );
  320. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  321. const viewElement = new ViewContainerElement( 'blockquote' );
  322. conversionApi.mapper.bindElements( data.item, viewElement );
  323. viewWriter.insert( viewPosition, viewElement );
  324. if ( consumable.consume( data.item, 'addAttribute:linkHref' ) ) {
  325. const viewA = new ViewAttributeElement(
  326. 'a', { href: data.item.getAttribute( 'linkHref' ) }, new ViewText( 'see source' )
  327. );
  328. if ( consumable.consume( data.item, 'addAttribute:linkTitle' ) ) {
  329. viewA.setAttribute( 'title', data.item.getAttribute( 'linkTitle' ) );
  330. }
  331. viewWriter.insert( new ViewPosition( viewElement, viewElement.childCount ), viewA );
  332. }
  333. evt.stop();
  334. }, { priority: 'high' } );
  335. const modelChangeLinkAttrQuoteConverter = function( evt, data, consumable, conversionApi ) {
  336. const viewKey = data.attributeKey.substr( 4 ).toLowerCase();
  337. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  338. const viewElement = conversionApi.mapper.toViewElement( data.item );
  339. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  340. if ( data.attributeNewValue !== null ) {
  341. viewA.setAttribute( viewKey, data.attributeNewValue );
  342. } else {
  343. viewA.removeAttribute( viewKey );
  344. }
  345. evt.stop();
  346. };
  347. modelDispatcher.on( 'changeAttribute:linkHref:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  348. modelDispatcher.on( 'changeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  349. modelDispatcher.on( 'removeAttribute:linkHref:quote', ( evt, data, consumable, conversionApi ) => {
  350. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  351. const viewElement = conversionApi.mapper.toViewElement( data.item );
  352. const viewA = viewElement.getChild( viewElement.childCount - 1 );
  353. const aIndex = viewA.index;
  354. viewWriter.remove( ViewRange.createFromParentsAndOffsets( viewElement, aIndex, viewElement, aIndex + 1 ) );
  355. evt.stop();
  356. }, { priority: 'high' } );
  357. modelDispatcher.on( 'removeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter, { priority: 'high' } );
  358. // QUOTE VIEW TO MODEL CONVERTERS
  359. viewDispatcher.on( 'element:blockquote', ( evt, data, consumable, conversionApi ) => {
  360. if ( consumable.consume( data.input, { name: true } ) ) {
  361. data.output = new ModelElement( 'quote' );
  362. const viewA = data.input.getChild( data.input.childCount - 1 );
  363. // Convert the special "a" first, before converting all children.
  364. if ( viewA instanceof ViewElement && viewA.name == 'a' && consumable.consume( viewA, { name: true } ) ) {
  365. if ( consumable.consume( viewA, { attribute: 'href' } ) ) {
  366. data.output.setAttribute( 'linkHref', viewA.getAttribute( 'href' ) );
  367. }
  368. if ( consumable.consume( viewA, { attribute: 'title' } ) ) {
  369. data.output.setAttribute( 'linkTitle', viewA.getAttribute( 'title' ) );
  370. }
  371. }
  372. const children = conversionApi.convertChildren( data.input, consumable );
  373. data.output.appendChildren( children );
  374. }
  375. } );
  376. } );
  377. it( 'should convert model text with linkHref and linkTitle to view', () => {
  378. const modelText = new ModelText( 'foo', { linkHref: 'foo.html', linkTitle: 'Foo title' } );
  379. modelRoot.appendChildren( modelText );
  380. let range = ModelRange.createIn( modelRoot );
  381. modelDispatcher.convertInsertion( range );
  382. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="foo.html" title="Foo title">foo</a></div>' );
  383. // Let's change link's attributes.
  384. modelWriter.setAttributes( {
  385. linkHref: 'bar.html',
  386. linkTitle: 'Bar title'
  387. }, range );
  388. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkHref', 'foo.html', 'bar.html' );
  389. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkTitle', 'Foo title', 'Bar title' );
  390. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">foo</a></div>' );
  391. modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) );
  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( 'linkTitle', range );
  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( 'linkHref', range );
  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. expect( modelToString( viewDispatcher.convert( viewTable ) ) )
  519. .to.equal( '<paragraph>foo <$text linkHref="bar.html">bar</$text></paragraph><paragraph>abc</paragraph>' );
  520. } );
  521. // Model converter that converts any non-converted elements and attributes into view elements and attributes.
  522. // View converter that converts any non-converted elements and attributes into model elements and attributes.
  523. describe( 'universal converter', () => {
  524. beforeEach( () => {
  525. // "Universal" converters
  526. modelDispatcher.on( 'insert', insertElement( data => new ViewContainerElement( data.item.name ) ), { priority: 'lowest' } );
  527. modelDispatcher.on( 'addAttribute', setAttribute(), { priority: 'lowest' } );
  528. modelDispatcher.on( 'changeAttribute', setAttribute(), { priority: 'lowest' } );
  529. modelDispatcher.on( 'removeAttribute', removeAttribute(), { priority: 'lowest' } );
  530. viewDispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  531. if ( consumable.consume( data.input, { name: true } ) ) {
  532. data.output = new ModelElement( data.input.name );
  533. for ( const key of data.input.getAttributeKeys() ) {
  534. if ( consumable.consume( data.input, { attribute: key } ) ) {
  535. data.output.setAttribute( key, data.input.getAttribute( key ) );
  536. }
  537. }
  538. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) );
  539. }
  540. }, { priority: 'lowest' } );
  541. // "Real" converters -- added with higher priority. Should overwrite the "universal" converters.
  542. modelDispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  543. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  544. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  545. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  546. viewDispatcher.on( 'element:img', ( evt, data, consumable ) => {
  547. if ( consumable.consume( data.input, { name: true } ) ) {
  548. const modelImage = new ModelElement( 'image' );
  549. for ( const attributeKey of data.input.getAttributeKeys() ) {
  550. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  551. }
  552. data.output = modelImage;
  553. }
  554. } );
  555. viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => {
  556. if ( consumable.consume( data.input, { name: true } ) ) {
  557. if ( !data.output ) {
  558. data.output = conversionApi.convertChildren( data.input, consumable );
  559. }
  560. for ( const child of data.output ) {
  561. child.setAttribute( 'bold', true );
  562. }
  563. }
  564. } );
  565. } );
  566. it( 'should convert model to view', () => {
  567. const modelElement = new ModelElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  568. new ModelElement( 'tr', null, [
  569. new ModelElement( 'td', null, [
  570. new ModelText( 'foo ' ),
  571. new ModelText( 'abc', { bold: true } ),
  572. new ModelText( ' bar' )
  573. ] ),
  574. new ModelElement( 'td', null, [
  575. new ModelElement( 'foo', { foo: 'bar' }, new ModelText( 'bar' ) )
  576. ] )
  577. ] )
  578. ] );
  579. modelRoot.appendChildren( modelElement );
  580. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  581. expect( viewToString( viewRoot ) ).to.equal(
  582. '<div>' +
  583. '<table cellpadding="5" cellspacing="5">' +
  584. '<tr>' +
  585. '<td>foo <strong>abc</strong> bar</td>' +
  586. '<td><foo foo="bar">bar</foo></td>' +
  587. '</tr>' +
  588. '</table>' +
  589. '</div>'
  590. );
  591. } );
  592. it( 'should convert view to model', () => {
  593. const viewElement = new ViewContainerElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  594. new ViewContainerElement( 'tr', null, [
  595. new ViewContainerElement( 'td', null, [
  596. new ViewText( 'foo ' ),
  597. new ViewAttributeElement( 'strong', null, new ViewText( 'abc' ) ),
  598. new ViewText( ' bar' )
  599. ] ),
  600. new ViewContainerElement( 'td', null, new ViewContainerElement( 'foo', { foo: 'bar' }, new ViewText( 'bar' ) ) )
  601. ] )
  602. ] );
  603. const modelElement = viewDispatcher.convert( viewElement );
  604. expect( modelToString( modelElement ) ).to.equal(
  605. '<table cellpadding="5" cellspacing="5">' +
  606. '<tr>' +
  607. '<td>foo <$text bold="true">abc</$text> bar</td>' +
  608. '<td><foo foo="bar">bar</foo></td>' +
  609. '</tr>' +
  610. '</table>'
  611. );
  612. } );
  613. } );
  614. } );