documentselection.js 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  6. import Batch from '../../src/model/batch';
  7. import Element from '../../src/model/element';
  8. import Text from '../../src/model/text';
  9. import Range from '../../src/model/range';
  10. import Position from '../../src/model/position';
  11. import LiveRange from '../../src/model/liverange';
  12. import DocumentSelection from '../../src/model/documentselection';
  13. import InsertOperation from '../../src/model/operation/insertoperation';
  14. import MoveOperation from '../../src/model/operation/moveoperation';
  15. import RemoveOperation from '../../src/model/operation/removeoperation';
  16. import AttributeOperation from '../../src/model/operation/attributeoperation';
  17. import SplitDelta from '../../src/model/delta/splitdelta';
  18. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  19. import count from '@ckeditor/ckeditor5-utils/src/count';
  20. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  21. import { wrapInDelta } from '../../tests/model/_utils/utils';
  22. import { setData, getData } from '../../src/dev-utils/model';
  23. testUtils.createSinonSandbox();
  24. describe( 'DocumentSelection', () => {
  25. let model, doc, root, selection, liveRange, range;
  26. const fooStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'foo' );
  27. const abcStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'abc' );
  28. beforeEach( () => {
  29. model = new Model();
  30. doc = model.document;
  31. root = doc.createRoot();
  32. root.appendChildren( [
  33. new Element( 'p' ),
  34. new Element( 'p' ),
  35. new Element( 'p', [], new Text( 'foobar' ) ),
  36. new Element( 'p' ),
  37. new Element( 'p' ),
  38. new Element( 'p' ),
  39. new Element( 'p', [], new Text( 'foobar' ) )
  40. ] );
  41. selection = doc.selection;
  42. model.schema.register( 'p', { inheritAllFrom: '$block' } );
  43. model.schema.register( 'widget', {
  44. isObject: true
  45. } );
  46. liveRange = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  47. range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 2 ] ) );
  48. } );
  49. afterEach( () => {
  50. model.destroy();
  51. liveRange.detach();
  52. } );
  53. describe( 'default range', () => {
  54. it( 'should go to the first editable element', () => {
  55. const ranges = Array.from( selection.getRanges() );
  56. expect( ranges.length ).to.equal( 1 );
  57. expect( selection.anchor.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
  58. expect( selection.focus.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
  59. expect( selection ).to.have.property( 'isBackward', false );
  60. } );
  61. it( 'should be set to the beginning of the doc if there is no editable element', () => {
  62. model = new Model();
  63. doc = model.document;
  64. root = doc.createRoot();
  65. root.insertChildren( 0, new Text( 'foobar' ) );
  66. selection = doc.selection;
  67. const ranges = Array.from( selection.getRanges() );
  68. expect( ranges.length ).to.equal( 1 );
  69. expect( selection.anchor.isEqual( new Position( root, [ 0 ] ) ) ).to.be.true;
  70. expect( selection.focus.isEqual( new Position( root, [ 0 ] ) ) ).to.be.true;
  71. expect( selection ).to.have.property( 'isBackward', false );
  72. expect( count( selection.getAttributes() ) ).to.equal( 0 );
  73. } );
  74. it( 'should skip element when you can not put selection', () => {
  75. model = new Model();
  76. doc = model.document;
  77. root = doc.createRoot();
  78. root.insertChildren( 0, [
  79. new Element( 'img' ),
  80. new Element( 'p', [], new Text( 'foobar' ) )
  81. ] );
  82. model.schema.register( 'img' );
  83. model.schema.register( 'p', { inheritAllFrom: '$block' } );
  84. selection = doc.selection;
  85. const ranges = Array.from( selection.getRanges() );
  86. expect( ranges.length ).to.equal( 1 );
  87. expect( selection.anchor.isEqual( new Position( root, [ 1, 0 ] ) ) ).to.be.true;
  88. expect( selection.focus.isEqual( new Position( root, [ 1, 0 ] ) ) ).to.be.true;
  89. expect( selection ).to.have.property( 'isBackward', false );
  90. expect( count( selection.getAttributes() ) ).to.equal( 0 );
  91. } );
  92. } );
  93. describe( 'isCollapsed', () => {
  94. it( 'should be true for the default range (in text position)', () => {
  95. expect( selection.isCollapsed ).to.be.true;
  96. } );
  97. it( 'should be false for the default range (object selection) ', () => {
  98. root.insertChildren( 0, new Element( 'widget' ) );
  99. expect( selection.isCollapsed ).to.be.false;
  100. } );
  101. it( 'should back off to the default algorithm if selection has ranges', () => {
  102. selection._setTo( range );
  103. expect( selection.isCollapsed ).to.be.false;
  104. } );
  105. } );
  106. describe( 'anchor', () => {
  107. it( 'should equal the default range\'s start (in text position)', () => {
  108. const expectedPos = new Position( root, [ 0, 0 ] );
  109. expect( selection.anchor.isEqual( expectedPos ) ).to.be.true;
  110. } );
  111. it( 'should equal the default range\'s start (object selection)', () => {
  112. root.insertChildren( 0, new Element( 'widget' ) );
  113. const expectedPos = new Position( root, [ 0 ] );
  114. expect( selection.anchor.isEqual( expectedPos ) ).to.be.true;
  115. } );
  116. it( 'should back off to the default algorithm if selection has ranges', () => {
  117. selection._setTo( range );
  118. expect( selection.anchor.isEqual( range.start ) ).to.be.true;
  119. } );
  120. } );
  121. describe( 'focus', () => {
  122. it( 'should equal the default range\'s end (in text position)', () => {
  123. const expectedPos = new Position( root, [ 0, 0 ] );
  124. expect( selection.focus.isEqual( expectedPos ) ).to.be.true;
  125. } );
  126. it( 'should equal the default range\'s end (object selection)', () => {
  127. root.insertChildren( 0, new Element( 'widget' ) );
  128. const expectedPos = new Position( root, [ 1 ] );
  129. expect( selection.focus.isEqual( expectedPos ) ).to.be.true;
  130. expect( selection.focus.isEqual( selection.getFirstRange().end ) ).to.be.true;
  131. } );
  132. it( 'should back off to the default algorithm if selection has ranges', () => {
  133. selection._setTo( range );
  134. expect( selection.focus.isEqual( range.end ) ).to.be.true;
  135. } );
  136. } );
  137. describe( 'rangeCount', () => {
  138. it( 'should return proper range count', () => {
  139. expect( selection.rangeCount ).to.equal( 1 );
  140. selection._setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
  141. expect( selection.rangeCount ).to.equal( 1 );
  142. selection._setTo( [
  143. new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ),
  144. new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) )
  145. ] );
  146. expect( selection.rangeCount ).to.equal( 2 );
  147. } );
  148. } );
  149. describe( 'hasOwnRange', () => {
  150. it( 'should return true if selection has any ranges set', () => {
  151. selection._setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
  152. expect( selection.hasOwnRange ).to.be.true;
  153. } );
  154. it( 'should return false if selection has a default range', () => {
  155. expect( selection.hasOwnRange ).to.be.false;
  156. } );
  157. } );
  158. describe( 'setTo - set collapsed at', () => {
  159. it( 'detaches all existing ranges', () => {
  160. selection._setTo( [ range, liveRange ] );
  161. const spy = testUtils.sinon.spy( LiveRange.prototype, 'detach' );
  162. selection._setTo( root );
  163. expect( spy.calledTwice ).to.be.true;
  164. } );
  165. } );
  166. describe( 'destroy()', () => {
  167. it( 'should unbind all events', () => {
  168. selection._setTo( [ range, liveRange ] );
  169. const ranges = Array.from( selection._selection._ranges );
  170. sinon.spy( ranges[ 0 ], 'detach' );
  171. sinon.spy( ranges[ 1 ], 'detach' );
  172. selection.destroy();
  173. expect( ranges[ 0 ].detach.called ).to.be.true;
  174. expect( ranges[ 1 ].detach.called ).to.be.true;
  175. ranges[ 0 ].detach.restore();
  176. ranges[ 1 ].detach.restore();
  177. } );
  178. } );
  179. describe( 'setFocus()', () => {
  180. it( 'modifies default range', () => {
  181. const startPos = selection.getFirstPosition();
  182. const endPos = Position.createAt( root, 'end' );
  183. selection._setFocus( endPos );
  184. expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
  185. expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
  186. } );
  187. it( 'detaches the range it replaces', () => {
  188. const startPos = Position.createAt( root, 1 );
  189. const endPos = Position.createAt( root, 2 );
  190. const newEndPos = Position.createAt( root, 4 );
  191. const spy = testUtils.sinon.spy( LiveRange.prototype, 'detach' );
  192. selection._setTo( new Range( startPos, endPos ) );
  193. selection._setFocus( newEndPos );
  194. expect( spy.calledOnce ).to.be.true;
  195. } );
  196. it( 'refreshes attributes', () => {
  197. const spy = sinon.spy( selection._selection, '_updateAttributes' );
  198. selection._setFocus( Position.createAt( root, 1 ) );
  199. expect( spy.called ).to.be.true;
  200. } );
  201. } );
  202. describe( 'setTo - removeAllRanges', () => {
  203. let spy, ranges;
  204. beforeEach( () => {
  205. selection._setTo( [ liveRange, range ] );
  206. spy = sinon.spy();
  207. selection.on( 'change:range', spy );
  208. ranges = Array.from( selection._selection._ranges );
  209. sinon.spy( ranges[ 0 ], 'detach' );
  210. sinon.spy( ranges[ 1 ], 'detach' );
  211. selection._setTo( null );
  212. } );
  213. afterEach( () => {
  214. ranges[ 0 ].detach.restore();
  215. ranges[ 1 ].detach.restore();
  216. } );
  217. it( 'should remove all stored ranges (and reset to default range)', () => {
  218. expect( Array.from( selection.getRanges() ).length ).to.equal( 1 );
  219. expect( selection.anchor.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
  220. expect( selection.focus.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
  221. } );
  222. it( 'should detach ranges', () => {
  223. expect( ranges[ 0 ].detach.called ).to.be.true;
  224. expect( ranges[ 1 ].detach.called ).to.be.true;
  225. } );
  226. it( 'should refresh attributes', () => {
  227. const spy = sinon.spy( selection._selection, '_updateAttributes' );
  228. selection._setTo( null );
  229. expect( spy.called ).to.be.true;
  230. } );
  231. } );
  232. // TODO - merge with other setTo's
  233. describe( 'setTo()', () => {
  234. it( 'should throw an error when range is invalid', () => {
  235. expect( () => {
  236. selection._setTo( [ { invalid: 'range' } ] );
  237. } ).to.throw( CKEditorError, /model-selection-added-not-range/ );
  238. } );
  239. it( 'should detach removed ranges', () => {
  240. selection._setTo( [ liveRange, range ] );
  241. const oldRanges = Array.from( selection._selection._ranges );
  242. sinon.spy( oldRanges[ 0 ], 'detach' );
  243. sinon.spy( oldRanges[ 1 ], 'detach' );
  244. selection._setTo( [] );
  245. expect( oldRanges[ 0 ].detach.called ).to.be.true;
  246. expect( oldRanges[ 1 ].detach.called ).to.be.true;
  247. } );
  248. it( 'should refresh attributes', () => {
  249. const spy = sinon.spy( selection._selection, '_updateAttributes' );
  250. selection._setTo( [ range ] );
  251. expect( spy.called ).to.be.true;
  252. } );
  253. // See #630.
  254. it( 'should refresh attributes – integration test for #630', () => {
  255. model.schema.extend( '$text', { allowIn: '$root' } );
  256. setData( model, 'f<$text italic="true">[o</$text><$text bold="true">ob]a</$text>r' );
  257. selection._setTo( [ Range.createFromPositionAndShift( selection.getLastRange().end, 0 ) ] );
  258. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  259. expect( selection.hasAttribute( 'italic' ) ).to.equal( false );
  260. expect( getData( model ) )
  261. .to.equal( 'f<$text italic="true">o</$text><$text bold="true">ob[]a</$text>r' );
  262. } );
  263. } );
  264. describe( 'getFirstRange()', () => {
  265. it( 'should return default range if no ranges were added', () => {
  266. const firstRange = selection.getFirstRange();
  267. expect( firstRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
  268. expect( firstRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
  269. } );
  270. } );
  271. describe( 'getLastRange()', () => {
  272. it( 'should return default range if no ranges were added', () => {
  273. const lastRange = selection.getLastRange();
  274. expect( lastRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
  275. expect( lastRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
  276. } );
  277. } );
  278. describe( '_isStoreAttributeKey', () => {
  279. it( 'should return true if given key is a key of an attribute stored in element by DocumentSelection', () => {
  280. expect( DocumentSelection._isStoreAttributeKey( fooStoreAttrKey ) ).to.be.true;
  281. } );
  282. it( 'should return false if given key is not a key of an attribute stored in element by DocumentSelection', () => {
  283. expect( DocumentSelection._isStoreAttributeKey( 'foo' ) ).to.be.false;
  284. } );
  285. } );
  286. // DocumentSelection uses LiveRanges so here are only simple test to see if integration is
  287. // working well, without getting into complicated corner cases.
  288. describe( 'after applying an operation should get updated and fire events', () => {
  289. let spyRange;
  290. beforeEach( () => {
  291. root.removeChildren( 0, root.childCount );
  292. root.insertChildren( 0, [
  293. new Element( 'p', [], new Text( 'abcdef' ) ),
  294. new Element( 'p', [], new Text( 'foobar' ) ),
  295. new Text( 'xyz' )
  296. ] );
  297. selection._setTo( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 4 ] ) ) );
  298. spyRange = sinon.spy();
  299. selection.on( 'change:range', spyRange );
  300. } );
  301. describe( 'InsertOperation', () => {
  302. it( 'before selection', () => {
  303. selection.on( 'change:range', ( evt, data ) => {
  304. expect( data.directChange ).to.be.false;
  305. } );
  306. model.applyOperation( wrapInDelta(
  307. new InsertOperation(
  308. new Position( root, [ 0, 1 ] ),
  309. 'xyz',
  310. doc.version
  311. )
  312. ) );
  313. const range = selection.getFirstRange();
  314. expect( range.start.path ).to.deep.equal( [ 0, 5 ] );
  315. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  316. expect( spyRange.calledOnce ).to.be.true;
  317. } );
  318. it( 'inside selection', () => {
  319. selection.on( 'change:range', ( evt, data ) => {
  320. expect( data.directChange ).to.be.false;
  321. } );
  322. model.applyOperation( wrapInDelta(
  323. new InsertOperation(
  324. new Position( root, [ 1, 0 ] ),
  325. 'xyz',
  326. doc.version
  327. )
  328. ) );
  329. const range = selection.getFirstRange();
  330. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  331. expect( range.end.path ).to.deep.equal( [ 1, 7 ] );
  332. expect( spyRange.calledOnce ).to.be.true;
  333. } );
  334. } );
  335. describe( 'MoveOperation', () => {
  336. it( 'move range from before a selection', () => {
  337. selection.on( 'change:range', ( evt, data ) => {
  338. expect( data.directChange ).to.be.false;
  339. } );
  340. model.applyOperation( wrapInDelta(
  341. new MoveOperation(
  342. new Position( root, [ 0, 0 ] ),
  343. 2,
  344. new Position( root, [ 2 ] ),
  345. doc.version
  346. )
  347. ) );
  348. const range = selection.getFirstRange();
  349. expect( range.start.path ).to.deep.equal( [ 0, 0 ] );
  350. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  351. expect( spyRange.calledOnce ).to.be.true;
  352. } );
  353. it( 'moved into before a selection', () => {
  354. selection.on( 'change:range', ( evt, data ) => {
  355. expect( data.directChange ).to.be.false;
  356. } );
  357. model.applyOperation( wrapInDelta(
  358. new MoveOperation(
  359. new Position( root, [ 2 ] ),
  360. 2,
  361. new Position( root, [ 0, 0 ] ),
  362. doc.version
  363. )
  364. ) );
  365. const range = selection.getFirstRange();
  366. expect( range.start.path ).to.deep.equal( [ 0, 4 ] );
  367. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  368. expect( spyRange.calledOnce ).to.be.true;
  369. } );
  370. it( 'move range from inside of selection', () => {
  371. selection.on( 'change:range', ( evt, data ) => {
  372. expect( data.directChange ).to.be.false;
  373. } );
  374. model.applyOperation( wrapInDelta(
  375. new MoveOperation(
  376. new Position( root, [ 1, 0 ] ),
  377. 2,
  378. new Position( root, [ 2 ] ),
  379. doc.version
  380. )
  381. ) );
  382. const range = selection.getFirstRange();
  383. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  384. expect( range.end.path ).to.deep.equal( [ 1, 2 ] );
  385. expect( spyRange.calledOnce ).to.be.true;
  386. } );
  387. it( 'moved range intersects with selection', () => {
  388. selection.on( 'change:range', ( evt, data ) => {
  389. expect( data.directChange ).to.be.false;
  390. } );
  391. model.applyOperation( wrapInDelta(
  392. new MoveOperation(
  393. new Position( root, [ 1, 3 ] ),
  394. 2,
  395. new Position( root, [ 4 ] ),
  396. doc.version
  397. )
  398. ) );
  399. const range = selection.getFirstRange();
  400. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  401. expect( range.end.path ).to.deep.equal( [ 5 ] );
  402. expect( spyRange.calledOnce ).to.be.true;
  403. } );
  404. it( 'split inside selection (do not break selection)', () => {
  405. selection.on( 'change:range', ( evt, data ) => {
  406. expect( data.directChange ).to.be.false;
  407. } );
  408. const batch = new Batch();
  409. const splitDelta = new SplitDelta();
  410. const insertOperation = new InsertOperation(
  411. new Position( root, [ 2 ] ),
  412. new Element( 'p' ),
  413. 0
  414. );
  415. const moveOperation = new MoveOperation(
  416. new Position( root, [ 1, 2 ] ),
  417. 4,
  418. new Position( root, [ 2, 0 ] ),
  419. 1
  420. );
  421. batch.addDelta( splitDelta );
  422. splitDelta.addOperation( insertOperation );
  423. splitDelta.addOperation( moveOperation );
  424. model.applyOperation( insertOperation );
  425. model.applyOperation( moveOperation );
  426. const range = selection.getFirstRange();
  427. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  428. expect( range.end.path ).to.deep.equal( [ 2, 2 ] );
  429. expect( spyRange.calledOnce ).to.be.true;
  430. } );
  431. } );
  432. describe( 'AttributeOperation', () => {
  433. it( 'changed range includes selection anchor', () => {
  434. const spyAttribute = sinon.spy();
  435. selection.on( 'change:attribute', spyAttribute );
  436. selection.on( 'change:attribute', ( evt, data ) => {
  437. expect( data.directChange ).to.be.false;
  438. expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] );
  439. } );
  440. model.applyOperation( wrapInDelta(
  441. new AttributeOperation(
  442. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  443. 'foo',
  444. null,
  445. 'bar',
  446. doc.version
  447. )
  448. ) );
  449. expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
  450. expect( spyAttribute.calledOnce ).to.be.true;
  451. } );
  452. it( 'should not overwrite previously set attributes', () => {
  453. selection._setAttribute( 'foo', 'xyz' );
  454. const spyAttribute = sinon.spy();
  455. selection.on( 'change:attribute', spyAttribute );
  456. model.applyOperation( wrapInDelta(
  457. new AttributeOperation(
  458. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  459. 'foo',
  460. null,
  461. 'bar',
  462. doc.version
  463. )
  464. ) );
  465. expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' );
  466. expect( spyAttribute.called ).to.be.false;
  467. } );
  468. it( 'should not overwrite previously removed attributes', () => {
  469. selection._setAttribute( 'foo', 'xyz' );
  470. selection._removeAttribute( 'foo' );
  471. const spyAttribute = sinon.spy();
  472. selection.on( 'change:attribute', spyAttribute );
  473. model.applyOperation( wrapInDelta(
  474. new AttributeOperation(
  475. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  476. 'foo',
  477. null,
  478. 'bar',
  479. doc.version
  480. )
  481. ) );
  482. expect( selection.hasAttribute( 'foo' ) ).to.be.false;
  483. expect( spyAttribute.called ).to.be.false;
  484. } );
  485. } );
  486. describe( 'RemoveOperation', () => {
  487. it( 'fix selection range if it ends up in graveyard #1', () => {
  488. selection._setTo( new Position( root, [ 1, 3 ] ) );
  489. model.applyOperation( wrapInDelta(
  490. new RemoveOperation(
  491. new Position( root, [ 1, 2 ] ),
  492. 2,
  493. new Position( doc.graveyard, [ 0 ] ),
  494. doc.version
  495. )
  496. ) );
  497. expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
  498. } );
  499. it( 'fix selection range if it ends up in graveyard #2', () => {
  500. selection._setTo( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] );
  501. model.applyOperation( wrapInDelta(
  502. new RemoveOperation(
  503. new Position( root, [ 1, 2 ] ),
  504. 2,
  505. new Position( doc.graveyard, [ 0 ] ),
  506. doc.version
  507. )
  508. ) );
  509. expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
  510. } );
  511. it( 'fix selection range if it ends up in graveyard #3', () => {
  512. selection._setTo( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] );
  513. model.applyOperation( wrapInDelta(
  514. new RemoveOperation(
  515. new Position( root, [ 1 ] ),
  516. 2,
  517. new Position( doc.graveyard, [ 0 ] ),
  518. doc.version
  519. )
  520. ) );
  521. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 6 ] );
  522. } );
  523. it( 'fix selection range if it ends up in graveyard #4 - whole content removed', () => {
  524. model.applyOperation( wrapInDelta(
  525. new RemoveOperation(
  526. new Position( root, [ 0 ] ),
  527. 3,
  528. new Position( doc.graveyard, [ 0 ] ),
  529. doc.version
  530. )
  531. ) );
  532. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] );
  533. model.applyOperation( wrapInDelta(
  534. new InsertOperation(
  535. new Position( root, [ 0 ] ),
  536. new Element( 'p' ),
  537. doc.version
  538. )
  539. ) );
  540. // Now it's clear that it's the default range.
  541. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] );
  542. } );
  543. } );
  544. } );
  545. describe( 'attributes', () => {
  546. let fullP, emptyP, rangeInFullP, rangeInEmptyP;
  547. beforeEach( () => {
  548. root.removeChildren( 0, root.childCount );
  549. root.appendChildren( [
  550. new Element( 'p', [], new Text( 'foobar' ) ),
  551. new Element( 'p', [], [] )
  552. ] );
  553. fullP = root.getChild( 0 );
  554. emptyP = root.getChild( 1 );
  555. rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) );
  556. rangeInEmptyP = new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) );
  557. // I've lost 30 mins debugging why my tests fail and that was due to the above code reusing
  558. // a root which wasn't empty (so the ranges didn't actualy make much sense).
  559. expect( root.childCount ).to.equal( 2 );
  560. } );
  561. describe( '_setAttribute()', () => {
  562. it( 'should set attribute', () => {
  563. selection._setTo( [ rangeInEmptyP ] );
  564. selection._setAttribute( 'foo', 'bar' );
  565. expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
  566. } );
  567. } );
  568. describe( 'removeAttribute()', () => {
  569. it( 'should remove attribute set on the text fragment', () => {
  570. selection._setTo( [ rangeInFullP ] );
  571. selection._setAttribute( 'foo', 'bar' );
  572. selection._removeAttribute( 'foo' );
  573. expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
  574. } );
  575. } );
  576. describe( 'clearAttributes()', () => {
  577. it( 'should remove all stored attributes if the selection is in empty node', () => {
  578. selection._setTo( [ rangeInEmptyP ] );
  579. selection._setAttribute( 'foo', 'bar' );
  580. selection._setAttribute( 'abc', 'xyz' );
  581. selection._clearAttributes();
  582. expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
  583. expect( selection.getAttribute( 'abc' ) ).to.be.undefined;
  584. // TODO
  585. // expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  586. // expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  587. } );
  588. } );
  589. describe( '_getStoredAttributes()', () => {
  590. it( 'should return no values if there are no ranges in selection', () => {
  591. const values = Array.from( selection._getStoredAttributes() );
  592. expect( values ).to.deep.equal( [] );
  593. } );
  594. } );
  595. describe( 'are updated on a direct range change', () => {
  596. beforeEach( () => {
  597. root.insertChildren( 0, [
  598. new Element( 'p', { p: true } ),
  599. new Text( 'a', { a: true } ),
  600. new Element( 'p', { p: true } ),
  601. new Text( 'b', { b: true } ),
  602. new Text( 'c', { c: true } ),
  603. new Element( 'p', [], [
  604. new Text( 'd', { d: true } )
  605. ] ),
  606. new Element( 'p', { p: true } ),
  607. new Text( 'e', { e: true } )
  608. ] );
  609. } );
  610. it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => {
  611. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  612. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  613. // Step into elements when looking for first character:
  614. selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] );
  615. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  616. } );
  617. it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => {
  618. // Take styles from character before selection.
  619. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] );
  620. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  621. // If there are none,
  622. // Take styles from character after selection.
  623. selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] );
  624. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  625. // If there are none,
  626. // Look from the selection position to the beginning of node looking for character to take attributes from.
  627. selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] );
  628. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] );
  629. // If there are none,
  630. // Look from the selection position to the end of node looking for character to take attributes from.
  631. selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] );
  632. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  633. // If there are no characters to copy attributes from, use stored attributes.
  634. selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] );
  635. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] );
  636. } );
  637. it( 'should overwrite any previously set attributes', () => {
  638. selection._setTo( new Position( root, [ 5, 0 ] ) );
  639. selection._setAttribute( 'x', true );
  640. selection._setAttribute( 'y', true );
  641. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] );
  642. selection._setTo( new Position( root, [ 1 ] ) );
  643. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  644. } );
  645. it( 'should fire change:attribute event', () => {
  646. const spy = sinon.spy();
  647. selection.on( 'change:attribute', spy );
  648. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  649. expect( spy.calledOnce ).to.be.true;
  650. } );
  651. it( 'should not fire change:attribute event if attributes did not change', () => {
  652. selection._setTo( new Position( root, [ 5, 0 ] ) );
  653. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  654. const spy = sinon.spy();
  655. selection.on( 'change:attribute', spy );
  656. selection._setTo( new Position( root, [ 5, 1 ] ) );
  657. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  658. expect( spy.called ).to.be.false;
  659. } );
  660. } );
  661. // #986
  662. describe( 'are not inherited from the inside of object elements', () => {
  663. beforeEach( () => {
  664. model.schema.register( 'image', {
  665. isObject: true
  666. } );
  667. model.schema.extend( 'image', { allowIn: '$root' } );
  668. model.schema.extend( 'image', { allowIn: '$block' } );
  669. model.schema.register( 'caption' );
  670. model.schema.extend( 'caption', { allowIn: 'image' } );
  671. model.schema.extend( '$text', {
  672. allowIn: [ 'image', 'caption' ],
  673. allowAttributes: 'bold'
  674. } );
  675. } );
  676. it( 'ignores attributes inside an object if selection contains that object', () => {
  677. setData( model, '<p>[<image><$text bold="true">Caption for the image.</$text></image>]</p>' );
  678. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  679. } );
  680. it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => {
  681. setData( model, '<p>[<image><caption><$text bold="true">Caption for the image.</$text></caption></image>]</p>' );
  682. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  683. } );
  684. it( 'ignores attributes inside an object if selection contains that object (block level)', () => {
  685. setData( model, '<p>foo</p>[<image><$text bold="true">Caption for the image.</$text></image>]<p>foo</p>' );
  686. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  687. } );
  688. it( 'reads attributes from text even if the selection contains an object', () => {
  689. setData( model, '<p>x<$text bold="true">[bar</$text><image></image>foo]</p>' );
  690. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  691. } );
  692. it( 'reads attributes when the entire selection inside an object', () => {
  693. setData( model, '<p><image><caption><$text bold="true">[bar]</$text></caption></image></p>' );
  694. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  695. } );
  696. it( 'stops reading attributes if selection starts with an object', () => {
  697. setData( model, '<p>[<image></image><$text bold="true">bar]</$text></p>' );
  698. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  699. } );
  700. } );
  701. describe( 'parent element\'s attributes', () => {
  702. it( 'are set using a normal batch', () => {
  703. const batchTypes = [];
  704. model.on( 'applyOperation', ( event, args ) => {
  705. const operation = args[ 0 ];
  706. const batch = operation.delta.batch;
  707. batchTypes.push( batch.type );
  708. } );
  709. selection._setTo( [ rangeInEmptyP ] );
  710. model.change( writer => {
  711. writer.setSelectionAttribute( 'foo', 'bar' );
  712. } );
  713. expect( batchTypes ).to.deep.equal( [ 'default' ] );
  714. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  715. } );
  716. it( 'are removed when any content is inserted (reuses the same batch)', () => {
  717. // Dedupe batches by using a map (multiple change events will be fired).
  718. const batchTypes = new Map();
  719. selection._setTo( rangeInEmptyP );
  720. selection._setAttribute( 'foo', 'bar' );
  721. selection._setAttribute( 'abc', 'bar' );
  722. model.on( 'applyOperation', ( event, args ) => {
  723. const operation = args[ 0 ];
  724. const batch = operation.delta.batch;
  725. batchTypes.set( batch, batch.type );
  726. } );
  727. model.change( writer => {
  728. writer.insertText( 'x', rangeInEmptyP.start );
  729. } );
  730. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  731. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  732. expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] );
  733. } );
  734. it( 'are removed when any content is moved into', () => {
  735. selection._setTo( rangeInEmptyP );
  736. selection._setAttribute( 'foo', 'bar' );
  737. model.change( writer => {
  738. writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start );
  739. } );
  740. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  741. } );
  742. it( 'are removed when containing element is merged with a non-empty element', () => {
  743. const emptyP2 = new Element( 'p', null, 'x' );
  744. root.appendChildren( emptyP2 );
  745. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  746. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  747. model.change( writer => {
  748. // <emptyP>{}<emptyP2>
  749. writer.merge( Position.createAfter( emptyP ) );
  750. } );
  751. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  752. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  753. } );
  754. it( 'are removed even when there is no selection in it', () => {
  755. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  756. selection._setTo( [ rangeInFullP ] );
  757. model.change( writer => {
  758. writer.insertText( 'x', rangeInEmptyP.start );
  759. } );
  760. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  761. } );
  762. it( 'are removed only once in case of multi-op deltas', () => {
  763. let batch;
  764. const emptyP2 = new Element( 'p', null, 'x' );
  765. root.appendChildren( emptyP2 );
  766. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  767. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  768. model.change( writer => {
  769. batch = writer.batch;
  770. // <emptyP>{}<emptyP2>
  771. writer.merge( Position.createAfter( emptyP ) );
  772. } );
  773. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  774. // Attribute delta is only one.
  775. expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] );
  776. } );
  777. it( 'uses model change to clear attributes', () => {
  778. selection._setTo( [ rangeInEmptyP ] );
  779. model.change( writer => {
  780. writer.setSelectionAttribute( 'foo', 'bar' );
  781. writer.insertText( 'x', rangeInEmptyP.start );
  782. // `emptyP` still has the attribute, because attribute clearing is in enqueued block.
  783. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  784. } );
  785. // When the dust settles, `emptyP` should not have the attribute.
  786. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  787. } );
  788. it( 'are not removed or merged when containing element is merged with another empty element', () => {
  789. const emptyP2 = new Element( 'p', null );
  790. root.appendChildren( emptyP2 );
  791. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  792. emptyP2.setAttribute( abcStoreAttrKey, 'bar' );
  793. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  794. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  795. model.change( writer => {
  796. // <emptyP>{}<emptyP2>
  797. writer.merge( Position.createAfter( emptyP ) );
  798. } );
  799. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  800. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  801. } );
  802. // Rename and some other deltas don't specify range in doc#change event.
  803. // So let's see if there's no crash or something.
  804. it( 'are not removed on rename', () => {
  805. model.change( writer => {
  806. writer.setSelection( rangeInEmptyP );
  807. writer.setSelectionAttribute( 'foo', 'bar' );
  808. } );
  809. sinon.spy( model, 'enqueueChange' );
  810. model.change( writer => {
  811. writer.rename( emptyP, 'pnew' );
  812. } );
  813. expect( model.enqueueChange.called ).to.be.false;
  814. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  815. } );
  816. } );
  817. } );
  818. it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
  819. root.removeChildren( 0, root.childCount );
  820. root.appendChildren( '\uD83D\uDCA9' );
  821. expect( () => {
  822. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 0, root, 1 ) );
  823. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  824. expect( () => {
  825. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 2 ) );
  826. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  827. } );
  828. it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
  829. root.removeChildren( 0, root.childCount );
  830. root.appendChildren( 'foo̻̐ͩbar' );
  831. expect( () => {
  832. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 3, root, 9 ) );
  833. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  834. expect( () => {
  835. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 4, root, 9 ) );
  836. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  837. expect( () => {
  838. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 5, root, 9 ) );
  839. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  840. expect( () => {
  841. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 3 ) );
  842. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  843. expect( () => {
  844. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 4 ) );
  845. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  846. expect( () => {
  847. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 5 ) );
  848. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  849. } );
  850. } );