view.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import View from '../../../src/view/view';
  7. import Observer from '../../../src/view/observer/observer';
  8. import MutationObserver from '../../../src/view/observer/mutationobserver';
  9. import KeyObserver from '../../../src/view/observer/keyobserver';
  10. import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
  11. import SelectionObserver from '../../../src/view/observer/selectionobserver';
  12. import FocusObserver from '../../../src/view/observer/focusobserver';
  13. import CompositionObserver from '../../../src/view/observer/compositionobserver';
  14. import ViewRange from '../../../src/view/range';
  15. import ViewElement from '../../../src/view/element';
  16. import ViewPosition from '../../../src/view/position';
  17. import ViewSelection from '../../../src/view/selection';
  18. import { isBlockFiller, BR_FILLER } from '../../../src/view/filler';
  19. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  20. import log from '@ckeditor/ckeditor5-utils/src/log';
  21. import count from '@ckeditor/ckeditor5-utils/src/count';
  22. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  23. import createViewRoot from '../_utils/createroot';
  24. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  25. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  26. describe( 'view', () => {
  27. const DEFAULT_OBSERVERS_COUNT = 6;
  28. let domRoot, view, viewDocument, ObserverMock, instantiated, enabled, ObserverMockGlobalCount;
  29. testUtils.createSinonSandbox();
  30. beforeEach( () => {
  31. domRoot = createElement( document, 'div', {
  32. id: 'editor',
  33. contenteditable: 'true'
  34. } );
  35. document.body.appendChild( domRoot );
  36. view = new View();
  37. viewDocument = view.document;
  38. ObserverMock = class extends Observer {
  39. constructor( view ) {
  40. super( view );
  41. this.enable = sinon.spy();
  42. this.disable = sinon.spy();
  43. this.observe = sinon.spy();
  44. this.destroy = sinon.spy();
  45. }
  46. };
  47. instantiated = 0;
  48. enabled = 0;
  49. ObserverMockGlobalCount = class extends Observer {
  50. constructor( view ) {
  51. super( view );
  52. instantiated++;
  53. this.observe = sinon.spy();
  54. }
  55. enable() {
  56. enabled++;
  57. }
  58. };
  59. } );
  60. afterEach( () => {
  61. domRoot.remove();
  62. view.destroy();
  63. } );
  64. it( 'should add default observers', () => {
  65. expect( count( view._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
  66. expect( view.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
  67. expect( view.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
  68. expect( view.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
  69. expect( view.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
  70. expect( view.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver );
  71. expect( view.getObserver( CompositionObserver ) ).to.be.instanceof( CompositionObserver );
  72. } );
  73. describe( 'attachDomRoot()', () => {
  74. it( 'should attach DOM element to main view element', () => {
  75. const domDiv = document.createElement( 'div' );
  76. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  77. expect( count( view.domRoots ) ).to.equal( 0 );
  78. view.attachDomRoot( domDiv );
  79. expect( count( view.domRoots ) ).to.equal( 1 );
  80. expect( view.getDomRoot() ).to.equal( domDiv );
  81. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  82. expect( view._renderer.markedChildren.has( viewRoot ) ).to.be.true;
  83. domDiv.remove();
  84. } );
  85. it( 'should attach DOM element to custom view element', () => {
  86. const domH1 = document.createElement( 'h1' );
  87. const viewH1 = createViewRoot( viewDocument, 'h1', 'header' );
  88. expect( count( view.domRoots ) ).to.equal( 0 );
  89. view.attachDomRoot( domH1, 'header' );
  90. expect( count( view.domRoots ) ).to.equal( 1 );
  91. expect( view.getDomRoot( 'header' ) ).to.equal( domH1 );
  92. expect( view.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 );
  93. expect( view._renderer.markedChildren.has( viewH1 ) ).to.be.true;
  94. } );
  95. it( 'should handle the "contenteditable" attribute management on #isReadOnly change', () => {
  96. const domDiv = document.createElement( 'div' );
  97. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  98. view.attachDomRoot( domDiv );
  99. viewRoot.isReadOnly = false;
  100. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  101. viewRoot.isReadOnly = true;
  102. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'false' );
  103. } );
  104. it( 'should call observe on each observer', () => {
  105. // The variable will be overwritten.
  106. view.destroy();
  107. view = new View();
  108. viewDocument = view.document;
  109. view._renderer.render = sinon.spy();
  110. const domDiv1 = document.createElement( 'div' );
  111. domDiv1.setAttribute( 'id', 'editor' );
  112. const domDiv2 = document.createElement( 'div' );
  113. domDiv2.setAttribute( 'id', 'editor' );
  114. const observerMock = view.addObserver( ObserverMock );
  115. const observerMockGlobalCount = view.addObserver( ObserverMockGlobalCount );
  116. createViewRoot( viewDocument, 'div', 'root1' );
  117. view.attachDomRoot( document.createElement( 'div' ), 'root1' );
  118. sinon.assert.calledOnce( observerMock.observe );
  119. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  120. } );
  121. } );
  122. describe( 'detachDomRoot()', () => {
  123. it( 'should remove DOM root and unbind DOM element', () => {
  124. const domDiv = document.createElement( 'div' );
  125. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  126. view.attachDomRoot( domDiv );
  127. expect( count( view.domRoots ) ).to.equal( 1 );
  128. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  129. view.detachDomRoot( 'main' );
  130. expect( count( view.domRoots ) ).to.equal( 0 );
  131. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.be.undefined;
  132. domDiv.remove();
  133. } );
  134. it( 'should restore the DOM root attributes to the state before attachDomRoot()', () => {
  135. const domDiv = document.createElement( 'div' );
  136. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  137. domDiv.setAttribute( 'foo', 'bar' );
  138. domDiv.setAttribute( 'data-baz', 'qux' );
  139. domDiv.classList.add( 'foo-class' );
  140. view.attachDomRoot( domDiv );
  141. view.change( writer => {
  142. writer.addClass( 'addedClass', viewRoot );
  143. writer.setAttribute( 'added-attribute', 'foo', viewRoot );
  144. writer.setAttribute( 'foo', 'changed the value', viewRoot );
  145. } );
  146. view.detachDomRoot( 'main' );
  147. const attributes = {};
  148. for ( const attribute of Array.from( domDiv.attributes ) ) {
  149. attributes[ attribute.name ] = attribute.value;
  150. }
  151. expect( attributes ).to.deep.equal( {
  152. foo: 'bar',
  153. 'data-baz': 'qux',
  154. class: 'foo-class'
  155. } );
  156. domDiv.remove();
  157. } );
  158. it( 'should remove the "contenteditable" attribute from the DOM root', () => {
  159. const domDiv = document.createElement( 'div' );
  160. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  161. view.attachDomRoot( domDiv );
  162. view.forceRender();
  163. viewRoot.isReadOnly = false;
  164. expect( domDiv.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  165. view.detachDomRoot( 'main' );
  166. expect( domDiv.hasAttribute( 'contenteditable' ) ).to.be.false;
  167. domDiv.remove();
  168. } );
  169. } );
  170. describe( 'addObserver()', () => {
  171. beforeEach( () => {
  172. // The variable will be overwritten.
  173. view.destroy();
  174. view = new View();
  175. viewDocument = view.document;
  176. view._renderer.render = sinon.spy();
  177. } );
  178. afterEach( () => {
  179. view.destroy();
  180. } );
  181. it( 'should be instantiated and enabled on adding', () => {
  182. const observerMock = view.addObserver( ObserverMock );
  183. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  184. expect( observerMock ).to.have.property( 'document', viewDocument );
  185. sinon.assert.calledOnce( observerMock.enable );
  186. } );
  187. it( 'should return observer instance each time addObserver is called', () => {
  188. const observerMock1 = view.addObserver( ObserverMock );
  189. const observerMock2 = view.addObserver( ObserverMock );
  190. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  191. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  192. expect( observerMock1 ).to.equals( observerMock2 );
  193. } );
  194. it( 'should instantiate one observer only once', () => {
  195. view.addObserver( ObserverMockGlobalCount );
  196. view.addObserver( ObserverMockGlobalCount );
  197. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  198. expect( instantiated ).to.equal( 1 );
  199. expect( enabled ).to.equal( 1 );
  200. view.addObserver( ObserverMock );
  201. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  202. } );
  203. it( 'should instantiate child class of already registered observer', () => {
  204. class ObserverMock extends Observer {
  205. enable() {}
  206. }
  207. class ChildObserverMock extends ObserverMock {
  208. enable() {}
  209. }
  210. view.addObserver( ObserverMock );
  211. view.addObserver( ChildObserverMock );
  212. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  213. } );
  214. it( 'should be disabled and re-enabled on render', () => {
  215. const observerMock = view.addObserver( ObserverMock );
  216. view.forceRender();
  217. sinon.assert.calledOnce( observerMock.disable );
  218. sinon.assert.calledOnce( view._renderer.render );
  219. sinon.assert.calledTwice( observerMock.enable );
  220. } );
  221. it( 'should call observe on each root', () => {
  222. createViewRoot( viewDocument, 'div', 'roo1' );
  223. createViewRoot( viewDocument, 'div', 'roo2' );
  224. view.attachDomRoot( document.createElement( 'div' ), 'roo1' );
  225. view.attachDomRoot( document.createElement( 'div' ), 'roo2' );
  226. const observerMock = view.addObserver( ObserverMock );
  227. sinon.assert.calledTwice( observerMock.observe );
  228. } );
  229. } );
  230. describe( 'getObserver()', () => {
  231. it( 'should return observer it it is added', () => {
  232. const addedObserverMock = view.addObserver( ObserverMock );
  233. const getObserverMock = view.getObserver( ObserverMock );
  234. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  235. expect( getObserverMock ).to.equal( addedObserverMock );
  236. } );
  237. it( 'should return undefined if observer is not added', () => {
  238. const getObserverMock = view.getObserver( ObserverMock );
  239. expect( getObserverMock ).to.be.undefined;
  240. } );
  241. } );
  242. describe( 'scrollToTheSelection()', () => {
  243. beforeEach( () => {
  244. // Silence the Rect warnings.
  245. testUtils.sinon.stub( log, 'warn' );
  246. } );
  247. it( 'does nothing when there are no ranges in the selection', () => {
  248. const stub = testUtils.sinon.stub( global.window, 'scrollTo' );
  249. view.scrollToTheSelection();
  250. sinon.assert.notCalled( stub );
  251. } );
  252. it( 'scrolls to the first range in selection with an offset', () => {
  253. const root = createViewRoot( viewDocument, 'div', 'main' );
  254. const stub = testUtils.sinon.stub( global.window, 'scrollTo' );
  255. const range = ViewRange._createIn( root );
  256. view.attachDomRoot( domRoot );
  257. view.change( writer => {
  258. writer.setSelection( range );
  259. } );
  260. // Make sure the window will have to scroll to the domRoot.
  261. Object.assign( domRoot.style, {
  262. position: 'absolute',
  263. top: '-1000px',
  264. left: '-1000px'
  265. } );
  266. view.scrollToTheSelection();
  267. sinon.assert.calledWithMatch( stub, sinon.match.number, sinon.match.number );
  268. } );
  269. } );
  270. describe( 'disableObservers()', () => {
  271. it( 'should disable observers', () => {
  272. const addedObserverMock = view.addObserver( ObserverMock );
  273. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  274. expect( addedObserverMock.disable.called ).to.be.false;
  275. view.disableObservers();
  276. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  277. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  278. } );
  279. } );
  280. describe( 'enableObservers()', () => {
  281. it( 'should enable observers', () => {
  282. const addedObserverMock = view.addObserver( ObserverMock );
  283. view.disableObservers();
  284. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  285. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  286. view.enableObservers();
  287. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  288. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  289. } );
  290. } );
  291. describe( 'focus()', () => {
  292. let domEditable, viewEditable;
  293. beforeEach( () => {
  294. domEditable = document.createElement( 'div' );
  295. domEditable.setAttribute( 'contenteditable', 'true' );
  296. document.body.appendChild( domEditable );
  297. viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  298. view.attachDomRoot( domEditable );
  299. view.change( writer => {
  300. writer.setSelection( viewEditable, 0 );
  301. } );
  302. } );
  303. afterEach( () => {
  304. document.body.removeChild( domEditable );
  305. } );
  306. it( 'should focus editable with selection', () => {
  307. const converterFocusSpy = testUtils.sinon.spy( view.domConverter, 'focus' );
  308. const renderSpy = testUtils.sinon.spy( view, 'forceRender' );
  309. view.focus();
  310. expect( converterFocusSpy.called ).to.be.true;
  311. expect( renderSpy.calledOnce ).to.be.true;
  312. expect( document.activeElement ).to.equal( domEditable );
  313. const domSelection = document.getSelection();
  314. expect( domSelection.rangeCount ).to.equal( 1 );
  315. const domRange = domSelection.getRangeAt( 0 );
  316. expect( domRange.startContainer ).to.equal( domEditable );
  317. expect( domRange.startOffset ).to.equal( 0 );
  318. expect( domRange.collapsed ).to.be.true;
  319. } );
  320. it( 'should not focus if document is already focused', () => {
  321. const converterFocusSpy = testUtils.sinon.spy( view.domConverter, 'focus' );
  322. const renderSpy = testUtils.sinon.spy( view, 'forceRender' );
  323. viewDocument.isFocused = true;
  324. view.focus();
  325. expect( converterFocusSpy.called ).to.be.false;
  326. expect( renderSpy.called ).to.be.false;
  327. } );
  328. it( 'should log warning when no selection', () => {
  329. const logSpy = testUtils.sinon.stub( log, 'warn' );
  330. view.change( writer => {
  331. writer.setSelection( null );
  332. } );
  333. view.focus();
  334. expect( logSpy.calledOnce ).to.be.true;
  335. expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^view-focus-no-selection/ );
  336. } );
  337. } );
  338. describe( 'isFocused', () => {
  339. it( 'should change renderer.isFocused too', () => {
  340. expect( viewDocument.isFocused ).to.equal( false );
  341. expect( view._renderer.isFocused ).to.equal( false );
  342. viewDocument.isFocused = true;
  343. expect( viewDocument.isFocused ).to.equal( true );
  344. expect( view._renderer.isFocused ).to.equal( true );
  345. } );
  346. } );
  347. describe( 'forceRender()', () => {
  348. it( 'disable observers, renders and enable observers', () => {
  349. const observerMock = view.addObserver( ObserverMock );
  350. const renderStub = sinon.stub( view._renderer, 'render' );
  351. view.forceRender();
  352. sinon.assert.callOrder( observerMock.disable, renderStub, observerMock.enable );
  353. } );
  354. it( 'should fire `render` and `layoutChanged` even if there were no changes', () => {
  355. const renderSpy = sinon.spy();
  356. const layoutChangedSpy = sinon.spy();
  357. view.on( 'render', renderSpy );
  358. view.document.on( 'layoutChanged', layoutChangedSpy );
  359. view.forceRender();
  360. sinon.assert.calledOnce( renderSpy );
  361. sinon.assert.calledOnce( layoutChangedSpy );
  362. } );
  363. it( 'should fire `render` and `layoutChanged` if there is some buffered change', () => {
  364. const renderSpy = sinon.spy();
  365. const layoutChangedSpy = sinon.spy();
  366. view.on( 'render', renderSpy );
  367. view.document.on( 'layoutChanged', layoutChangedSpy );
  368. view.document.selection._setTo( null );
  369. view.forceRender();
  370. sinon.assert.calledOnce( renderSpy );
  371. sinon.assert.calledOnce( layoutChangedSpy );
  372. } );
  373. } );
  374. describe( 'view and DOM integration', () => {
  375. it( 'should remove content of the DOM', () => {
  376. const domDiv = createElement( document, 'div', { id: 'editor' }, [
  377. createElement( document, 'p' ),
  378. createElement( document, 'p' )
  379. ] );
  380. const view = new View();
  381. const viewDocument = view.document;
  382. createViewRoot( viewDocument, 'div', 'main' );
  383. view.attachDomRoot( domDiv );
  384. view.forceRender();
  385. expect( domDiv.childNodes.length ).to.equal( 1 );
  386. expect( isBlockFiller( domDiv.childNodes[ 0 ], BR_FILLER ) ).to.be.true;
  387. view.destroy();
  388. domDiv.remove();
  389. } );
  390. it( 'should render changes in the Document', () => {
  391. const domDiv = document.createElement( 'div' );
  392. const view = new View();
  393. const viewDocument = view.document;
  394. createViewRoot( viewDocument, 'div', 'main' );
  395. view.attachDomRoot( domDiv );
  396. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  397. view.forceRender();
  398. expect( domDiv.childNodes.length ).to.equal( 1 );
  399. expect( domDiv.childNodes[ 0 ].tagName ).to.equal( 'P' );
  400. view.destroy();
  401. } );
  402. it( 'should render attribute changes', () => {
  403. const domRoot = document.createElement( 'div' );
  404. const view = new View();
  405. const viewDocument = view.document;
  406. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  407. view.attachDomRoot( domRoot );
  408. const viewP = new ViewElement( 'p', { class: 'foo' } );
  409. viewRoot._appendChild( viewP );
  410. view.forceRender();
  411. expect( domRoot.childNodes.length ).to.equal( 1 );
  412. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'foo' );
  413. viewP._setAttribute( 'class', 'bar' );
  414. view.forceRender();
  415. expect( domRoot.childNodes.length ).to.equal( 1 );
  416. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'bar' );
  417. view.destroy();
  418. domRoot.remove();
  419. } );
  420. } );
  421. describe( 'change()', () => {
  422. it( 'should throw when someone tries to change view during rendering', () => {
  423. const domDiv = document.createElement( 'div' );
  424. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  425. let renderingCalled = false;
  426. view.attachDomRoot( domDiv );
  427. view.change( writer => {
  428. const p = writer.createContainerElement( 'p' );
  429. const ui = writer.createUIElement( 'span', null, function( domDocument ) {
  430. const element = this.toDomElement( domDocument );
  431. expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^cannot-change-view-tree/ );
  432. renderingCalled = true;
  433. return element;
  434. } );
  435. writer.insert( ViewPosition._createAt( p, 0 ), ui );
  436. writer.insert( ViewPosition._createAt( viewRoot, 0 ), p );
  437. } );
  438. expect( renderingCalled ).to.be.true;
  439. domDiv.remove();
  440. } );
  441. it( 'should throw when someone tries to use change() method in post-fixer', () => {
  442. const domDiv = document.createElement( 'div' );
  443. createViewRoot( viewDocument, 'div', 'main' );
  444. view.attachDomRoot( domDiv );
  445. viewDocument.registerPostFixer( () => {
  446. expect( () => {
  447. view.change( () => {} );
  448. } ).to.throw( CKEditorError, /^cannot-change-view-tree/ );
  449. } );
  450. view.forceRender();
  451. domDiv.remove();
  452. } );
  453. it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => {
  454. const renderSpy = sinon.spy( view._renderer, 'render' );
  455. const eventSpy = sinon.spy();
  456. view.on( 'render', eventSpy );
  457. view.change( writer => {
  458. writer.setSelection( null );
  459. } );
  460. sinon.assert.callOrder( renderSpy, eventSpy );
  461. } );
  462. it( 'should fire render event once for nested change blocks', () => {
  463. const renderSpy = sinon.spy( view._renderer, 'render' );
  464. const eventSpy = sinon.spy();
  465. const viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  466. view.on( 'render', eventSpy );
  467. view.change( writer => {
  468. writer.setSelection( null );
  469. view.change( writer => {
  470. writer.setSelection( viewEditable, 0 );
  471. } );
  472. view.change( writer => {
  473. writer.setSelection( null );
  474. view.change( writer => {
  475. writer.setSelection( viewEditable, 0 );
  476. } );
  477. } );
  478. view.change( writer => {
  479. writer.setSelection( null );
  480. } );
  481. } );
  482. sinon.assert.calledOnce( renderSpy );
  483. sinon.assert.calledOnce( eventSpy );
  484. sinon.assert.callOrder( renderSpy, eventSpy );
  485. } );
  486. it( 'should fire render event once even if render is called during the change', () => {
  487. const renderSpy = sinon.spy( view._renderer, 'render' );
  488. const eventSpy = sinon.spy();
  489. view.on( 'render', eventSpy );
  490. view.change( () => {
  491. view.forceRender();
  492. view.change( writer => {
  493. writer.setSelection( null );
  494. view.forceRender();
  495. } );
  496. view.forceRender();
  497. } );
  498. sinon.assert.calledOnce( renderSpy );
  499. sinon.assert.calledOnce( eventSpy );
  500. sinon.assert.callOrder( renderSpy, eventSpy );
  501. } );
  502. it( 'should call post-fixers after change but before rendering', () => {
  503. const postFixer1 = sinon.spy( () => false );
  504. const postFixer2 = sinon.spy( () => false );
  505. const changeSpy = sinon.spy();
  506. const eventSpy = sinon.spy();
  507. viewDocument.registerPostFixer( postFixer1 );
  508. viewDocument.registerPostFixer( postFixer2 );
  509. view.on( 'render', eventSpy );
  510. view.change( writer => {
  511. changeSpy();
  512. writer.setSelection( null );
  513. } );
  514. sinon.assert.calledOnce( postFixer1 );
  515. sinon.assert.calledOnce( postFixer2 );
  516. sinon.assert.calledOnce( changeSpy );
  517. sinon.assert.calledOnce( eventSpy );
  518. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  519. } );
  520. it( 'should call post-fixers until all are done', () => {
  521. let called = false;
  522. const postFixer1 = sinon.spy();
  523. const postFixer2 = sinon.spy();
  524. const changeSpy = sinon.spy();
  525. const eventSpy = sinon.spy();
  526. viewDocument.registerPostFixer( () => {
  527. if ( !called ) {
  528. called = true;
  529. postFixer1();
  530. return true;
  531. }
  532. postFixer2();
  533. return false;
  534. } );
  535. view.on( 'render', eventSpy );
  536. view.change( writer => {
  537. changeSpy();
  538. writer.setSelection( null );
  539. } );
  540. sinon.assert.calledOnce( postFixer1 );
  541. sinon.assert.calledOnce( postFixer2 );
  542. sinon.assert.calledOnce( changeSpy );
  543. sinon.assert.calledOnce( eventSpy );
  544. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  545. } );
  546. it( 'should return result of the callback', () => {
  547. const result = view.change( () => {
  548. return 'FooBar';
  549. } );
  550. expect( result ).to.equal( 'FooBar' );
  551. } );
  552. it( 'should return result of the callback with nested change block', () => {
  553. let result2 = false;
  554. let result3 = false;
  555. const result1 = view.change( () => {
  556. return view.change( () => {
  557. result2 = view.change( () => {
  558. return true;
  559. } );
  560. result3 = view.change( () => {} );
  561. return 42;
  562. } );
  563. } );
  564. expect( result1 ).to.equal( 42 );
  565. expect( result2 ).to.equal( true );
  566. expect( result3 ).to.undefined;
  567. } );
  568. } );
  569. describe( 'createPositionAt()', () => {
  570. it( 'should return instance of Position', () => {
  571. createViewRoot( viewDocument, 'div', 'main' );
  572. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  573. expect( view.createPositionAt( viewDocument.getRoot(), 0 ) ).to.be.instanceof( ViewPosition );
  574. } );
  575. } );
  576. describe( 'createPositionAfter()', () => {
  577. it( 'should return instance of Position', () => {
  578. createViewRoot( viewDocument, 'div', 'main' );
  579. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  580. expect( view.createPositionAfter( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  581. } );
  582. } );
  583. describe( 'createPositionBefore()', () => {
  584. it( 'should return instance of Position', () => {
  585. createViewRoot( viewDocument, 'div', 'main' );
  586. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  587. expect( view.createPositionBefore( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  588. } );
  589. } );
  590. describe( 'createRange()', () => {
  591. it( 'should return instance of Range', () => {
  592. createViewRoot( viewDocument, 'div', 'main' );
  593. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  594. expect( view.createRange( view.createPositionAt( viewDocument.getRoot(), 0 ) ) ).to.be.instanceof( ViewRange );
  595. } );
  596. } );
  597. describe( 'createRangeIn()', () => {
  598. it( 'should return instance of Range', () => {
  599. createViewRoot( viewDocument, 'div', 'main' );
  600. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  601. expect( view.createRangeIn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  602. } );
  603. } );
  604. describe( 'createRangeOn()', () => {
  605. it( 'should return instance of Range', () => {
  606. createViewRoot( viewDocument, 'div', 'main' );
  607. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  608. expect( view.createRangeOn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  609. } );
  610. } );
  611. describe( 'createSelection()', () => {
  612. it( 'should return instance of Selection', () => {
  613. createViewRoot( viewDocument, 'div', 'main' );
  614. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  615. expect( view.createSelection() ).to.be.instanceof( ViewSelection );
  616. } );
  617. } );
  618. describe( 'destroy()', () => {
  619. it( 'should destroy all observers', () => {
  620. const observerMock = view.addObserver( ObserverMock );
  621. view.destroy();
  622. sinon.assert.calledOnce( observerMock.destroy );
  623. } );
  624. } );
  625. } );