document.js 14 KB

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