document.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: view, browser-only */
  6. 'use strict';
  7. import Document from '/ckeditor5/engine/view/document.js';
  8. import Observer from '/ckeditor5/engine/view/observer/observer.js';
  9. import Renderer from '/ckeditor5/engine/view/renderer.js';
  10. import Writer from '/ckeditor5/engine/view/writer.js';
  11. import DomConverter from '/ckeditor5/engine/view/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.roots ) ).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.appendChild( domP );
  53. const viewDocument = new Document();
  54. const ret = viewDocument.createRoot( domDiv );
  55. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  56. expect( count( viewDocument.roots ) ).to.equal( 1 );
  57. const domRoot = viewDocument.getDomRoot();
  58. const viewRoot = viewDocument.getRoot();
  59. expect( ret ).to.equal( viewRoot );
  60. expect( domRoot ).to.equal( domDiv );
  61. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  62. expect( viewRoot.name.toLowerCase() ).to.equal( 'div' );
  63. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  64. } );
  65. it( 'should call observe on each observer', () => {
  66. const viewDocument = new Document( document.createElement( 'div' ) );
  67. viewDocument.renderer.render = sinon.spy();
  68. const domDiv1 = document.createElement( 'div' );
  69. domDiv1.setAttribute( 'id', 'editor' );
  70. const domDiv2 = document.createElement( 'div' );
  71. domDiv2.setAttribute( 'id', 'editor' );
  72. const observerMock = viewDocument.addObserver( ObserverMock );
  73. const observerMockGlobalCount = viewDocument.addObserver( ObserverMockGlobalCount );
  74. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  75. sinon.assert.calledOnce( observerMock.observe );
  76. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  77. } );
  78. it( 'should create "main" root by default', () => {
  79. const domDiv = document.createElement( 'div' );
  80. const viewDocument = new Document();
  81. const ret = viewDocument.createRoot( domDiv );
  82. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  83. expect( count( viewDocument.roots ) ).to.equal( 1 );
  84. const domRoot = viewDocument.domRoots.get( 'main' );
  85. const viewRoot = viewDocument.roots.get( 'main' );
  86. expect( ret ).to.equal( viewRoot );
  87. expect( domRoot ).to.equal( domDiv );
  88. } );
  89. it( 'should create root with given name', () => {
  90. const domDiv = document.createElement( 'div' );
  91. const viewDocument = new Document();
  92. const ret = viewDocument.createRoot( domDiv, 'header' );
  93. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  94. expect( count( viewDocument.roots ) ).to.equal( 1 );
  95. const domRoot = viewDocument.domRoots.get( 'header' );
  96. const viewRoot = viewDocument.roots.get( 'header' );
  97. expect( ret ).to.equal( viewRoot );
  98. expect( domRoot ).to.equal( domDiv );
  99. } );
  100. it( 'should create root without attaching DOM element', () => {
  101. const viewDocument = new Document();
  102. const ret = viewDocument.createRoot( 'div' );
  103. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  104. expect( count( viewDocument.roots ) ).to.equal( 1 );
  105. expect( ret ).to.equal( viewDocument.getRoot() );
  106. } );
  107. } );
  108. describe( 'attachDomRoot', () => {
  109. it( 'should create root without attach DOM element to the view element', () => {
  110. const domDiv = document.createElement( 'div' );
  111. const viewDocument = new Document();
  112. const viewRoot = viewDocument.createRoot( 'div' );
  113. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  114. expect( count( viewDocument.roots ) ).to.equal( 1 );
  115. expect( viewRoot ).to.equal( viewDocument.getRoot() );
  116. viewDocument.attachDomRoot( domDiv );
  117. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  118. expect( count( viewDocument.roots ) ).to.equal( 1 );
  119. expect( viewDocument.getDomRoot() ).to.equal( domDiv );
  120. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  121. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  122. } );
  123. it( 'should create root without attach DOM element to the view element with given name', () => {
  124. const domH1 = document.createElement( 'h1' );
  125. const viewDocument = new Document();
  126. viewDocument.createRoot( 'div' );
  127. const viewH1 = viewDocument.createRoot( 'h1', 'header' );
  128. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  129. expect( count( viewDocument.roots ) ).to.equal( 2 );
  130. expect( viewH1 ).to.equal( viewDocument.getRoot( 'header' ) );
  131. viewDocument.attachDomRoot( domH1, 'header' );
  132. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  133. expect( count( viewDocument.roots ) ).to.equal( 2 );
  134. expect( viewDocument.getDomRoot( 'header' ) ).to.equal( domH1 );
  135. expect( viewDocument.domConverter.getCorrespondingDom( viewH1 ) ).to.equal( domH1 );
  136. expect( viewDocument.renderer.markedChildren.has( viewH1 ) ).to.be.true;
  137. } );
  138. } );
  139. describe( 'getRoot', () => {
  140. it( 'should return "main" root', () => {
  141. const viewDocument = new Document();
  142. viewDocument.createRoot( document.createElement( 'div' ) );
  143. expect( count( viewDocument.roots ) ).to.equal( 1 );
  144. expect( viewDocument.getRoot() ).to.equal( viewDocument.roots.get( 'main' ) );
  145. } );
  146. it( 'should return named root', () => {
  147. const viewDocument = new Document();
  148. viewDocument.createRoot( document.createElement( 'h1' ), 'header' );
  149. expect( count( viewDocument.roots ) ).to.equal( 1 );
  150. expect( viewDocument.getRoot( 'header' ) ).to.equal( viewDocument.roots.get( 'header' ) );
  151. } );
  152. } );
  153. describe( 'addObserver', () => {
  154. let viewDocument;
  155. beforeEach( () => {
  156. viewDocument = new Document( document.createElement( 'div' ) );
  157. viewDocument.renderer.render = sinon.spy();
  158. } );
  159. it( 'should be instantiated and enabled on adding', () => {
  160. const observerMock = viewDocument.addObserver( ObserverMock );
  161. expect( viewDocument._observers.size ).to.equal( 1 );
  162. expect( observerMock ).to.have.property( 'document', viewDocument );
  163. sinon.assert.calledOnce( observerMock.enable );
  164. } );
  165. it( 'should return observer instance ever time addObserver is called', () => {
  166. const observerMock1 = viewDocument.addObserver( ObserverMock );
  167. const observerMock2 = viewDocument.addObserver( ObserverMock );
  168. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  169. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  170. expect( observerMock1 ).to.equals( observerMock2 );
  171. } );
  172. it( 'should instantiate one observer only once', () => {
  173. viewDocument.addObserver( ObserverMockGlobalCount );
  174. viewDocument.addObserver( ObserverMockGlobalCount );
  175. expect( viewDocument._observers.size ).to.equal( 1 );
  176. expect( instantiated ).to.equal( 1 );
  177. expect( enabled ).to.equal( 1 );
  178. viewDocument.addObserver( ObserverMock );
  179. expect( viewDocument._observers.size ).to.equal( 2 );
  180. } );
  181. it( 'should instantiate child class of already registered observer', () => {
  182. class ObserverMock extends Observer {
  183. enable() {}
  184. }
  185. class ChildObserverMock extends ObserverMock {
  186. enable() {}
  187. }
  188. viewDocument.addObserver( ObserverMock );
  189. viewDocument.addObserver( ChildObserverMock );
  190. expect( viewDocument._observers.size ).to.equal( 2 );
  191. } );
  192. it( 'should be disabled and re-enabled on render', () => {
  193. const observerMock = viewDocument.addObserver( ObserverMock );
  194. viewDocument.render();
  195. sinon.assert.calledOnce( observerMock.disable );
  196. sinon.assert.calledOnce( viewDocument.renderer.render );
  197. sinon.assert.calledTwice( observerMock.enable );
  198. } );
  199. it( 'should call observe on each root', () => {
  200. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  201. viewDocument.createRoot( document.createElement( 'div' ), 'root2' );
  202. const observerMock = viewDocument.addObserver( ObserverMock );
  203. sinon.assert.calledTwice( observerMock.observe );
  204. } );
  205. } );
  206. describe( 'getObserver', () => {
  207. it( 'should return observer it it is added', () => {
  208. const viewDocument = new Document();
  209. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  210. const getObserverMock = viewDocument.getObserver( ObserverMock );
  211. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  212. expect( getObserverMock ).to.equal( addedObserverMock );
  213. } );
  214. it( 'should return undefined if observer is not added', () => {
  215. const viewDocument = new Document();
  216. const getObserverMock = viewDocument.getObserver( ObserverMock );
  217. expect( getObserverMock ).to.be.undefined();
  218. } );
  219. } );
  220. describe( 'disableObservers', () => {
  221. it( 'should disable observers', () => {
  222. const viewDocument = new Document();
  223. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  224. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  225. expect( addedObserverMock.disable.called ).to.be.false;
  226. viewDocument.disableObservers();
  227. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  228. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  229. } );
  230. } );
  231. describe( 'enableObservers', () => {
  232. it( 'should enable observers', () => {
  233. const viewDocument = new Document();
  234. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  235. viewDocument.disableObservers();
  236. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  237. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  238. viewDocument.enableObservers();
  239. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  240. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  241. } );
  242. } );
  243. } );