Named exports from ol/events

This commit is contained in:
Tim Schaub
2018-01-24 10:09:57 -07:00
parent 1786bbbe80
commit 7e7631c42a
74 changed files with 437 additions and 445 deletions

View File

@@ -1,4 +1,4 @@
import _ol_events_ from '../../../src/ol/events.js';
import {listen, listenOnce, bindListener, unlisten, unlistenAll, unlistenByKey, findListener, getListeners} from '../../../src/ol/events.js';
import EventTarget from '../../../src/ol/events/EventTarget.js';
describe('ol.events', function() {
@@ -13,13 +13,13 @@ describe('ol.events', function() {
};
});
describe('bindListener_()', function() {
describe('bindListener()', function() {
it('binds a listener and returns a bound listener function', function() {
const listenerObj = {
listener: sinon.spy(),
bindTo: {id: 1}
};
const boundListener = _ol_events_.bindListener_(listenerObj);
const boundListener = bindListener(listenerObj);
expect(listenerObj.boundListener).to.equal(boundListener);
boundListener();
expect(listenerObj.listener.thisValues[0]).to.equal(listenerObj.bindTo);
@@ -29,7 +29,7 @@ describe('ol.events', function() {
listener: sinon.spy(),
target: {id: 1}
};
const boundListener = _ol_events_.bindListener_(listenerObj);
const boundListener = bindListener(listenerObj);
expect(listenerObj.boundListener).to.equal(boundListener);
boundListener();
expect(listenerObj.listener.thisValues[0]).to.equal(listenerObj.target);
@@ -42,19 +42,16 @@ describe('ol.events', function() {
bindTo: bindTo,
callOnce: true
};
const unlistenSpy = sinon.spy(_ol_events_, 'unlistenByKey'); // eslint-disable-line openlayers-internal/no-missing-requires
listenerObj.listener = function() {
expect(this).to.equal(bindTo);
expect(unlistenSpy.firstCall.args[0]).to.eql(listenerObj);
};
const boundListener = _ol_events_.bindListener_(listenerObj);
const boundListener = bindListener(listenerObj);
expect(listenerObj.boundListener).to.equal(boundListener);
boundListener();
unlistenSpy.restore();
});
});
describe('findListener_()', function() {
describe('findListener()', function() {
let listener, listenerObj, listeners;
beforeEach(function() {
@@ -69,18 +66,18 @@ describe('ol.events', function() {
it('searches a listener array for a specific listener', function() {
const bindTo = {id: 1};
let result = _ol_events_.findListener_(listeners, listener);
let result = findListener(listeners, listener);
expect(result).to.be(listenerObj);
result = _ol_events_.findListener_(listeners, listener, bindTo);
result = findListener(listeners, listener, bindTo);
expect(result).to.be(undefined);
listenerObj.bindTo = bindTo;
result = _ol_events_.findListener_(listeners, listener);
result = findListener(listeners, listener);
expect(result).to.be(undefined);
result = _ol_events_.findListener_(listeners, listener, bindTo);
result = findListener(listeners, listener, bindTo);
expect(result).to.be(listenerObj);
});
it('marks the delete index on a listener object', function() {
const result = _ol_events_.findListener_(listeners, listener, undefined, true);
const result = findListener(listeners, listener, undefined, true);
expect(result).to.be(listenerObj);
expect(listenerObj.deleteIndex).to.be(0);
});
@@ -88,37 +85,37 @@ describe('ol.events', function() {
describe('getListeners()', function() {
it('returns listeners for a target and type', function() {
const foo = _ol_events_.listen(target, 'foo', function() {});
const bar = _ol_events_.listen(target, 'bar', function() {});
expect (_ol_events_.getListeners(target, 'foo')).to.eql([foo]);
expect (_ol_events_.getListeners(target, 'bar')).to.eql([bar]);
const foo = listen(target, 'foo', function() {});
const bar = listen(target, 'bar', function() {});
expect (getListeners(target, 'foo')).to.eql([foo]);
expect (getListeners(target, 'bar')).to.eql([bar]);
});
it('returns undefined when no listeners are registered', function() {
expect (_ol_events_.getListeners(target, 'foo')).to.be(undefined);
expect (getListeners(target, 'foo')).to.be(undefined);
});
});
describe('listen()', function() {
it('calls addEventListener on the target', function() {
_ol_events_.listen(target, 'foo', function() {});
listen(target, 'foo', function() {});
expect(add.callCount).to.be(1);
});
it('returns a key', function() {
const key = _ol_events_.listen(target, 'foo', function() {});
const key = listen(target, 'foo', function() {});
expect(key).to.be.a(Object);
});
it('does not add the same listener twice', function() {
const listener = function() {};
const key1 = _ol_events_.listen(target, 'foo', listener);
const key2 = _ol_events_.listen(target, 'foo', listener);
const key1 = listen(target, 'foo', listener);
const key2 = listen(target, 'foo', listener);
expect(key1).to.equal(key2);
expect(add.callCount).to.be(1);
});
it('only treats listeners as same when all args are equal', function() {
const listener = function() {};
_ol_events_.listen(target, 'foo', listener, {});
_ol_events_.listen(target, 'foo', listener, {});
_ol_events_.listen(target, 'foo', listener, undefined);
listen(target, 'foo', listener, {});
listen(target, 'foo', listener, {});
listen(target, 'foo', listener, undefined);
expect(add.callCount).to.be(3);
});
});
@@ -126,7 +123,7 @@ describe('ol.events', function() {
describe('listenOnce()', function() {
it('creates a one-off listener', function() {
const listener = sinon.spy();
const key = _ol_events_.listenOnce(target, 'foo', listener);
const key = listenOnce(target, 'foo', listener);
expect(add.callCount).to.be(1);
expect(key.callOnce).to.be(true);
key.boundListener();
@@ -135,17 +132,17 @@ describe('ol.events', function() {
});
it('does not add the same listener twice', function() {
const listener = function() {};
const key1 = _ol_events_.listenOnce(target, 'foo', listener);
const key2 = _ol_events_.listenOnce(target, 'foo', listener);
const key1 = listenOnce(target, 'foo', listener);
const key2 = listenOnce(target, 'foo', listener);
expect(key1).to.equal(key2);
expect(add.callCount).to.be(1);
expect(key1.callOnce).to.be(true);
});
it('listen() can turn a one-off listener into a permanent one', function() {
const listener = sinon.spy();
let key = _ol_events_.listenOnce(target, 'foo', listener);
let key = listenOnce(target, 'foo', listener);
expect(key.callOnce).to.be(true);
key = _ol_events_.listen(target, 'foo', listener);
key = listen(target, 'foo', listener);
expect(add.callCount).to.be(1);
expect(key.callOnce).to.be(false);
key.boundListener();
@@ -156,42 +153,42 @@ describe('ol.events', function() {
describe('unlisten()', function() {
it('unregisters previously registered listeners', function() {
const listener = function() {};
_ol_events_.listen(target, 'foo', listener);
_ol_events_.unlisten(target, 'foo', listener);
expect(_ol_events_.getListeners(target, 'foo')).to.be(undefined);
listen(target, 'foo', listener);
unlisten(target, 'foo', listener);
expect(getListeners(target, 'foo')).to.be(undefined);
});
it('works with multiple types', function() {
const listener = function() {};
_ol_events_.listen(target, ['foo', 'bar'], listener);
_ol_events_.unlisten(target, ['bar', 'foo'], listener);
expect(_ol_events_.getListeners(target, 'foo')).to.be(undefined);
expect(_ol_events_.getListeners(target, 'bar')).to.be(undefined);
listen(target, ['foo', 'bar'], listener);
unlisten(target, ['bar', 'foo'], listener);
expect(getListeners(target, 'foo')).to.be(undefined);
expect(getListeners(target, 'bar')).to.be(undefined);
});
});
describe('unlistenByKey()', function() {
it('unregisters previously registered listeners', function() {
const key = _ol_events_.listen(target, 'foo', function() {});
_ol_events_.unlistenByKey(key);
expect(_ol_events_.getListeners(target, 'foo')).to.be(undefined);
const key = listen(target, 'foo', function() {});
unlistenByKey(key);
expect(getListeners(target, 'foo')).to.be(undefined);
});
it('works with multiple types', function() {
const key = _ol_events_.listen(target, ['foo', 'bar'], function() {});
_ol_events_.unlistenByKey(key);
expect(_ol_events_.getListeners(target, 'foo')).to.be(undefined);
expect(_ol_events_.getListeners(target, 'bar')).to.be(undefined);
const key = listen(target, ['foo', 'bar'], function() {});
unlistenByKey(key);
expect(getListeners(target, 'foo')).to.be(undefined);
expect(getListeners(target, 'bar')).to.be(undefined);
});
});
describe('unlistenAll()', function() {
it('unregisters all listeners registered for a target', function() {
const keys = [
_ol_events_.listen(target, 'foo', function() {}),
_ol_events_.listen(target, 'bar', function() {})
listen(target, 'foo', function() {}),
listen(target, 'bar', function() {})
];
_ol_events_.unlistenAll(target);
expect(_ol_events_.getListeners(target, 'foo')).to.be(undefined);
expect(_ol_events_.getListeners(target, 'bar')).to.be(undefined);
unlistenAll(target);
expect(getListeners(target, 'foo')).to.be(undefined);
expect(getListeners(target, 'bar')).to.be(undefined);
expect('ol_lm' in target).to.be(false);
expect(keys).to.eql([{}, {}]);
});
@@ -201,17 +198,17 @@ describe('ol.events', function() {
it('does not register duplicated listeners', function() {
const target = new EventTarget();
const listener = function() {};
const key1 = _ol_events_.listen(target, 'foo', listener);
const key1 = listen(target, 'foo', listener);
expect(target.getListeners('foo')).to.eql([key1.boundListener]);
const key2 = _ol_events_.listen(target, 'foo', listener);
const key2 = listen(target, 'foo', listener);
expect(key2.boundListener).to.equal(key1.boundListener);
expect(target.getListeners('foo')).to.eql([key1.boundListener]);
});
it('registers multiple listeners if this object is different', function() {
const target = new EventTarget();
const listener = function() {};
const key1 = _ol_events_.listen(target, 'foo', listener, {});
const key2 = _ol_events_.listen(target, 'foo', listener, {});
const key1 = listen(target, 'foo', listener, {});
const key2 = listen(target, 'foo', listener, {});
expect(key1.boundListener).to.not.equal(key2.boundListener);
expect(target.getListeners('foo')).to.eql(
[key1.boundListener, key2.boundListener]);