document.js 14 KB

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