domemittermixin.js 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global document, Event, MouseEvent */
  6. /* bender-tags: ui */
  7. 'use strict';
  8. const modules = bender.amd.require( 'core/lib/lodash/object', 'core/ui/domemittermixin', 'core/emittermixin' );
  9. let emitter, domEmitter, node;
  10. bender.tools.createSinonSandbox();
  11. let getEmitterInstance = () => modules[ 'core/lib/lodash/object' ].extend( {}, modules[ 'core/emittermixin' ] );
  12. let getDOMEmitterInstance = () => modules[ 'core/lib/lodash/object' ].extend( {}, modules[ 'core/ui/domemittermixin' ] );
  13. let getDOMNodeInstance = () => document.createElement( 'div' );
  14. function updateEmitterInstance() {
  15. emitter = getEmitterInstance();
  16. }
  17. function updateDOMEmitterInstance() {
  18. domEmitter = getDOMEmitterInstance();
  19. }
  20. function updateDOMNodeInstance() {
  21. node = getDOMNodeInstance();
  22. }
  23. beforeEach( updateEmitterInstance );
  24. beforeEach( updateDOMEmitterInstance );
  25. beforeEach( updateDOMNodeInstance );
  26. describe( 'listenTo', () => {
  27. it( 'should listen to EmitterMixin events', () => {
  28. let spy = bender.sinon.spy();
  29. domEmitter.listenTo( emitter, 'test', spy );
  30. emitter.fire( 'test' );
  31. sinon.assert.calledOnce( spy );
  32. } );
  33. it( 'should listen to native DOM events', () => {
  34. let spy = bender.sinon.spy();
  35. domEmitter.listenTo( node, 'test', spy );
  36. let event = new Event( 'test' );
  37. node.dispatchEvent( event );
  38. sinon.assert.calledOnce( spy );
  39. } );
  40. } );
  41. describe( 'stopListening', () => {
  42. it( 'should stop listening to a specific event callback', () => {
  43. let spy1 = bender.sinon.spy();
  44. let spy2 = bender.sinon.spy();
  45. domEmitter.listenTo( node, 'event1', spy1 );
  46. domEmitter.listenTo( node, 'event2', spy2 );
  47. node.dispatchEvent( new Event( 'event1' ) );
  48. node.dispatchEvent( new Event( 'event2' ) );
  49. domEmitter.stopListening( node, 'event1', spy1 );
  50. node.dispatchEvent( new Event( 'event1' ) );
  51. node.dispatchEvent( new Event( 'event2' ) );
  52. sinon.assert.calledOnce( spy1 );
  53. sinon.assert.calledTwice( spy2 );
  54. } );
  55. it( 'should stop listening to an specific event', () => {
  56. let spy1a = bender.sinon.spy();
  57. let spy1b = bender.sinon.spy();
  58. let spy2 = bender.sinon.spy();
  59. domEmitter.listenTo( node, 'event1', spy1a );
  60. domEmitter.listenTo( node, 'event1', spy1b );
  61. domEmitter.listenTo( node, 'event2', spy2 );
  62. node.dispatchEvent( new Event( 'event1' ) );
  63. node.dispatchEvent( new Event( 'event2' ) );
  64. sinon.assert.calledOnce( spy1a );
  65. sinon.assert.calledOnce( spy1b );
  66. sinon.assert.calledOnce( spy2 );
  67. domEmitter.stopListening( node, 'event1' );
  68. node.dispatchEvent( new Event( 'event1' ) );
  69. node.dispatchEvent( new Event( 'event2' ) );
  70. sinon.assert.calledOnce( spy1a );
  71. sinon.assert.calledOnce( spy1b );
  72. sinon.assert.calledTwice( spy2 );
  73. } );
  74. it( 'should stop listening to all events from a specific node', () => {
  75. let spy1 = bender.sinon.spy();
  76. let spy2 = bender.sinon.spy();
  77. domEmitter.listenTo( node, 'event1', spy1 );
  78. domEmitter.listenTo( node, 'event2', spy2 );
  79. node.dispatchEvent( new Event( 'event1' ) );
  80. node.dispatchEvent( new Event( 'event2' ) );
  81. domEmitter.stopListening( node );
  82. node.dispatchEvent( new Event( 'event1' ) );
  83. node.dispatchEvent( new Event( 'event2' ) );
  84. sinon.assert.calledOnce( spy1 );
  85. sinon.assert.calledOnce( spy2 );
  86. } );
  87. it( 'should stop listening to everything', () => {
  88. let spy1 = bender.sinon.spy();
  89. let spy2 = bender.sinon.spy();
  90. let node1 = getDOMNodeInstance();
  91. let node2 = getDOMNodeInstance();
  92. domEmitter.listenTo( node1, 'event1', spy1 );
  93. domEmitter.listenTo( node2, 'event2', spy2 );
  94. expect( domEmitter ).to.have.property( '_listeningTo' );
  95. node1.dispatchEvent( new Event( 'event1' ) );
  96. node2.dispatchEvent( new Event( 'event2' ) );
  97. domEmitter.stopListening();
  98. node1.dispatchEvent( new Event( 'event1' ) );
  99. node2.dispatchEvent( new Event( 'event2' ) );
  100. sinon.assert.calledOnce( spy1 );
  101. sinon.assert.calledOnce( spy2 );
  102. expect( domEmitter ).to.not.have.property( '_listeningTo' );
  103. } );
  104. it( 'should not stop other nodes when a non-listened node is provided', () => {
  105. let spy = bender.sinon.spy();
  106. let node1 = getDOMNodeInstance();
  107. let node2 = getDOMNodeInstance();
  108. domEmitter.listenTo( node1, 'test', spy );
  109. domEmitter.stopListening( node2 );
  110. node1.dispatchEvent( new Event( 'test' ) );
  111. sinon.assert.called( spy );
  112. } );
  113. it( 'should pass DOM Event data to the listener', () => {
  114. let spy = bender.sinon.spy();
  115. let node = getDOMNodeInstance();
  116. domEmitter.listenTo( node, 'click', spy );
  117. let mouseEvent = new MouseEvent( 'click', {
  118. screenX: 10,
  119. screenY: 20
  120. } );
  121. node.dispatchEvent( mouseEvent );
  122. sinon.assert.calledOnce( spy );
  123. expect( spy.args[ 0 ][ 1 ] ).to.be.equal( mouseEvent );
  124. } );
  125. it( 'should detach native DOM event listener proxy, specific event', () => {
  126. let spy1a = bender.sinon.spy();
  127. let spy1b = bender.sinon.spy();
  128. domEmitter.listenTo( node, 'test', spy1a );
  129. let proxyEmitter = domEmitter._getProxyEmitter( node );
  130. let spy2 = bender.sinon.spy( proxyEmitter, 'fire' );
  131. node.dispatchEvent( new Event( 'test' ) );
  132. sinon.assert.calledOnce( spy1a );
  133. sinon.assert.calledOnce( spy2 );
  134. domEmitter.stopListening( node, 'test' );
  135. node.dispatchEvent( new Event( 'test' ) );
  136. sinon.assert.calledOnce( spy1a );
  137. sinon.assert.calledOnce( spy2 );
  138. // Attach same event again.
  139. domEmitter.listenTo( node, 'test', spy1b );
  140. node.dispatchEvent( new Event( 'test' ) );
  141. expect( proxyEmitter ).to.be.equal( domEmitter._getProxyEmitter( node ) );
  142. sinon.assert.calledOnce( spy1a );
  143. sinon.assert.calledOnce( spy1b );
  144. sinon.assert.calledTwice( spy2 );
  145. } );
  146. it( 'should detach native DOM event listener proxy, specific callback', () => {
  147. let spy1a = bender.sinon.spy();
  148. let spy1b = bender.sinon.spy();
  149. let spy1c = bender.sinon.spy();
  150. domEmitter.listenTo( node, 'test', spy1a );
  151. domEmitter.listenTo( node, 'test', spy1b );
  152. let proxyEmitter = domEmitter._getProxyEmitter( node );
  153. let spy2 = bender.sinon.spy( proxyEmitter, 'fire' );
  154. node.dispatchEvent( new Event( 'test' ) );
  155. sinon.assert.calledOnce( spy1a );
  156. sinon.assert.calledOnce( spy1b );
  157. sinon.assert.calledOnce( spy2 );
  158. domEmitter.stopListening( node, 'test', spy1a );
  159. node.dispatchEvent( new Event( 'test' ) );
  160. sinon.assert.calledOnce( spy1a );
  161. sinon.assert.calledTwice( spy1b );
  162. sinon.assert.calledTwice( spy2 );
  163. domEmitter.stopListening( node, 'test', spy1b );
  164. node.dispatchEvent( new Event( 'test' ) );
  165. sinon.assert.calledOnce( spy1a );
  166. sinon.assert.calledTwice( spy1b );
  167. sinon.assert.calledTwice( spy2 );
  168. // Attach same event again.
  169. domEmitter.listenTo( node, 'test', spy1c );
  170. node.dispatchEvent( new Event( 'test' ) );
  171. expect( proxyEmitter ).to.be.equal( domEmitter._getProxyEmitter( node ) );
  172. sinon.assert.calledOnce( spy1a );
  173. sinon.assert.calledTwice( spy1b );
  174. sinon.assert.calledOnce( spy1c );
  175. sinon.assert.calledThrice( spy2 );
  176. } );
  177. it( 'should detach native DOM event listener proxy, specific emitter', () => {
  178. let spy1a = bender.sinon.spy();
  179. let spy1b = bender.sinon.spy();
  180. let spy1c = bender.sinon.spy();
  181. let spy1d = bender.sinon.spy();
  182. domEmitter.listenTo( node, 'test1', spy1a );
  183. domEmitter.listenTo( node, 'test2', spy1b );
  184. let proxyEmitter = domEmitter._getProxyEmitter( node );
  185. let spy2 = bender.sinon.spy( proxyEmitter, 'fire' );
  186. node.dispatchEvent( new Event( 'test1' ) );
  187. node.dispatchEvent( new Event( 'test2' ) );
  188. sinon.assert.calledOnce( spy1a );
  189. sinon.assert.calledOnce( spy1b );
  190. sinon.assert.calledTwice( spy2 );
  191. domEmitter.stopListening( node );
  192. node.dispatchEvent( new Event( 'test1' ) );
  193. node.dispatchEvent( new Event( 'test2' ) );
  194. sinon.assert.calledOnce( spy1a );
  195. sinon.assert.calledOnce( spy1b );
  196. sinon.assert.calledTwice( spy2 );
  197. // Attach same event again.
  198. domEmitter.listenTo( node, 'test1', spy1c );
  199. domEmitter.listenTo( node, 'test2', spy1d );
  200. // Old proxy emitter died when stopped listening to the node.
  201. let proxyEmitter2 = domEmitter._getProxyEmitter( node );
  202. let spy3 = bender.sinon.spy( proxyEmitter2, 'fire' );
  203. node.dispatchEvent( new Event( 'test1' ) );
  204. node.dispatchEvent( new Event( 'test2' ) );
  205. expect( proxyEmitter ).to.not.be.equal( proxyEmitter2 );
  206. sinon.assert.calledOnce( spy1a );
  207. sinon.assert.calledOnce( spy1b );
  208. sinon.assert.calledOnce( spy1c );
  209. sinon.assert.calledOnce( spy1d );
  210. sinon.assert.calledTwice( spy2 );
  211. sinon.assert.calledTwice( spy3 );
  212. } );
  213. it( 'should detach native DOM event listener proxy, everything', () => {
  214. let spy1a = bender.sinon.spy();
  215. let spy1b = bender.sinon.spy();
  216. let spy1c = bender.sinon.spy();
  217. let spy1d = bender.sinon.spy();
  218. domEmitter.listenTo( node, 'test1', spy1a );
  219. domEmitter.listenTo( node, 'test2', spy1b );
  220. let proxyEmitter = domEmitter._getProxyEmitter( node );
  221. let spy2 = bender.sinon.spy( proxyEmitter, 'fire' );
  222. node.dispatchEvent( new Event( 'test1' ) );
  223. node.dispatchEvent( new Event( 'test2' ) );
  224. sinon.assert.calledOnce( spy1a );
  225. sinon.assert.calledOnce( spy1b );
  226. sinon.assert.calledTwice( spy2 );
  227. domEmitter.stopListening();
  228. node.dispatchEvent( new Event( 'test1' ) );
  229. node.dispatchEvent( new Event( 'test2' ) );
  230. sinon.assert.calledOnce( spy1a );
  231. sinon.assert.calledOnce( spy1b );
  232. sinon.assert.calledTwice( spy2 );
  233. // Attach same event again.
  234. domEmitter.listenTo( node, 'test1', spy1c );
  235. domEmitter.listenTo( node, 'test2', spy1d );
  236. // Old proxy emitter died when stopped listening to the node.
  237. let proxyEmitter2 = domEmitter._getProxyEmitter( node );
  238. let spy3 = bender.sinon.spy( proxyEmitter2, 'fire' );
  239. node.dispatchEvent( new Event( 'test1' ) );
  240. node.dispatchEvent( new Event( 'test2' ) );
  241. expect( proxyEmitter ).to.not.be.equal( proxyEmitter2 );
  242. sinon.assert.calledOnce( spy1a );
  243. sinon.assert.calledOnce( spy1b );
  244. sinon.assert.calledOnce( spy1c );
  245. sinon.assert.calledOnce( spy1d );
  246. sinon.assert.calledTwice( spy2 );
  247. sinon.assert.calledTwice( spy3 );
  248. } );
  249. } );