8
0

advanced-converters.js 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  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 ViewElement from '/ckeditor5/engine/view/element.js';
  15. import ViewContainerElement from '/ckeditor5/engine/view/containerelement.js';
  16. import ViewAttributeElement from '/ckeditor5/engine/view/attributeelement.js';
  17. import ViewText from '/ckeditor5/engine/view/text.js';
  18. import viewWriter from '/ckeditor5/engine/view/writer.js';
  19. import ViewPosition from '/ckeditor5/engine/view/position.js';
  20. import ViewRange from '/ckeditor5/engine/view/range.js';
  21. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  22. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  23. import ViewConversionDispatcher from '/ckeditor5/engine/conversion/viewconversiondispatcher.js';
  24. import {
  25. insertElement,
  26. insertText,
  27. setAttribute,
  28. removeAttribute,
  29. wrap,
  30. unwrap,
  31. move,
  32. remove,
  33. eventNameToConsumableType
  34. } from '/ckeditor5/engine/conversion/model-to-view-converters.js';
  35. import { convertToModelFragment, convertText } from '/ckeditor5/engine/conversion/view-to-model-converters.js';
  36. let modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher;
  37. beforeEach( () => {
  38. modelDoc = new ModelDocument();
  39. modelRoot = modelDoc.createRoot();
  40. viewRoot = new ViewContainerElement( 'div' );
  41. mapper = new Mapper();
  42. mapper.bindElements( modelRoot, viewRoot );
  43. modelDispatcher = new ModelConversionDispatcher( { mapper } );
  44. // Schema is mocked up because we don't care about it in those tests.
  45. viewDispatcher = new ViewConversionDispatcher( { schema: { check: () => true } } );
  46. modelDispatcher.on( 'insert:$text', insertText() );
  47. modelDispatcher.on( 'move', move() );
  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.text + '</$text>' : item.text;
  89. } else {
  90. let walker = new ModelWalker( { boundaries: ModelRange.createFromElement( 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.getChildCount() > 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.convertInsert( ModelRange.createFromElement( 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', ModelRange.createOnElement( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  207. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( 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' }, new ModelElement( 'caption', {}, 'foobar' ) );
  212. modelRoot.appendChildren( modelElement );
  213. modelDispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  214. expect( viewToString( viewRoot ) ).to.equal(
  215. '<div><figure><img src="foo.jpg" title="foo"></img><figcaption>foobar</figcaption></figure></div>'
  216. );
  217. modelElement.setAttribute( 'src', 'new.jpg' );
  218. modelElement.removeAttribute( 'title' );
  219. modelDispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'src', 'bar.jpg', 'new.jpg' );
  220. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'title', 'bar', null );
  221. expect( viewToString( viewRoot ) ).to.equal( '<div><figure><img src="new.jpg"></img><figcaption>foobar</figcaption></figure></div>' );
  222. } );
  223. it( 'should convert view image to model', () => {
  224. let viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } );
  225. let modelElement = viewDispatcher.convert( viewElement );
  226. // Attaching to tree so tree walker works fine in `modelToString`.
  227. modelRoot.appendChildren( modelElement );
  228. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"></image>' );
  229. } );
  230. it( 'should convert view figure to model', () => {
  231. let viewElement = new ViewContainerElement(
  232. 'figure',
  233. null,
  234. [
  235. new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ),
  236. new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) )
  237. ]
  238. );
  239. let modelElement = viewDispatcher.convert( viewElement );
  240. // Attaching to tree so tree walker works fine in `modelToString`.
  241. modelRoot.appendChildren( modelElement );
  242. expect( modelToString( modelElement ) ).to.equal( '<image src="bar.jpg" title="bar"><caption>foobar</caption></image>' );
  243. } );
  244. } );
  245. // Converter overwrites default attribute converter for `linkHref` and `linkTitle` attribute is set on `quote` element.
  246. //
  247. // Model:
  248. //
  249. // [quote {linkHref='foo.html' linkTitle='Foo source'}]
  250. // ├─ f
  251. // ├─ o
  252. // └─ o
  253. //
  254. // foo {linkHref='foo.html' linkTitle='Foo title'}
  255. //
  256. // View:
  257. //
  258. // <blockquote>
  259. // ├─ foo
  260. // └─ <a href="foo.html" title="Foo source">
  261. // └─ see source
  262. //
  263. // <a href="foo.html" title="Foo title">
  264. // └─ foo
  265. describe( 'custom attribute handling for given element', () => {
  266. beforeEach( () => {
  267. // NORMAL LINK MODEL TO VIEW CONVERTERS
  268. modelDispatcher.on( 'addAttribute:linkHref', wrap( ( value ) => new ViewAttributeElement( 'a', { href: value } ) ), null, 99 );
  269. modelDispatcher.on( 'addAttribute:linkTitle', wrap( ( value ) => new ViewAttributeElement( 'a', { title: value } ) ), null, 99 );
  270. const changeLinkAttribute = function( elementCreator ) {
  271. return ( evt, data, consumable, conversionApi ) => {
  272. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  273. const viewRange = conversionApi.mapper.toViewRange( data.range );
  274. const viewOldA = elementCreator( data.attributeOldValue );
  275. const viewNewA = elementCreator( data.attributeNewValue );
  276. viewWriter.unwrap( viewRange, viewOldA, evt.priority );
  277. viewWriter.wrap( viewRange, viewNewA, evt.priority );
  278. evt.stop();
  279. };
  280. };
  281. modelDispatcher.on(
  282. 'changeAttribute:linkHref',
  283. changeLinkAttribute( ( value ) => new ViewAttributeElement( 'a', { href: value } ) ),
  284. null,
  285. 99
  286. );
  287. modelDispatcher.on(
  288. 'changeAttribute:linkTitle',
  289. changeLinkAttribute( ( value ) => new ViewAttributeElement( 'a', { title: value } ) ),
  290. null,
  291. 99
  292. );
  293. modelDispatcher.on(
  294. 'removeAttribute:linkHref',
  295. unwrap( ( value ) => new ViewAttributeElement( 'a', { href: value } ) ),
  296. null,
  297. 99
  298. );
  299. modelDispatcher.on(
  300. 'removeAttribute:linkTitle',
  301. unwrap( ( value ) => new ViewAttributeElement( 'a', { title: value } ) ),
  302. null,
  303. 99
  304. );
  305. // NORMAL LINK VIEW TO MODEL CONVERTERS
  306. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  307. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  308. if ( !data.output ) {
  309. data.output = conversionApi.convertChildren( data.input, consumable );
  310. }
  311. for ( let child of data.output ) {
  312. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  313. }
  314. }
  315. } );
  316. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  317. if ( consumable.consume( data.input, { attribute: 'title' } ) ) {
  318. if ( !data.output ) {
  319. data.output = conversionApi.convertChildren( data.input, consumable );
  320. }
  321. for ( let child of data.output ) {
  322. child.setAttribute( 'linkTitle', data.input.getAttribute( 'title' ) );
  323. }
  324. }
  325. } );
  326. // QUOTE MODEL TO VIEW CONVERTERS
  327. modelDispatcher.on( 'insert:quote', ( evt, data, consumable, conversionApi ) => {
  328. consumable.consume( data.item, 'insert' );
  329. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  330. const viewElement = new ViewContainerElement( 'blockquote' );
  331. conversionApi.mapper.bindElements( data.item, viewElement );
  332. viewWriter.insert( viewPosition, viewElement );
  333. if ( consumable.consume( data.item, 'addAttribute:linkHref' ) ) {
  334. const viewA = new ViewAttributeElement( 'a', { href: data.item.getAttribute( 'linkHref' ) }, new ViewText( 'see source' ) );
  335. if ( consumable.consume( data.item, 'addAttribute:linkTitle' ) ) {
  336. viewA.setAttribute( 'title', data.item.getAttribute( 'linkTitle' ) );
  337. }
  338. viewWriter.insert( new ViewPosition( viewElement, viewElement.getChildCount() ), viewA );
  339. }
  340. evt.stop();
  341. } );
  342. const modelChangeLinkAttrQuoteConverter = function( evt, data, consumable, conversionApi ) {
  343. let viewKey = data.attributeKey.substr( 4 ).toLowerCase();
  344. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  345. const viewElement = conversionApi.mapper.toViewElement( data.item );
  346. const viewA = viewElement.getChild( viewElement.getChildCount() - 1 );
  347. if ( data.attributeNewValue !== null ) {
  348. viewA.setAttribute( viewKey, data.attributeNewValue );
  349. } else {
  350. viewA.removeAttribute( viewKey );
  351. }
  352. evt.stop();
  353. };
  354. modelDispatcher.on( 'changeAttribute:linkHref:quote', modelChangeLinkAttrQuoteConverter );
  355. modelDispatcher.on( 'changeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter );
  356. modelDispatcher.on( 'removeAttribute:linkHref:quote', ( evt, data, consumable, conversionApi ) => {
  357. consumable.consume( data.item, eventNameToConsumableType( evt.name ) );
  358. const viewElement = conversionApi.mapper.toViewElement( data.item );
  359. const viewA = viewElement.getChild( viewElement.getChildCount() - 1 );
  360. const aIndex = viewA.getIndex();
  361. viewWriter.remove( ViewRange.createFromParentsAndOffsets( viewElement, aIndex, viewElement, aIndex + 1 ) );
  362. evt.stop();
  363. } );
  364. modelDispatcher.on( 'removeAttribute:linkTitle:quote', modelChangeLinkAttrQuoteConverter );
  365. // QUOTE VIEW TO MODEL CONVERTERS
  366. viewDispatcher.on( 'element:blockquote', ( evt, data, consumable, conversionApi ) => {
  367. if ( consumable.consume( data.input, { name: true } ) ) {
  368. data.output = new ModelElement( 'quote' );
  369. const viewA = data.input.getChild( data.input.getChildCount() - 1 );
  370. // Convert the special "a" first, before converting all children.
  371. if ( viewA instanceof ViewElement && viewA.name == 'a' && consumable.consume( viewA, { name: true } ) ) {
  372. if ( consumable.consume( viewA, { attribute: 'href' } ) ) {
  373. data.output.setAttribute( 'linkHref', viewA.getAttribute( 'href' ) );
  374. }
  375. if ( consumable.consume( viewA, { attribute: 'title' } ) ) {
  376. data.output.setAttribute( 'linkTitle', viewA.getAttribute( 'title' ) );
  377. }
  378. }
  379. const children = conversionApi.convertChildren( data.input, consumable );
  380. data.output.appendChildren( children );
  381. }
  382. } );
  383. } );
  384. it( 'should convert model text with linkHref and linkTitle to view', () => {
  385. const modelText = new ModelText( 'foo', { linkHref: 'foo.html', linkTitle: 'Foo title' } );
  386. modelRoot.appendChildren( modelText );
  387. let range = ModelRange.createFromElement( modelRoot );
  388. modelDispatcher.convertInsert( range );
  389. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="foo.html" title="Foo title">foo</a></div>' );
  390. // Let's change link's attributes.
  391. for ( let value of range ) {
  392. value.item.setAttribute( 'linkHref', 'bar.html' );
  393. value.item.setAttribute( 'linkTitle', 'Bar title' );
  394. }
  395. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkHref', 'foo.html', 'bar.html' );
  396. modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkTitle', 'Foo title', 'Bar title' );
  397. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html" title="Bar title">foo</a></div>' );
  398. // Let's remove a letter from the link.
  399. const removed = modelRoot.removeChildren( 0, 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. for ( let value of range ) {
  409. value.item.removeAttribute( 'linkTitle' );
  410. }
  411. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkTitle', 'Bar title', null );
  412. expect( viewToString( viewRoot ) ).to.equal( '<div><a href="bar.html">oo</a></div>' );
  413. // Let's remove the other attribute.
  414. for ( let value of range ) {
  415. value.item.removeAttribute( 'linkHref' );
  416. }
  417. modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkHref', 'bar.html', null );
  418. expect( viewToString( viewRoot ) ).to.equal( '<div>oo</div>' );
  419. } );
  420. it( 'should convert a view element to model', () => {
  421. let viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) );
  422. let modelText = viewDispatcher.convert( viewElement )[ 0 ];
  423. expect( modelText ).to.be.instanceof( ModelText );
  424. expect( modelText.text ).to.equal( 'foo' );
  425. expect( modelText.getAttribute( 'linkHref' ) ).to.equal( 'foo.html' );
  426. expect( modelText.getAttribute( 'linkTitle' ) ).to.equal( 'Foo title' );
  427. } );
  428. it( 'should convert quote model element with linkHref and linkTitle attribute to view', () => {
  429. let modelElement = new ModelElement( 'quote', { linkHref: 'foo.html', linkTitle: 'Foo source' }, 'foo' );
  430. modelRoot.appendChildren( modelElement );
  431. modelDispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  432. let expected = '<div><blockquote>foo<a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  433. expect( viewToString( viewRoot ) ).to.equal( expected );
  434. modelDispatcher.on( 'addAttribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  435. modelDispatcher.on( 'changeAttribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  436. modelDispatcher.on( 'removeAttribute:bold', unwrap( new ViewAttributeElement( 'strong' ) ) );
  437. modelElement.appendChildren( new ModelText( 'bar', { bold: true } ) );
  438. modelDispatcher.convertInsert( ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 6 ) );
  439. expected = '<div><blockquote>foo<strong>bar</strong><a href="foo.html" title="Foo source">see source</a></blockquote></div>';
  440. expect( viewToString( viewRoot ) ).to.equal( expected );
  441. modelElement.removeAttribute( 'linkTitle' );
  442. modelElement.setAttribute( 'linkHref', 'bar.html' );
  443. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'linkTitle', 'Foo source', null );
  444. modelDispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'linkHref', 'foo.html', 'bar.html' );
  445. expected = '<div><blockquote>foo<strong>bar</strong><a href="bar.html">see source</a></blockquote></div>';
  446. expect( viewToString( viewRoot ) ).to.equal( expected );
  447. modelElement.removeAttribute( 'linkHref' );
  448. modelDispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'linkHref', 'bar.html', null );
  449. expected = '<div><blockquote>foo<strong>bar</strong></blockquote></div>';
  450. expect( viewToString( viewRoot ) ).to.equal( expected );
  451. } );
  452. it( 'should convert view blockquote with a element to model', () => {
  453. let viewElement = new ViewContainerElement(
  454. 'blockquote',
  455. null,
  456. [
  457. new ViewText( 'foo' ),
  458. new ViewAttributeElement(
  459. 'a',
  460. {
  461. href: 'foo.html',
  462. title: 'Foo source'
  463. },
  464. new ViewText( 'see source' )
  465. )
  466. ]
  467. );
  468. let modelElement = viewDispatcher.convert( viewElement );
  469. modelRoot.appendChildren( modelElement );
  470. expect( modelToString( modelElement ) ).to.equal( '<quote linkHref="foo.html" linkTitle="Foo source">foo</quote>' );
  471. } );
  472. } );
  473. // Default view converter for tables that will convert table structure into paragraphs if tables are not supported.
  474. // TRs are supposed to become paragraphs and TDs content should be separated using space.
  475. it( 'default table view to model converter', () => {
  476. viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => {
  477. if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) {
  478. if ( !data.output ) {
  479. data.output = conversionApi.convertChildren( data.input, consumable );
  480. }
  481. for ( let child of data.output ) {
  482. child.setAttribute( 'linkHref', data.input.getAttribute( 'href' ) );
  483. }
  484. }
  485. } );
  486. viewDispatcher.on( 'element:tr', ( evt, data, consumable, conversionApi ) => {
  487. if ( consumable.consume( data.input, { name: true } ) ) {
  488. data.output = new ModelElement( 'paragraph' );
  489. const children = conversionApi.convertChildren( data.input, consumable );
  490. for ( let i = 1; i < children.length; i++ ) {
  491. if ( children[ i ] instanceof ModelText && children[ i - 1 ] instanceof ModelText ) {
  492. children[ i - 1 ].text += ' ';
  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. let 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. let model = viewDispatcher.convert( viewTable );
  519. let modelFragment = new ModelDocumentFragment( model );
  520. expect( modelToString( modelFragment ) )
  521. .to.equal( '<paragraph>foo <$text linkHref="bar.html">bar</$text></paragraph><paragraph>abc</paragraph>' );
  522. } );
  523. // Model converter that converts any non-converted elements and attributes into view elements and attributes.
  524. // View converter that converts any non-converted elements and attributes into model elements and attributes.
  525. describe( 'universal converter', () => {
  526. beforeEach( () => {
  527. // "Universal" converters
  528. modelDispatcher.on( 'insert', insertElement( ( data ) => new ViewContainerElement( data.item.name ) ), null, 99 );
  529. modelDispatcher.on( 'addAttribute', setAttribute(), null, 99 );
  530. modelDispatcher.on( 'changeAttribute', setAttribute(), null, 99 );
  531. modelDispatcher.on( 'removeAttribute', removeAttribute(), null, 99 );
  532. viewDispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  533. if ( consumable.consume( data.input, { name: true } ) ) {
  534. data.output = new ModelElement( data.input.name );
  535. for ( let key of data.input.getAttributeKeys() ) {
  536. if ( consumable.consume( data.input, { attribute: key } ) ) {
  537. data.output.setAttribute( key, data.input.getAttribute( key ) );
  538. }
  539. }
  540. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) );
  541. }
  542. }, null, 99 );
  543. // "Real" converters -- added with sooner priority. Should overwrite the "universal" converters.
  544. modelDispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
  545. modelDispatcher.on( 'addAttribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  546. modelDispatcher.on( 'changeAttribute:bold', wrap( new ViewAttributeElement( 'strong' ) ) );
  547. modelDispatcher.on( 'removeAttribute:bold', unwrap( new ViewAttributeElement( 'strong' ) ) );
  548. viewDispatcher.on( 'element:img', ( evt, data, consumable ) => {
  549. if ( consumable.consume( data.input, { name: true } ) ) {
  550. const modelImage = new ModelElement( 'image' );
  551. for ( let attributeKey of data.input.getAttributeKeys() ) {
  552. modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) );
  553. }
  554. data.output = modelImage;
  555. }
  556. } );
  557. viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => {
  558. if ( consumable.consume( data.input, { name: true } ) ) {
  559. if ( !data.output ) {
  560. data.output = conversionApi.convertChildren( data.input, consumable );
  561. }
  562. for ( let child of data.output ) {
  563. child.setAttribute( 'bold', true );
  564. }
  565. }
  566. } );
  567. } );
  568. it( 'should convert model to view', () => {
  569. let modelElement = new ModelElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  570. new ModelElement( 'tr', null, [
  571. new ModelElement( 'td', null, [
  572. 'foo ',
  573. new ModelText( 'abc', { bold: true } ),
  574. ' bar'
  575. ] ),
  576. new ModelElement( 'td', null, [
  577. new ModelElement( 'foo', { foo: 'bar' }, 'bar' )
  578. ] )
  579. ] )
  580. ] );
  581. modelRoot.appendChildren( modelElement );
  582. modelDispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  583. expect( viewToString( viewRoot ) ).to.equal(
  584. '<div>' +
  585. '<table cellpadding="5" cellspacing="5">' +
  586. '<tr>' +
  587. '<td>foo <strong>abc</strong> bar</td>' +
  588. '<td><foo foo="bar">bar</foo></td>' +
  589. '</tr>' +
  590. '</table>' +
  591. '</div>'
  592. );
  593. } );
  594. it( 'should convert view to model', () => {
  595. let viewElement = new ViewContainerElement( 'table', { cellpadding: 5, cellspacing: 5 }, [
  596. new ViewContainerElement( 'tr', null, [
  597. new ViewContainerElement( 'td', null, [
  598. new ViewText( 'foo ' ),
  599. new ViewAttributeElement( 'strong', null, new ViewText( 'abc' ) ),
  600. new ViewText( ' bar' )
  601. ] ),
  602. new ViewContainerElement( 'td', null, new ViewContainerElement( 'foo', { foo: 'bar' }, new ViewText( 'bar' ) ) )
  603. ] )
  604. ] );
  605. let modelElement = viewDispatcher.convert( viewElement );
  606. modelRoot.appendChildren( modelElement );
  607. expect( modelToString( modelElement ) ).to.equal(
  608. '<table cellpadding="5" cellspacing="5">' +
  609. '<tr>' +
  610. '<td>foo <$text bold="true">abc</$text> bar</td>' +
  611. '<td><foo foo="bar">bar</foo></td>' +
  612. '</tr>' +
  613. '</table>'
  614. );
  615. } );
  616. } );