document.js 15 KB

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