buildmodelconverter.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import buildModelConverter from '../../src/conversion/buildmodelconverter';
  6. import ModelDocument from '../../src/model/document';
  7. import ModelElement from '../../src/model/element';
  8. import ModelText from '../../src/model/text';
  9. import ModelRange from '../../src/model/range';
  10. import ModelPosition from '../../src/model/position';
  11. import modelWriter from '../../src/model/writer';
  12. import ViewDocument from '../../src/view/document';
  13. import ViewElement from '../../src/view/element';
  14. import ViewContainerElement from '../../src/view/containerelement';
  15. import ViewAttributeElement from '../../src/view/attributeelement';
  16. import ViewText from '../../src/view/text';
  17. import Mapper from '../../src/conversion/mapper';
  18. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  19. import {
  20. insertText,
  21. move,
  22. remove
  23. } from '../../src/conversion/model-to-view-converters';
  24. import {
  25. convertCollapsedSelection,
  26. clearAttributes
  27. } from '../../src/conversion/model-selection-to-view-converters';
  28. import { createRangeOnElementOnly } from '../../tests/model/_utils/utils';
  29. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  30. function viewAttributesToString( item ) {
  31. let result = '';
  32. for ( let key of item.getAttributeKeys() ) {
  33. let value = item.getAttribute( key );
  34. if ( value ) {
  35. result += ' ' + key + '="' + value + '"';
  36. }
  37. }
  38. return result;
  39. }
  40. function viewToString( item ) {
  41. let result = '';
  42. if ( item instanceof ViewText ) {
  43. result = item.data;
  44. } else {
  45. // ViewElement or ViewDocumentFragment.
  46. for ( let child of item.getChildren() ) {
  47. result += viewToString( child );
  48. }
  49. if ( item instanceof ViewElement ) {
  50. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  51. }
  52. }
  53. return result;
  54. }
  55. describe( 'Model converter builder', () => {
  56. let dispatcher, mapper;
  57. let modelDoc, modelRoot;
  58. let viewDoc, viewRoot, viewSelection;
  59. beforeEach( () => {
  60. modelDoc = new ModelDocument();
  61. modelRoot = modelDoc.createRoot( 'root', 'root' );
  62. viewDoc = new ViewDocument();
  63. viewRoot = viewDoc.createRoot( 'div' );
  64. viewSelection = viewDoc.selection;
  65. mapper = new Mapper();
  66. mapper.bindElements( modelRoot, viewRoot );
  67. dispatcher = new ModelConversionDispatcher( { mapper, viewSelection } );
  68. dispatcher.on( 'insert:$text', insertText() );
  69. dispatcher.on( 'move', move() );
  70. dispatcher.on( 'remove', remove() );
  71. } );
  72. afterEach( () => {
  73. viewDoc.destroy();
  74. } );
  75. describe( 'model element to view element conversion', () => {
  76. it( 'using passed view element name', () => {
  77. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  78. let modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) );
  79. modelRoot.appendChildren( modelElement );
  80. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  81. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  82. } );
  83. it( 'using passed view element', () => {
  84. buildModelConverter().for( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) );
  85. let modelElement = new ModelElement( 'image' );
  86. modelRoot.appendChildren( modelElement );
  87. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  88. expect( viewToString( viewRoot ) ).to.equal( '<div><img></img></div>' );
  89. } );
  90. it( 'using passed creator function', () => {
  91. buildModelConverter().for( dispatcher )
  92. .fromElement( 'header' )
  93. .toElement( ( data ) => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) );
  94. let modelElement = new ModelElement( 'header', { level: 2 }, new ModelText( 'foobar' ) );
  95. modelRoot.appendChildren( modelElement );
  96. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  97. expect( viewToString( viewRoot ) ).to.equal( '<div><h2>foobar</h2></div>' );
  98. } );
  99. } );
  100. describe( 'model attribute to view element conversion', () => {
  101. beforeEach( () => {
  102. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  103. } );
  104. it( 'using passed view element name', () => {
  105. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' );
  106. let modelElement = new ModelText( 'foo', { bold: true } );
  107. modelRoot.appendChildren( modelElement );
  108. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  109. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  110. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' );
  111. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  112. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  113. } );
  114. it( 'using passed view element', () => {
  115. buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) );
  116. let modelElement = new ModelText( 'foo', { bold: true } );
  117. modelRoot.appendChildren( modelElement );
  118. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  119. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  120. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' );
  121. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null );
  122. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  123. } );
  124. it( 'using passed creator function', () => {
  125. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  126. let modelElement = new ModelText( 'foo', { italic: 'em' } );
  127. modelRoot.appendChildren( modelElement );
  128. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  129. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  130. modelWriter.setAttribute( ModelRange.createIn( modelRoot ), 'italic', 'i' );
  131. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'em', 'i' );
  132. expect( viewToString( viewRoot ) ).to.equal( '<div><i>foo</i></div>' );
  133. modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'italic' );
  134. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'i', null );
  135. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  136. } );
  137. it( 'selection conversion', () => {
  138. // This test requires collapsed range selection converter (breaking attributes) and clearing "artifacts".
  139. dispatcher.on( 'selection', clearAttributes() );
  140. dispatcher.on( 'selection', convertCollapsedSelection() );
  141. // Model converter builder should add selection converter.
  142. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  143. modelRoot.appendChildren( new ModelText( 'foo', { italic: 'em' } ) );
  144. // Set collapsed selection after "f".
  145. const position = new ModelPosition( modelRoot, [ 1 ] );
  146. modelDoc.selection.setRanges( [ new ModelRange( position, position ) ] );
  147. modelDoc.selection._updateAttributes();
  148. // Convert stuff.
  149. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  150. dispatcher.convertSelection( modelDoc.selection );
  151. // Check if view structure is ok.
  152. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  153. // Check if view selection is collapsed after "f" letter.
  154. let ranges = Array.from( viewSelection.getRanges() );
  155. expect( ranges.length ).to.equal( 1 );
  156. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  157. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  158. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  159. // Change selection attribute, convert it.
  160. modelDoc.selection.setAttribute( 'italic', 'i' );
  161. dispatcher.convertSelection( modelDoc.selection );
  162. // Check if view structure has changed.
  163. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><i></i><em>oo</em></div>' );
  164. // Check if view selection is inside new <em> element.
  165. ranges = Array.from( viewSelection.getRanges() );
  166. expect( ranges.length ).to.equal( 1 );
  167. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  168. expect( ranges[ 0 ].start.parent.name ).to.equal( 'i' );
  169. expect( ranges[ 0 ].start.offset ).to.equal( 0 );
  170. // Some more tests checking how selection attributes changes are converted:
  171. modelDoc.selection.removeAttribute( 'italic' );
  172. dispatcher.convertSelection( modelDoc.selection );
  173. expect( viewToString( viewRoot ) ).to.equal( '<div><em>f</em><em>oo</em></div>' );
  174. ranges = Array.from( viewSelection.getRanges() );
  175. expect( ranges[ 0 ].start.parent.name ).to.equal( 'div' );
  176. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  177. modelDoc.selection.setAttribute( 'italic', 'em' );
  178. dispatcher.convertSelection( modelDoc.selection );
  179. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  180. ranges = Array.from( viewSelection.getRanges() );
  181. expect( ranges.length ).to.equal( 1 );
  182. expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true;
  183. expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo".
  184. expect( ranges[ 0 ].start.offset ).to.equal( 1 );
  185. } );
  186. } );
  187. describe( 'model attribute to view attribute conversion', () => {
  188. beforeEach( () => {
  189. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  190. } );
  191. it( 'using default 1-to-1 conversion', () => {
  192. buildModelConverter().for( dispatcher ).fromAttribute( 'class' ).toAttribute();
  193. let modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, new ModelText( 'foobar' ) );
  194. modelRoot.appendChildren( modelElement );
  195. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  196. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="myClass">foobar</p></div>' );
  197. modelElement.setAttribute( 'class', 'newClass' );
  198. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'myClass', 'newClass' );
  199. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="newClass">foobar</p></div>' );
  200. modelElement.removeAttribute( 'class' );
  201. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'newClass', null );
  202. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  203. } );
  204. it( 'using passed attribute key', () => {
  205. buildModelConverter().for( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' );
  206. let modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, new ModelText( 'foobar' ) );
  207. modelRoot.appendChildren( modelElement );
  208. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  209. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="abc">foobar</p></div>' );
  210. modelElement.setAttribute( 'theme', 'xyz' );
  211. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'abc', 'xyz' );
  212. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="xyz">foobar</p></div>' );
  213. modelElement.removeAttribute( 'theme' );
  214. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'xyz', null );
  215. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  216. } );
  217. it( 'using passed attribute key and value', () => {
  218. buildModelConverter().for( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' );
  219. let modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, new ModelText( 'foobar' ) );
  220. modelRoot.appendChildren( modelElement );
  221. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  222. expect( viewToString( viewRoot ) ).to.equal( '<div><p style="background:yellow;">foobar</p></div>' );
  223. modelElement.removeAttribute( 'highlighted' );
  224. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'highlighted', true, null );
  225. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  226. } );
  227. it( 'using passed attribute creator function', () => {
  228. buildModelConverter().for( dispatcher )
  229. .fromAttribute( 'theme' )
  230. .toAttribute( ( value ) => ( { key: 'class', value: value + '-theme' } ) );
  231. let modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) );
  232. modelRoot.appendChildren( modelElement );
  233. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  234. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice-theme">foobar</p></div>' );
  235. modelElement.setAttribute( 'theme', 'good' );
  236. dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'nice', 'good' );
  237. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="good-theme">foobar</p></div>' );
  238. modelElement.removeAttribute( 'theme' );
  239. dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'good', null );
  240. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  241. } );
  242. } );
  243. describe( 'model marker to view element conversion', () => {
  244. let modelText, modelElement;
  245. beforeEach( () => {
  246. modelText = new ModelText( 'foobar' );
  247. modelElement = new ModelElement( 'paragraph', null, [ modelText ] );
  248. modelRoot.appendChildren( modelElement );
  249. let viewText = new ViewText( 'foobar' );
  250. let viewElement = new ViewContainerElement( 'p', null, [ viewText ] );
  251. viewRoot.appendChildren( viewElement );
  252. mapper.bindElements( modelElement, viewElement );
  253. } );
  254. it( 'using passed view element name', () => {
  255. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'strong' );
  256. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  257. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<strong>ob</strong>ar</p></div>' );
  258. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  259. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  260. } );
  261. it( 'using passed view element', () => {
  262. const viewElement = new ViewAttributeElement( 'span', { class: 'search' } );
  263. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( viewElement );
  264. dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  265. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search">ob</span>ar</p></div>' );
  266. dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  267. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  268. } );
  269. it( 'using passed creator function', () => {
  270. buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( ( data ) => {
  271. const className = 'search search-color-' + data.name.split( ':' )[ 1 ];
  272. return new ViewAttributeElement( 'span', { class: className } );
  273. } );
  274. dispatcher.convertMarker( 'addMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  275. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search search-color-red">ob</span>ar</p></div>' );
  276. dispatcher.convertMarker( 'removeMarker', 'search:blue', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  277. // Nothing should change as we remove a marker with different name, which should generate different view attribute element.
  278. expect( viewToString( viewRoot ) ).to.equal( '<div><p>fo<span class="search search-color-red">ob</span>ar</p></div>' );
  279. dispatcher.convertMarker( 'removeMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) );
  280. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  281. } );
  282. } );
  283. describe( 'withPriority', () => {
  284. it( 'should change default converters priority', () => {
  285. buildModelConverter().for( dispatcher ).fromElement( 'custom' ).toElement( 'custom' );
  286. buildModelConverter().for( dispatcher ).fromElement( 'custom' ).withPriority( 'high' ).toElement( 'other' );
  287. let modelElement = new ModelElement( 'custom', null, new ModelText( 'foobar' ) );
  288. modelRoot.appendChildren( modelElement );
  289. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
  290. expect( viewToString( viewRoot ) ).to.equal( '<div><other>foobar</other></div>' );
  291. } );
  292. } );
  293. it( 'should throw when trying to build model element to view attribute converter', () => {
  294. expect( () => {
  295. buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true );
  296. } ).to.throw( CKEditorError, /^build-model-converter-non-attribute-to-attribute/ );
  297. } );
  298. } );