| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /* globals document */
- import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
- import Document from '../../../src/view/document';
- import Observer from '../../../src/view/observer/observer';
- import MutationObserver from '../../../src/view/observer/mutationobserver';
- import SelectionObserver from '../../../src/view/observer/selectionobserver';
- import FocusObserver from '../../../src/view/observer/focusobserver';
- import KeyObserver from '../../../src/view/observer/keyobserver';
- import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
- import Renderer from '../../../src/view/renderer';
- import ViewRange from '../../../src/view/range';
- import DomConverter from '../../../src/view/domconverter';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import count from '@ckeditor/ckeditor5-utils/src/count';
- import log from '@ckeditor/ckeditor5-utils/src/log';
- testUtils.createSinonSandbox();
- describe( 'Document', () => {
- const DEFAULT_OBSERVERS_COUNT = 5;
- let ObserverMock, ObserverMockGlobalCount, instantiated, enabled, domRoot, viewDocument;
- beforeEach( () => {
- domRoot = createElement( document, 'div', {
- id: 'editor',
- contenteditable: 'true'
- } );
- document.body.appendChild( domRoot );
- instantiated = 0;
- enabled = 0;
- ObserverMock = class extends Observer {
- constructor( viewDocument ) {
- super( viewDocument );
- this.enable = sinon.spy();
- this.disable = sinon.spy();
- this.observe = sinon.spy();
- }
- };
- ObserverMockGlobalCount = class extends Observer {
- constructor( viewDocument ) {
- super( viewDocument );
- instantiated++;
- this.observe = sinon.spy();
- }
- enable() {
- enabled++;
- }
- };
- viewDocument = new Document();
- } );
- afterEach( () => {
- viewDocument.destroy();
- domRoot.remove();
- } );
- describe( 'constructor()', () => {
- it( 'should create Document with all properties', () => {
- expect( count( viewDocument.domRoots ) ).to.equal( 0 );
- expect( count( viewDocument.roots ) ).to.equal( 0 );
- expect( viewDocument ).to.have.property( 'renderer' ).that.is.instanceOf( Renderer );
- expect( viewDocument ).to.have.property( 'domConverter' ).that.is.instanceOf( DomConverter );
- expect( viewDocument ).to.have.property( 'isFocused' ).that.is.false;
- } );
- it( 'should add default observers', () => {
- expect( count( viewDocument._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
- expect( viewDocument.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
- expect( viewDocument.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
- expect( viewDocument.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
- expect( viewDocument.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
- expect( viewDocument.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver );
- } );
- } );
- describe( 'createRoot()', () => {
- it( 'should create root', () => {
- const domP = document.createElement( 'p' );
- const domDiv = document.createElement( 'div' );
- domDiv.appendChild( domP );
- const ret = viewDocument.createRoot( domDiv );
- expect( count( viewDocument.domRoots ) ).to.equal( 1 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- const domRoot = viewDocument.getDomRoot();
- const viewRoot = viewDocument.getRoot();
- expect( ret ).to.equal( viewRoot );
- expect( domRoot ).to.equal( domDiv );
- expect( viewDocument.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
- expect( viewRoot.name ).to.equal( 'div' );
- expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
- } );
- it( 'should call observe on each observer', () => {
- // The variable will be overwritten.
- viewDocument.destroy();
- viewDocument = new Document( document.createElement( 'div' ) );
- viewDocument.renderer.render = sinon.spy();
- const domDiv1 = document.createElement( 'div' );
- domDiv1.setAttribute( 'id', 'editor' );
- const domDiv2 = document.createElement( 'div' );
- domDiv2.setAttribute( 'id', 'editor' );
- const observerMock = viewDocument.addObserver( ObserverMock );
- const observerMockGlobalCount = viewDocument.addObserver( ObserverMockGlobalCount );
- viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
- sinon.assert.calledOnce( observerMock.observe );
- sinon.assert.calledOnce( observerMockGlobalCount.observe );
- } );
- it( 'should create "main" root by default', () => {
- const domDiv = document.createElement( 'div' );
- const ret = viewDocument.createRoot( domDiv );
- expect( count( viewDocument.domRoots ) ).to.equal( 1 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- const domRoot = viewDocument.domRoots.get( 'main' );
- const viewRoot = viewDocument.roots.get( 'main' );
- expect( ret ).to.equal( viewRoot );
- expect( domRoot ).to.equal( domDiv );
- } );
- it( 'should create root with given name', () => {
- const domDiv = document.createElement( 'div' );
- const ret = viewDocument.createRoot( domDiv, 'header' );
- expect( count( viewDocument.domRoots ) ).to.equal( 1 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- const domRoot = viewDocument.domRoots.get( 'header' );
- const viewRoot = viewDocument.roots.get( 'header' );
- expect( ret ).to.equal( viewRoot );
- expect( domRoot ).to.equal( domDiv );
- } );
- it( 'should create root without attaching DOM element', () => {
- const ret = viewDocument.createRoot( 'div' );
- expect( count( viewDocument.domRoots ) ).to.equal( 0 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- expect( ret ).to.equal( viewDocument.getRoot() );
- } );
- } );
- describe( 'attachDomRoot()', () => {
- it( 'should create root without attach DOM element to the view element', () => {
- const domDiv = document.createElement( 'div' );
- const viewRoot = viewDocument.createRoot( 'div' );
- expect( count( viewDocument.domRoots ) ).to.equal( 0 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- expect( viewRoot ).to.equal( viewDocument.getRoot() );
- viewDocument.attachDomRoot( domDiv );
- expect( count( viewDocument.domRoots ) ).to.equal( 1 );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- expect( viewDocument.getDomRoot() ).to.equal( domDiv );
- expect( viewDocument.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
- expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
- } );
- it( 'should create root without attach DOM element to the view element with given name', () => {
- const domH1 = document.createElement( 'h1' );
- viewDocument.createRoot( 'DIV' );
- const viewH1 = viewDocument.createRoot( 'h1', 'header' );
- expect( count( viewDocument.domRoots ) ).to.equal( 0 );
- expect( count( viewDocument.roots ) ).to.equal( 2 );
- expect( viewH1 ).to.equal( viewDocument.getRoot( 'header' ) );
- viewDocument.attachDomRoot( domH1, 'header' );
- expect( count( viewDocument.domRoots ) ).to.equal( 1 );
- expect( count( viewDocument.roots ) ).to.equal( 2 );
- expect( viewDocument.getDomRoot( 'header' ) ).to.equal( domH1 );
- expect( viewDocument.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 );
- expect( viewDocument.getRoot().name ).to.equal( 'div' );
- expect( viewDocument.renderer.markedChildren.has( viewH1 ) ).to.be.true;
- } );
- } );
- describe( 'getRoot()', () => {
- it( 'should return "main" root', () => {
- viewDocument.createRoot( document.createElement( 'div' ) );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- expect( viewDocument.getRoot() ).to.equal( viewDocument.roots.get( 'main' ) );
- } );
- it( 'should return named root', () => {
- viewDocument.createRoot( document.createElement( 'h1' ), 'header' );
- expect( count( viewDocument.roots ) ).to.equal( 1 );
- expect( viewDocument.getRoot( 'header' ) ).to.equal( viewDocument.roots.get( 'header' ) );
- } );
- } );
- describe( 'addObserver()', () => {
- beforeEach( () => {
- // The variable will be overwritten.
- viewDocument.destroy();
- viewDocument = new Document( document.createElement( 'div' ) );
- viewDocument.renderer.render = sinon.spy();
- } );
- afterEach( () => {
- viewDocument.destroy();
- } );
- it( 'should be instantiated and enabled on adding', () => {
- const observerMock = viewDocument.addObserver( ObserverMock );
- expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
- expect( observerMock ).to.have.property( 'document', viewDocument );
- sinon.assert.calledOnce( observerMock.enable );
- } );
- it( 'should return observer instance each time addObserver is called', () => {
- const observerMock1 = viewDocument.addObserver( ObserverMock );
- const observerMock2 = viewDocument.addObserver( ObserverMock );
- expect( observerMock1 ).to.be.instanceof( ObserverMock );
- expect( observerMock2 ).to.be.instanceof( ObserverMock );
- expect( observerMock1 ).to.equals( observerMock2 );
- } );
- it( 'should instantiate one observer only once', () => {
- viewDocument.addObserver( ObserverMockGlobalCount );
- viewDocument.addObserver( ObserverMockGlobalCount );
- expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
- expect( instantiated ).to.equal( 1 );
- expect( enabled ).to.equal( 1 );
- viewDocument.addObserver( ObserverMock );
- expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
- } );
- it( 'should instantiate child class of already registered observer', () => {
- class ObserverMock extends Observer {
- enable() {}
- }
- class ChildObserverMock extends ObserverMock {
- enable() {}
- }
- viewDocument.addObserver( ObserverMock );
- viewDocument.addObserver( ChildObserverMock );
- expect( viewDocument._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
- } );
- it( 'should be disabled and re-enabled on render', () => {
- const observerMock = viewDocument.addObserver( ObserverMock );
- viewDocument.render();
- sinon.assert.calledOnce( observerMock.disable );
- sinon.assert.calledOnce( viewDocument.renderer.render );
- sinon.assert.calledTwice( observerMock.enable );
- } );
- it( 'should call observe on each root', () => {
- viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
- viewDocument.createRoot( document.createElement( 'div' ), 'root2' );
- const observerMock = viewDocument.addObserver( ObserverMock );
- sinon.assert.calledTwice( observerMock.observe );
- } );
- } );
- describe( 'getObserver()', () => {
- it( 'should return observer it it is added', () => {
- const addedObserverMock = viewDocument.addObserver( ObserverMock );
- const getObserverMock = viewDocument.getObserver( ObserverMock );
- expect( getObserverMock ).to.be.instanceof( ObserverMock );
- expect( getObserverMock ).to.equal( addedObserverMock );
- } );
- it( 'should return undefined if observer is not added', () => {
- const getObserverMock = viewDocument.getObserver( ObserverMock );
- expect( getObserverMock ).to.be.undefined;
- } );
- } );
- describe( 'disableObservers()', () => {
- it( 'should disable observers', () => {
- const addedObserverMock = viewDocument.addObserver( ObserverMock );
- expect( addedObserverMock.enable.calledOnce ).to.be.true;
- expect( addedObserverMock.disable.called ).to.be.false;
- viewDocument.disableObservers();
- expect( addedObserverMock.enable.calledOnce ).to.be.true;
- expect( addedObserverMock.disable.calledOnce ).to.be.true;
- } );
- } );
- describe( 'enableObservers()', () => {
- it( 'should enable observers', () => {
- const addedObserverMock = viewDocument.addObserver( ObserverMock );
- viewDocument.disableObservers();
- expect( addedObserverMock.enable.calledOnce ).to.be.true;
- expect( addedObserverMock.disable.calledOnce ).to.be.true;
- viewDocument.enableObservers();
- expect( addedObserverMock.enable.calledTwice ).to.be.true;
- expect( addedObserverMock.disable.calledOnce ).to.be.true;
- } );
- } );
- describe( 'isFocused', () => {
- it( 'should change renderer.isFocused too', () => {
- expect( viewDocument.isFocused ).to.equal( false );
- expect( viewDocument.renderer.isFocused ).to.equal( false );
- viewDocument.isFocused = true;
- expect( viewDocument.isFocused ).to.equal( true );
- expect( viewDocument.renderer.isFocused ).to.equal( true );
- } );
- } );
- describe( 'focus()', () => {
- let domEditable, viewEditable;
- beforeEach( () => {
- domEditable = document.createElement( 'div' );
- domEditable.setAttribute( 'contenteditable', 'true' );
- document.body.appendChild( domEditable );
- viewEditable = viewDocument.createRoot( domEditable );
- viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewEditable, 0, viewEditable, 0 ) );
- } );
- afterEach( () => {
- document.body.removeChild( domEditable );
- } );
- it( 'should focus editable with selection', () => {
- const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
- const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
- viewDocument.focus();
- expect( converterFocusSpy.called ).to.be.true;
- expect( renderSpy.calledOnce ).to.be.true;
- expect( document.activeElement ).to.equal( domEditable );
- const domSelection = document.getSelection();
- expect( domSelection.rangeCount ).to.equal( 1 );
- const domRange = domSelection.getRangeAt( 0 );
- expect( domRange.startContainer ).to.equal( domEditable );
- expect( domRange.startOffset ).to.equal( 0 );
- expect( domRange.collapsed ).to.be.true;
- } );
- it( 'should not focus if document is already focused', () => {
- const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
- const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
- viewDocument.isFocused = true;
- viewDocument.focus();
- expect( converterFocusSpy.called ).to.be.false;
- expect( renderSpy.called ).to.be.false;
- } );
- it( 'should log warning when no selection', () => {
- const logSpy = testUtils.sinon.stub( log, 'warn' );
- viewDocument.selection.removeAllRanges();
- viewDocument.focus();
- expect( logSpy.calledOnce ).to.be.true;
- expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^view-focus-no-selection/ );
- } );
- } );
- describe( 'render()', () => {
- it( 'should fire an event', () => {
- const spy = sinon.spy();
- viewDocument.on( 'render', spy );
- viewDocument.render();
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'disable observers, renders and enable observers', () => {
- const observerMock = viewDocument.addObserver( ObserverMock );
- const renderStub = sinon.stub( viewDocument.renderer, 'render' );
- viewDocument.render();
- sinon.assert.callOrder( observerMock.disable, renderStub, observerMock.enable );
- } );
- } );
- } );
|