document.js 11 KB

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