document.js 15 KB

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