deletecontent.js 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import Model from '../../../src/model/model';
  6. import Position from '../../../src/model/position';
  7. import Range from '../../../src/model/range';
  8. import Selection from '../../../src/model/selection';
  9. import Element from '../../../src/model/element';
  10. import deleteContent from '../../../src/model/utils/deletecontent';
  11. import { setData, getData } from '../../../src/dev-utils/model';
  12. import { stringify } from '../../../src/dev-utils/view';
  13. describe( 'DataController utils', () => {
  14. let model, doc;
  15. describe( 'deleteContent', () => {
  16. it( 'should use parent batch', () => {
  17. model = new Model();
  18. doc = model.document;
  19. doc.createRoot();
  20. model.schema.extend( '$text', { allowIn: '$root' } );
  21. setData( model, 'x[abc]x' );
  22. model.change( writer => {
  23. deleteContent( model, doc.selection );
  24. expect( writer.batch.operations ).to.length( 1 );
  25. } );
  26. } );
  27. it( 'should not do anything if the selection is already in graveyard', () => {
  28. model = new Model();
  29. doc = model.document;
  30. const gy = model.document.graveyard;
  31. gy._appendChild( new Element( 'paragraph' ) );
  32. const baseVersion = model.document.baseVersion;
  33. model.change( writer => {
  34. sinon.spy( writer, 'remove' );
  35. const selection = writer.createSelection( writer.createRangeIn( gy ) );
  36. deleteContent( model, selection );
  37. expect( writer.remove.called ).to.be.false;
  38. } );
  39. expect( model.document.baseVersion ).to.equal( baseVersion );
  40. } );
  41. describe( 'in simple scenarios', () => {
  42. beforeEach( () => {
  43. model = new Model();
  44. doc = model.document;
  45. doc.createRoot();
  46. const schema = model.schema;
  47. schema.register( 'image', { allowWhere: '$text' } );
  48. schema.extend( '$text', { allowIn: '$root' } );
  49. } );
  50. it( 'should be able to delete content at custom selection', () => {
  51. setData( model, 'a[]bcd' );
  52. const range = new Range(
  53. new Position( doc.getRoot(), [ 2 ] ),
  54. new Position( doc.getRoot(), [ 3 ] )
  55. );
  56. const selection = new Selection( [ range ] );
  57. model.change( () => {
  58. deleteContent( model, selection );
  59. expect( getData( model ) ).to.equal( 'a[]bd' );
  60. } );
  61. } );
  62. test(
  63. 'does nothing on collapsed selection',
  64. 'f[]oo',
  65. 'f[]oo'
  66. );
  67. test(
  68. 'deletes single character',
  69. 'f[o]o',
  70. 'f[]o'
  71. );
  72. it( 'deletes single character (backward selection)', () => {
  73. setData( model, 'f[o]o', { lastRangeBackward: true } );
  74. deleteContent( model, doc.selection );
  75. expect( getData( model ) ).to.equal( 'f[]o' );
  76. } );
  77. test(
  78. 'deletes whole text',
  79. '[foo]',
  80. '[]'
  81. );
  82. test(
  83. 'deletes whole text between nodes',
  84. '<image></image>[foo]<image></image>',
  85. '<image></image>[]<image></image>'
  86. );
  87. test(
  88. 'deletes an element',
  89. 'x[<image></image>]y',
  90. 'x[]y'
  91. );
  92. test(
  93. 'deletes a bunch of nodes',
  94. 'w[x<image></image>y]z',
  95. 'w[]z'
  96. );
  97. test(
  98. 'does not break things when option.merge passed',
  99. 'w[x<image></image>y]z',
  100. 'w[]z'
  101. );
  102. } );
  103. describe( 'with text attributes', () => {
  104. beforeEach( () => {
  105. model = new Model();
  106. doc = model.document;
  107. doc.createRoot();
  108. const schema = model.schema;
  109. schema.register( 'image', { allowWhere: '$text' } );
  110. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  111. schema.extend( '$text', {
  112. allowIn: '$root',
  113. allowAttributes: [ 'bold', 'italic' ]
  114. } );
  115. } );
  116. it( 'deletes characters (first half has attrs)', () => {
  117. setData( model, '<$text bold="true">fo[o</$text>b]ar' );
  118. deleteContent( model, doc.selection );
  119. expect( getData( model ) ).to.equal( '<$text bold="true">fo[]</$text>ar' );
  120. expect( doc.selection.getAttribute( 'bold' ) ).to.equal( true );
  121. } );
  122. it( 'deletes characters (2nd half has attrs)', () => {
  123. setData( model, 'fo[o<$text bold="true">b]ar</$text>' );
  124. deleteContent( model, doc.selection );
  125. expect( getData( model ) ).to.equal( 'fo[]<$text bold="true">ar</$text>' );
  126. expect( doc.selection.getAttribute( 'bold' ) ).to.undefined;
  127. } );
  128. it( 'clears selection attrs when emptied content', () => {
  129. setData( model, '<paragraph>x</paragraph><paragraph>[<$text bold="true">foo</$text>]</paragraph><paragraph>y</paragraph>' );
  130. deleteContent( model, doc.selection );
  131. expect( getData( model ) ).to.equal( '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>y</paragraph>' );
  132. expect( doc.selection.getAttribute( 'bold' ) ).to.undefined;
  133. } );
  134. it( 'leaves selection attributes when text contains them', () => {
  135. setData(
  136. model,
  137. '<paragraph>x<$text bold="true">a[foo]b</$text>y</paragraph>',
  138. {
  139. selectionAttributes: {
  140. bold: true
  141. }
  142. }
  143. );
  144. deleteContent( model, doc.selection );
  145. expect( getData( model ) ).to.equal( '<paragraph>x<$text bold="true">a[]b</$text>y</paragraph>' );
  146. expect( doc.selection.getAttribute( 'bold' ) ).to.equal( true );
  147. } );
  148. } );
  149. // Note: The algorithm does not care what kind of it's merging as it knows nothing useful about these elements.
  150. // In most cases it handles all elements like you'd expect to handle block elements in HTML. However,
  151. // in some scenarios where the tree depth is bigger results may be hard to justify. In fact, such cases
  152. // should not happen unless we're talking about lists or tables, but these features will need to cover
  153. // their scenarios themselves. In all generic scenarios elements are never nested.
  154. //
  155. // You may also be thinking – but I don't want my elements to be merged. It means that there are some special rules,
  156. // like – multiple editing hosts (cE=true/false in use) or block limit elements like <td>.
  157. // Those case should, again, be handled by their specific implementations.
  158. describe( 'in multi-element scenarios', () => {
  159. beforeEach( () => {
  160. model = new Model();
  161. doc = model.document;
  162. doc.createRoot();
  163. const schema = model.schema;
  164. schema.register( 'paragraph', {
  165. inheritAllFrom: '$block',
  166. allowIn: 'pparent',
  167. allowAttributes: 'align'
  168. } );
  169. schema.register( 'heading1', { inheritAllFrom: '$block', allowIn: 'pparent' } );
  170. schema.register( 'image', { inheritAllFrom: '$text' } );
  171. schema.register( 'pchild', { allowIn: 'paragraph' } );
  172. schema.register( 'pparent', { allowIn: '$root' } );
  173. schema.register( 'hchild', { allowIn: 'heading1' } );
  174. schema.register( 'widget', { isObject: true, allowWhere: '$text', isInline: true } );
  175. schema.extend( '$text', { allowIn: [ 'pchild', 'pparent', 'hchild' ] } );
  176. } );
  177. test(
  178. 'do not merge when no need to',
  179. '<paragraph>x</paragraph><paragraph>[foo]</paragraph><paragraph>y</paragraph>',
  180. '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>y</paragraph>'
  181. );
  182. test(
  183. 'merges second element into the first one (same name)',
  184. '<paragraph>x</paragraph><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  185. '<paragraph>x</paragraph><paragraph>fo[]ar</paragraph><paragraph>y</paragraph>'
  186. );
  187. test(
  188. 'removes first element when it\'s empty but second element is not empty (same name)',
  189. '<paragraph>x</paragraph><paragraph>[foo</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  190. '<paragraph>x</paragraph><paragraph>[]ar</paragraph><paragraph>y</paragraph>'
  191. );
  192. test(
  193. 'does not remove first element when first element contains object (same name)',
  194. '<paragraph>x</paragraph><paragraph><widget></widget>[foo</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  195. '<paragraph>x</paragraph><paragraph><widget></widget>[]ar</paragraph><paragraph>y</paragraph>'
  196. );
  197. test(
  198. 'does not merge second element into the first one (same name, !option.merge)',
  199. '<paragraph>x</paragraph><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  200. '<paragraph>x</paragraph><paragraph>fo[]</paragraph><paragraph>ar</paragraph><paragraph>y</paragraph>',
  201. { leaveUnmerged: true }
  202. );
  203. test(
  204. 'does not remove first empty element when it\'s empty but second element is not empty (same name, !option.merge)',
  205. '<paragraph>x</paragraph><paragraph>[foo</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  206. '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>ar</paragraph><paragraph>y</paragraph>',
  207. { leaveUnmerged: true }
  208. );
  209. test(
  210. 'merges second element into the first one (different name)',
  211. '<paragraph>x</paragraph><heading1>fo[o</heading1><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  212. '<paragraph>x</paragraph><heading1>fo[]ar</heading1><paragraph>y</paragraph>'
  213. );
  214. test(
  215. 'removes first element when it\'s empty but second element is not empty (different name)',
  216. '<paragraph>x</paragraph><heading1>[foo</heading1><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  217. '<paragraph>x</paragraph><paragraph>[]ar</paragraph><paragraph>y</paragraph>'
  218. );
  219. // Note: in all these cases we ignore the direction of merge.
  220. // If https://github.com/ckeditor/ckeditor5-engine/issues/470 was fixed we could differently treat
  221. // forward and backward delete.
  222. it( 'merges second element into the first one (different name, backward selection)', () => {
  223. setData(
  224. model,
  225. '<paragraph>x</paragraph><heading1>fo[o</heading1><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  226. { lastRangeBackward: true }
  227. );
  228. deleteContent( model, doc.selection );
  229. expect( getData( model ) ).to.equal( '<paragraph>x</paragraph><heading1>fo[]ar</heading1><paragraph>y</paragraph>' );
  230. } );
  231. test(
  232. 'merges second element into the first one (different attrs)',
  233. '<paragraph>x</paragraph><paragraph align="l">fo[o</paragraph><paragraph>b]ar</paragraph><paragraph>y</paragraph>',
  234. '<paragraph>x</paragraph><paragraph align="l">fo[]ar</paragraph><paragraph>y</paragraph>'
  235. );
  236. test(
  237. 'removes empty first element',
  238. '<paragraph>x</paragraph><heading1>[</heading1><paragraph>fo]o</paragraph><paragraph>y</paragraph>',
  239. '<paragraph>x</paragraph><paragraph>[]o</paragraph><paragraph>y</paragraph>'
  240. );
  241. test(
  242. 'merges empty element into the first element',
  243. '<heading1>f[oo</heading1><paragraph>bar]</paragraph><paragraph>x</paragraph>',
  244. '<heading1>f[]</heading1><paragraph>x</paragraph>'
  245. );
  246. test(
  247. 'leaves just one element when all selected',
  248. '<paragraph>[x</paragraph><paragraph>foo</paragraph><paragraph>y]bar</paragraph>',
  249. '<paragraph>[]bar</paragraph>'
  250. );
  251. test(
  252. 'leaves just one element when all selected (different name)',
  253. '<heading1>[x</heading1><paragraph>foo</paragraph><paragraph>y]bar</paragraph>',
  254. '<paragraph>[]bar</paragraph>'
  255. );
  256. test(
  257. 'leaves just one (first) element when all selected (different name)',
  258. '<heading1>foo[x</heading1><paragraph>bar</paragraph><paragraph>y]</paragraph>',
  259. '<heading1>foo[]</heading1>'
  260. );
  261. it( 'uses merge operation even if merged element is empty', () => {
  262. let mergeSpy;
  263. setData( model, '<paragraph>ab[cd</paragraph><paragraph>efgh]</paragraph>' );
  264. model.change( writer => {
  265. mergeSpy = sinon.spy( writer, 'merge' );
  266. deleteContent( model, doc.selection );
  267. } );
  268. expect( getData( model ) ).to.equal( '<paragraph>ab[]</paragraph>' );
  269. expect( mergeSpy.called ).to.be.true;
  270. } );
  271. it( 'uses merge operation even if merged element is empty #2', () => {
  272. let mergeSpy;
  273. setData( model, '<paragraph>ab[</paragraph><paragraph>]</paragraph>' );
  274. model.change( writer => {
  275. mergeSpy = sinon.spy( writer, 'merge' );
  276. deleteContent( model, doc.selection );
  277. } );
  278. expect( getData( model ) ).to.equal( '<paragraph>ab[]</paragraph>' );
  279. expect( mergeSpy.called ).to.be.true;
  280. } );
  281. it( 'uses merge operation if first element is empty (because of content delete) and last is not', () => {
  282. let mergeSpy;
  283. setData( model, '<paragraph>[abcd</paragraph><paragraph>ef]gh</paragraph>' );
  284. model.change( writer => {
  285. mergeSpy = sinon.spy( writer, 'merge' );
  286. deleteContent( model, doc.selection );
  287. } );
  288. expect( getData( model ) ).to.equal( '<paragraph>[]gh</paragraph>' );
  289. expect( mergeSpy.called ).to.be.true;
  290. } );
  291. it( 'uses merge operation if first element is empty and last is not', () => {
  292. let mergeSpy;
  293. setData( model, '<paragraph>[</paragraph><paragraph>ef]gh</paragraph>' );
  294. model.change( writer => {
  295. mergeSpy = sinon.spy( writer, 'merge' );
  296. deleteContent( model, doc.selection );
  297. } );
  298. expect( getData( model ) ).to.equal( '<paragraph>[]gh</paragraph>' );
  299. expect( mergeSpy.called ).to.be.true;
  300. } );
  301. it( 'does not try to move the second block if not needed', () => {
  302. let mergeSpy, moveSpy;
  303. setData( model, '<paragraph>ab[cd</paragraph><paragraph>ef]gh</paragraph>' );
  304. model.change( writer => {
  305. mergeSpy = sinon.spy( writer, 'merge' );
  306. moveSpy = sinon.spy( writer, 'move' );
  307. deleteContent( model, doc.selection );
  308. } );
  309. expect( getData( model ) ).to.equal( '<paragraph>ab[]gh</paragraph>' );
  310. expect( moveSpy.called ).to.be.false;
  311. expect( mergeSpy.called ).to.be.true;
  312. } );
  313. // Note: in all these cases we ignore the direction of merge.
  314. // If https://github.com/ckeditor/ckeditor5-engine/issues/470 was fixed we could differently treat
  315. // forward and backward delete.
  316. describe( 'with nested elements', () => {
  317. test(
  318. 'merges elements when deep nested',
  319. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph><pchild>b]ar</pchild>y</paragraph>',
  320. '<paragraph>x<pchild>fo[]ar</pchild>y</paragraph>'
  321. );
  322. test(
  323. 'removes block element with nested element',
  324. '<paragraph><pchild>[foo</pchild></paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  325. '<paragraph><pchild>[]ar</pchild></paragraph>'
  326. );
  327. test(
  328. 'does not remove block element with nested element and object',
  329. '<paragraph><pchild><widget></widget>[foo</pchild></paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  330. '<paragraph><pchild><widget></widget>[]ar</pchild></paragraph>'
  331. );
  332. test(
  333. 'merges heading element',
  334. '<heading1><hchild>x[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  335. '<heading1><hchild>x[]ar</hchild></heading1>'
  336. );
  337. test(
  338. 'removes heading element',
  339. '<heading1><hchild>[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  340. '<paragraph><pchild>[]ar</pchild></paragraph>'
  341. );
  342. test(
  343. 'does not remove heading element if contains object',
  344. '<heading1><hchild><widget></widget>[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  345. '<heading1><hchild><widget></widget>[]ar</hchild></heading1>'
  346. );
  347. test(
  348. 'merges elements when left end deep nested',
  349. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph>b]ary</paragraph><paragraph>x</paragraph>',
  350. '<paragraph>x<pchild>fo[]ary</pchild></paragraph><paragraph>x</paragraph>'
  351. );
  352. test(
  353. 'removes elements when left end deep nested and will be empty',
  354. '<paragraph><pchild>[foo</pchild></paragraph><paragraph>b]ar</paragraph><paragraph>x</paragraph>',
  355. '<paragraph>[]ar</paragraph><paragraph>x</paragraph>'
  356. );
  357. test(
  358. 'merges elements when right end deep nested',
  359. '<paragraph>x</paragraph><paragraph>fo[o</paragraph><paragraph><pchild>b]ar</pchild>x</paragraph>',
  360. '<paragraph>x</paragraph><paragraph>fo[]ar</paragraph><paragraph>x</paragraph>'
  361. );
  362. test(
  363. 'removes element when right end deep nested but left end would be empty',
  364. '<paragraph>x</paragraph><paragraph>[foo</paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  365. '<paragraph>x</paragraph><paragraph><pchild>[]ar</pchild></paragraph>'
  366. );
  367. test(
  368. 'merges elements when right end deep nested (in an empty container)',
  369. '<paragraph>fo[o</paragraph><paragraph><pchild>bar]</pchild></paragraph>',
  370. '<paragraph>fo[]</paragraph>'
  371. );
  372. test(
  373. 'removes elements when left end deep nested (in an empty container)',
  374. '<paragraph><pchild>[foo</pchild></paragraph><paragraph>b]ar</paragraph><paragraph>x</paragraph>',
  375. '<paragraph>[]ar</paragraph><paragraph>x</paragraph>'
  376. );
  377. describe( 'with 3rd level of nesting', () => {
  378. test(
  379. 'merges elements when deep nested (same name)',
  380. '<pparent>x<paragraph>x<pchild>fo[o</pchild></paragraph></pparent>' +
  381. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  382. '<pparent>x<paragraph>x<pchild>fo[]ar</pchild>y</paragraph>y</pparent>'
  383. );
  384. test(
  385. 'removes elements when deep nested (same name)',
  386. '<pparent><paragraph><pchild>[foo</pchild></paragraph></pparent>' +
  387. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  388. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  389. );
  390. test(
  391. 'removes elements up to common ancestor when deep nested (same name)',
  392. '<pparent>' +
  393. '<paragraph><pchild>[foo</pchild></paragraph>' +
  394. '<paragraph><pchild>b]ar</pchild>y</paragraph>y' +
  395. '</pparent>',
  396. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  397. );
  398. test(
  399. 'merges elements when deep nested (different name)',
  400. '<pparent>x<heading1>x<hchild>fo[o</hchild></heading1></pparent>' +
  401. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  402. '<pparent>x<heading1>x<hchild>fo[]ar</hchild>y</heading1>y</pparent>'
  403. );
  404. test(
  405. 'removes elements when deep nested (different name)',
  406. '<pparent><heading1><hchild>[foo</hchild></heading1></pparent>' +
  407. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  408. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  409. );
  410. test(
  411. 'merges elements up to common ancestor when deep nested (different names)',
  412. '<pparent>' +
  413. '<heading1><hchild>fo[o</hchild></heading1>' +
  414. '<paragraph><pchild>b]ar</pchild></paragraph>' +
  415. '</pparent>',
  416. '<pparent><heading1><hchild>fo[]ar</hchild></heading1></pparent>'
  417. );
  418. test(
  419. 'removes elements up to common ancestor when deep nested (different names)',
  420. '<pparent>' +
  421. '<heading1><hchild>[foo</hchild></heading1>' +
  422. '<paragraph><pchild>b]ar</pchild>y</paragraph>y' +
  423. '</pparent>',
  424. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  425. );
  426. } );
  427. describe( 'with 3rd level of nesting o the left end', () => {
  428. test(
  429. 'merges elements',
  430. '<pparent>x<paragraph>foo<pchild>ba[r</pchild></paragraph></pparent>' +
  431. '<paragraph>b]om</paragraph>',
  432. '<pparent>x<paragraph>foo<pchild>ba[]om</pchild></paragraph></pparent>'
  433. );
  434. test(
  435. 'merges elements (different names)',
  436. '<pparent>x<heading1>foo<hchild>ba[r</hchild></heading1></pparent>' +
  437. '<paragraph>b]om</paragraph>',
  438. '<pparent>x<heading1>foo<hchild>ba[]om</hchild></heading1></pparent>'
  439. );
  440. test(
  441. 'removes elements',
  442. '<pparent><paragraph><pchild>[bar</pchild></paragraph></pparent>' +
  443. '<paragraph>b]om</paragraph>',
  444. '<paragraph>[]om</paragraph>'
  445. );
  446. test(
  447. 'removes elements up to common ancestor (different names)',
  448. '<pparent>' +
  449. '<heading1><hchild>[foo</hchild></heading1>' +
  450. '<paragraph>b]ar</paragraph>y' +
  451. '</pparent>',
  452. '<pparent><paragraph>[]ar</paragraph>y</pparent>'
  453. );
  454. } );
  455. describe( 'with 3rd level of nesting o the right end', () => {
  456. test(
  457. 'merges elements',
  458. '<paragraph>b[om</paragraph>' +
  459. '<pparent><paragraph><pchild>ba]r</pchild></paragraph></pparent>',
  460. '<paragraph>b[]r</paragraph>'
  461. );
  462. test(
  463. 'merges elements (different names)',
  464. '<paragraph>bo[m</paragraph>' +
  465. '<pparent><heading1><hchild>b]ar</hchild></heading1></pparent>',
  466. '<paragraph>bo[]ar</paragraph>'
  467. );
  468. test(
  469. 'merges elements (different names, reversed)',
  470. '<heading1>bo[m</heading1>' +
  471. '<pparent><paragraph><pchild>b]ar</pchild></paragraph></pparent>',
  472. '<heading1>bo[]ar</heading1>'
  473. );
  474. test(
  475. 'removes elements',
  476. '<paragraph>[bom</paragraph>' +
  477. '<pparent><paragraph><pchild>b]ar</pchild></paragraph></pparent>',
  478. '<pparent><paragraph><pchild>[]ar</pchild></paragraph></pparent>'
  479. );
  480. test(
  481. 'removes elements up to common ancestor (different names)',
  482. '<pparent>' +
  483. '<heading1>[bar</heading1>y' +
  484. '<paragraph><pchild>f]oo</pchild></paragraph>' +
  485. '</pparent>',
  486. '<pparent><paragraph><pchild>[]oo</pchild></paragraph></pparent>'
  487. );
  488. } );
  489. } );
  490. describe( 'with object elements', () => {
  491. beforeEach( () => {
  492. const schema = model.schema;
  493. schema.register( 'blockWidget', {
  494. isObject: true
  495. } );
  496. schema.register( 'nestedEditable', {
  497. isLimit: true
  498. } );
  499. schema.extend( 'blockWidget', { allowIn: '$root' } );
  500. schema.extend( 'nestedEditable', { allowIn: 'blockWidget' } );
  501. schema.extend( '$text', { allowIn: 'nestedEditable' } );
  502. } );
  503. test(
  504. 'does not merge an object element (if it is first)',
  505. '<blockWidget><nestedEditable>fo[o</nestedEditable></blockWidget><paragraph>b]ar</paragraph>',
  506. '<blockWidget><nestedEditable>fo[]</nestedEditable></blockWidget><paragraph>ar</paragraph>'
  507. );
  508. test(
  509. 'does not merge an object element (if it is second)',
  510. '<paragraph>ba[r</paragraph><blockWidget><nestedEditable>f]oo</nestedEditable></blockWidget>',
  511. '<paragraph>ba[]</paragraph><blockWidget><nestedEditable>oo</nestedEditable></blockWidget>'
  512. );
  513. } );
  514. describe( 'filtering out', () => {
  515. beforeEach( () => {
  516. const schema = model.schema;
  517. schema.addAttributeCheck( ( ctx, attributeName ) => {
  518. // Disallow 'c' on pchild>pchild>$text.
  519. if ( ctx.endsWith( 'pchild pchild $text' ) && attributeName == 'c' ) {
  520. return false;
  521. }
  522. // Allow 'a' and 'b' on paragraph>$text.
  523. if ( ctx.endsWith( 'paragraph $text' ) && [ 'a', 'b' ].includes( attributeName ) ) {
  524. return true;
  525. }
  526. // Allow 'b' and 'c' in pchild>$text.
  527. if ( ctx.endsWith( 'pchild $text' ) && [ 'b', 'c' ].includes( attributeName ) ) {
  528. return true;
  529. }
  530. } );
  531. schema.extend( 'pchild', { allowIn: 'pchild' } );
  532. } );
  533. test(
  534. 'filters out disallowed attributes after left merge',
  535. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph>y]<$text a="1" b="1">z</$text></paragraph>',
  536. '<paragraph>x<pchild>fo[]<$text b="1">z</$text></pchild></paragraph>'
  537. );
  538. test(
  539. 'filters out disallowed attributes from nested nodes after left merge',
  540. '<paragraph>' +
  541. 'x' +
  542. '<pchild>fo[o</pchild>' +
  543. '</paragraph>' +
  544. '<paragraph>' +
  545. 'b]a<$text a="1" b="1">r</$text>' +
  546. '<pchild>b<$text b="1" c="1">i</$text>z</pchild>' +
  547. 'y' +
  548. '</paragraph>',
  549. '<paragraph>' +
  550. 'x' +
  551. '<pchild>' +
  552. 'fo[]a<$text b="1">r</$text>' +
  553. '<pchild>b<$text b="1">i</$text>z</pchild>' +
  554. 'y' +
  555. '</pchild>' +
  556. '</paragraph>'
  557. );
  558. test(
  559. 'filters out disallowed attributes after right merge',
  560. '<paragraph>fo[o</paragraph><paragraph><pchild>x<$text b="1" c="1">y]z</$text></pchild></paragraph>',
  561. '<paragraph>fo[]<$text b="1">z</$text></paragraph>'
  562. );
  563. } );
  564. } );
  565. describe( 'in element selections scenarios', () => {
  566. beforeEach( () => {
  567. model = new Model();
  568. doc = model.document;
  569. // <p> like root.
  570. doc.createRoot( 'paragraph', 'paragraphRoot' );
  571. // <body> like root.
  572. doc.createRoot( '$root', 'bodyRoot' );
  573. // Special root which allows only blockWidgets inside itself.
  574. doc.createRoot( 'restrictedRoot', 'restrictedRoot' );
  575. const schema = model.schema;
  576. schema.register( 'image', { allowWhere: '$text' } );
  577. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  578. schema.register( 'heading1', { inheritAllFrom: '$block' } );
  579. schema.register( 'blockWidget', { isLimit: true } );
  580. schema.register( 'restrictedRoot', {
  581. isLimit: true
  582. } );
  583. schema.extend( '$block', { allowIn: '$root' } );
  584. schema.extend( 'blockWidget', { allowIn: '$root' } );
  585. schema.extend( 'blockWidget', { allowIn: 'restrictedRoot' } );
  586. } );
  587. // See also "in simple scenarios => deletes an element".
  588. it( 'deletes two inline elements', () => {
  589. model.schema.extend( 'paragraph', {
  590. isLimit: true
  591. } );
  592. setData(
  593. model,
  594. 'x[<image></image><image></image>]z',
  595. { rootName: 'paragraphRoot' }
  596. );
  597. deleteContent( model, doc.selection );
  598. expect( getData( model, { rootName: 'paragraphRoot' } ) )
  599. .to.equal( 'x[]z' );
  600. } );
  601. it( 'moves the (custom) selection to the nearest paragraph', () => {
  602. setData(
  603. model,
  604. '<paragraph>[x]</paragraph><paragraph>yyy</paragraph><paragraph>z</paragraph>',
  605. { rootName: 'bodyRoot' }
  606. );
  607. const root = doc.getRoot( 'bodyRoot' );
  608. // [<paragraph>yyy</paragraph>]
  609. const selection = new Selection( [
  610. new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) )
  611. ] );
  612. deleteContent( model, selection );
  613. expect( getData( model, { rootName: 'bodyRoot' } ) )
  614. .to.equal( '<paragraph>[x]</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  615. expect( stringify( root, selection ) )
  616. .to.equal( '<$root><paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>z</paragraph></$root>' );
  617. } );
  618. it( 'creates a paragraph when text is not allowed (block widget selected)', () => {
  619. setData(
  620. model,
  621. '<paragraph>x</paragraph>[<blockWidget></blockWidget>]<paragraph>z</paragraph>',
  622. { rootName: 'bodyRoot' }
  623. );
  624. deleteContent( model, doc.selection );
  625. expect( getData( model, { rootName: 'bodyRoot' } ) )
  626. .to.equal( '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>z</paragraph>' );
  627. } );
  628. it( 'creates paragraph when text is not allowed (heading selected)', () => {
  629. setData(
  630. model,
  631. '<paragraph>x</paragraph><heading1>yyy</heading1><paragraph>z</paragraph>',
  632. { rootName: 'bodyRoot' }
  633. );
  634. // [<heading1>yyy</heading1>]
  635. const range = new Range(
  636. new Position( doc.getRoot( 'bodyRoot' ), [ 1 ] ),
  637. new Position( doc.getRoot( 'bodyRoot' ), [ 2 ] )
  638. );
  639. deleteContent( model, new Selection( range ) );
  640. expect( getData( model, { rootName: 'bodyRoot', withoutSelection: true } ) )
  641. .to.equal( '<paragraph>x</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  642. } );
  643. it( 'creates paragraph when text is not allowed (two blocks selected)', () => {
  644. setData(
  645. model,
  646. '<paragraph>x</paragraph><heading1>yyy</heading1><paragraph>yyy</paragraph><paragraph>z</paragraph>',
  647. { rootName: 'bodyRoot' }
  648. );
  649. // [<heading1>yyy</heading1><paragraph>yyy</paragraph>]
  650. const range = new Range(
  651. new Position( doc.getRoot( 'bodyRoot' ), [ 1 ] ),
  652. new Position( doc.getRoot( 'bodyRoot' ), [ 3 ] )
  653. );
  654. deleteContent( model, new Selection( range ) );
  655. expect( getData( model, { rootName: 'bodyRoot', withoutSelection: true } ) )
  656. .to.equal( '<paragraph>x</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  657. } );
  658. it( 'creates paragraph when text is not allowed (all content selected)', () => {
  659. setData(
  660. model,
  661. '[<heading1>x</heading1><paragraph>z</paragraph>]',
  662. { rootName: 'bodyRoot' }
  663. );
  664. deleteContent( model, doc.selection );
  665. expect( getData( model, { rootName: 'bodyRoot' } ) )
  666. .to.equal( '<paragraph>[]</paragraph>' );
  667. } );
  668. it( 'does not create a paragraph when it is not allowed', () => {
  669. setData(
  670. model,
  671. '<blockWidget></blockWidget>[<blockWidget></blockWidget>]<blockWidget></blockWidget>',
  672. { rootName: 'restrictedRoot' }
  673. );
  674. deleteContent( model, doc.selection );
  675. expect( getData( model, { rootName: 'restrictedRoot' } ) )
  676. .to.equal( '<blockWidget></blockWidget>[]<blockWidget></blockWidget>' );
  677. } );
  678. it( 'does not create a paragraph when doNotAutoparagraph option is set to true', () => {
  679. setData(
  680. model,
  681. '<paragraph>x</paragraph>[<blockWidget></blockWidget>]<paragraph>z</paragraph>',
  682. { rootName: 'bodyRoot' }
  683. );
  684. deleteContent( model, doc.selection, { doNotAutoparagraph: true } );
  685. expect( getData( model, { rootName: 'bodyRoot' } ) )
  686. .to.equal( '<paragraph>x[]</paragraph><paragraph>z</paragraph>' );
  687. } );
  688. it( 'does not create a paragraph when after deletion there is no valid selection range (empty root)', () => {
  689. setData(
  690. model,
  691. '[<blockWidget></blockWidget>]',
  692. { rootName: 'bodyRoot' }
  693. );
  694. deleteContent( model, doc.selection, { doNotAutoparagraph: true } );
  695. expect( getData( model, { rootName: 'bodyRoot' } ) )
  696. .to.equal( '[]' );
  697. } );
  698. } );
  699. describe( 'integration with inline limit elements', () => {
  700. beforeEach( () => {
  701. model = new Model();
  702. doc = model.document;
  703. doc.createRoot();
  704. const schema = model.schema;
  705. schema.register( 'inlineLimit', {
  706. isLimit: true,
  707. allowIn: '$root'
  708. } );
  709. schema.extend( '$text', {
  710. allowIn: [ 'inlineLimit', '$root', 'x' ]
  711. } );
  712. schema.register( 'x', { allowIn: '$root' } );
  713. } );
  714. test(
  715. 'should delete inside inline limit element',
  716. '<inlineLimit>foo [bar] baz</inlineLimit>',
  717. '<inlineLimit>foo [] baz</inlineLimit>'
  718. );
  719. test(
  720. 'should delete whole inline limit element',
  721. 'x[<inlineLimit>foo bar</inlineLimit>]x',
  722. 'x[]x'
  723. );
  724. test(
  725. 'should delete from two inline limit elements',
  726. '<inlineLimit>foo [bar</inlineLimit><inlineLimit>baz] qux</inlineLimit>',
  727. '<inlineLimit>foo []</inlineLimit><inlineLimit> qux</inlineLimit>'
  728. );
  729. test(
  730. 'merge option should be ignored if both elements are limits',
  731. '<inlineLimit>foo [bar</inlineLimit><inlineLimit>baz] qux</inlineLimit>',
  732. '<inlineLimit>foo []</inlineLimit><inlineLimit> qux</inlineLimit>'
  733. );
  734. test(
  735. 'merge option should be ignored if the first element is a limit',
  736. '<inlineLimit>foo [bar</inlineLimit><x>baz] qux</x>',
  737. '<inlineLimit>foo []</inlineLimit><x> qux</x>'
  738. );
  739. test(
  740. 'merge option should be ignored if the second element is a limit',
  741. '<x>baz [qux</x><inlineLimit>foo] bar</inlineLimit>',
  742. '<x>baz []</x><inlineLimit> bar</inlineLimit>'
  743. );
  744. } );
  745. describe( 'integration with block limit elements', () => {
  746. beforeEach( () => {
  747. model = new Model();
  748. doc = model.document;
  749. doc.createRoot();
  750. const schema = model.schema;
  751. schema.register( 'blockLimit', {
  752. isLimit: true
  753. } );
  754. schema.extend( 'blockLimit', { allowIn: '$root' } );
  755. schema.extend( '$block', { allowIn: 'blockLimit' } );
  756. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  757. schema.register( 'blockQuote', {
  758. allowWhere: '$block',
  759. allowContentOf: '$root'
  760. } );
  761. } );
  762. test(
  763. 'should delete inside block limit element',
  764. '<blockLimit><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph></blockLimit>',
  765. '<blockLimit><paragraph>fo[]</paragraph><paragraph>ar</paragraph></blockLimit>',
  766. { leaveUnmerged: true }
  767. );
  768. test(
  769. 'should delete inside block limit element (with merge)',
  770. '<blockLimit><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph></blockLimit>',
  771. '<blockLimit><paragraph>fo[]ar</paragraph></blockLimit>'
  772. );
  773. test(
  774. 'should delete whole block limit element',
  775. '<paragraph>x</paragraph>[<blockLimit><paragraph>foo</paragraph></blockLimit>]<paragraph>x</paragraph>',
  776. '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>x</paragraph>'
  777. );
  778. test(
  779. 'should delete from two block limit elements',
  780. '<blockLimit><paragraph>foo [bar</paragraph></blockLimit><blockLimit><paragraph>baz] qux</paragraph></blockLimit>',
  781. '<blockLimit><paragraph>foo []</paragraph></blockLimit><blockLimit><paragraph> qux</paragraph></blockLimit>'
  782. );
  783. test(
  784. 'merge option should be ignored if any of the elements is a limit',
  785. '<blockLimit><paragraph>foo [bar</paragraph></blockLimit><blockLimit><paragraph>baz] qux</paragraph></blockLimit>',
  786. '<blockLimit><paragraph>foo []</paragraph></blockLimit><blockLimit><paragraph> qux</paragraph></blockLimit>'
  787. );
  788. // See: https://github.com/ckeditor/ckeditor5/issues/1265.
  789. it( 'should proper merge two elements which are inside limit element', () => {
  790. setData( model,
  791. '<blockLimit>' +
  792. '<blockQuote>' +
  793. '<paragraph>Foo</paragraph>' +
  794. '</blockQuote>' +
  795. '<paragraph>[]Bar</paragraph>' +
  796. '</blockLimit>'
  797. );
  798. model.modifySelection( doc.selection, { direction: 'backward' } );
  799. deleteContent( model, doc.selection );
  800. expect( getData( model ) ).to.equal(
  801. '<blockLimit>' +
  802. '<blockQuote>' +
  803. '<paragraph>Foo[]Bar</paragraph>' +
  804. '</blockQuote>' +
  805. '</blockLimit>' );
  806. } );
  807. it( 'should proper merge elements which are inside limit element (nested elements)', () => {
  808. setData( model,
  809. '<blockQuote>' +
  810. '<blockLimit>' +
  811. '<blockQuote>' +
  812. '<paragraph>Foo.</paragraph>' +
  813. '<blockQuote>' +
  814. '<paragraph>Foo</paragraph>' +
  815. '</blockQuote>' +
  816. '</blockQuote>' +
  817. '<paragraph>[]Bar</paragraph>' +
  818. '</blockLimit>' +
  819. '</blockQuote>'
  820. );
  821. model.modifySelection( doc.selection, { direction: 'backward' } );
  822. deleteContent( model, doc.selection );
  823. expect( getData( model ) ).to.equal(
  824. '<blockQuote>' +
  825. '<blockLimit>' +
  826. '<blockQuote>' +
  827. '<paragraph>Foo.</paragraph>' +
  828. '<blockQuote>' +
  829. '<paragraph>Foo[]Bar</paragraph>' +
  830. '</blockQuote>' +
  831. '</blockQuote>' +
  832. '</blockLimit>' +
  833. '</blockQuote>'
  834. );
  835. } );
  836. } );
  837. describe( 'should leave a paragraph if the entire content was selected', () => {
  838. beforeEach( () => {
  839. model = new Model();
  840. doc = model.document;
  841. doc.createRoot();
  842. const schema = model.schema;
  843. schema.register( 'div', {
  844. inheritAllFrom: '$block',
  845. isLimit: true
  846. } );
  847. schema.register( 'article', {
  848. inheritAllFrom: '$block',
  849. isLimit: true
  850. } );
  851. schema.register( 'image', {
  852. allowWhere: '$text',
  853. isObject: true
  854. } );
  855. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  856. schema.register( 'heading1', { inheritAllFrom: '$block' } );
  857. schema.register( 'heading2', { inheritAllFrom: '$block' } );
  858. schema.extend( '$text', { allowIn: '$root' } );
  859. schema.extend( 'image', { allowIn: '$root' } );
  860. schema.extend( 'image', { allowIn: 'heading1' } );
  861. schema.extend( 'heading1', { allowIn: 'div' } );
  862. schema.extend( 'paragraph', { allowIn: 'div' } );
  863. schema.extend( 'heading1', { allowIn: 'article' } );
  864. schema.extend( 'heading2', { allowIn: 'article' } );
  865. } );
  866. test(
  867. 'but not if only one block was selected',
  868. '<heading1>[xx]</heading1>',
  869. '<heading1>[]</heading1>'
  870. );
  871. test(
  872. 'when the entire heading and paragraph were selected',
  873. '<heading1>[xx</heading1><paragraph>yy]</paragraph>',
  874. '<paragraph>[]</paragraph>'
  875. );
  876. test(
  877. 'when the entire content was selected',
  878. '<heading1>[x</heading1><paragraph>foo</paragraph><paragraph>y]</paragraph>',
  879. '<paragraph>[]</paragraph>'
  880. );
  881. test(
  882. 'inside the limit element when the entire heading and paragraph were inside',
  883. '<div><heading1>[xx</heading1><paragraph>yy]</paragraph></div>',
  884. '<div><paragraph>[]</paragraph></div>'
  885. );
  886. test(
  887. 'but not if schema does not accept paragraph in limit element',
  888. '<article><heading1>[xx</heading1><heading2>yy]</heading2></article>',
  889. '<article><heading1>[]</heading1></article>'
  890. );
  891. test(
  892. 'but not if selection is not containing the whole content',
  893. '<image></image><heading1>[xx</heading1><paragraph>yy]</paragraph>',
  894. '<image></image><heading1>[]</heading1>'
  895. );
  896. test(
  897. 'but not if only single element is selected',
  898. '<heading1>[<image></image>xx]</heading1>',
  899. '<heading1>[]</heading1>'
  900. );
  901. it( 'when root element was not added as Schema limits work fine as well', () => {
  902. doc.createRoot( 'paragraph', 'paragraphRoot' );
  903. setData(
  904. model,
  905. 'x[<image></image><image></image>]z',
  906. { rootName: 'paragraphRoot' }
  907. );
  908. deleteContent( model, doc.selection );
  909. expect( getData( model, { rootName: 'paragraphRoot' } ) )
  910. .to.equal( 'x[]z' );
  911. } );
  912. test(
  913. 'but not if the flag "doNotResetEntireContent" is set to true',
  914. '<heading1>[</heading1><paragraph>]</paragraph>',
  915. '<heading1>[]</heading1>',
  916. {
  917. doNotResetEntireContent: true
  918. }
  919. );
  920. } );
  921. function test( title, input, output, options ) {
  922. it( title, () => {
  923. model.enqueueChange( 'transparent', () => {
  924. setData( model, input );
  925. deleteContent( model, doc.selection, options );
  926. } );
  927. expect( getData( model ) ).to.equal( output );
  928. } );
  929. }
  930. } );
  931. } );