8
0

advanced-converters.js 28 KB

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