documentselection.js 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162
  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 - remove all ranges', () => {
  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. describe( 'setTo()', () => {
  233. it( 'should throw an error when range is invalid', () => {
  234. expect( () => {
  235. selection._setTo( [ { invalid: 'range' } ] );
  236. } ).to.throw( CKEditorError, /model-selection-added-not-range/ );
  237. } );
  238. it( 'should log a warning when trying to set selection to the graveyard', () => {
  239. // eslint-disable-next-line no-undef
  240. const warnStub = sinon.stub( console, 'warn' );
  241. const range = new Range( new Position( model.document.graveyard, [ 0 ] ) );
  242. selection._setTo( range );
  243. expect( warnStub.calledOnce ).to.equal( true );
  244. expect( warnStub.getCall( 0 ).args[ 0 ] ).to.match( /model-selection-range-in-graveyard/ );
  245. expect( selection._ranges ).to.deep.equal( [] );
  246. warnStub.restore();
  247. } );
  248. it( 'should detach removed ranges', () => {
  249. selection._setTo( [ liveRange, range ] );
  250. const oldRanges = Array.from( selection._selection._ranges );
  251. sinon.spy( oldRanges[ 0 ], 'detach' );
  252. sinon.spy( oldRanges[ 1 ], 'detach' );
  253. selection._setTo( [] );
  254. expect( oldRanges[ 0 ].detach.called ).to.be.true;
  255. expect( oldRanges[ 1 ].detach.called ).to.be.true;
  256. } );
  257. it( 'should refresh attributes', () => {
  258. const spy = sinon.spy( selection._selection, '_updateAttributes' );
  259. selection._setTo( [ range ] );
  260. expect( spy.called ).to.be.true;
  261. } );
  262. // See #630.
  263. it( 'should refresh attributes – integration test for #630', () => {
  264. model.schema.extend( '$text', { allowIn: '$root' } );
  265. setData( model, 'f<$text italic="true">[o</$text><$text bold="true">ob]a</$text>r' );
  266. selection._setTo( [ Range.createFromPositionAndShift( selection.getLastRange().end, 0 ) ] );
  267. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  268. expect( selection.hasAttribute( 'italic' ) ).to.equal( false );
  269. expect( getData( model ) )
  270. .to.equal( 'f<$text italic="true">o</$text><$text bold="true">ob[]a</$text>r' );
  271. } );
  272. } );
  273. describe( 'getFirstRange()', () => {
  274. it( 'should return default range if no ranges were added', () => {
  275. const firstRange = selection.getFirstRange();
  276. expect( firstRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
  277. expect( firstRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
  278. } );
  279. } );
  280. describe( 'getLastRange()', () => {
  281. it( 'should return default range if no ranges were added', () => {
  282. const lastRange = selection.getLastRange();
  283. expect( lastRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
  284. expect( lastRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
  285. } );
  286. } );
  287. describe( '_isStoreAttributeKey', () => {
  288. it( 'should return true if given key is a key of an attribute stored in element by DocumentSelection', () => {
  289. expect( DocumentSelection._isStoreAttributeKey( fooStoreAttrKey ) ).to.be.true;
  290. } );
  291. it( 'should return false if given key is not a key of an attribute stored in element by DocumentSelection', () => {
  292. expect( DocumentSelection._isStoreAttributeKey( 'foo' ) ).to.be.false;
  293. } );
  294. } );
  295. describe( 'getSelectedElement()', () => {
  296. it( 'should return selected element', () => {
  297. selection._setTo( liveRange );
  298. const p = root.getChild( 0 );
  299. expect( selection.getSelectedElement() ).to.equal( p );
  300. } );
  301. } );
  302. // DocumentSelection uses LiveRanges so here are only simple test to see if integration is
  303. // working well, without getting into complicated corner cases.
  304. describe( 'after applying an operation should get updated and fire events', () => {
  305. let spyRange;
  306. beforeEach( () => {
  307. root.removeChildren( 0, root.childCount );
  308. root.insertChildren( 0, [
  309. new Element( 'p', [], new Text( 'abcdef' ) ),
  310. new Element( 'p', [], new Text( 'foobar' ) ),
  311. new Text( 'xyz' )
  312. ] );
  313. selection._setTo( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 4 ] ) ) );
  314. spyRange = sinon.spy();
  315. selection.on( 'change:range', spyRange );
  316. } );
  317. describe( 'InsertOperation', () => {
  318. it( 'before 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, [ 0, 1 ] ),
  325. 'xyz',
  326. doc.version
  327. )
  328. ) );
  329. const range = selection.getFirstRange();
  330. expect( range.start.path ).to.deep.equal( [ 0, 5 ] );
  331. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  332. expect( spyRange.calledOnce ).to.be.true;
  333. } );
  334. it( 'inside selection', () => {
  335. selection.on( 'change:range', ( evt, data ) => {
  336. expect( data.directChange ).to.be.false;
  337. } );
  338. model.applyOperation( wrapInDelta(
  339. new InsertOperation(
  340. new Position( root, [ 1, 0 ] ),
  341. 'xyz',
  342. doc.version
  343. )
  344. ) );
  345. const range = selection.getFirstRange();
  346. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  347. expect( range.end.path ).to.deep.equal( [ 1, 7 ] );
  348. expect( spyRange.calledOnce ).to.be.true;
  349. } );
  350. } );
  351. describe( 'MoveOperation', () => {
  352. it( 'move range from before a selection', () => {
  353. selection.on( 'change:range', ( evt, data ) => {
  354. expect( data.directChange ).to.be.false;
  355. } );
  356. model.applyOperation( wrapInDelta(
  357. new MoveOperation(
  358. new Position( root, [ 0, 0 ] ),
  359. 2,
  360. new Position( root, [ 2 ] ),
  361. doc.version
  362. )
  363. ) );
  364. const range = selection.getFirstRange();
  365. expect( range.start.path ).to.deep.equal( [ 0, 0 ] );
  366. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  367. expect( spyRange.calledOnce ).to.be.true;
  368. } );
  369. it( 'moved into before a selection', () => {
  370. selection.on( 'change:range', ( evt, data ) => {
  371. expect( data.directChange ).to.be.false;
  372. } );
  373. model.applyOperation( wrapInDelta(
  374. new MoveOperation(
  375. new Position( root, [ 2 ] ),
  376. 2,
  377. new Position( root, [ 0, 0 ] ),
  378. doc.version
  379. )
  380. ) );
  381. const range = selection.getFirstRange();
  382. expect( range.start.path ).to.deep.equal( [ 0, 4 ] );
  383. expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
  384. expect( spyRange.calledOnce ).to.be.true;
  385. } );
  386. it( 'move range from inside of selection', () => {
  387. selection.on( 'change:range', ( evt, data ) => {
  388. expect( data.directChange ).to.be.false;
  389. } );
  390. model.applyOperation( wrapInDelta(
  391. new MoveOperation(
  392. new Position( root, [ 1, 0 ] ),
  393. 2,
  394. new Position( root, [ 2 ] ),
  395. doc.version
  396. )
  397. ) );
  398. const range = selection.getFirstRange();
  399. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  400. expect( range.end.path ).to.deep.equal( [ 1, 2 ] );
  401. expect( spyRange.calledOnce ).to.be.true;
  402. } );
  403. it( 'moved range intersects with selection', () => {
  404. selection.on( 'change:range', ( evt, data ) => {
  405. expect( data.directChange ).to.be.false;
  406. } );
  407. model.applyOperation( wrapInDelta(
  408. new MoveOperation(
  409. new Position( root, [ 1, 3 ] ),
  410. 2,
  411. new Position( root, [ 4 ] ),
  412. doc.version
  413. )
  414. ) );
  415. const range = selection.getFirstRange();
  416. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  417. expect( range.end.path ).to.deep.equal( [ 5 ] );
  418. expect( spyRange.calledOnce ).to.be.true;
  419. } );
  420. it( 'split inside selection (do not break selection)', () => {
  421. selection.on( 'change:range', ( evt, data ) => {
  422. expect( data.directChange ).to.be.false;
  423. } );
  424. const batch = new Batch();
  425. const splitDelta = new SplitDelta();
  426. const insertOperation = new InsertOperation(
  427. new Position( root, [ 2 ] ),
  428. new Element( 'p' ),
  429. 0
  430. );
  431. const moveOperation = new MoveOperation(
  432. new Position( root, [ 1, 2 ] ),
  433. 4,
  434. new Position( root, [ 2, 0 ] ),
  435. 1
  436. );
  437. batch.addDelta( splitDelta );
  438. splitDelta.addOperation( insertOperation );
  439. splitDelta.addOperation( moveOperation );
  440. model.applyOperation( insertOperation );
  441. model.applyOperation( moveOperation );
  442. const range = selection.getFirstRange();
  443. expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
  444. expect( range.end.path ).to.deep.equal( [ 2, 2 ] );
  445. expect( spyRange.calledOnce ).to.be.true;
  446. } );
  447. } );
  448. describe( 'AttributeOperation', () => {
  449. it( 'changed range includes selection anchor', () => {
  450. const spyAttribute = sinon.spy();
  451. selection.on( 'change:attribute', spyAttribute );
  452. selection.on( 'change:attribute', ( evt, data ) => {
  453. expect( data.directChange ).to.be.false;
  454. expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] );
  455. } );
  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( 'bar' );
  466. expect( spyAttribute.calledOnce ).to.be.true;
  467. } );
  468. it( 'should not overwrite previously set attributes', () => {
  469. selection._setAttribute( 'foo', 'xyz' );
  470. const spyAttribute = sinon.spy();
  471. selection.on( 'change:attribute', spyAttribute );
  472. model.applyOperation( wrapInDelta(
  473. new AttributeOperation(
  474. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  475. 'foo',
  476. null,
  477. 'bar',
  478. doc.version
  479. )
  480. ) );
  481. expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' );
  482. expect( spyAttribute.called ).to.be.false;
  483. } );
  484. it( 'should not overwrite previously set attributes with same values', () => {
  485. selection._setAttribute( 'foo', 'xyz' );
  486. const spyAttribute = sinon.spy();
  487. selection.on( 'change:attribute', spyAttribute );
  488. model.applyOperation( wrapInDelta(
  489. new AttributeOperation(
  490. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  491. 'foo',
  492. null,
  493. 'xyz',
  494. doc.version
  495. )
  496. ) );
  497. expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' );
  498. expect( spyAttribute.called ).to.be.false;
  499. } );
  500. it( 'should not overwrite previously removed attributes', () => {
  501. selection._setAttribute( 'foo', 'xyz' );
  502. selection._removeAttribute( 'foo' );
  503. const spyAttribute = sinon.spy();
  504. selection.on( 'change:attribute', spyAttribute );
  505. model.applyOperation( wrapInDelta(
  506. new AttributeOperation(
  507. new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
  508. 'foo',
  509. null,
  510. 'bar',
  511. doc.version
  512. )
  513. ) );
  514. expect( selection.hasAttribute( 'foo' ) ).to.be.false;
  515. expect( spyAttribute.called ).to.be.false;
  516. } );
  517. } );
  518. describe( 'RemoveOperation', () => {
  519. it( 'fix selection range if it ends up in graveyard #1', () => {
  520. selection._setTo( new Position( root, [ 1, 3 ] ) );
  521. model.applyOperation( wrapInDelta(
  522. new RemoveOperation(
  523. new Position( root, [ 1, 2 ] ),
  524. 2,
  525. new Position( doc.graveyard, [ 0 ] ),
  526. doc.version
  527. )
  528. ) );
  529. expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
  530. } );
  531. it( 'fix selection range if it ends up in graveyard #2', () => {
  532. selection._setTo( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] );
  533. model.applyOperation( wrapInDelta(
  534. new RemoveOperation(
  535. new Position( root, [ 1, 2 ] ),
  536. 2,
  537. new Position( doc.graveyard, [ 0 ] ),
  538. doc.version
  539. )
  540. ) );
  541. expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
  542. } );
  543. it( 'fix selection range if it ends up in graveyard #3', () => {
  544. selection._setTo( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] );
  545. model.applyOperation( wrapInDelta(
  546. new RemoveOperation(
  547. new Position( root, [ 1 ] ),
  548. 2,
  549. new Position( doc.graveyard, [ 0 ] ),
  550. doc.version
  551. )
  552. ) );
  553. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 6 ] );
  554. } );
  555. it( 'fix selection range if it ends up in graveyard #4 - whole content removed', () => {
  556. model.applyOperation( wrapInDelta(
  557. new RemoveOperation(
  558. new Position( root, [ 0 ] ),
  559. 3,
  560. new Position( doc.graveyard, [ 0 ] ),
  561. doc.version
  562. )
  563. ) );
  564. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] );
  565. model.applyOperation( wrapInDelta(
  566. new InsertOperation(
  567. new Position( root, [ 0 ] ),
  568. new Element( 'p' ),
  569. doc.version
  570. )
  571. ) );
  572. // Now it's clear that it's the default range.
  573. expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] );
  574. } );
  575. } );
  576. it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => {
  577. root.removeChildren( 0, root.childCount );
  578. root.insertChildren( 0, [
  579. new Element( 'p', [], new Text( 'abcdef' ) ),
  580. new Element( 'p', [], new Text( 'foobar' ) ),
  581. new Text( 'xyz #2' )
  582. ] );
  583. selection._setTo( [
  584. Range.createIn( root.getNodeByPath( [ 0 ] ) ),
  585. Range.createIn( root.getNodeByPath( [ 1 ] ) )
  586. ] );
  587. spyRange = sinon.spy();
  588. selection.on( 'change:range', spyRange );
  589. model.applyOperation( wrapInDelta(
  590. new InsertOperation(
  591. new Position( root, [ 0 ] ),
  592. 'xyz #1',
  593. doc.version
  594. )
  595. ) );
  596. expect( spyRange.calledOnce ).to.be.true;
  597. } );
  598. } );
  599. describe( 'attributes', () => {
  600. let fullP, emptyP, rangeInFullP, rangeInEmptyP;
  601. beforeEach( () => {
  602. root.removeChildren( 0, root.childCount );
  603. root.appendChildren( [
  604. new Element( 'p', [], new Text( 'foobar' ) ),
  605. new Element( 'p', [], [] )
  606. ] );
  607. fullP = root.getChild( 0 );
  608. emptyP = root.getChild( 1 );
  609. rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) );
  610. rangeInEmptyP = new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) );
  611. // I've lost 30 mins debugging why my tests fail and that was due to the above code reusing
  612. // a root which wasn't empty (so the ranges didn't actually make much sense).
  613. expect( root.childCount ).to.equal( 2 );
  614. } );
  615. describe( '_setAttribute()', () => {
  616. it( 'should set attribute', () => {
  617. selection._setTo( [ rangeInEmptyP ] );
  618. selection._setAttribute( 'foo', 'bar' );
  619. expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
  620. } );
  621. } );
  622. describe( 'removeAttribute()', () => {
  623. it( 'should remove attribute set on the text fragment', () => {
  624. selection._setTo( [ rangeInFullP ] );
  625. selection._setAttribute( 'foo', 'bar' );
  626. selection._removeAttribute( 'foo' );
  627. expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
  628. } );
  629. } );
  630. describe( '_getStoredAttributes()', () => {
  631. it( 'should return no values if there are no ranges in selection', () => {
  632. const values = Array.from( selection._getStoredAttributes() );
  633. expect( values ).to.deep.equal( [] );
  634. } );
  635. } );
  636. describe( 'are updated on a direct range change', () => {
  637. beforeEach( () => {
  638. root.insertChildren( 0, [
  639. new Element( 'p', { p: true } ),
  640. new Text( 'a', { a: true } ),
  641. new Element( 'p', { p: true } ),
  642. new Text( 'b', { b: true } ),
  643. new Text( 'c', { c: true } ),
  644. new Element( 'p', [], [
  645. new Text( 'd', { d: true } )
  646. ] ),
  647. new Element( 'p', { p: true } ),
  648. new Text( 'e', { e: true } )
  649. ] );
  650. } );
  651. it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => {
  652. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  653. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  654. // Step into elements when looking for first character:
  655. selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] );
  656. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  657. } );
  658. it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => {
  659. // Take styles from character before selection.
  660. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] );
  661. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  662. // If there are none,
  663. // Take styles from character after selection.
  664. selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] );
  665. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
  666. // If there are none,
  667. // Look from the selection position to the beginning of node looking for character to take attributes from.
  668. selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] );
  669. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] );
  670. // If there are none,
  671. // Look from the selection position to the end of node looking for character to take attributes from.
  672. selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] );
  673. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  674. // If there are no characters to copy attributes from, use stored attributes.
  675. selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] );
  676. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] );
  677. } );
  678. it( 'should overwrite any previously set attributes', () => {
  679. selection._setTo( new Position( root, [ 5, 0 ] ) );
  680. selection._setAttribute( 'x', true );
  681. selection._setAttribute( 'y', true );
  682. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] );
  683. selection._setTo( new Position( root, [ 1 ] ) );
  684. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
  685. } );
  686. it( 'should fire change:attribute event', () => {
  687. const spy = sinon.spy();
  688. selection.on( 'change:attribute', spy );
  689. selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
  690. expect( spy.calledOnce ).to.be.true;
  691. } );
  692. it( 'should not fire change:attribute event if attributes did not change', () => {
  693. selection._setTo( new Position( root, [ 5, 0 ] ) );
  694. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  695. const spy = sinon.spy();
  696. selection.on( 'change:attribute', spy );
  697. selection._setTo( new Position( root, [ 5, 1 ] ) );
  698. expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
  699. expect( spy.called ).to.be.false;
  700. } );
  701. } );
  702. // #986
  703. describe( 'are not inherited from the inside of object elements', () => {
  704. beforeEach( () => {
  705. model.schema.register( 'image', {
  706. isObject: true
  707. } );
  708. model.schema.extend( 'image', { allowIn: '$root' } );
  709. model.schema.extend( 'image', { allowIn: '$block' } );
  710. model.schema.register( 'caption' );
  711. model.schema.extend( 'caption', { allowIn: 'image' } );
  712. model.schema.extend( '$text', {
  713. allowIn: [ 'image', 'caption' ],
  714. allowAttributes: 'bold'
  715. } );
  716. } );
  717. it( 'ignores attributes inside an object if selection contains that object', () => {
  718. setData( model, '<p>[<image><$text bold="true">Caption for the image.</$text></image>]</p>' );
  719. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  720. } );
  721. it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => {
  722. setData( model, '<p>[<image><caption><$text bold="true">Caption for the image.</$text></caption></image>]</p>' );
  723. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  724. } );
  725. it( 'ignores attributes inside an object if selection contains that object (block level)', () => {
  726. setData( model, '<p>foo</p>[<image><$text bold="true">Caption for the image.</$text></image>]<p>foo</p>' );
  727. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  728. } );
  729. it( 'reads attributes from text even if the selection contains an object', () => {
  730. setData( model, '<p>x<$text bold="true">[bar</$text><image></image>foo]</p>' );
  731. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  732. } );
  733. it( 'reads attributes when the entire selection inside an object', () => {
  734. setData( model, '<p><image><caption><$text bold="true">[bar]</$text></caption></image></p>' );
  735. expect( selection.getAttribute( 'bold' ) ).to.equal( true );
  736. } );
  737. it( 'stops reading attributes if selection starts with an object', () => {
  738. setData( model, '<p>[<image></image><$text bold="true">bar]</$text></p>' );
  739. expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
  740. } );
  741. } );
  742. describe( 'parent element\'s attributes', () => {
  743. it( 'are set using a normal batch', () => {
  744. const batchTypes = [];
  745. model.on( 'applyOperation', ( event, args ) => {
  746. const operation = args[ 0 ];
  747. const batch = operation.delta.batch;
  748. batchTypes.push( batch.type );
  749. } );
  750. selection._setTo( [ rangeInEmptyP ] );
  751. model.change( writer => {
  752. writer.setSelectionAttribute( 'foo', 'bar' );
  753. } );
  754. expect( batchTypes ).to.deep.equal( [ 'default' ] );
  755. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  756. } );
  757. it( 'are removed when any content is inserted (reuses the same batch)', () => {
  758. // Dedupe batches by using a map (multiple change events will be fired).
  759. const batchTypes = new Map();
  760. selection._setTo( rangeInEmptyP );
  761. selection._setAttribute( 'foo', 'bar' );
  762. selection._setAttribute( 'abc', 'bar' );
  763. model.on( 'applyOperation', ( event, args ) => {
  764. const operation = args[ 0 ];
  765. const batch = operation.delta.batch;
  766. batchTypes.set( batch, batch.type );
  767. } );
  768. model.change( writer => {
  769. writer.insertText( 'x', rangeInEmptyP.start );
  770. } );
  771. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  772. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  773. expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] );
  774. } );
  775. it( 'are removed when any content is moved into', () => {
  776. selection._setTo( rangeInEmptyP );
  777. selection._setAttribute( 'foo', 'bar' );
  778. model.change( writer => {
  779. writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start );
  780. } );
  781. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  782. } );
  783. it( 'are removed when containing element is merged with a non-empty element', () => {
  784. const emptyP2 = new Element( 'p', null, 'x' );
  785. root.appendChildren( emptyP2 );
  786. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  787. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  788. model.change( writer => {
  789. // <emptyP>{}<emptyP2>
  790. writer.merge( Position.createAfter( emptyP ) );
  791. } );
  792. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  793. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  794. } );
  795. it( 'are removed even when there is no selection in it', () => {
  796. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  797. selection._setTo( [ rangeInFullP ] );
  798. model.change( writer => {
  799. writer.insertText( 'x', rangeInEmptyP.start );
  800. } );
  801. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  802. } );
  803. it( 'are removed only once in case of multi-op deltas', () => {
  804. let batch;
  805. const emptyP2 = new Element( 'p', null, 'x' );
  806. root.appendChildren( emptyP2 );
  807. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  808. emptyP2.setAttribute( fooStoreAttrKey, 'bar' );
  809. model.change( writer => {
  810. batch = writer.batch;
  811. // <emptyP>{}<emptyP2>
  812. writer.merge( Position.createAfter( emptyP ) );
  813. } );
  814. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  815. // Attribute delta is only one.
  816. expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] );
  817. } );
  818. it( 'uses model change to clear attributes', () => {
  819. selection._setTo( [ rangeInEmptyP ] );
  820. model.change( writer => {
  821. writer.setSelectionAttribute( 'foo', 'bar' );
  822. writer.insertText( 'x', rangeInEmptyP.start );
  823. // `emptyP` still has the attribute, because attribute clearing is in enqueued block.
  824. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  825. } );
  826. // When the dust settles, `emptyP` should not have the attribute.
  827. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
  828. } );
  829. it( 'are not removed or merged when containing element is merged with another empty element', () => {
  830. const emptyP2 = new Element( 'p', null );
  831. root.appendChildren( emptyP2 );
  832. emptyP.setAttribute( fooStoreAttrKey, 'bar' );
  833. emptyP2.setAttribute( abcStoreAttrKey, 'bar' );
  834. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
  835. expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
  836. model.change( writer => {
  837. // <emptyP>{}<emptyP2>
  838. writer.merge( Position.createAfter( emptyP ) );
  839. } );
  840. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  841. expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
  842. } );
  843. // Rename and some other deltas don't specify range in doc#change event.
  844. // So let's see if there's no crash or something.
  845. it( 'are not removed on rename', () => {
  846. model.change( writer => {
  847. writer.setSelection( rangeInEmptyP );
  848. writer.setSelectionAttribute( 'foo', 'bar' );
  849. } );
  850. sinon.spy( model, 'enqueueChange' );
  851. model.change( writer => {
  852. writer.rename( emptyP, 'pnew' );
  853. } );
  854. expect( model.enqueueChange.called ).to.be.false;
  855. expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
  856. } );
  857. } );
  858. } );
  859. it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
  860. root.removeChildren( 0, root.childCount );
  861. root.appendChildren( '\uD83D\uDCA9' );
  862. expect( () => {
  863. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 0, root, 1 ) );
  864. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  865. expect( () => {
  866. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 2 ) );
  867. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  868. } );
  869. it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
  870. root.removeChildren( 0, root.childCount );
  871. root.appendChildren( 'foo̻̐ͩbar' );
  872. expect( () => {
  873. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 3, root, 9 ) );
  874. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  875. expect( () => {
  876. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 4, root, 9 ) );
  877. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  878. expect( () => {
  879. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 5, root, 9 ) );
  880. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  881. expect( () => {
  882. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 3 ) );
  883. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  884. expect( () => {
  885. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 4 ) );
  886. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  887. expect( () => {
  888. doc.selection._setTo( Range.createFromParentsAndOffsets( root, 1, root, 5 ) );
  889. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  890. } );
  891. } );