document.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. /* bender-tags: view, browser-only */
  7. import Document from '/ckeditor5/engine/view/document.js';
  8. import Observer from '/ckeditor5/engine/view/observer/observer.js';
  9. import MutationObserver from '/ckeditor5/engine/view/observer/mutationobserver.js';
  10. import SelectionObserver from '/ckeditor5/engine/view/observer/selectionobserver.js';
  11. import FocusObserver from '/ckeditor5/engine/view/observer/focusobserver.js';
  12. import KeyObserver from '/ckeditor5/engine/view/observer/keyobserver.js';
  13. import Renderer from '/ckeditor5/engine/view/renderer.js';
  14. import ViewRange from '/ckeditor5/engine/view/range.js';
  15. import DomConverter from '/ckeditor5/engine/view/domconverter.js';
  16. import testUtils from '/tests/core/_utils/utils.js';
  17. import count from '/ckeditor5/utils/count.js';
  18. import log from '/ckeditor5/utils/log.js';
  19. testUtils.createSinonSandbox();
  20. describe( 'Document', () => {
  21. const DEFAULT_OBSERVERS_COUNT = 4;
  22. let ObserverMock, ObserverMockGlobalCount, instantiated, enabled;
  23. beforeEach( () => {
  24. instantiated = 0;
  25. enabled = 0;
  26. ObserverMock = class extends Observer {
  27. constructor( viewDocument ) {
  28. super( viewDocument );
  29. this.enable = sinon.spy();
  30. this.disable = sinon.spy();
  31. this.observe = sinon.spy();
  32. }
  33. };
  34. ObserverMockGlobalCount = class extends Observer {
  35. constructor( viewDocument ) {
  36. super( viewDocument );
  37. instantiated++;
  38. this.observe = sinon.spy();
  39. }
  40. enable() {
  41. enabled++;
  42. }
  43. };
  44. } );
  45. describe( 'constructor', () => {
  46. it( 'should create Document with all properties', () => {
  47. const viewDocument = new Document();
  48. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  49. expect( count( viewDocument.roots ) ).to.equal( 0 );
  50. expect( viewDocument ).to.have.property( 'renderer' ).that.is.instanceOf( Renderer );
  51. expect( viewDocument ).to.have.property( 'domConverter' ).that.is.instanceOf( DomConverter );
  52. expect( viewDocument ).to.have.property( 'isFocused' ).that.is.false;
  53. } );
  54. it( 'should add default observers', () => {
  55. const viewDocument = new Document();
  56. expect( count( viewDocument._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
  57. expect( viewDocument.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
  58. expect( viewDocument.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
  59. expect( viewDocument.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
  60. expect( viewDocument.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
  61. } );
  62. } );
  63. describe( 'createRoot', () => {
  64. it( 'should create root', () => {
  65. const domP = document.createElement( 'p' );
  66. const domDiv = document.createElement( 'div' );
  67. domDiv.appendChild( domP );
  68. const viewDocument = new Document();
  69. const ret = viewDocument.createRoot( domDiv );
  70. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  71. expect( count( viewDocument.roots ) ).to.equal( 1 );
  72. const domRoot = viewDocument.getDomRoot();
  73. const viewRoot = viewDocument.getRoot();
  74. expect( ret ).to.equal( viewRoot );
  75. expect( domRoot ).to.equal( domDiv );
  76. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  77. expect( viewRoot.name ).to.equal( 'div' );
  78. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  79. } );
  80. it( 'should call observe on each observer', () => {
  81. const viewDocument = new Document( document.createElement( 'div' ) );
  82. viewDocument.renderer.render = sinon.spy();
  83. const domDiv1 = document.createElement( 'div' );
  84. domDiv1.setAttribute( 'id', 'editor' );
  85. const domDiv2 = document.createElement( 'div' );
  86. domDiv2.setAttribute( 'id', 'editor' );
  87. const observerMock = viewDocument.addObserver( ObserverMock );
  88. const observerMockGlobalCount = viewDocument.addObserver( ObserverMockGlobalCount );
  89. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  90. sinon.assert.calledOnce( observerMock.observe );
  91. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  92. } );
  93. it( 'should create "main" root by default', () => {
  94. const domDiv = document.createElement( 'div' );
  95. const viewDocument = new Document();
  96. const ret = viewDocument.createRoot( domDiv );
  97. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  98. expect( count( viewDocument.roots ) ).to.equal( 1 );
  99. const domRoot = viewDocument.domRoots.get( 'main' );
  100. const viewRoot = viewDocument.roots.get( 'main' );
  101. expect( ret ).to.equal( viewRoot );
  102. expect( domRoot ).to.equal( domDiv );
  103. } );
  104. it( 'should create root with given name', () => {
  105. const domDiv = document.createElement( 'div' );
  106. const viewDocument = new Document();
  107. const ret = viewDocument.createRoot( domDiv, 'header' );
  108. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  109. expect( count( viewDocument.roots ) ).to.equal( 1 );
  110. const domRoot = viewDocument.domRoots.get( 'header' );
  111. const viewRoot = viewDocument.roots.get( 'header' );
  112. expect( ret ).to.equal( viewRoot );
  113. expect( domRoot ).to.equal( domDiv );
  114. } );
  115. it( 'should create root without attaching DOM element', () => {
  116. const viewDocument = new Document();
  117. const ret = viewDocument.createRoot( 'div' );
  118. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  119. expect( count( viewDocument.roots ) ).to.equal( 1 );
  120. expect( ret ).to.equal( viewDocument.getRoot() );
  121. } );
  122. } );
  123. describe( 'attachDomRoot', () => {
  124. it( 'should create root without attach DOM element to the view element', () => {
  125. const domDiv = document.createElement( 'div' );
  126. const viewDocument = new Document();
  127. const viewRoot = viewDocument.createRoot( 'div' );
  128. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  129. expect( count( viewDocument.roots ) ).to.equal( 1 );
  130. expect( viewRoot ).to.equal( viewDocument.getRoot() );
  131. viewDocument.attachDomRoot( domDiv );
  132. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  133. expect( count( viewDocument.roots ) ).to.equal( 1 );
  134. expect( viewDocument.getDomRoot() ).to.equal( domDiv );
  135. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  136. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  137. } );
  138. it( 'should create root without attach DOM element to the view element with given name', () => {
  139. const domH1 = document.createElement( 'h1' );
  140. const viewDocument = new Document();
  141. viewDocument.createRoot( 'DIV' );
  142. const viewH1 = viewDocument.createRoot( 'h1', 'header' );
  143. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  144. expect( count( viewDocument.roots ) ).to.equal( 2 );
  145. expect( viewH1 ).to.equal( viewDocument.getRoot( 'header' ) );
  146. viewDocument.attachDomRoot( domH1, 'header' );
  147. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  148. expect( count( viewDocument.roots ) ).to.equal( 2 );
  149. expect( viewDocument.getDomRoot( 'header' ) ).to.equal( domH1 );
  150. expect( viewDocument.domConverter.getCorrespondingDom( viewH1 ) ).to.equal( domH1 );
  151. expect( viewDocument.getRoot().name ).to.equal( 'div' );
  152. expect( viewDocument.renderer.markedChildren.has( viewH1 ) ).to.be.true;
  153. } );
  154. } );
  155. describe( 'getRoot', () => {
  156. it( 'should return "main" root', () => {
  157. const viewDocument = new Document();
  158. viewDocument.createRoot( document.createElement( 'div' ) );
  159. expect( count( viewDocument.roots ) ).to.equal( 1 );
  160. expect( viewDocument.getRoot() ).to.equal( viewDocument.roots.get( 'main' ) );
  161. } );
  162. it( 'should return named root', () => {
  163. const viewDocument = new Document();
  164. viewDocument.createRoot( document.createElement( 'h1' ), 'header' );
  165. expect( count( viewDocument.roots ) ).to.equal( 1 );
  166. expect( viewDocument.getRoot( 'header' ) ).to.equal( viewDocument.roots.get( 'header' ) );
  167. } );
  168. } );
  169. describe( 'addObserver', () => {
  170. let viewDocument;
  171. beforeEach( () => {
  172. viewDocument = new Document( document.createElement( 'div' ) );
  173. viewDocument.renderer.render = sinon.spy();
  174. } );
  175. it( 'should be instantiated and enabled on adding', () => {
  176. const observerMock = viewDocument.addObserver( ObserverMock );
  177. expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  178. expect( observerMock ).to.have.property( 'document', viewDocument );
  179. sinon.assert.calledOnce( observerMock.enable );
  180. } );
  181. it( 'should return observer instance each time addObserver is called', () => {
  182. const observerMock1 = viewDocument.addObserver( ObserverMock );
  183. const observerMock2 = viewDocument.addObserver( ObserverMock );
  184. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  185. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  186. expect( observerMock1 ).to.equals( observerMock2 );
  187. } );
  188. it( 'should instantiate one observer only once', () => {
  189. viewDocument.addObserver( ObserverMockGlobalCount );
  190. viewDocument.addObserver( ObserverMockGlobalCount );
  191. expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  192. expect( instantiated ).to.equal( 1 );
  193. expect( enabled ).to.equal( 1 );
  194. viewDocument.addObserver( ObserverMock );
  195. expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  196. } );
  197. it( 'should instantiate child class of already registered observer', () => {
  198. class ObserverMock extends Observer {
  199. enable() {}
  200. }
  201. class ChildObserverMock extends ObserverMock {
  202. enable() {}
  203. }
  204. viewDocument.addObserver( ObserverMock );
  205. viewDocument.addObserver( ChildObserverMock );
  206. expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  207. } );
  208. it( 'should be disabled and re-enabled on render', () => {
  209. const observerMock = viewDocument.addObserver( ObserverMock );
  210. viewDocument.render();
  211. sinon.assert.calledOnce( observerMock.disable );
  212. sinon.assert.calledOnce( viewDocument.renderer.render );
  213. sinon.assert.calledTwice( observerMock.enable );
  214. } );
  215. it( 'should call observe on each root', () => {
  216. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  217. viewDocument.createRoot( document.createElement( 'div' ), 'root2' );
  218. const observerMock = viewDocument.addObserver( ObserverMock );
  219. sinon.assert.calledTwice( observerMock.observe );
  220. } );
  221. } );
  222. describe( 'getObserver', () => {
  223. it( 'should return observer it it is added', () => {
  224. const viewDocument = new Document();
  225. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  226. const getObserverMock = viewDocument.getObserver( ObserverMock );
  227. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  228. expect( getObserverMock ).to.equal( addedObserverMock );
  229. } );
  230. it( 'should return undefined if observer is not added', () => {
  231. const viewDocument = new Document();
  232. const getObserverMock = viewDocument.getObserver( ObserverMock );
  233. expect( getObserverMock ).to.be.undefined();
  234. } );
  235. } );
  236. describe( 'disableObservers', () => {
  237. it( 'should disable observers', () => {
  238. const viewDocument = new Document();
  239. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  240. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  241. expect( addedObserverMock.disable.called ).to.be.false;
  242. viewDocument.disableObservers();
  243. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  244. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  245. } );
  246. } );
  247. describe( 'enableObservers', () => {
  248. it( 'should enable observers', () => {
  249. const viewDocument = new Document();
  250. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  251. viewDocument.disableObservers();
  252. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  253. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  254. viewDocument.enableObservers();
  255. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  256. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  257. } );
  258. } );
  259. describe( 'isFocused', () => {
  260. it( 'should change renderer.isFocused too', () => {
  261. const viewDocument = new Document();
  262. expect( viewDocument.isFocused ).to.equal( false );
  263. expect( viewDocument.renderer.isFocused ).to.equal( false );
  264. viewDocument.isFocused = true;
  265. expect( viewDocument.isFocused ).to.equal( true );
  266. expect( viewDocument.renderer.isFocused ).to.equal( true );
  267. } );
  268. } );
  269. describe( 'focus', () => {
  270. let viewDocument, domEditable, viewEditable;
  271. beforeEach( () => {
  272. viewDocument = new Document();
  273. domEditable = document.createElement( 'div' );
  274. domEditable.setAttribute( 'contenteditable', 'true' );
  275. document.body.appendChild( domEditable );
  276. viewEditable = viewDocument.createRoot( domEditable );
  277. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewEditable, 0, viewEditable, 0 ) );
  278. } );
  279. afterEach( () => {
  280. document.body.removeChild( domEditable );
  281. } );
  282. it( 'should focus editable with selection', () => {
  283. const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
  284. const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
  285. viewDocument.focus();
  286. expect( converterFocusSpy.called ).to.be.true;
  287. expect( renderSpy.calledOnce ).to.be.true;
  288. expect( document.activeElement ).to.equal( domEditable );
  289. const domSelection = document.getSelection();
  290. expect( domSelection.rangeCount ).to.equal( 1 );
  291. const domRange = domSelection.getRangeAt( 0 );
  292. expect( domRange.startContainer ).to.equal( domEditable );
  293. expect( domRange.startOffset ).to.equal( 0 );
  294. expect( domRange.collapsed ).to.be.true;
  295. } );
  296. it( 'should not focus if document is already focused', () => {
  297. const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
  298. const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
  299. viewDocument.isFocused = true;
  300. viewDocument.focus();
  301. expect( converterFocusSpy.called ).to.be.false;
  302. expect( renderSpy.called ).to.be.false;
  303. } );
  304. it( 'should log warning when no selection', () => {
  305. const logSpy = testUtils.sinon.stub( log, 'warn' );
  306. viewDocument.selection.removeAllRanges();
  307. viewDocument.focus();
  308. expect( logSpy.calledOnce ).to.be.true;
  309. expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^view-focus-no-selection/ );
  310. } );
  311. } );
  312. } );