markercollection.js 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import MarkerCollection from '../../src/model/markercollection';
  6. import Position from '../../src/model/position';
  7. import Range from '../../src/model/range';
  8. import Text from '../../src/model/text';
  9. import Model from '../../src/model/model';
  10. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  11. describe( 'MarkerCollection', () => {
  12. let markers, range, range2, doc, root;
  13. beforeEach( () => {
  14. const model = new Model();
  15. doc = model.document;
  16. markers = new MarkerCollection();
  17. root = doc.createRoot();
  18. range = Range.createFromParentsAndOffsets( root, 0, root, 1 );
  19. range2 = Range.createFromParentsAndOffsets( root, 0, root, 2 );
  20. } );
  21. describe( 'iterator', () => {
  22. it( 'should return markers added to the marker collection', () => {
  23. markers._set( 'a', range );
  24. markers._set( 'b', range );
  25. const markerA = markers.get( 'a' );
  26. const markerB = markers.get( 'b' );
  27. const markersArray = Array.from( markers );
  28. expect( markersArray.includes( markerA ) ).to.be.true;
  29. expect( markersArray.includes( markerB ) ).to.be.true;
  30. expect( markersArray.length ).to.equal( 2 );
  31. } );
  32. } );
  33. describe( '_set', () => {
  34. it( 'should create a marker, fire add:<markerName> event and return true', () => {
  35. sinon.spy( markers, 'fire' );
  36. const result = markers._set( 'name', range );
  37. const marker = markers.get( 'name' );
  38. expect( result ).to.equal( marker );
  39. expect( marker.name ).to.equal( 'name' );
  40. expect( marker.getRange().isEqual( range ) ).to.be.true;
  41. expect( markers.fire.calledWithExactly( 'add:name', marker ) ).to.be.true;
  42. } );
  43. it( 'should fire remove:<markerName> event, and create a new marker if marker with given name was in the collection', () => {
  44. const marker1 = markers._set( 'name', range );
  45. sinon.spy( markers, 'fire' );
  46. const marker2 = markers._set( 'name', range2 );
  47. expect( markers.fire.calledWithExactly( 'remove:name', marker1 ) ).to.be.true;
  48. expect( markers.fire.calledWithExactly( 'add:name', marker2 ) ).to.be.true;
  49. expect( marker2.name ).to.equal( 'name' );
  50. expect( marker2.getRange().isEqual( range2 ) ).to.be.true;
  51. expect( marker1 ).not.to.equal( marker2 );
  52. } );
  53. it( 'should not fire event and return the same marker if given marker has a range equal to given range', () => {
  54. const marker1 = markers._set( 'name', range );
  55. sinon.spy( markers, 'fire' );
  56. const marker2 = markers._set( 'name', range );
  57. expect( marker1 ).to.equal( marker2 );
  58. expect( markers.fire.notCalled ).to.be.true;
  59. } );
  60. it( 'should accept marker instance instead of name', () => {
  61. markers._set( 'name', range );
  62. const marker1 = markers.get( 'name' );
  63. const result = markers._set( marker1, range2 );
  64. const marker2 = markers.get( 'name' );
  65. expect( result ).to.equal( marker2 );
  66. expect( marker2.getRange().isEqual( range2 ) );
  67. expect( marker1 ).not.to.equal( marker2 );
  68. } );
  69. } );
  70. describe( 'has', () => {
  71. it( 'should return false if marker with given name is not in the collection', () => {
  72. expect( markers.has( 'name' ) ).to.be.false;
  73. } );
  74. it( 'should return true if marker with given name is in the collection', () => {
  75. markers._set( 'name', range );
  76. expect( markers.has( 'name' ) ).to.be.true;
  77. } );
  78. } );
  79. describe( 'get', () => {
  80. it( 'should return null if marker with given name has not been found', () => {
  81. expect( markers.get( 'name' ) ).to.be.null;
  82. } );
  83. it( 'should always return same instance of marker', () => {
  84. expect( markers.get( 'name' ) ).to.equal( markers.get( 'name' ) );
  85. } );
  86. } );
  87. describe( '_remove', () => {
  88. it( 'should remove marker, return true and fire remove:<markerName> event', () => {
  89. const marker = markers._set( 'name', range );
  90. sinon.spy( markers, 'fire' );
  91. const result = markers._remove( 'name' );
  92. expect( result ).to.be.true;
  93. expect( markers.fire.calledWithExactly( 'remove:name', marker ) ).to.be.true;
  94. expect( markers.get( 'name' ) ).to.be.null;
  95. } );
  96. it( 'should destroy marker instance', () => {
  97. const marker = markers._set( 'name', range );
  98. const liveRange = marker._liveRange;
  99. sinon.spy( marker, 'stopListening' );
  100. sinon.spy( liveRange, 'detach' );
  101. markers._remove( 'name' );
  102. expect( marker.stopListening.calledOnce ).to.be.true;
  103. expect( marker._liveRange ).to.be.null;
  104. expect( liveRange.detach.calledOnce ).to.be.true;
  105. } );
  106. it( 'should return false if name has not been found in collection', () => {
  107. markers._set( 'name', range );
  108. sinon.spy( markers, 'fire' );
  109. const result = markers._remove( 'other' );
  110. expect( result ).to.be.false;
  111. expect( markers.fire.notCalled ).to.be.true;
  112. } );
  113. it( 'should accept marker instance instead of name', () => {
  114. const marker = markers._set( 'name', range );
  115. sinon.spy( markers, 'fire' );
  116. const result = markers._remove( marker );
  117. expect( result ).to.be.true;
  118. expect( markers.fire.calledWithExactly( 'remove:name', marker ) ).to.be.true;
  119. expect( markers.get( 'name' ) ).to.be.null;
  120. } );
  121. } );
  122. describe( 'getMarkersGroup', () => {
  123. it( 'returns all markers which names start on given prefix', () => {
  124. const markerFooA = markers._set( 'foo:a', range );
  125. const markerFooB = markers._set( 'foo:b', range );
  126. markers._set( 'bar:a', range );
  127. markers._set( 'foobar:a', range );
  128. expect( Array.from( markers.getMarkersGroup( 'foo' ) ) ).to.deep.equal( [ markerFooA, markerFooB ] );
  129. expect( Array.from( markers.getMarkersGroup( 'a' ) ) ).to.deep.equal( [] );
  130. } );
  131. } );
  132. describe( 'getMarkersAtPosition', () => {
  133. it( 'should return iterator iterating over all markers that contains given position', () => {
  134. markers._set( 'a', range );
  135. const markerB = markers._set( 'b', range2 );
  136. const result = Array.from( markers.getMarkersAtPosition( Position.createAt( root, 1 ) ) );
  137. expect( result ).to.deep.equal( [ markerB ] );
  138. } );
  139. } );
  140. describe( 'destroy', () => {
  141. it( 'should make MarkerCollection stop listening to all events and destroy all markers', () => {
  142. const markerA = markers._set( 'a', range );
  143. const markerB = markers._set( 'b', range2 );
  144. sinon.spy( markers, 'stopListening' );
  145. sinon.spy( markerA, 'stopListening' );
  146. sinon.spy( markerB, 'stopListening' );
  147. markers.destroy();
  148. expect( markers.stopListening.calledWithExactly() ).to.be.true;
  149. expect( markerA.stopListening.calledWithExactly() ).to.be.true;
  150. expect( markerB.stopListening.calledWithExactly() ).to.be.true;
  151. expect( markerA._liveRange ).to.be.null;
  152. expect( markerB._liveRange ).to.be.null;
  153. } );
  154. } );
  155. } );
  156. describe( 'Marker', () => {
  157. let model, doc, root;
  158. beforeEach( () => {
  159. model = new Model();
  160. doc = model.document;
  161. root = doc.createRoot();
  162. } );
  163. it( 'should provide API that returns up-to-date marker range parameters', () => {
  164. root.appendChildren( new Text( 'foo' ) );
  165. const range = Range.createFromParentsAndOffsets( root, 1, root, 2 );
  166. const marker = model.markers._set( 'name', range );
  167. expect( marker.getRange().isEqual( range ) ).to.be.true;
  168. expect( marker.getStart().isEqual( range.start ) ).to.be.true;
  169. expect( marker.getEnd().isEqual( range.end ) ).to.be.true;
  170. model.change( writer => {
  171. writer.insertText( 'abc', root );
  172. } );
  173. const updatedRange = Range.createFromParentsAndOffsets( root, 4, root, 5 );
  174. expect( marker.getRange().isEqual( updatedRange ) ).to.be.true;
  175. expect( marker.getStart().isEqual( updatedRange.start ) ).to.be.true;
  176. expect( marker.getEnd().isEqual( updatedRange.end ) ).to.be.true;
  177. } );
  178. it( 'should throw when using the API if marker was removed from markers collection', () => {
  179. const range = Range.createFromParentsAndOffsets( root, 1, root, 2 );
  180. const marker = model.markers._set( 'name', range );
  181. model.markers._remove( 'name' );
  182. expect( () => {
  183. marker.getRange();
  184. } ).to.throw( CKEditorError, /^marker-destroyed/ );
  185. expect( () => {
  186. marker.getStart();
  187. } ).to.throw( CKEditorError, /^marker-destroyed/ );
  188. expect( () => {
  189. marker.getEnd();
  190. } ).to.throw( CKEditorError, /^marker-destroyed/ );
  191. } );
  192. it( 'should delegate events from live range', () => {
  193. const range = Range.createFromParentsAndOffsets( root, 1, root, 2 );
  194. const marker = model.markers._set( 'name', range );
  195. const eventRange = sinon.spy();
  196. const eventContent = sinon.spy();
  197. marker.on( 'change:range', eventRange );
  198. marker.on( 'change:content', eventContent );
  199. marker._liveRange.fire( 'change:range', null, {} );
  200. marker._liveRange.fire( 'change:content', null, {} );
  201. expect( eventRange.calledOnce ).to.be.true;
  202. expect( eventContent.calledOnce ).to.be.true;
  203. } );
  204. } );