8
0

advanced-converters.js 28 KB

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