document.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  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. import Document from '/ckeditor5/engine/treeview/document.js';
  8. import Observer from '/ckeditor5/engine/treeview/observer/observer.js';
  9. import Renderer from '/ckeditor5/engine/treeview/renderer.js';
  10. import Writer from '/ckeditor5/engine/treeview/writer.js';
  11. import DomConverter from '/ckeditor5/engine/treeview/domconverter.js';
  12. import count from '/ckeditor5/utils/count.js';
  13. describe( 'Document', () => {
  14. let ObserverMock, ObserverMockGlobalCount, instantiated, enabled;
  15. beforeEach( () => {
  16. instantiated = 0;
  17. enabled = 0;
  18. ObserverMock = class extends Observer {
  19. constructor( viewDocument ) {
  20. super( viewDocument );
  21. this.enable = sinon.spy();
  22. this.disable = sinon.spy();
  23. this.observe = sinon.spy();
  24. }
  25. };
  26. ObserverMockGlobalCount = class extends Observer {
  27. constructor( viewDocument ) {
  28. super( viewDocument );
  29. instantiated++;
  30. this.observe = sinon.spy();
  31. }
  32. enable() {
  33. enabled++;
  34. }
  35. };
  36. } );
  37. describe( 'constructor', () => {
  38. it( 'should create Document with all properties', () => {
  39. const viewDocument = new Document();
  40. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  41. expect( count( viewDocument.viewRoots ) ).to.equal( 0 );
  42. expect( count( viewDocument._observers ) ).to.equal( 0 );
  43. expect( viewDocument ).to.have.property( 'renderer' ).that.is.instanceOf( Renderer );
  44. expect( viewDocument ).to.have.property( 'writer' ).that.is.instanceOf( Writer );
  45. expect( viewDocument ).to.have.property( 'domConverter' ).that.is.instanceOf( DomConverter );
  46. } );
  47. } );
  48. describe( 'createRoot', () => {
  49. it( 'should create root', () => {
  50. const domP = document.createElement( 'p' );
  51. const domDiv = document.createElement( 'div' );
  52. domDiv.setAttribute( 'id', 'editor' );
  53. domDiv.appendChild( domP );
  54. const viewDocument = new Document();
  55. const ret = viewDocument.createRoot( domDiv, 'editor' );
  56. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  57. expect( count( viewDocument.viewRoots ) ).to.equal( 1 );
  58. const domRoot = viewDocument.domRoots.get( 'editor' );
  59. const viewRoot = viewDocument.viewRoots.get( 'editor' );
  60. expect( ret ).to.equal( viewRoot );
  61. expect( domRoot ).to.equal( domDiv );
  62. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  63. expect( viewRoot.name ).to.equal( 'div' );
  64. expect( viewRoot.getAttribute( 'id' ) ).to.equal( 'editor' );
  65. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  66. } );
  67. it( 'should call observe on each observer', () => {
  68. const viewDocument = new Document( document.createElement( 'div' ) );
  69. viewDocument.renderer.render = sinon.spy();
  70. const domDiv1 = document.createElement( 'div' );
  71. domDiv1.setAttribute( 'id', 'editor' );
  72. const domDiv2 = document.createElement( 'div' );
  73. domDiv2.setAttribute( 'id', 'editor' );
  74. const observerMock = viewDocument.addObserver( ObserverMock );
  75. const observerMockGlobalCount = viewDocument.addObserver( ObserverMockGlobalCount );
  76. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  77. sinon.assert.calledOnce( observerMock.observe );
  78. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  79. } );
  80. it( 'should create "main" root by default', () => {
  81. const domDiv = document.createElement( 'div' );
  82. const viewDocument = new Document();
  83. const ret = viewDocument.createRoot( domDiv );
  84. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  85. expect( count( viewDocument.viewRoots ) ).to.equal( 1 );
  86. const domRoot = viewDocument.domRoots.get( 'main' );
  87. const viewRoot = viewDocument.viewRoots.get( 'main' );
  88. expect( ret ).to.equal( viewRoot );
  89. expect( domRoot ).to.equal( domDiv );
  90. } );
  91. } );
  92. describe( 'getRoot', () => {
  93. it( 'should return "main" root', () => {
  94. const viewDocument = new Document();
  95. viewDocument.createRoot( document.createElement( 'div' ) );
  96. expect( count( viewDocument.viewRoots ) ).to.equal( 1 );
  97. expect( viewDocument.getRoot() ).to.equal( viewDocument.viewRoots.get( 'main' ) );
  98. } );
  99. it( 'should return named root', () => {
  100. const viewDocument = new Document();
  101. viewDocument.createRoot( document.createElement( 'h1' ), 'header' );
  102. expect( count( viewDocument.viewRoots ) ).to.equal( 1 );
  103. expect( viewDocument.getRoot( 'header' ) ).to.equal( viewDocument.viewRoots.get( 'header' ) );
  104. } );
  105. } );
  106. describe( 'addObserver', () => {
  107. let viewDocument;
  108. beforeEach( () => {
  109. viewDocument = new Document( document.createElement( 'div' ) );
  110. viewDocument.renderer.render = sinon.spy();
  111. } );
  112. it( 'should be instantiated and enabled on adding', () => {
  113. const observerMock = viewDocument.addObserver( ObserverMock );
  114. expect( viewDocument._observers.size ).to.equal( 1 );
  115. expect( observerMock ).to.have.property( 'document', viewDocument );
  116. sinon.assert.calledOnce( observerMock.enable );
  117. } );
  118. it( 'should return observer instance ever time addObserver is called', () => {
  119. const observerMock1 = viewDocument.addObserver( ObserverMock );
  120. const observerMock2 = viewDocument.addObserver( ObserverMock );
  121. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  122. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  123. expect( observerMock1 ).to.equals( observerMock2 );
  124. } );
  125. it( 'should instantiate one observer only once', () => {
  126. viewDocument.addObserver( ObserverMockGlobalCount );
  127. viewDocument.addObserver( ObserverMockGlobalCount );
  128. expect( viewDocument._observers.size ).to.equal( 1 );
  129. expect( instantiated ).to.equal( 1 );
  130. expect( enabled ).to.equal( 1 );
  131. viewDocument.addObserver( ObserverMock );
  132. expect( viewDocument._observers.size ).to.equal( 2 );
  133. } );
  134. it( 'should instantiate child class of already registered observer', () => {
  135. class ObserverMock extends Observer {
  136. enable() {}
  137. }
  138. class ChildObserverMock extends ObserverMock {
  139. enable() {}
  140. }
  141. viewDocument.addObserver( ObserverMock );
  142. viewDocument.addObserver( ChildObserverMock );
  143. expect( viewDocument._observers.size ).to.equal( 2 );
  144. } );
  145. it( 'should be disabled and re-enabled on render', () => {
  146. const observerMock = viewDocument.addObserver( ObserverMock );
  147. viewDocument.render();
  148. sinon.assert.calledOnce( observerMock.disable );
  149. sinon.assert.calledOnce( viewDocument.renderer.render );
  150. sinon.assert.calledTwice( observerMock.enable );
  151. } );
  152. it( 'should call observe on each root', () => {
  153. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  154. viewDocument.createRoot( document.createElement( 'div' ), 'root2' );
  155. const observerMock = viewDocument.addObserver( ObserverMock );
  156. sinon.assert.calledTwice( observerMock.observe );
  157. } );
  158. } );
  159. describe( 'getObserver', () => {
  160. it( 'should return observer it it is added', () => {
  161. const viewDocument = new Document();
  162. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  163. const getObserverMock = viewDocument.getObserver( ObserverMock );
  164. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  165. expect( getObserverMock ).to.equal( addedObserverMock );
  166. } );
  167. it( 'should return undefined if observer is not added', () => {
  168. const viewDocument = new Document();
  169. const getObserverMock = viewDocument.getObserver( ObserverMock );
  170. expect( getObserverMock ).to.be.undefined();
  171. } );
  172. } );
  173. } );