8
0

documentselection.js 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108
  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. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  585. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  586. } );
  587. } );
  588. describe( '_getStoredAttributes()', () => {
  589. it( 'should return no values if there are no ranges in selection', () => {
  590. const values = Array.from( selection._getStoredAttributes() );
  591. expect( values ).to.deep.equal( [] );
  592. } );
  593. } );
  594. describe( 'are updated on a direct range change', () => {
  595. beforeEach( () => {
  596. root.insertChildren( 0, [
  597. new Element( 'p', { p: true } ),
  598. new Text( 'a', { a: true } ),
  599. new Element( 'p', { p: true } ),
  600. new Text( 'b', { b: true } ),
  601. new Text( 'c', { c: true } ),
  602. new Element( 'p', [], [
  603. new Text( 'd', { d: true } )
  604. ] ),
  605. new Element( 'p', { p: true } ),
  606. new Text( 'e', { e: true } )
  607. ] );
  608. } );
  609. it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => {
  610. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  611. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  612. // Step into elements when looking for first character:
  613. selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] );
  614. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  615. } );
  616. it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => {
  617. // Take styles from character before selection.
  618. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] );
  619. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  620. // If there are none,
  621. // Take styles from character after selection.
  622. selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] );
  623. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  624. // If there are none,
  625. // Look from the selection position to the beginning of node looking for character to take attributes from.
  626. selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] );
  627. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] );
  628. // If there are none,
  629. // Look from the selection position to the end of node looking for character to take attributes from.
  630. selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] );
  631. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  632. // If there are no characters to copy attributes from, use stored attributes.
  633. selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] );
  634. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] );
  635. } );
  636. it( 'should overwrite any previously set attributes', () => {
  637. selection._setTo( new Position( root, [ 5, 0 ] ) );
  638. selection._setAttribute( 'x', true );
  639. selection._setAttribute( 'y', true );
  640. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] );
  641. selection._setTo( new Position( root, [ 1 ] ) );
  642. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  643. } );
  644. it( 'should fire change:attribute event', () => {
  645. const spy = sinon.spy();
  646. selection.on( 'change:attribute', spy );
  647. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  648. expect( spy.calledOnce ).to.be.true;
  649. } );
  650. it( 'should not fire change:attribute event if attributes did not change', () => {
  651. selection._setTo( new Position( root, [ 5, 0 ] ) );
  652. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  653. const spy = sinon.spy();
  654. selection.on( 'change:attribute', spy );
  655. selection._setTo( new Position( root, [ 5, 1 ] ) );
  656. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  657. expect( spy.called ).to.be.false;
  658. } );
  659. } );
  660. // #986
  661. describe( 'are not inherited from the inside of object elements', () => {
  662. beforeEach( () => {
  663. model.schema.register( 'image', {
  664. isObject: true
  665. } );
  666. model.schema.extend( 'image', { allowIn: '$root' } );
  667. model.schema.extend( 'image', { allowIn: '$block' } );
  668. model.schema.register( 'caption' );
  669. model.schema.extend( 'caption', { allowIn: 'image' } );
  670. model.schema.extend( '$text', {
  671. allowIn: [ 'image', 'caption' ],
  672. allowAttributes: 'bold'
  673. } );
  674. } );
  675. it( 'ignores attributes inside an object if selection contains that object', () => {
  676. setData( model, '<p>[<image><$text bold="true">Caption for the image.</$text></image>]</p>' );
  677. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  678. } );
  679. it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => {
  680. setData( model, '<p>[<image><caption><$text bold="true">Caption for the image.</$text></caption></image>]</p>' );
  681. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  682. } );
  683. it( 'ignores attributes inside an object if selection contains that object (block level)', () => {
  684. setData( model, '<p>foo</p>[<image><$text bold="true">Caption for the image.</$text></image>]<p>foo</p>' );
  685. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  686. } );
  687. it( 'reads attributes from text even if the selection contains an object', () => {
  688. setData( model, '<p>x<$text bold="true">[bar</$text><image></image>foo]</p>' );
  689. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  690. } );
  691. it( 'reads attributes when the entire selection inside an object', () => {
  692. setData( model, '<p><image><caption><$text bold="true">[bar]</$text></caption></image></p>' );
  693. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  694. } );
  695. it( 'stops reading attributes if selection starts with an object', () => {
  696. setData( model, '<p>[<image></image><$text bold="true">bar]</$text></p>' );
  697. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  698. } );
  699. } );
  700. describe( 'parent element\'s attributes', () => {
  701. it( 'are set using a normal batch', () => {
  702. const batchTypes = [];
  703. model.on( 'applyOperation', ( event, args ) => {
  704. const operation = args[ 0 ];
  705. const batch = operation.delta.batch;
  706. batchTypes.push( batch.type );
  707. } );
  708. selection._setTo( [ rangeInEmptyP ] );
  709. model.change( writer => {
  710. writer.setSelectionAttribute( 'foo', 'bar' );
  711. } );
  712. expect( batchTypes ).to.deep.equal( [ 'default' ] );
  713. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  714. } );
  715. it( 'are removed when any content is inserted (reuses the same batch)', () => {
  716. // Dedupe batches by using a map (multiple change events will be fired).
  717. const batchTypes = new Map();
  718. selection._setTo( rangeInEmptyP );
  719. selection._setAttribute( 'foo', 'bar' );
  720. selection._setAttribute( 'abc', 'bar' );
  721. model.on( 'applyOperation', ( event, args ) => {
  722. const operation = args[ 0 ];
  723. const batch = operation.delta.batch;
  724. batchTypes.set( batch, batch.type );
  725. } );
  726. model.change( writer => {
  727. writer.insertText( 'x', rangeInEmptyP.start );
  728. } );
  729. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  730. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  731. expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] );
  732. } );
  733. it( 'are removed when any content is moved into', () => {
  734. selection._setTo( rangeInEmptyP );
  735. selection._setAttribute( 'foo', 'bar' );
  736. model.change( writer => {
  737. writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start );
  738. } );
  739. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  740. } );
  741. it( 'are removed when containing element is merged with a non-empty element', () => {
  742. const emptyP2 = new Element( 'p', null, 'x' );
  743. root.appendChildren( emptyP2 );
  744. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  745. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  746. model.change( writer => {
  747. // <emptyP>{}<emptyP2>
  748. writer.merge( Position.createAfter( emptyP ) );
  749. } );
  750. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  751. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  752. } );
  753. it( 'are removed even when there is no selection in it', () => {
  754. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  755. selection._setTo( [ rangeInFullP ] );
  756. model.change( writer => {
  757. writer.insertText( 'x', rangeInEmptyP.start );
  758. } );
  759. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  760. } );
  761. it( 'are removed only once in case of multi-op deltas', () => {
  762. let batch;
  763. const emptyP2 = new Element( 'p', null, 'x' );
  764. root.appendChildren( emptyP2 );
  765. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  766. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  767. model.change( writer => {
  768. batch = writer.batch;
  769. // <emptyP>{}<emptyP2>
  770. writer.merge( Position.createAfter( emptyP ) );
  771. } );
  772. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  773. // Attribute delta is only one.
  774. expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] );
  775. } );
  776. it( 'uses model change to clear attributes', () => {
  777. selection._setTo( [ rangeInEmptyP ] );
  778. model.change( writer => {
  779. writer.setSelectionAttribute( 'foo', 'bar' );
  780. writer.insertText( 'x', rangeInEmptyP.start );
  781. // `emptyP` still has the attribute, because attribute clearing is in enqueued block.
  782. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  783. } );
  784. // When the dust settles, `emptyP` should not have the attribute.
  785. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  786. } );
  787. it( 'are not removed or merged when containing element is merged with another empty element', () => {
  788. const emptyP2 = new Element( 'p', null );
  789. root.appendChildren( emptyP2 );
  790. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  791. emptyP2.setAttribute( abcStoreAttrKey, 'bar' );
  792. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  793. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  794. model.change( writer => {
  795. // <emptyP>{}<emptyP2>
  796. writer.merge( Position.createAfter( emptyP ) );
  797. } );
  798. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  799. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  800. } );
  801. // Rename and some other deltas don't specify range in doc#change event.
  802. // So let's see if there's no crash or something.
  803. it( 'are not removed on rename', () => {
  804. model.change( writer => {
  805. writer.setSelection( rangeInEmptyP );
  806. writer.setSelectionAttribute( 'foo', 'bar' );
  807. } );
  808. sinon.spy( model, 'enqueueChange' );
  809. model.change( writer => {
  810. writer.rename( emptyP, 'pnew' );
  811. } );
  812. expect( model.enqueueChange.called ).to.be.false;
  813. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  814. } );
  815. } );
  816. } );
  817. it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
  818. root.removeChildren( 0, root.childCount );
  819. root.appendChildren( '\uD83D\uDCA9' );
  820. expect( () => {
  821. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 0, root, 1 ) );
  822. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  823. expect( () => {
  824. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 2 ) );
  825. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  826. } );
  827. it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
  828. root.removeChildren( 0, root.childCount );
  829. root.appendChildren( 'foo̻̐ͩbar' );
  830. expect( () => {
  831. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 3, root, 9 ) );
  832. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  833. expect( () => {
  834. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 4, root, 9 ) );
  835. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  836. expect( () => {
  837. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 5, root, 9 ) );
  838. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  839. expect( () => {
  840. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 3 ) );
  841. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  842. expect( () => {
  843. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 4 ) );
  844. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  845. expect( () => {
  846. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 5 ) );
  847. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  848. } );
  849. } );