advanced-converters.js 28 KB

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