model-converter-builder.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treecontroller */
  6. 'use strict';
  7. import BuildModelConverterFor from '/ckeditor5/engine/treecontroller/model-converter-builder.js';
  8. import ModelDocument from '/ckeditor5/engine/treemodel/document.js';
  9. import ModelElement from '/ckeditor5/engine/treemodel/element.js';
  10. import ModelText from '/ckeditor5/engine/treemodel/text.js';
  11. import ModelRange from '/ckeditor5/engine/treemodel/range.js';
  12. import ViewElement from '/ckeditor5/engine/treeview/element.js';
  13. import ViewContainerElement from '/ckeditor5/engine/treeview/containerelement.js';
  14. import ViewAttributeElement from '/ckeditor5/engine/treeview/attributeelement.js';
  15. import ViewText from '/ckeditor5/engine/treeview/text.js';
  16. import ViewWriter from '/ckeditor5/engine/treeview/writer.js';
  17. import Mapper from '/ckeditor5/engine/treecontroller/mapper.js';
  18. import ModelConversionDispatcher from '/ckeditor5/engine/treecontroller/modelconversiondispatcher.js';
  19. import {
  20. insertText,
  21. move,
  22. remove
  23. } from '/ckeditor5/engine/treecontroller/model-to-view-converters.js';
  24. function viewAttributesToString( item ) {
  25. let result = '';
  26. for ( let key of item.getAttributeKeys() ) {
  27. let value = item.getAttribute( key );
  28. if ( value ) {
  29. result += ' ' + key + '="' + value + '"';
  30. }
  31. }
  32. return result;
  33. }
  34. function viewToString( item ) {
  35. let result = '';
  36. if ( item instanceof ViewText ) {
  37. result = item.data;
  38. } else {
  39. // ViewElement or ViewDocumentFragment.
  40. for ( let child of item.getChildren() ) {
  41. result += viewToString( child );
  42. }
  43. if ( item instanceof ViewElement ) {
  44. result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
  45. }
  46. }
  47. return result;
  48. }
  49. describe( 'Model converter builder', () => {
  50. let dispatcher, modelDoc, modelRoot, viewRoot, mapper, writer;
  51. beforeEach( () => {
  52. modelDoc = new ModelDocument();
  53. modelRoot = modelDoc.createRoot( 'root', 'root' );
  54. viewRoot = new ViewContainerElement( 'div' );
  55. mapper = new Mapper();
  56. mapper.bindElements( modelRoot, viewRoot );
  57. writer = new ViewWriter();
  58. dispatcher = new ModelConversionDispatcher( { writer, mapper } );
  59. dispatcher.on( 'insert:$text', insertText() );
  60. dispatcher.on( 'move', move() );
  61. dispatcher.on( 'remove', remove() );
  62. } );
  63. describe( 'model element to view element conversion', () => {
  64. it( 'using passed view element name', () => {
  65. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  66. let modelElement = new ModelElement( 'paragraph', null, 'foobar' );
  67. modelRoot.appendChildren( modelElement );
  68. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  69. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  70. } );
  71. it( 'using passed view element', () => {
  72. BuildModelConverterFor( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) );
  73. let modelElement = new ModelElement( 'image' );
  74. modelRoot.appendChildren( modelElement );
  75. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  76. expect( viewToString( viewRoot ) ).to.equal( '<div><img></img></div>' );
  77. } );
  78. it( 'using passed creator function', () => {
  79. BuildModelConverterFor( dispatcher )
  80. .fromElement( 'header' )
  81. .toElement( ( data ) => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) );
  82. let modelElement = new ModelElement( 'header', { level: 2 }, 'foobar' );
  83. modelRoot.appendChildren( modelElement );
  84. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  85. expect( viewToString( viewRoot ) ).to.equal( '<div><h2>foobar</h2></div>' );
  86. } );
  87. } );
  88. describe( 'model attribute to view element conversion', () => {
  89. beforeEach( () => {
  90. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  91. } );
  92. it( 'using passed view element name', () => {
  93. BuildModelConverterFor( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' );
  94. let modelElement = new ModelText( 'foo', { bold: true } );
  95. modelRoot.appendChildren( modelElement );
  96. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  97. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  98. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  99. value.item.removeAttribute( 'bold' );
  100. }
  101. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'bold', true, null );
  102. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  103. } );
  104. it( 'using passed view element', () => {
  105. BuildModelConverterFor( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) );
  106. let modelElement = new ModelText( 'foo', { bold: true } );
  107. modelRoot.appendChildren( modelElement );
  108. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  109. expect( viewToString( viewRoot ) ).to.equal( '<div><strong>foo</strong></div>' );
  110. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  111. value.item.removeAttribute( 'bold' );
  112. }
  113. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'bold', true, null );
  114. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  115. } );
  116. it( 'using passed creator function', () => {
  117. BuildModelConverterFor( dispatcher ).fromAttribute( 'italic' ).toElement( ( value ) => new ViewAttributeElement( value ) );
  118. let modelElement = new ModelText( 'foo', { italic: 'em' } );
  119. modelRoot.appendChildren( modelElement );
  120. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  121. expect( viewToString( viewRoot ) ).to.equal( '<div><em>foo</em></div>' );
  122. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  123. value.item.setAttribute( 'italic', 'i' );
  124. }
  125. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createFromElement( modelRoot ), 'italic', 'em', 'i' );
  126. expect( viewToString( viewRoot ) ).to.equal( '<div><i>foo</i></div>' );
  127. for ( let value of ModelRange.createFromElement( modelRoot ) ) {
  128. value.item.removeAttribute();
  129. }
  130. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelRoot ), 'italic', 'i', null );
  131. expect( viewToString( viewRoot ) ).to.equal( '<div>foo</div>' );
  132. } );
  133. } );
  134. describe( 'model attribute to view attribute conversion', () => {
  135. beforeEach( () => {
  136. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  137. } );
  138. it( 'using default 1-to-1 conversion', () => {
  139. BuildModelConverterFor( dispatcher ).fromAttribute( 'class' ).toAttribute();
  140. let modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, 'foobar' );
  141. modelRoot.appendChildren( modelElement );
  142. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  143. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="myClass">foobar</p></div>' );
  144. modelElement.setAttribute( 'class', 'newClass' );
  145. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'myClass', 'newClass' );
  146. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="newClass">foobar</p></div>' );
  147. modelElement.removeAttribute( 'class' );
  148. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'newClass', null );
  149. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  150. } );
  151. it( 'using passed attribute key', () => {
  152. BuildModelConverterFor( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' );
  153. let modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, 'foobar' );
  154. modelRoot.appendChildren( modelElement );
  155. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  156. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="abc">foobar</p></div>' );
  157. modelElement.setAttribute( 'theme', 'xyz' );
  158. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'abc', 'xyz' );
  159. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="xyz">foobar</p></div>' );
  160. modelElement.removeAttribute( 'theme' );
  161. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'xyz', null );
  162. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  163. } );
  164. it( 'using passed attribute key and value', () => {
  165. BuildModelConverterFor( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' );
  166. let modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, 'foobar' );
  167. modelRoot.appendChildren( modelElement );
  168. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  169. expect( viewToString( viewRoot ) ).to.equal( '<div><p style="background:yellow;">foobar</p></div>' );
  170. modelElement.removeAttribute( 'highlighted' );
  171. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'highlighted', true, null );
  172. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  173. } );
  174. it( 'using passed attribute creator function', () => {
  175. BuildModelConverterFor( dispatcher )
  176. .fromAttribute( 'theme' )
  177. .toAttribute( ( value ) => ( { key: 'class', value: value + '-theme' } ) );
  178. let modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, 'foobar' );
  179. modelRoot.appendChildren( modelElement );
  180. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  181. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice-theme">foobar</p></div>' );
  182. modelElement.setAttribute( 'theme', 'good' );
  183. dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'nice', 'good' );
  184. expect( viewToString( viewRoot ) ).to.equal( '<div><p class="good-theme">foobar</p></div>' );
  185. modelElement.removeAttribute( 'theme' );
  186. dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'theme', 'good', null );
  187. expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
  188. } );
  189. } );
  190. describe( 'withPriority', () => {
  191. it( 'should change default converters priority', () => {
  192. BuildModelConverterFor( dispatcher ).fromElement( 'custom' ).toElement( 'custom' );
  193. BuildModelConverterFor( dispatcher ).fromElement( 'custom' ).withPriority( 0 ).toElement( 'other' );
  194. let modelElement = new ModelElement( 'custom', null, 'foobar' );
  195. modelRoot.appendChildren( modelElement );
  196. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  197. expect( viewToString( viewRoot ) ).to.equal( '<div><other>foobar</other></div>' );
  198. } );
  199. } );
  200. it( 'should do nothing on model element to view attribute conversion', () => {
  201. BuildModelConverterFor( dispatcher ).fromElement( 'div' ).toElement( 'div' );
  202. // Should do nothing:
  203. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true );
  204. // If above would do something this one would not be fired:
  205. BuildModelConverterFor( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' );
  206. let modelElement = new ModelElement( 'div', null, new ModelElement( 'paragraph', null, 'foobar' ) );
  207. modelRoot.appendChildren( modelElement );
  208. dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
  209. expect( viewToString( viewRoot ) ).to.equal( '<div><div><p>foobar</p></div></div>' );
  210. } );
  211. } );