renderer.js 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treeview */
  6. 'use strict';
  7. const modules = bender.amd.require(
  8. 'core/treeview/renderer',
  9. 'core/treeview/element',
  10. 'core/treeview/text',
  11. 'core/treeview/converter',
  12. 'core/ckeditorerror'
  13. );
  14. describe( 'Renderer', () => {
  15. let Renderer, ViewElement, ViewText, CKEditorError, Converter;
  16. let converter, renderer;
  17. before( () => {
  18. Renderer = modules[ 'core/treeview/renderer' ];
  19. ViewElement = modules[ 'core/treeview/element' ];
  20. ViewText = modules[ 'core/treeview/text' ];
  21. CKEditorError = modules[ 'core/ckeditorerror' ];
  22. Converter = modules[ 'core/treeview/converter' ];
  23. converter = new Converter();
  24. renderer = new Renderer( converter );
  25. } );
  26. describe( 'markToSync', () => {
  27. let viewNode;
  28. beforeEach( () => {
  29. viewNode = new ViewElement( 'p' );
  30. const domNode = document.createElement( 'p' );
  31. converter.bindElements( domNode, viewNode );
  32. viewNode.appendChildren( new ViewText( 'foo' ) );
  33. renderer.markedTexts.clear();
  34. renderer.markedAttrs.clear();
  35. renderer.markedChildren.clear();
  36. } );
  37. it( 'should mark attributes which need update', () => {
  38. viewNode.setAttr( 'class', 'foo' );
  39. renderer.markToSync( viewNode, 'ATTRIBUTES_NEED_UPDATE' );
  40. expect( renderer.markedAttrs.has( viewNode ) ).to.be.true;
  41. } );
  42. it( 'should mark children which need update', () => {
  43. viewNode.appendChildren( new ViewText( 'foo' ) );
  44. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  45. expect( renderer.markedChildren.has( viewNode ) ).to.be.true;
  46. } );
  47. it( 'should not mark children if element has no corresponding node', () => {
  48. // Overwrite viewNode with node without coresponding DOM node.
  49. viewNode = new ViewElement( 'p' );
  50. viewNode.appendChildren( new ViewText( 'foo' ) );
  51. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  52. expect( renderer.markedTexts.has( viewNode ) ).to.be.false;
  53. } );
  54. it( 'should mark text which need update', () => {
  55. const viewText = new ViewText( 'foo' );
  56. viewNode.appendChildren( viewText );
  57. viewText.setText( 'bar' );
  58. renderer.markToSync( viewText, 'TEXT_NEEDS_UPDATE' );
  59. expect( renderer.markedTexts.has( viewText ) ).to.be.true;
  60. } );
  61. it( 'should not mark text if parent has no corresponding node', () => {
  62. const viewText = new ViewText( 'foo' );
  63. // Overwrite viewNode with node without coresponding DOM node.
  64. viewNode = new ViewElement( 'p' );
  65. viewNode.appendChildren( viewText );
  66. viewText.setText( 'bar' );
  67. renderer.markToSync( viewText, 'TEXT_NEEDS_UPDATE' );
  68. expect( renderer.markedTexts.has( viewText ) ).to.be.false;
  69. } );
  70. it( 'should throw if the type is unknown', () => {
  71. expect( () => {
  72. renderer.markToSync( viewNode, 'UNKNOWN' );
  73. } ).to.throw( CKEditorError, /^renderer-unknown-type/ );
  74. } );
  75. } );
  76. describe( 'render', () => {
  77. let viewNode, domNode;
  78. beforeEach( () => {
  79. viewNode = new ViewElement( 'p' );
  80. domNode = document.createElement( 'p' );
  81. converter.bindElements( domNode, viewNode );
  82. renderer.markedTexts.clear();
  83. renderer.markedAttrs.clear();
  84. renderer.markedChildren.clear();
  85. } );
  86. it( 'should update attributes', () => {
  87. viewNode.setAttr( 'class', 'foo' );
  88. renderer.markToSync( viewNode, 'ATTRIBUTES_NEED_UPDATE' );
  89. renderer.render();
  90. expect( domNode.getAttribute( 'class' ) ).to.equal( 'foo' );
  91. expect( renderer.markedAttrs.size ).to.equal( 0 );
  92. } );
  93. it( 'should remove attributes', () => {
  94. viewNode.setAttr( 'class', 'foo' );
  95. domNode.setAttribute( 'id', 'bar' );
  96. domNode.setAttribute( 'class', 'bar' );
  97. renderer.markToSync( viewNode, 'ATTRIBUTES_NEED_UPDATE' );
  98. renderer.render();
  99. expect( domNode.getAttribute( 'class' ) ).to.equal( 'foo' );
  100. expect( domNode.getAttribute( 'id' ) ).to.be.not.ok;
  101. expect( renderer.markedAttrs.size ).to.equal( 0 );
  102. } );
  103. it( 'should add children', () => {
  104. viewNode.appendChildren( new ViewText( 'foo' ) );
  105. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  106. renderer.render();
  107. expect( domNode.childNodes.length ).to.equal( 1 );
  108. expect( domNode.childNodes[ 0 ].data ).to.equal( 'foo' );
  109. expect( renderer.markedChildren.size ).to.equal( 0 );
  110. } );
  111. it( 'should remove children', () => {
  112. viewNode.appendChildren( new ViewText( 'foo' ) );
  113. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  114. renderer.render();
  115. expect( domNode.childNodes.length ).to.equal( 1 );
  116. expect( domNode.childNodes[ 0 ].data ).to.equal( 'foo' );
  117. viewNode.removeChildren( 0, 1 );
  118. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  119. renderer.render();
  120. expect( domNode.childNodes.length ).to.equal( 0 );
  121. expect( renderer.markedChildren.size ).to.equal( 0 );
  122. } );
  123. it( 'should update text', () => {
  124. const viewText = new ViewText( 'foo' );
  125. viewNode.appendChildren( viewText );
  126. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  127. renderer.render();
  128. expect( domNode.childNodes.length ).to.equal( 1 );
  129. expect( domNode.childNodes[ 0 ].data ).to.equal( 'foo' );
  130. viewText.setText( 'bar' );
  131. renderer.markToSync( viewText, 'TEXT_NEEDS_UPDATE' );
  132. renderer.render();
  133. expect( domNode.childNodes.length ).to.equal( 1 );
  134. expect( domNode.childNodes[ 0 ].data ).to.equal( 'bar' );
  135. expect( renderer.markedTexts.size ).to.equal( 0 );
  136. } );
  137. it( 'should not update text parent child list changed', () => {
  138. const viewImg = new ViewElement( 'img' );
  139. const viewText = new ViewText( 'foo' );
  140. viewNode.appendChildren( [ viewImg, viewText ] );
  141. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  142. renderer.markToSync( viewText, 'TEXT_NEEDS_UPDATE' );
  143. renderer.render();
  144. expect( domNode.childNodes.length ).to.equal( 2 );
  145. expect( domNode.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'img' );
  146. expect( domNode.childNodes[ 1 ].data ).to.equal( 'foo' );
  147. } );
  148. it( 'should not change text if it is the same during text rendering', () => {
  149. const viewText = new ViewText( 'foo' );
  150. viewNode.appendChildren( viewText );
  151. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  152. renderer.render();
  153. // This should not be changed during the render.
  154. const domText = domNode.childNodes[ 0 ];
  155. renderer.markToSync( viewText, 'TEXT_NEEDS_UPDATE' );
  156. renderer.render();
  157. expect( domNode.childNodes.length ).to.equal( 1 );
  158. expect( domNode.childNodes[ 0 ] ).to.equal( domText );
  159. } );
  160. it( 'should not change text if it is the same during children rendering', () => {
  161. const viewText = new ViewText( 'foo' );
  162. viewNode.appendChildren( viewText );
  163. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  164. renderer.render();
  165. // This should not be changed during the render.
  166. const domText = domNode.childNodes[ 0 ];
  167. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  168. renderer.render();
  169. expect( domNode.childNodes.length ).to.equal( 1 );
  170. expect( domNode.childNodes[ 0 ] ).to.equal( domText );
  171. } );
  172. it( 'should not change element if it is the same', () => {
  173. const viewImg = new ViewElement( 'img' );
  174. viewNode.appendChildren( viewImg );
  175. // This should not be changed during the render.
  176. const domImg = document.createElement( 'img' );
  177. domNode.appendChild( domImg );
  178. converter.bindElements( domImg, viewImg );
  179. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  180. renderer.render();
  181. expect( domNode.childNodes.length ).to.equal( 1 );
  182. expect( domNode.childNodes[ 0 ] ).to.equal( domImg );
  183. } );
  184. it( 'should change element if it is different', () => {
  185. const viewImg = new ViewElement( 'img' );
  186. viewNode.appendChildren( viewImg );
  187. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  188. renderer.render();
  189. const viewP = new ViewElement( 'p' );
  190. viewNode.removeChildren( 0, 1 );
  191. viewNode.appendChildren( viewP );
  192. renderer.markToSync( viewNode, 'CHILDREN_NEED_UPDATE' );
  193. renderer.render();
  194. expect( domNode.childNodes.length ).to.equal( 1 );
  195. expect( domNode.childNodes[ 0 ].tagName.toLowerCase() ).to.equal( 'p' );
  196. } );
  197. } );
  198. } );