8
0

deletecontent.js 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149
  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 remove operation if first element is empty (because of content delete) and last is not', () => {
  282. let mergeSpy;
  283. let removeSpy;
  284. setData( model, '<paragraph>[abcd</paragraph><paragraph>ef]gh</paragraph>' );
  285. model.change( writer => {
  286. mergeSpy = sinon.spy( writer, 'merge' );
  287. removeSpy = sinon.spy( writer, 'remove' );
  288. deleteContent( model, doc.selection );
  289. } );
  290. expect( getData( model ) ).to.equal( '<paragraph>[]gh</paragraph>' );
  291. expect( mergeSpy.called ).to.be.false;
  292. expect( removeSpy.called ).to.be.true;
  293. } );
  294. it( 'uses remove operation if first element is empty and last is not', () => {
  295. let mergeSpy;
  296. let removeSpy;
  297. setData( model, '<paragraph>[</paragraph><paragraph>ef]gh</paragraph>' );
  298. model.change( writer => {
  299. mergeSpy = sinon.spy( writer, 'merge' );
  300. removeSpy = sinon.spy( writer, 'remove' );
  301. deleteContent( model, doc.selection );
  302. } );
  303. expect( getData( model ) ).to.equal( '<paragraph>[]gh</paragraph>' );
  304. expect( mergeSpy.called ).to.be.false;
  305. expect( removeSpy.called ).to.be.true;
  306. } );
  307. it( 'does not try to move the second block if not needed', () => {
  308. let mergeSpy, moveSpy;
  309. setData( model, '<paragraph>ab[cd</paragraph><paragraph>ef]gh</paragraph>' );
  310. model.change( writer => {
  311. mergeSpy = sinon.spy( writer, 'merge' );
  312. moveSpy = sinon.spy( writer, 'move' );
  313. deleteContent( model, doc.selection );
  314. } );
  315. expect( getData( model ) ).to.equal( '<paragraph>ab[]gh</paragraph>' );
  316. expect( moveSpy.called ).to.be.false;
  317. expect( mergeSpy.called ).to.be.true;
  318. } );
  319. // Note: in all these cases we ignore the direction of merge.
  320. // If https://github.com/ckeditor/ckeditor5-engine/issues/470 was fixed we could differently treat
  321. // forward and backward delete.
  322. describe( 'with nested elements', () => {
  323. test(
  324. 'merges elements when deep nested',
  325. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph><pchild>b]ar</pchild>y</paragraph>',
  326. '<paragraph>x<pchild>fo[]ar</pchild>y</paragraph>'
  327. );
  328. test(
  329. 'removes block element with nested element',
  330. '<paragraph><pchild>[foo</pchild></paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  331. '<paragraph><pchild>[]ar</pchild></paragraph>'
  332. );
  333. test(
  334. 'does not remove block element with nested element and object',
  335. '<paragraph><pchild><widget></widget>[foo</pchild></paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  336. '<paragraph><pchild><widget></widget>[]ar</pchild></paragraph>'
  337. );
  338. test(
  339. 'merges heading element',
  340. '<heading1><hchild>x[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  341. '<heading1><hchild>x[]ar</hchild></heading1>'
  342. );
  343. test(
  344. 'removes heading element',
  345. '<heading1><hchild>[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  346. '<paragraph><pchild>[]ar</pchild></paragraph>'
  347. );
  348. test(
  349. 'does not remove heading element if contains object',
  350. '<heading1><hchild><widget></widget>[foo</hchild></heading1><paragraph><pchild>b]ar</pchild></paragraph>',
  351. '<heading1><hchild><widget></widget>[]ar</hchild></heading1>'
  352. );
  353. test(
  354. 'merges elements when left end deep nested',
  355. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph>b]ary</paragraph><paragraph>x</paragraph>',
  356. '<paragraph>x<pchild>fo[]ary</pchild></paragraph><paragraph>x</paragraph>'
  357. );
  358. test(
  359. 'removes elements when left end deep nested and will be empty',
  360. '<paragraph><pchild>[foo</pchild></paragraph><paragraph>b]ar</paragraph><paragraph>x</paragraph>',
  361. '<paragraph>[]ar</paragraph><paragraph>x</paragraph>'
  362. );
  363. test(
  364. 'merges elements when right end deep nested',
  365. '<paragraph>x</paragraph><paragraph>fo[o</paragraph><paragraph><pchild>b]ar</pchild>x</paragraph>',
  366. '<paragraph>x</paragraph><paragraph>fo[]ar</paragraph><paragraph>x</paragraph>'
  367. );
  368. test(
  369. 'removes element when right end deep nested but left end would be empty',
  370. '<paragraph>x</paragraph><paragraph>[foo</paragraph><paragraph><pchild>b]ar</pchild></paragraph>',
  371. '<paragraph>x</paragraph><paragraph><pchild>[]ar</pchild></paragraph>'
  372. );
  373. test(
  374. 'merges elements when right end deep nested (in an empty container)',
  375. '<paragraph>fo[o</paragraph><paragraph><pchild>bar]</pchild></paragraph>',
  376. '<paragraph>fo[]</paragraph>'
  377. );
  378. test(
  379. 'removes elements when left end deep nested (in an empty container)',
  380. '<paragraph><pchild>[foo</pchild></paragraph><paragraph>b]ar</paragraph><paragraph>x</paragraph>',
  381. '<paragraph>[]ar</paragraph><paragraph>x</paragraph>'
  382. );
  383. describe( 'with 3rd level of nesting', () => {
  384. test(
  385. 'merges elements when deep nested (same name)',
  386. '<pparent>x<paragraph>x<pchild>fo[o</pchild></paragraph></pparent>' +
  387. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  388. '<pparent>x<paragraph>x<pchild>fo[]ar</pchild>y</paragraph>y</pparent>'
  389. );
  390. test(
  391. 'removes elements when deep nested (same name)',
  392. '<pparent><paragraph><pchild>[foo</pchild></paragraph></pparent>' +
  393. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  394. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  395. );
  396. test(
  397. 'removes elements up to common ancestor when deep nested (same name)',
  398. '<pparent>' +
  399. '<paragraph><pchild>[foo</pchild></paragraph>' +
  400. '<paragraph><pchild>b]ar</pchild>y</paragraph>y' +
  401. '</pparent>',
  402. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  403. );
  404. test(
  405. 'merges elements when deep nested (different name)',
  406. '<pparent>x<heading1>x<hchild>fo[o</hchild></heading1></pparent>' +
  407. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  408. '<pparent>x<heading1>x<hchild>fo[]ar</hchild>y</heading1>y</pparent>'
  409. );
  410. test(
  411. 'removes elements when deep nested (different name)',
  412. '<pparent><heading1><hchild>[foo</hchild></heading1></pparent>' +
  413. '<pparent><paragraph><pchild>b]ar</pchild>y</paragraph>y</pparent>',
  414. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  415. );
  416. test(
  417. 'removes elements up to common ancestor when deep nested (different names)',
  418. '<pparent>' +
  419. '<heading1><hchild>[foo</hchild></heading1>' +
  420. '<paragraph><pchild>b]ar</pchild>y</paragraph>y' +
  421. '</pparent>',
  422. '<pparent><paragraph><pchild>[]ar</pchild>y</paragraph>y</pparent>'
  423. );
  424. } );
  425. describe( 'with 3rd level of nesting o the left end', () => {
  426. test(
  427. 'merges elements',
  428. '<pparent>x<paragraph>foo<pchild>ba[r</pchild></paragraph></pparent>' +
  429. '<paragraph>b]om</paragraph>',
  430. '<pparent>x<paragraph>foo<pchild>ba[]om</pchild></paragraph></pparent>'
  431. );
  432. test(
  433. 'merges elements (different names)',
  434. '<pparent>x<heading1>foo<hchild>ba[r</hchild></heading1></pparent>' +
  435. '<paragraph>b]om</paragraph>',
  436. '<pparent>x<heading1>foo<hchild>ba[]om</hchild></heading1></pparent>'
  437. );
  438. test(
  439. 'removes elements',
  440. '<pparent><paragraph><pchild>[bar</pchild></paragraph></pparent>' +
  441. '<paragraph>b]om</paragraph>',
  442. '<paragraph>[]om</paragraph>'
  443. );
  444. test(
  445. 'removes elements up to common ancestor (different names)',
  446. '<pparent>' +
  447. '<heading1><hchild>[foo</hchild></heading1>' +
  448. '<paragraph>b]ar</paragraph>y' +
  449. '</pparent>',
  450. '<pparent><paragraph>[]ar</paragraph>y</pparent>'
  451. );
  452. } );
  453. describe( 'with 3rd level of nesting o the right end', () => {
  454. test(
  455. 'merges elements',
  456. '<paragraph>b[om</paragraph>' +
  457. '<pparent><paragraph><pchild>ba]r</pchild></paragraph></pparent>',
  458. '<paragraph>b[]r</paragraph>'
  459. );
  460. test(
  461. 'merges elements (different names)',
  462. '<paragraph>bo[m</paragraph>' +
  463. '<pparent><heading1><hchild>b]ar</hchild></heading1></pparent>',
  464. '<paragraph>bo[]ar</paragraph>'
  465. );
  466. test(
  467. 'merges elements (different names, reversed)',
  468. '<heading1>bo[m</heading1>' +
  469. '<pparent><paragraph><pchild>b]ar</pchild></paragraph></pparent>',
  470. '<heading1>bo[]ar</heading1>'
  471. );
  472. test(
  473. 'removes elements',
  474. '<paragraph>[bom</paragraph>' +
  475. '<pparent><paragraph><pchild>b]ar</pchild></paragraph></pparent>',
  476. '<pparent><paragraph><pchild>[]ar</pchild></paragraph></pparent>'
  477. );
  478. test(
  479. 'removes elements up to common ancestor (different names)',
  480. '<pparent>' +
  481. '<heading1>[bar</heading1>y' +
  482. '<paragraph><pchild>f]oo</pchild></paragraph>' +
  483. '</pparent>',
  484. '<pparent><paragraph><pchild>[]oo</pchild></paragraph></pparent>'
  485. );
  486. } );
  487. } );
  488. describe( 'with object elements', () => {
  489. beforeEach( () => {
  490. const schema = model.schema;
  491. schema.register( 'blockWidget', {
  492. isObject: true
  493. } );
  494. schema.register( 'nestedEditable', {
  495. isLimit: true
  496. } );
  497. schema.extend( 'blockWidget', { allowIn: '$root' } );
  498. schema.extend( 'nestedEditable', { allowIn: 'blockWidget' } );
  499. schema.extend( '$text', { allowIn: 'nestedEditable' } );
  500. } );
  501. test(
  502. 'does not merge an object element (if it is first)',
  503. '<blockWidget><nestedEditable>fo[o</nestedEditable></blockWidget><paragraph>b]ar</paragraph>',
  504. '<blockWidget><nestedEditable>fo[]</nestedEditable></blockWidget><paragraph>ar</paragraph>'
  505. );
  506. test(
  507. 'does not merge an object element (if it is second)',
  508. '<paragraph>ba[r</paragraph><blockWidget><nestedEditable>f]oo</nestedEditable></blockWidget>',
  509. '<paragraph>ba[]</paragraph><blockWidget><nestedEditable>oo</nestedEditable></blockWidget>'
  510. );
  511. } );
  512. describe( 'filtering out', () => {
  513. beforeEach( () => {
  514. const schema = model.schema;
  515. schema.addAttributeCheck( ( ctx, attributeName ) => {
  516. // Disallow 'c' on pchild>pchild>$text.
  517. if ( ctx.endsWith( 'pchild pchild $text' ) && attributeName == 'c' ) {
  518. return false;
  519. }
  520. // Allow 'a' and 'b' on paragraph>$text.
  521. if ( ctx.endsWith( 'paragraph $text' ) && [ 'a', 'b' ].includes( attributeName ) ) {
  522. return true;
  523. }
  524. // Allow 'b' and 'c' in pchild>$text.
  525. if ( ctx.endsWith( 'pchild $text' ) && [ 'b', 'c' ].includes( attributeName ) ) {
  526. return true;
  527. }
  528. } );
  529. schema.extend( 'pchild', { allowIn: 'pchild' } );
  530. } );
  531. test(
  532. 'filters out disallowed attributes after left merge',
  533. '<paragraph>x<pchild>fo[o</pchild></paragraph><paragraph>y]<$text a="1" b="1">z</$text></paragraph>',
  534. '<paragraph>x<pchild>fo[]<$text b="1">z</$text></pchild></paragraph>'
  535. );
  536. test(
  537. 'filters out disallowed attributes from nested nodes after left merge',
  538. '<paragraph>' +
  539. 'x' +
  540. '<pchild>fo[o</pchild>' +
  541. '</paragraph>' +
  542. '<paragraph>' +
  543. 'b]a<$text a="1" b="1">r</$text>' +
  544. '<pchild>b<$text b="1" c="1">i</$text>z</pchild>' +
  545. 'y' +
  546. '</paragraph>',
  547. '<paragraph>' +
  548. 'x' +
  549. '<pchild>' +
  550. 'fo[]a<$text b="1">r</$text>' +
  551. '<pchild>b<$text b="1">i</$text>z</pchild>' +
  552. 'y' +
  553. '</pchild>' +
  554. '</paragraph>'
  555. );
  556. test(
  557. 'filters out disallowed attributes after right merge',
  558. '<paragraph>fo[o</paragraph><paragraph><pchild>x<$text b="1" c="1">y]z</$text></pchild></paragraph>',
  559. '<paragraph>fo[]<$text b="1">z</$text></paragraph>'
  560. );
  561. } );
  562. } );
  563. describe( 'in element selections scenarios', () => {
  564. beforeEach( () => {
  565. model = new Model();
  566. doc = model.document;
  567. // <p> like root.
  568. doc.createRoot( 'paragraph', 'paragraphRoot' );
  569. // <body> like root.
  570. doc.createRoot( '$root', 'bodyRoot' );
  571. // Special root which allows only blockWidgets inside itself.
  572. doc.createRoot( 'restrictedRoot', 'restrictedRoot' );
  573. const schema = model.schema;
  574. schema.register( 'image', { allowWhere: '$text' } );
  575. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  576. schema.register( 'heading1', { inheritAllFrom: '$block' } );
  577. schema.register( 'blockWidget', { isLimit: true } );
  578. schema.register( 'restrictedRoot', {
  579. isLimit: true
  580. } );
  581. schema.extend( '$block', { allowIn: '$root' } );
  582. schema.extend( 'blockWidget', { allowIn: '$root' } );
  583. schema.extend( 'blockWidget', { allowIn: 'restrictedRoot' } );
  584. } );
  585. // See also "in simple scenarios => deletes an element".
  586. it( 'deletes two inline elements', () => {
  587. model.schema.extend( 'paragraph', {
  588. isLimit: true
  589. } );
  590. setData(
  591. model,
  592. 'x[<image></image><image></image>]z',
  593. { rootName: 'paragraphRoot' }
  594. );
  595. deleteContent( model, doc.selection );
  596. expect( getData( model, { rootName: 'paragraphRoot' } ) )
  597. .to.equal( 'x[]z' );
  598. } );
  599. it( 'moves the (custom) selection to the nearest paragraph', () => {
  600. setData(
  601. model,
  602. '<paragraph>[x]</paragraph><paragraph>yyy</paragraph><paragraph>z</paragraph>',
  603. { rootName: 'bodyRoot' }
  604. );
  605. const root = doc.getRoot( 'bodyRoot' );
  606. // [<paragraph>yyy</paragraph>]
  607. const selection = new Selection( [
  608. new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) )
  609. ] );
  610. deleteContent( model, selection );
  611. expect( getData( model, { rootName: 'bodyRoot' } ) )
  612. .to.equal( '<paragraph>[x]</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  613. expect( stringify( root, selection ) )
  614. .to.equal( '<$root><paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>z</paragraph></$root>' );
  615. } );
  616. it( 'creates a paragraph when text is not allowed (block widget selected)', () => {
  617. setData(
  618. model,
  619. '<paragraph>x</paragraph>[<blockWidget></blockWidget>]<paragraph>z</paragraph>',
  620. { rootName: 'bodyRoot' }
  621. );
  622. deleteContent( model, doc.selection );
  623. expect( getData( model, { rootName: 'bodyRoot' } ) )
  624. .to.equal( '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>z</paragraph>' );
  625. } );
  626. it( 'creates paragraph when text is not allowed (heading selected)', () => {
  627. setData(
  628. model,
  629. '<paragraph>x</paragraph><heading1>yyy</heading1><paragraph>z</paragraph>',
  630. { rootName: 'bodyRoot' }
  631. );
  632. // [<heading1>yyy</heading1>]
  633. const range = new Range(
  634. new Position( doc.getRoot( 'bodyRoot' ), [ 1 ] ),
  635. new Position( doc.getRoot( 'bodyRoot' ), [ 2 ] )
  636. );
  637. deleteContent( model, new Selection( range ) );
  638. expect( getData( model, { rootName: 'bodyRoot', withoutSelection: true } ) )
  639. .to.equal( '<paragraph>x</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  640. } );
  641. it( 'creates paragraph when text is not allowed (two blocks selected)', () => {
  642. setData(
  643. model,
  644. '<paragraph>x</paragraph><heading1>yyy</heading1><paragraph>yyy</paragraph><paragraph>z</paragraph>',
  645. { rootName: 'bodyRoot' }
  646. );
  647. // [<heading1>yyy</heading1><paragraph>yyy</paragraph>]
  648. const range = new Range(
  649. new Position( doc.getRoot( 'bodyRoot' ), [ 1 ] ),
  650. new Position( doc.getRoot( 'bodyRoot' ), [ 3 ] )
  651. );
  652. deleteContent( model, new Selection( range ) );
  653. expect( getData( model, { rootName: 'bodyRoot', withoutSelection: true } ) )
  654. .to.equal( '<paragraph>x</paragraph><paragraph></paragraph><paragraph>z</paragraph>' );
  655. } );
  656. it( 'creates paragraph when text is not allowed (all content selected)', () => {
  657. setData(
  658. model,
  659. '[<heading1>x</heading1><paragraph>z</paragraph>]',
  660. { rootName: 'bodyRoot' }
  661. );
  662. deleteContent( model, doc.selection );
  663. expect( getData( model, { rootName: 'bodyRoot' } ) )
  664. .to.equal( '<paragraph>[]</paragraph>' );
  665. } );
  666. it( 'does not create a paragraph when it is not allowed', () => {
  667. setData(
  668. model,
  669. '<blockWidget></blockWidget>[<blockWidget></blockWidget>]<blockWidget></blockWidget>',
  670. { rootName: 'restrictedRoot' }
  671. );
  672. deleteContent( model, doc.selection );
  673. expect( getData( model, { rootName: 'restrictedRoot' } ) )
  674. .to.equal( '<blockWidget></blockWidget>[]<blockWidget></blockWidget>' );
  675. } );
  676. it( 'does not create a paragraph when doNotAutoparagraph option is set to true', () => {
  677. setData(
  678. model,
  679. '<paragraph>x</paragraph>[<blockWidget></blockWidget>]<paragraph>z</paragraph>',
  680. { rootName: 'bodyRoot' }
  681. );
  682. deleteContent( model, doc.selection, { doNotAutoparagraph: true } );
  683. expect( getData( model, { rootName: 'bodyRoot' } ) )
  684. .to.equal( '<paragraph>x[]</paragraph><paragraph>z</paragraph>' );
  685. } );
  686. it( 'does not create a paragraph when after deletion there is no valid selection range (empty root)', () => {
  687. setData(
  688. model,
  689. '[<blockWidget></blockWidget>]',
  690. { rootName: 'bodyRoot' }
  691. );
  692. deleteContent( model, doc.selection, { doNotAutoparagraph: true } );
  693. expect( getData( model, { rootName: 'bodyRoot' } ) )
  694. .to.equal( '[]' );
  695. } );
  696. } );
  697. describe( 'integration with inline limit elements', () => {
  698. beforeEach( () => {
  699. model = new Model();
  700. doc = model.document;
  701. doc.createRoot();
  702. const schema = model.schema;
  703. schema.register( 'inlineLimit', {
  704. isLimit: true,
  705. allowIn: '$root'
  706. } );
  707. schema.extend( '$text', {
  708. allowIn: [ 'inlineLimit', '$root', 'x' ]
  709. } );
  710. schema.register( 'x', { allowIn: '$root' } );
  711. } );
  712. test(
  713. 'should delete inside inline limit element',
  714. '<inlineLimit>foo [bar] baz</inlineLimit>',
  715. '<inlineLimit>foo [] baz</inlineLimit>'
  716. );
  717. test(
  718. 'should delete whole inline limit element',
  719. 'x[<inlineLimit>foo bar</inlineLimit>]x',
  720. 'x[]x'
  721. );
  722. test(
  723. 'should delete from two inline limit elements',
  724. '<inlineLimit>foo [bar</inlineLimit><inlineLimit>baz] qux</inlineLimit>',
  725. '<inlineLimit>foo []</inlineLimit><inlineLimit> qux</inlineLimit>'
  726. );
  727. test(
  728. 'merge option should be ignored if both elements are limits',
  729. '<inlineLimit>foo [bar</inlineLimit><inlineLimit>baz] qux</inlineLimit>',
  730. '<inlineLimit>foo []</inlineLimit><inlineLimit> qux</inlineLimit>'
  731. );
  732. test(
  733. 'merge option should be ignored if the first element is a limit',
  734. '<inlineLimit>foo [bar</inlineLimit><x>baz] qux</x>',
  735. '<inlineLimit>foo []</inlineLimit><x> qux</x>'
  736. );
  737. test(
  738. 'merge option should be ignored if the second element is a limit',
  739. '<x>baz [qux</x><inlineLimit>foo] bar</inlineLimit>',
  740. '<x>baz []</x><inlineLimit> bar</inlineLimit>'
  741. );
  742. } );
  743. describe( 'integration with block limit elements', () => {
  744. beforeEach( () => {
  745. model = new Model();
  746. doc = model.document;
  747. doc.createRoot();
  748. const schema = model.schema;
  749. schema.register( 'blockLimit', {
  750. isLimit: true
  751. } );
  752. schema.extend( 'blockLimit', { allowIn: '$root' } );
  753. schema.extend( '$block', { allowIn: 'blockLimit' } );
  754. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  755. schema.register( 'blockQuote', {
  756. allowWhere: '$block',
  757. allowContentOf: '$root'
  758. } );
  759. } );
  760. test(
  761. 'should delete inside block limit element',
  762. '<blockLimit><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph></blockLimit>',
  763. '<blockLimit><paragraph>fo[]</paragraph><paragraph>ar</paragraph></blockLimit>',
  764. { leaveUnmerged: true }
  765. );
  766. test(
  767. 'should delete inside block limit element (with merge)',
  768. '<blockLimit><paragraph>fo[o</paragraph><paragraph>b]ar</paragraph></blockLimit>',
  769. '<blockLimit><paragraph>fo[]ar</paragraph></blockLimit>'
  770. );
  771. test(
  772. 'should delete whole block limit element',
  773. '<paragraph>x</paragraph>[<blockLimit><paragraph>foo</paragraph></blockLimit>]<paragraph>x</paragraph>',
  774. '<paragraph>x</paragraph><paragraph>[]</paragraph><paragraph>x</paragraph>'
  775. );
  776. test(
  777. 'should delete from two block limit elements',
  778. '<blockLimit><paragraph>foo [bar</paragraph></blockLimit><blockLimit><paragraph>baz] qux</paragraph></blockLimit>',
  779. '<blockLimit><paragraph>foo []</paragraph></blockLimit><blockLimit><paragraph> qux</paragraph></blockLimit>'
  780. );
  781. test(
  782. 'merge option should be ignored if any of the elements is a limit',
  783. '<blockLimit><paragraph>foo [bar</paragraph></blockLimit><blockLimit><paragraph>baz] qux</paragraph></blockLimit>',
  784. '<blockLimit><paragraph>foo []</paragraph></blockLimit><blockLimit><paragraph> qux</paragraph></blockLimit>'
  785. );
  786. // See: https://github.com/ckeditor/ckeditor5/issues/1265.
  787. it( 'should proper merge two elements which are inside limit element', () => {
  788. setData( model,
  789. '<blockLimit>' +
  790. '<blockQuote>' +
  791. '<paragraph>Foo</paragraph>' +
  792. '</blockQuote>' +
  793. '<paragraph>[]Bar</paragraph>' +
  794. '</blockLimit>'
  795. );
  796. model.modifySelection( doc.selection, { direction: 'backward' } );
  797. deleteContent( model, doc.selection );
  798. expect( getData( model ) ).to.equal(
  799. '<blockLimit>' +
  800. '<blockQuote>' +
  801. '<paragraph>Foo[]Bar</paragraph>' +
  802. '</blockQuote>' +
  803. '</blockLimit>' );
  804. } );
  805. it( 'should proper merge elements which are inside limit element (nested elements)', () => {
  806. setData( model,
  807. '<blockQuote>' +
  808. '<blockLimit>' +
  809. '<blockQuote>' +
  810. '<paragraph>Foo.</paragraph>' +
  811. '<blockQuote>' +
  812. '<paragraph>Foo</paragraph>' +
  813. '</blockQuote>' +
  814. '</blockQuote>' +
  815. '<paragraph>[]Bar</paragraph>' +
  816. '</blockLimit>' +
  817. '</blockQuote>'
  818. );
  819. model.modifySelection( doc.selection, { direction: 'backward' } );
  820. deleteContent( model, doc.selection );
  821. expect( getData( model ) ).to.equal(
  822. '<blockQuote>' +
  823. '<blockLimit>' +
  824. '<blockQuote>' +
  825. '<paragraph>Foo.</paragraph>' +
  826. '<blockQuote>' +
  827. '<paragraph>Foo[]Bar</paragraph>' +
  828. '</blockQuote>' +
  829. '</blockQuote>' +
  830. '</blockLimit>' +
  831. '</blockQuote>'
  832. );
  833. } );
  834. } );
  835. describe( 'should leave a paragraph if the entire content was selected', () => {
  836. beforeEach( () => {
  837. model = new Model();
  838. doc = model.document;
  839. doc.createRoot();
  840. const schema = model.schema;
  841. schema.register( 'div', {
  842. inheritAllFrom: '$block',
  843. isLimit: true
  844. } );
  845. schema.register( 'article', {
  846. inheritAllFrom: '$block',
  847. isLimit: true
  848. } );
  849. schema.register( 'image', {
  850. allowWhere: '$text',
  851. isObject: true
  852. } );
  853. schema.register( 'paragraph', { inheritAllFrom: '$block' } );
  854. schema.register( 'heading1', { inheritAllFrom: '$block' } );
  855. schema.register( 'heading2', { inheritAllFrom: '$block' } );
  856. schema.extend( '$text', { allowIn: '$root' } );
  857. schema.extend( 'image', { allowIn: '$root' } );
  858. schema.extend( 'image', { allowIn: 'heading1' } );
  859. schema.extend( 'heading1', { allowIn: 'div' } );
  860. schema.extend( 'paragraph', { allowIn: 'div' } );
  861. schema.extend( 'heading1', { allowIn: 'article' } );
  862. schema.extend( 'heading2', { allowIn: 'article' } );
  863. } );
  864. test(
  865. 'but not if only one block was selected',
  866. '<heading1>[xx]</heading1>',
  867. '<heading1>[]</heading1>'
  868. );
  869. test(
  870. 'when the entire heading and paragraph were selected',
  871. '<heading1>[xx</heading1><paragraph>yy]</paragraph>',
  872. '<paragraph>[]</paragraph>'
  873. );
  874. test(
  875. 'when the entire content was selected',
  876. '<heading1>[x</heading1><paragraph>foo</paragraph><paragraph>y]</paragraph>',
  877. '<paragraph>[]</paragraph>'
  878. );
  879. test(
  880. 'inside the limit element when the entire heading and paragraph were inside',
  881. '<div><heading1>[xx</heading1><paragraph>yy]</paragraph></div>',
  882. '<div><paragraph>[]</paragraph></div>'
  883. );
  884. test(
  885. 'but not if schema does not accept paragraph in limit element',
  886. '<article><heading1>[xx</heading1><heading2>yy]</heading2></article>',
  887. '<article><heading1>[]</heading1></article>'
  888. );
  889. test(
  890. 'but not if selection is not containing the whole content',
  891. '<image></image><heading1>[xx</heading1><paragraph>yy]</paragraph>',
  892. '<image></image><heading1>[]</heading1>'
  893. );
  894. test(
  895. 'but not if only single element is selected',
  896. '<heading1>[<image></image>xx]</heading1>',
  897. '<heading1>[]</heading1>'
  898. );
  899. it( 'when root element was not added as Schema limits work fine as well', () => {
  900. doc.createRoot( 'paragraph', 'paragraphRoot' );
  901. setData(
  902. model,
  903. 'x[<image></image><image></image>]z',
  904. { rootName: 'paragraphRoot' }
  905. );
  906. deleteContent( model, doc.selection );
  907. expect( getData( model, { rootName: 'paragraphRoot' } ) )
  908. .to.equal( 'x[]z' );
  909. } );
  910. test(
  911. 'but not if the flag "doNotResetEntireContent" is set to true',
  912. '<heading1>[</heading1><paragraph>]</paragraph>',
  913. '<heading1>[]</heading1>',
  914. {
  915. doNotResetEntireContent: true
  916. }
  917. );
  918. } );
  919. function test( title, input, output, options ) {
  920. it( title, () => {
  921. model.enqueueChange( 'transparent', () => {
  922. setData( model, input );
  923. deleteContent( model, doc.selection, options );
  924. } );
  925. expect( getData( model ) ).to.equal( output );
  926. } );
  927. }
  928. } );
  929. } );