8
0

advanced-converters.js 28 KB

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