Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Changed ImageLoadObserver from DomEventObserver to Observer.
Browse files Browse the repository at this point in the history
  • Loading branch information
oskarwrobel committed Jun 26, 2018
1 parent e09343d commit a1ed796
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 22 deletions.
23 changes: 15 additions & 8 deletions src/image/imageloadobserver.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* @module image/image/imageloadobserver
*/

import DomEventObserver from '@ckeditor/ckeditor5-engine/src/view/observer/domeventobserver';
import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';

/**
* Observes all new images added to the {@link module:engine/view/document~Document},
Expand All @@ -17,9 +17,9 @@ import DomEventObserver from '@ckeditor/ckeditor5-engine/src/view/observer/domev
*
* **Note:** This event is not fired for images that has been added to the document and rendered as `complete` (already loaded).
*
* @extends module:engine/view/observer/domeventobserver~DomEventObserver
* @extends module:engine/view/observer/observer~Observer
*/
export default class ImageLoadObserver extends DomEventObserver {
export default class ImageLoadObserver extends Observer {
constructor( view ) {
super( view );

Expand Down Expand Up @@ -67,7 +67,7 @@ export default class ImageLoadObserver extends DomEventObserver {

for ( const domElement of domNode.querySelectorAll( 'img' ) ) {
if ( !this._observedElements.has( domElement ) ) {
this.listenTo( domElement, 'load', ( evt, domEvt ) => this.onDomEvent( domEvt ) );
this.listenTo( domElement, 'load', ( evt, domEvt ) => this._fireEvents( domEvt ) );
this._observedElements.add( domElement );
}
}
Expand All @@ -82,11 +82,18 @@ export default class ImageLoadObserver extends DomEventObserver {
}

/**
* @inheritDoc
* Fires {@link module:engine/view/view/document~Document#event:layoutChanged} and
* {@link module:engine/view/document~Document#event:imageLoaded}
* if observer {@link #isEnabled is enabled}.
*
* @protected
* @param {Event} domEvent The DOM event.
*/
onDomEvent( domEvent ) {
this.document.fire( 'layoutChanged' );
this.fire( 'imageLoaded', domEvent );
_fireEvents( domEvent ) {
if ( this.isEnabled ) {
this.document.fire( 'layoutChanged' );
this.document.fire( 'imageLoaded', domEvent );
}
}

/**
Expand Down
48 changes: 34 additions & 14 deletions tests/image/imageloadobserver.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
/* globals document, Event */

import ImageLoadObserver from '../../src/image/imageloadobserver';
import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
import View from '@ckeditor/ckeditor5-engine/src/view/view';
import Position from '@ckeditor/ckeditor5-engine/src/view/position';
import Range from '@ckeditor/ckeditor5-engine/src/view/range';
import createViewRoot from '@ckeditor/ckeditor5-engine/tests/view/_utils/createroot';
import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';

describe( 'ClickObserver', () => {
describe( 'ImageLoadObserver', () => {
let view, viewDocument, observer, domRoot, viewRoot;

beforeEach( () => {
Expand All @@ -29,6 +30,10 @@ describe( 'ClickObserver', () => {
view.destroy();
} );

it( 'should extend Observer', () => {
expect( observer ).instanceof( Observer );
} );

it( 'should fire `loadImage` event for images in the document that are loaded with a delay', () => {
const spy = sinon.spy();

Expand All @@ -43,6 +48,34 @@ describe( 'ClickObserver', () => {
sinon.assert.calledOnce( spy );
} );

it( 'should fire `layoutChanged` along with `imageLoaded` event', () => {
const layoutChangedSpy = sinon.spy();
const imageLoadedSpy = sinon.spy();

view.document.on( 'layoutChanged', layoutChangedSpy );
view.document.on( 'imageLoaded', imageLoadedSpy );

observer._fireEvents( {} );

sinon.assert.calledOnce( layoutChangedSpy );
sinon.assert.calledOnce( imageLoadedSpy );
} );

it( 'should not fire events when observer is disabled', () => {
const layoutChangedSpy = sinon.spy();
const imageLoadedSpy = sinon.spy();

view.document.on( 'layoutChanged', layoutChangedSpy );
view.document.on( 'imageLoaded', imageLoadedSpy );

observer.isEnabled = false;

observer._fireEvents( {} );

sinon.assert.notCalled( layoutChangedSpy );
sinon.assert.notCalled( imageLoadedSpy );
} );

it( 'should not fire `loadImage` event for images removed from document', () => {
const spy = sinon.spy();

Expand Down Expand Up @@ -97,19 +130,6 @@ describe( 'ClickObserver', () => {
} ).to.not.throw();
} );

it( 'should call `layoutChanged` along with `imageLoaded` event', () => {
const layoutChangedSpy = sinon.spy();
const imageLoadedSpy = sinon.spy();

view.document.on( 'layoutChanged', layoutChangedSpy );
view.document.on( 'imageLoaded', imageLoadedSpy );

observer.onDomEvent( {} );

sinon.assert.calledOnce( layoutChangedSpy );
sinon.assert.calledOnce( imageLoadedSpy );
} );

it( 'should stop observing images on destroy', () => {
const spy = sinon.spy();

Expand Down

0 comments on commit a1ed796

Please sign in to comment.