document.js 14 KB

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