advanced-converters.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  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 ( let key of item.getAttributeKeys() ) {
  55. let 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 ( let 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 ( let 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. let attributes = modelAttributesToString( item );
  88. result = attributes ? '<$text' + attributes + '>' + item.data + '</$text>' : item.data;
  89. } else {
  90. let walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } );
  91. for ( let value of walker ) {
  92. result += modelToString( value.item );
  93. }
  94. if ( item instanceof ModelElement ) {
  95. let 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 ( let 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. let 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. let 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( '<div><figure><img src="new.jpg"></img><figcaption>foobar</figcaption></figure></div>' );
  224. } );
  225. it( 'should convert view image to model', () => {
  226. let viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } );
  227. let modelElement = viewDispatcher.convert( viewElement );
  228. // Attaching to tree so tree walker works fine in `modelToString`.
  229. modelRoot.appendChildren( modelElement );
  230. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"></image>' );
  231. } );
  232. it( 'should convert view figure to model', () => {
  233. let 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. let modelElement = viewDispatcher.convert( viewElement );
  242. // Attaching to tree so tree walker works fine in `modelToString`.
  243. modelRoot.appendChildren( modelElement );
  244. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"><caption>foobar</caption></image>' );
  245. } );
  246. } );
  247. // Converter overwrites default attribute converter for `linkHref` and `linkTitle` attribute is set on `quote` element.
  248. //
  249. // Model:
  250. //
  251. // [quote {linkHref='foo.html' linkTitle='Foo source'}]
  252. // ├─ f
  253. // ├─ o
  254. // └─ o
  255. //
  256. // foo {linkHref='foo.html' linkTitle='Foo title'}
  257. //
  258. // View:
  259. //
  260. // <blockquote>
  261. // ├─ foo
  262. // └─ <a href="foo.html" title="Foo source">
  263. // └─ see source
  264. //
  265. // <a href="foo.html" title="Foo title">
  266. // └─ foo
  267. describe( 'custom attribute handling for given element', () => {
  268. beforeEach( () => {
  269. // NORMAL LINK MODEL TO VIEW CONVERTERS
  270. modelDispatcher.on( 'addAttribute:linkHref', wrapItem( ( value ) => new ViewAttributeElement( 'a', { href: value } ) ) );
  271. modelDispatcher.on( 'addAttribute:linkTitle', wrapItem( ( value ) => new ViewAttributeElement( 'a', { title: value } ) ) );
  272. const changeLinkAttribute = function( elementCreator ) {
  273. return ( evt, data, consumable, conversionApi ) => {
  274. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  275. const viewRange = conversionApi.mapper.toViewRange( data.range );
  276. const viewOldA = elementCreator( data.attributeOldValue );
  277. const viewNewA = elementCreator( data.attributeNewValue );
  278. viewWriter.unwrap( viewRange, viewOldA, evt.priority );
  279. viewWriter.wrap( viewRange, viewNewA, evt.priority );
  280. evt.stop();
  281. };
  282. };
  283. modelDispatcher.on(
  284. 'changeAttribute:linkHref',
  285. changeLinkAttribute( ( value ) => new ViewAttributeElement( 'a', { href: value } ) )
  286. );
  287. modelDispatcher.on(
  288. 'changeAttribute:linkTitle',
  289. changeLinkAttribute( ( value ) => new ViewAttributeElement( 'a', { title: value } ) )
  290. );
  291. modelDispatcher.on(
  292. 'removeAttribute:linkHref',
  293. unwrapItem( ( value ) => new ViewAttributeElement( 'a', { href: value } ) )
  294. );
  295. modelDispatcher.on(
  296. 'removeAttribute:linkTitle',
  297. unwrapItem( ( value ) => new ViewAttributeElement( 'a', { title: value } ) )
  298. );
  299. // NORMAL LINK VIEW TO MODEL CONVERTERS
  300. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  301. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  302. if ( !data.output ) {
  303. data.output = conversionApi.convertChildren( data.input, consumable );
  304. }
  305. for ( let child of data.output ) {
  306. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  307. }
  308. }
  309. } );
  310. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  311. if ( consumable.consume( data.input, { attribute: 'title' } ) ) {
  312. if ( !data.output ) {
  313. data.output = conversionApi.convertChildren( data.input, consumable );
  314. }
  315. for ( let child of data.output ) {
  316. child.setAttribute( 'linkTitle', data.input.getAttribute( 'title' ) );
  317. }
  318. }
  319. } );
  320. // QUOTE MODEL TO VIEW CONVERTERS
  321. modelDispatcher.on( 'insert:quote', ( evt, data, consumable, conversionApi ) => {
  322. consumable.consume( data.item, 'insert' );
  323. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  324. const viewElement = new ViewContainerElement( 'blockquote' );
  325. conversionApi.mapper.bindElements( data.item, viewElement );
  326. viewWriter.insert( viewPosition, viewElement );
  327. if ( consumable.consume( data.item, 'addAttribute:linkHref' ) ) {
  328. const viewA = new ViewAttributeElement( 'a', { href: data.item.getAttribute( 'linkHref' ) }, new ViewText( 'see source' ) );
  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. let 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. let viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) );
  409. let modelText = viewDispatcher.convert( viewElement )[ 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. let 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( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'linkTitle', 'Foo source', null );
  431. modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'linkHref', 'foo.html', 'bar.html' );
  432. expected = '<div><blockquote>foo<strong>bar</strong><a href="bar.html">see source</a></blockquote></div>';
  433. expect( viewToString( viewRoot ) ).to.equal( expected );
  434. modelElement.removeAttribute( 'linkHref' );
  435. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'linkHref', 'bar.html', null );
  436. expected = '<div><blockquote>foo<strong>bar</strong></blockquote></div>';
  437. expect( viewToString( viewRoot ) ).to.equal( expected );
  438. } );
  439. it( 'should convert view blockquote with a element to model', () => {
  440. let viewElement = new ViewContainerElement(
  441. 'blockquote',
  442. null,
  443. [
  444. new ViewText( 'foo' ),
  445. new ViewAttributeElement(
  446. 'a',
  447. {
  448. href: 'foo.html',
  449. title: 'Foo source'
  450. },
  451. new ViewText( 'see source' )
  452. )
  453. ]
  454. );
  455. let modelElement = viewDispatcher.convert( viewElement );
  456. modelRoot.appendChildren( modelElement );
  457. expect( modelToString( modelElement ) ).to.equal( '<quote linkHref="foo.html" linkTitle="Foo source">foo</quote>' );
  458. } );
  459. } );
  460. // Default view converter for tables that will convert table structure into paragraphs if tables are not supported.
  461. // TRs are supposed to become paragraphs and TDs content should be separated using space.
  462. it( 'default table view to model converter', () => {
  463. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  464. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  465. if ( !data.output ) {
  466. data.output = conversionApi.convertChildren( data.input, consumable );
  467. }
  468. for ( let child of data.output ) {
  469. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  470. }
  471. }
  472. } );
  473. viewDispatcher.on( 'element:tr', ( evt, data, consumable, conversionApi ) => {
  474. if ( consumable.consume( data.input, { name: true } ) ) {
  475. data.output = new ModelElement( 'paragraph' );
  476. const children = conversionApi.convertChildren( data.input, consumable );
  477. for ( let i = 1; i < children.length; i++ ) {
  478. if ( children[ i ] instanceof ModelText && children[ i - 1 ] instanceof ModelText ) {
  479. children.splice( i, 0, new ModelText( ' ' ) );
  480. i++;
  481. }
  482. }
  483. data.output.appendChildren( children );
  484. }
  485. } );
  486. viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => {
  487. if ( consumable.consume( data.input, { name: true } ) ) {
  488. data.output = conversionApi.convertChildren( data.input, consumable );
  489. }
  490. } );
  491. viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => {
  492. if ( consumable.consume( data.input, { name: true } ) ) {
  493. data.output = conversionApi.convertChildren( data.input, consumable );
  494. }
  495. } );
  496. let viewTable = new ViewContainerElement( 'table', null, [
  497. new ViewContainerElement( 'tr', null, [
  498. new ViewContainerElement( 'td', null, new ViewText( 'foo' ) ),
  499. new ViewContainerElement( 'td', null, new ViewAttributeElement( 'a', { href: 'bar.html' }, new ViewText( 'bar' ) ) )
  500. ] ),
  501. new ViewContainerElement( 'tr', null, [
  502. new ViewContainerElement( 'td' ),
  503. new ViewContainerElement( 'td', null, new ViewText( 'abc' ) )
  504. ] )
  505. ] );
  506. let model = viewDispatcher.convert( viewTable );
  507. let modelFragment = new ModelDocumentFragment( model );
  508. expect( modelToString( modelFragment ) )
  509. .to.equal( '<paragraph>foo <$text linkHref="bar.html">bar</$text></paragraph><paragraph>abc</paragraph>' );
  510. } );
  511. // Model converter that converts any non-converted elements and attributes into view elements and attributes.
  512. // View converter that converts any non-converted elements and attributes into model elements and attributes.
  513. describe( 'universal converter', () => {
  514. beforeEach( () => {
  515. // "Universal" converters
  516. modelDispatcher.on( 'insert', insertElement( ( data ) => new ViewContainerElement( data.item.name ) ), { priority: 'lowest' } );
  517. modelDispatcher.on( 'addAttribute', setAttribute(), { priority: 'lowest' } );
  518. modelDispatcher.on( 'changeAttribute', setAttribute(), { priority: 'lowest' } );
  519. modelDispatcher.on( 'removeAttribute', removeAttribute(), { priority: 'lowest' } );
  520. viewDispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  521. if ( consumable.consume( data.input, { name: true } ) ) {
  522. data.output = new ModelElement( data.input.name );
  523. for ( let key of data.input.getAttributeKeys() ) {
  524. if ( consumable.consume( data.input, { attribute: key } ) ) {
  525. data.output.setAttribute( key, data.input.getAttribute( key ) );
  526. }
  527. }
  528. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) );
  529. }
  530. }, { priority: 'lowest' } );
  531. // "Real" converters -- added with higher priority. Should overwrite the "universal" converters.
  532. modelDispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  533. modelDispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  534. modelDispatcher.on( 'changeAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) );
  535. modelDispatcher.on( 'removeAttribute:bold', unwrapItem( new ViewAttributeElement( 'strong' ) ) );
  536. viewDispatcher.on( 'element:img', ( evt, data, consumable ) => {
  537. if ( consumable.consume( data.input, { name: true } ) ) {
  538. const modelImage = new ModelElement( 'image' );
  539. for ( let attributeKey of data.input.getAttributeKeys() ) {
  540. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  541. }
  542. data.output = modelImage;
  543. }
  544. } );
  545. viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => {
  546. if ( consumable.consume( data.input, { name: true } ) ) {
  547. if ( !data.output ) {
  548. data.output = conversionApi.convertChildren( data.input, consumable );
  549. }
  550. for ( let child of data.output ) {
  551. child.setAttribute( 'bold', true );
  552. }
  553. }
  554. } );
  555. } );
  556. it( 'should convert model to view', () => {
  557. let modelElement = new ModelElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  558. new ModelElement( 'tr', null, [
  559. new ModelElement( 'td', null, [
  560. new ModelText( 'foo ' ),
  561. new ModelText( 'abc', { bold: true } ),
  562. new ModelText( ' bar' )
  563. ] ),
  564. new ModelElement( 'td', null, [
  565. new ModelElement( 'foo', { foo: 'bar' }, new ModelText( 'bar' ) )
  566. ] )
  567. ] )
  568. ] );
  569. modelRoot.appendChildren( modelElement );
  570. modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  571. expect( viewToString( viewRoot ) ).to.equal(
  572. '<div>' +
  573. '<table cellpadding="5" cellspacing="5">' +
  574. '<tr>' +
  575. '<td>foo <strong>abc</strong> bar</td>' +
  576. '<td><foo foo="bar">bar</foo></td>' +
  577. '</tr>' +
  578. '</table>' +
  579. '</div>'
  580. );
  581. } );
  582. it( 'should convert view to model', () => {
  583. let viewElement = new ViewContainerElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  584. new ViewContainerElement( 'tr', null, [
  585. new ViewContainerElement( 'td', null, [
  586. new ViewText( 'foo ' ),
  587. new ViewAttributeElement( 'strong', null, new ViewText( 'abc' ) ),
  588. new ViewText( ' bar' )
  589. ] ),
  590. new ViewContainerElement( 'td', null, new ViewContainerElement( 'foo', { foo: 'bar' }, new ViewText( 'bar' ) ) )
  591. ] )
  592. ] );
  593. let modelElement = viewDispatcher.convert( viewElement );
  594. modelRoot.appendChildren( modelElement );
  595. expect( modelToString( modelElement ) ).to.equal(
  596. '<table cellpadding="5" cellspacing="5">' +
  597. '<tr>' +
  598. '<td>foo <$text bold="true">abc</$text> bar</td>' +
  599. '<td><foo foo="bar">bar</foo></td>' +
  600. '</tr>' +
  601. '</table>'
  602. );
  603. } );
  604. } );
  605. } );