markercollection.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import MarkerCollection from '../../src/model/markercollection';
  6. import Position from '../../src/model/position';
  7. import Range from '../../src/model/range';
  8. import LiveRange from '../../src/model/liverange';
  9. import Text from '../../src/model/text';
  10. import Model from '../../src/model/model';
  11. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  12. describe( 'MarkerCollection', () => {
  13. let markers, range, range2, doc, root;
  14. beforeEach( () => {
  15. const model = new Model();
  16. doc = model.document;
  17. markers = new MarkerCollection();
  18. root = doc.createRoot();
  19. range = new Range( Position._createAt( root, 0 ), Position._createAt( root, 1 ) );
  20. range2 = new Range( Position._createAt( root, 0 ), Position._createAt( root, 2 ) );
  21. } );
  22. describe( 'iterator', () => {
  23. it( 'should return markers added to the marker collection', () => {
  24. markers._set( 'a', range );
  25. markers._set( 'b', range );
  26. const markerA = markers.get( 'a' );
  27. const markerB = markers.get( 'b' );
  28. const markersArray = Array.from( markers );
  29. expect( markersArray.includes( markerA ) ).to.be.true;
  30. expect( markersArray.includes( markerB ) ).to.be.true;
  31. expect( markersArray.length ).to.equal( 2 );
  32. } );
  33. } );
  34. describe( '_set', () => {
  35. it( 'should create a marker and fire update:<markerName>', () => {
  36. sinon.spy( markers, 'fire' );
  37. const result = markers._set( 'name', range );
  38. const marker = markers.get( 'name' );
  39. expect( result ).to.equal( marker );
  40. expect( marker.name ).to.equal( 'name' );
  41. expect( marker.managedUsingOperations ).to.be.false;
  42. expect( marker.affectsData ).to.be.false;
  43. expect( marker.getRange().isEqual( range ) ).to.be.true;
  44. sinon.assert.calledWithExactly( markers.fire, 'update:name', result, null, range );
  45. } );
  46. it( 'should create a marker marked as managed by operations', () => {
  47. const marker = markers._set( 'name', range, true );
  48. expect( marker.managedUsingOperations ).to.be.true;
  49. } );
  50. it( 'should create a marker marked as affecting the data', () => {
  51. const marker = markers._set( 'name', range, false, true );
  52. expect( marker.affectsData ).to.be.true;
  53. } );
  54. it( 'should update marker range and fire update:<markerName> event if marker with given name was in the collection', () => {
  55. const marker = markers._set( 'name', range );
  56. sinon.spy( markers, 'fire' );
  57. sinon.spy( marker, '_detachLiveRange' );
  58. sinon.spy( marker, '_attachLiveRange' );
  59. const result = markers._set( 'name', range2 );
  60. expect( result ).to.equal( marker );
  61. expect( marker.getRange().isEqual( range2 ) ).to.be.true;
  62. sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, range2 );
  63. sinon.assert.calledOnce( marker._detachLiveRange );
  64. sinon.assert.calledOnce( marker._detachLiveRange );
  65. } );
  66. it( 'should update marker#managedUsingOperations and fire update:<markerName> event if marker with given name ' +
  67. 'was in the collection',
  68. () => {
  69. const marker = markers._set( 'name', range );
  70. sinon.spy( markers, 'fire' );
  71. sinon.spy( marker, '_detachLiveRange' );
  72. sinon.spy( marker, '_attachLiveRange' );
  73. const result = markers._set( 'name', range, true );
  74. expect( result ).to.equal( marker );
  75. expect( marker.managedUsingOperations ).to.be.true;
  76. expect( marker.getRange().isEqual( range ) ).to.be.true;
  77. sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, range );
  78. sinon.assert.notCalled( marker._detachLiveRange );
  79. sinon.assert.notCalled( marker._attachLiveRange );
  80. } );
  81. it( 'should not fire event if given marker has not changed', () => {
  82. const marker = markers._set( 'name', range );
  83. sinon.spy( markers, 'fire' );
  84. const result = markers._set( 'name', range );
  85. expect( marker ).to.equal( result );
  86. sinon.assert.notCalled( markers.fire );
  87. } );
  88. it( 'should accept marker instance instead of name', () => {
  89. const marker = markers._set( 'name', range );
  90. markers._set( marker, range2 );
  91. expect( marker.getRange().isEqual( range2 ) ).to.be.true;
  92. } );
  93. } );
  94. describe( 'has', () => {
  95. it( 'should return false if marker with given name is not in the collection', () => {
  96. expect( markers.has( 'name' ) ).to.be.false;
  97. } );
  98. it( 'should return true if marker with given name is in the collection', () => {
  99. markers._set( 'name', range );
  100. expect( markers.has( 'name' ) ).to.be.true;
  101. } );
  102. } );
  103. describe( 'get', () => {
  104. it( 'should return null if marker with given name has not been found', () => {
  105. expect( markers.get( 'name' ) ).to.be.null;
  106. } );
  107. it( 'should always return same instance of marker', () => {
  108. expect( markers.get( 'name' ) ).to.equal( markers.get( 'name' ) );
  109. } );
  110. } );
  111. describe( '_remove', () => {
  112. it( 'should remove marker, return true and fire update:<markerName> event', () => {
  113. const marker = markers._set( 'name', range );
  114. sinon.spy( markers, 'fire' );
  115. const result = markers._remove( 'name' );
  116. expect( result ).to.be.true;
  117. expect( markers.get( 'name' ) ).to.be.null;
  118. sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, null );
  119. } );
  120. it( 'should destroy marker instance', () => {
  121. const marker = markers._set( 'name', range );
  122. sinon.spy( marker, 'stopListening' );
  123. sinon.spy( marker, '_detachLiveRange' );
  124. markers._remove( 'name' );
  125. expect( marker.stopListening.calledOnce ).to.be.true;
  126. expect( marker._detachLiveRange.calledOnce ).to.be.true;
  127. } );
  128. it( 'should return false if name has not been found in collection', () => {
  129. markers._set( 'name', range );
  130. sinon.spy( markers, 'fire' );
  131. const result = markers._remove( 'other' );
  132. expect( result ).to.be.false;
  133. expect( markers.fire.notCalled ).to.be.true;
  134. } );
  135. it( 'should accept marker instance instead of name', () => {
  136. const marker = markers._set( 'name', range );
  137. sinon.spy( markers, 'fire' );
  138. const result = markers._remove( marker );
  139. expect( result ).to.be.true;
  140. expect( markers.fire.calledWithExactly( 'update:name', marker, range, null ) ).to.be.true;
  141. expect( markers.get( 'name' ) ).to.be.null;
  142. } );
  143. } );
  144. describe( '_refresh()', () => {
  145. it( 'should fire update:<markerName> event', () => {
  146. const marker = markers._set( 'name', range );
  147. sinon.spy( markers, 'fire' );
  148. markers._refresh( 'name' );
  149. sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, range, false, false );
  150. } );
  151. it( 'should throw if marker does not exist', () => {
  152. expectToThrowCKEditorError( () => {
  153. markers._refresh( 'name' );
  154. }, /^markercollection-refresh-marker-not-exists:/, markers );
  155. } );
  156. } );
  157. describe( 'getMarkersGroup', () => {
  158. it( 'returns all markers which names start on given prefix', () => {
  159. const markerFooA = markers._set( 'foo:a', range );
  160. const markerFooB = markers._set( 'foo:b', range );
  161. markers._set( 'bar:a', range );
  162. markers._set( 'foobar:a', range );
  163. expect( Array.from( markers.getMarkersGroup( 'foo' ) ) ).to.deep.equal( [ markerFooA, markerFooB ] );
  164. expect( Array.from( markers.getMarkersGroup( 'a' ) ) ).to.deep.equal( [] );
  165. } );
  166. } );
  167. describe( 'getMarkersAtPosition', () => {
  168. it( 'should return iterator iterating over all markers that contains given position', () => {
  169. markers._set( 'a', range );
  170. const markerB = markers._set( 'b', range2 );
  171. const result = Array.from( markers.getMarkersAtPosition( Position._createAt( root, 1 ) ) );
  172. expect( result ).to.deep.equal( [ markerB ] );
  173. } );
  174. } );
  175. describe( 'destroy', () => {
  176. it( 'should make MarkerCollection stop listening to all events and destroy all markers', () => {
  177. const markerA = markers._set( 'a', range );
  178. const markerB = markers._set( 'b', range2 );
  179. sinon.spy( markers, 'stopListening' );
  180. sinon.spy( markerA, 'stopListening' );
  181. sinon.spy( markerB, 'stopListening' );
  182. markers.destroy();
  183. expect( markers.stopListening.calledWithExactly() ).to.be.true;
  184. expect( markerA.stopListening.calledWithExactly() ).to.be.true;
  185. expect( markerB.stopListening.calledWithExactly() ).to.be.true;
  186. expect( markerA._liveRange ).to.be.null;
  187. expect( markerB._liveRange ).to.be.null;
  188. } );
  189. } );
  190. } );
  191. describe( 'Marker', () => {
  192. let model, doc, root;
  193. beforeEach( () => {
  194. model = new Model();
  195. doc = model.document;
  196. root = doc.createRoot();
  197. } );
  198. it( 'should provide API that returns up-to-date marker range parameters', () => {
  199. root._appendChild( new Text( 'foo' ) );
  200. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  201. const marker = model.markers._set( 'name', range );
  202. expect( marker.getRange().isEqual( range ) ).to.be.true;
  203. expect( marker.getStart().isEqual( range.start ) ).to.be.true;
  204. expect( marker.getEnd().isEqual( range.end ) ).to.be.true;
  205. model.change( writer => {
  206. writer.insertText( 'abc', root );
  207. } );
  208. const updatedRange = new Range( Position._createAt( root, 4 ), Position._createAt( root, 5 ) );
  209. expect( marker.getRange().isEqual( updatedRange ) ).to.be.true;
  210. expect( marker.getStart().isEqual( updatedRange.start ) ).to.be.true;
  211. expect( marker.getEnd().isEqual( updatedRange.end ) ).to.be.true;
  212. } );
  213. it( 'should throw when using the API if marker was removed from markers collection', () => {
  214. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  215. const marker = model.markers._set( 'name', range );
  216. model.markers._remove( 'name' );
  217. expectToThrowCKEditorError( () => {
  218. marker.getRange();
  219. }, /^marker-destroyed/ );
  220. expectToThrowCKEditorError( () => {
  221. marker.getStart();
  222. }, /^marker-destroyed/ );
  223. expectToThrowCKEditorError( () => {
  224. marker.getEnd();
  225. }, /^marker-destroyed/ );
  226. expectToThrowCKEditorError( () => {
  227. marker.managedUsingOperations;
  228. }, /^marker-destroyed/ );
  229. expectToThrowCKEditorError( () => {
  230. marker.affectsData;
  231. }, /^marker-destroyed/ );
  232. } );
  233. it( 'should attach live range to marker', () => {
  234. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  235. const marker = model.markers._set( 'name', range );
  236. const eventRange = sinon.spy();
  237. const eventContent = sinon.spy();
  238. marker.on( 'change:range', eventRange );
  239. marker.on( 'change:content', eventContent );
  240. marker._liveRange.fire( 'change:range', null, {} );
  241. marker._liveRange.fire( 'change:content', null, {} );
  242. expect( eventRange.calledOnce ).to.be.true;
  243. expect( eventContent.calledOnce ).to.be.true;
  244. } );
  245. it( 'should detach live range from marker', () => {
  246. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  247. const marker = model.markers._set( 'name', range );
  248. const liveRange = marker._liveRange;
  249. const eventRange = sinon.spy();
  250. const eventContent = sinon.spy();
  251. sinon.spy( liveRange, 'detach' );
  252. marker.on( 'change:range', eventRange );
  253. marker.on( 'change:content', eventContent );
  254. marker._detachLiveRange();
  255. liveRange.fire( 'change:range', null, {} );
  256. liveRange.fire( 'change:content', null, {} );
  257. expect( eventRange.notCalled ).to.be.true;
  258. expect( eventContent.notCalled ).to.be.true;
  259. expect( liveRange.detach.calledOnce ).to.be.true;
  260. } );
  261. it( 'should reattach live range to marker', () => {
  262. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  263. const marker = model.markers._set( 'name', range );
  264. const oldLiveRange = marker._liveRange;
  265. const newLiveRange = new LiveRange( Position._createAt( root, 0 ), Position._createAt( root, 1 ) );
  266. const eventRange = sinon.spy();
  267. const eventContent = sinon.spy();
  268. sinon.spy( oldLiveRange, 'detach' );
  269. marker.on( 'change:range', eventRange );
  270. marker.on( 'change:content', eventContent );
  271. marker._attachLiveRange( newLiveRange );
  272. oldLiveRange.fire( 'change:range', null, {} );
  273. oldLiveRange.fire( 'change:content', null, {} );
  274. expect( eventRange.notCalled ).to.be.true;
  275. expect( eventContent.notCalled ).to.be.true;
  276. expect( oldLiveRange.detach.calledOnce ).to.be.true;
  277. newLiveRange.fire( 'change:range', null, {} );
  278. newLiveRange.fire( 'change:content', null, {} );
  279. expect( eventRange.calledOnce ).to.be.true;
  280. expect( eventContent.calledOnce ).to.be.true;
  281. } );
  282. it( 'should change managedUsingOperations flag', () => {
  283. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  284. const marker = model.markers._set( 'name', range, false );
  285. expect( marker.managedUsingOperations ).to.be.false;
  286. model.markers._set( 'name', range, true );
  287. expect( marker.managedUsingOperations ).to.be.true;
  288. model.markers._set( 'name', range, false );
  289. expect( marker.managedUsingOperations ).to.be.false;
  290. } );
  291. it( 'should change affectsData flag', () => {
  292. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  293. const marker = model.markers._set( 'name', range, false, false );
  294. expect( marker.affectsData ).to.be.false;
  295. model.markers._set( 'name', range, false, true );
  296. expect( marker.affectsData ).to.be.true;
  297. model.markers._set( 'name', range, false, false );
  298. expect( marker.affectsData ).to.be.false;
  299. } );
  300. describe( 'is()', () => {
  301. let marker;
  302. beforeEach( () => {
  303. const range = new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) );
  304. marker = model.markers._set( 'name', range );
  305. } );
  306. it( 'should return true for "marker"', () => {
  307. expect( marker.is( 'marker' ) ).to.be.true;
  308. expect( marker.is( 'model:marker' ) ).to.be.true;
  309. } );
  310. it( 'should return false for incorrect values', () => {
  311. expect( marker.is( 'model' ) ).to.be.false;
  312. expect( marker.is( 'model:node' ) ).to.be.false;
  313. expect( marker.is( 'text' ) ).to.be.false;
  314. expect( marker.is( 'element', 'paragraph' ) ).to.be.false;
  315. } );
  316. } );
  317. } );