unwrap.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
  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 DowncastWriter from '../../../src/view/downcastwriter';
  6. import Element from '../../../src/view/element';
  7. import ContainerElement from '../../../src/view/containerelement';
  8. import AttributeElement from '../../../src/view/attributeelement';
  9. import EmptyElement from '../../../src/view/emptyelement';
  10. import UIElement from '../../../src/view/uielement';
  11. import Position from '../../../src/view/position';
  12. import Range from '../../../src/view/range';
  13. import Text from '../../../src/view/text';
  14. import { stringify, parse } from '../../../src/dev-utils/view';
  15. import Document from '../../../src/view/document';
  16. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  17. import { StylesProcessor } from '../../../src/view/stylesmap';
  18. describe( 'DowncastWriter', () => {
  19. describe( 'unwrap()', () => {
  20. let writer, document;
  21. // Executes test using `parse` and `stringify` utils functions.
  22. //
  23. // @param {String} input
  24. // @param {String} unwrapAttribute
  25. // @param {String} expected
  26. function testUnwrap( input, unwrapAttribute, expected ) {
  27. const { view, selection } = parse( input );
  28. const newRange = writer.unwrap( selection.getFirstRange(), parse( unwrapAttribute ) );
  29. expect( stringify( view.root, newRange, { showType: true, showPriority: true } ) ).to.equal( expected );
  30. }
  31. beforeEach( () => {
  32. document = new Document( new StylesProcessor() );
  33. writer = new DowncastWriter( document );
  34. } );
  35. it( 'should do nothing on collapsed ranges', () => {
  36. testUnwrap(
  37. '<container:p>f{}oo</container:p>',
  38. '<attribute:b view-priority="10"></attribute:b>',
  39. '<container:p>f{}oo</container:p>'
  40. );
  41. } );
  42. it( 'should do nothing on single text node', () => {
  43. testUnwrap(
  44. '<container:p>[foobar]</container:p>',
  45. '<attribute:b view-priority="1"></attribute:b>',
  46. '<container:p>[foobar]</container:p>'
  47. );
  48. } );
  49. it( 'should throw error when element is not instance of AttributeElement', () => {
  50. const container = new ContainerElement( document, 'p', null, new AttributeElement( document, 'b', null, new Text( 'foo' ) ) );
  51. const range = new Range(
  52. new Position( container, 0 ),
  53. new Position( container, 1 )
  54. );
  55. const b = new Element( document, 'b' );
  56. expectToThrowCKEditorError( () => {
  57. writer.unwrap( range, b );
  58. }, 'view-writer-unwrap-invalid-attribute', document );
  59. } );
  60. it( 'should throw error when range placed in two containers', () => {
  61. const container1 = new ContainerElement( document, 'p' );
  62. const container2 = new ContainerElement( document, 'p' );
  63. const range = new Range(
  64. new Position( container1, 0 ),
  65. new Position( container2, 1 )
  66. );
  67. const b = new AttributeElement( document, 'b' );
  68. expectToThrowCKEditorError( () => {
  69. writer.unwrap( range, b );
  70. }, 'view-writer-invalid-range-container', document );
  71. } );
  72. it( 'should throw when range has no parent container', () => {
  73. const el = new AttributeElement( document, 'b' );
  74. const b = new AttributeElement( document, 'b' );
  75. expectToThrowCKEditorError( () => {
  76. writer.unwrap( Range._createFromParentsAndOffsets( el, 0, el, 0 ), b );
  77. }, 'view-writer-invalid-range-container', document );
  78. } );
  79. it( 'should unwrap single node', () => {
  80. testUnwrap(
  81. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  82. '<attribute:b view-priority="1"></attribute:b>',
  83. '<container:p>[foobar]</container:p>'
  84. );
  85. } );
  86. it( 'should not unwrap attributes with different priorities #1', () => {
  87. testUnwrap(
  88. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  89. '<attribute:b view-priority="2"></attribute:b>',
  90. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>'
  91. );
  92. } );
  93. it( 'should not unwrap attributes with different priorities #2', () => {
  94. testUnwrap(
  95. '<container:p>' +
  96. '[' +
  97. '<attribute:b view-priority="2">foo</attribute:b>' +
  98. '<attribute:b view-priority="1">bar</attribute:b>' +
  99. '<attribute:b view-priority="2">baz</attribute:b>' +
  100. ']' +
  101. '</container:p>',
  102. '<attribute:b view-priority="2"></attribute:b>',
  103. '<container:p>[foo<attribute:b view-priority="1">bar</attribute:b>baz]</container:p>'
  104. );
  105. } );
  106. it( 'should unwrap part of the node', () => {
  107. testUnwrap(
  108. '<container:p>[baz<attribute:b view-priority="1">foo}bar</attribute:b></container:p>',
  109. '<attribute:b view-priority="1"></attribute:b>',
  110. '<container:p>[bazfoo]<attribute:b view-priority="1">bar</attribute:b></container:p>'
  111. );
  112. } );
  113. it( 'should support unicode', () => {
  114. testUnwrap(
  115. '<container:p>[நிலை<attribute:b view-priority="1">க்}கு</attribute:b></container:p>',
  116. '<attribute:b view-priority="1"></attribute:b>',
  117. '<container:p>[நிலைக்]<attribute:b view-priority="1">கு</attribute:b></container:p>'
  118. );
  119. } );
  120. it( 'should unwrap nested attributes', () => {
  121. testUnwrap(
  122. '<container:p>' +
  123. '[<attribute:u view-priority="1"><attribute:b view-priority="1">foobar</attribute:b></attribute:u>]' +
  124. '</container:p>',
  125. '<attribute:b view-priority="1"></attribute:b>',
  126. '<container:p>[<attribute:u view-priority="1">foobar</attribute:u>]</container:p>'
  127. );
  128. } );
  129. it( 'should unwrap a part of a nested attribute', () => {
  130. testUnwrap(
  131. '<container:p>' +
  132. '<attribute:u view-priority="1"><attribute:b view-priority="1">fo{ob}ar</attribute:b></attribute:u>' +
  133. '</container:p>',
  134. '<attribute:b view-priority="1"></attribute:b>',
  135. '<container:p>' +
  136. '<attribute:u view-priority="1">' +
  137. '<attribute:b view-priority="1">fo</attribute:b>' +
  138. '[ob]' +
  139. '<attribute:b view-priority="1">ar</attribute:b>' +
  140. '</attribute:u>' +
  141. '</container:p>'
  142. );
  143. } );
  144. it( 'should merge unwrapped nodes #1', () => {
  145. testUnwrap(
  146. '<container:p>foo[<attribute:b view-priority="1">bar</attribute:b>]baz</container:p>',
  147. '<attribute:b view-priority="1"></attribute:b>',
  148. '<container:p>foo{bar}baz</container:p>'
  149. );
  150. } );
  151. it( 'should merge unwrapped nodes #2', () => {
  152. const input = '<container:p>' +
  153. 'foo' +
  154. '<attribute:u view-priority="1">bar</attribute:u>' +
  155. '[' +
  156. '<attribute:b view-priority="1">' +
  157. '<attribute:u view-priority="1">bazqux</attribute:u>' +
  158. '</attribute:b>' +
  159. ']' +
  160. '</container:p>';
  161. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  162. const result = '<container:p>foo<attribute:u view-priority="1">bar{bazqux</attribute:u>]</container:p>';
  163. testUnwrap( input, attribute, result );
  164. } );
  165. it( 'should merge unwrapped nodes #3', () => {
  166. const input = '<container:p>' +
  167. 'foo' +
  168. '<attribute:u view-priority="1">bar</attribute:u>' +
  169. '[' +
  170. '<attribute:b view-priority="1">' +
  171. '<attribute:u view-priority="1">baz}qux</attribute:u>' +
  172. '</attribute:b>' +
  173. '</container:p>';
  174. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  175. const result = '<container:p>' +
  176. 'foo' +
  177. '<attribute:u view-priority="1">bar{baz</attribute:u>]' +
  178. '<attribute:b view-priority="1">' +
  179. '<attribute:u view-priority="1">qux</attribute:u>' +
  180. '</attribute:b>' +
  181. '</container:p>';
  182. testUnwrap( input, attribute, result );
  183. } );
  184. it( 'should merge unwrapped nodes #4', () => {
  185. const input = '<container:p>' +
  186. 'foo' +
  187. '<attribute:u view-priority="1">bar</attribute:u>' +
  188. '[' +
  189. '<attribute:b view-priority="1">' +
  190. '<attribute:u view-priority="1">baz</attribute:u>' +
  191. '</attribute:b>' +
  192. ']' +
  193. '<attribute:u view-priority="1">qux</attribute:u>' +
  194. '</container:p>';
  195. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  196. const result = '<container:p>' +
  197. 'foo' +
  198. '<attribute:u view-priority="1">bar{baz}qux</attribute:u>' +
  199. '</container:p>';
  200. testUnwrap( input, attribute, result );
  201. } );
  202. it( 'should merge unwrapped nodes #5', () => {
  203. const input = '<container:p>' +
  204. '[' +
  205. '<attribute:b view-priority="1"><attribute:u view-priority="1">foo</attribute:u></attribute:b>' +
  206. '<attribute:b view-priority="1"><attribute:u view-priority="1">bar</attribute:u></attribute:b>' +
  207. '<attribute:b view-priority="1"><attribute:u view-priority="1">baz</attribute:u></attribute:b>' +
  208. ']' +
  209. '</container:p>';
  210. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  211. const result = '<container:p>[<attribute:u view-priority="1">foobarbaz</attribute:u>]</container:p>';
  212. testUnwrap( input, attribute, result );
  213. } );
  214. it( 'should unwrap mixed ranges #1', () => {
  215. const input = '<container:p>' +
  216. '[' +
  217. '<attribute:u view-priority="1">' +
  218. '<attribute:b view-priority="1">foo]</attribute:b>' +
  219. '</attribute:u>' +
  220. '</container:p>';
  221. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  222. const result = '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>';
  223. testUnwrap( input, attribute, result );
  224. } );
  225. it( 'should unwrap mixed ranges #2', () => {
  226. testUnwrap(
  227. '<container:p>' +
  228. '[<attribute:u view-priority="1"><attribute:b view-priority="1">foo}</attribute:b></attribute:u>' +
  229. '</container:p>',
  230. '<attribute:b view-priority="1"></attribute:b>',
  231. '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>'
  232. );
  233. } );
  234. it( 'should unwrap single element by removing matching attributes', () => {
  235. testUnwrap(
  236. '<container:p>[<attribute:b view-priority="1" foo="bar" baz="qux">test</attribute:b>]</container:p>',
  237. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  238. '<container:p>[<attribute:b view-priority="1" foo="bar">test</attribute:b>]</container:p>'
  239. );
  240. } );
  241. it( 'should not unwrap single element when attributes are different', () => {
  242. testUnwrap(
  243. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>',
  244. '<attribute:b view-priority="1" baz="qux" test="true"></attribute:b>',
  245. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>'
  246. );
  247. } );
  248. it( 'should unwrap single element by removing matching classes', () => {
  249. testUnwrap(
  250. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  251. '<attribute:b view-priority="1" class="baz foo"></attribute:b>',
  252. '<container:p>[<attribute:b view-priority="1" class="bar">test</attribute:b>]</container:p>'
  253. );
  254. } );
  255. it( 'should not unwrap single element when classes are different', () => {
  256. testUnwrap(
  257. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  258. '<attribute:b view-priority="1" class="baz foo qux"></attribute:b>',
  259. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>'
  260. );
  261. } );
  262. it( 'should unwrap single element by removing matching styles', () => {
  263. testUnwrap(
  264. '<container:p>' +
  265. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px;">test</attribute:b>]' +
  266. '</container:p>',
  267. '<attribute:b view-priority="1" style="position: absolute;"></attribute:b>',
  268. '<container:p>[<attribute:b view-priority="1" style="color:red;top:10px">test</attribute:b>]</container:p>'
  269. );
  270. } );
  271. it( 'should not unwrap single element when styles are different', () => {
  272. testUnwrap(
  273. '<container:p>' +
  274. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  275. '</container:p>',
  276. '<attribute:b view-priority="1" style="position: relative;"></attribute:b>',
  277. '<container:p>' +
  278. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  279. '</container:p>'
  280. );
  281. } );
  282. it( 'should partially unwrap part of a node', () => {
  283. testUnwrap(
  284. '<container:p>' +
  285. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  286. '</container:p>',
  287. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  288. '<container:p>' +
  289. '[<attribute:b view-priority="1" baz="qux">foo</attribute:b>]' +
  290. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  291. '</container:p>'
  292. );
  293. } );
  294. it( 'should partially unwrap a nested attribute', () => {
  295. testUnwrap(
  296. '<container:p>' +
  297. '[<attribute:i view-priority="1">' +
  298. '<attribute:b view-priority="1" style="color:red;position:absolute;top:10px;">test</attribute:b>' +
  299. '</attribute:i>]' +
  300. '</container:p>',
  301. '<attribute:b view-priority="1" style="position: absolute;"></attribute:b>',
  302. '<container:p>' +
  303. '[<attribute:i view-priority="1">' +
  304. '<attribute:b view-priority="1" style="color:red;top:10px">test</attribute:b>' +
  305. '</attribute:i>]' +
  306. '</container:p>'
  307. );
  308. } );
  309. it( 'should partially unwrap a part of a nested attribute', () => {
  310. testUnwrap(
  311. '<container:p>' +
  312. '<attribute:i view-priority="1">' +
  313. '<attribute:b view-priority="1" style="color:red;position:absolute;top:10px;">t{es}t</attribute:b>' +
  314. '</attribute:i>' +
  315. '</container:p>',
  316. '<attribute:b view-priority="1" style="position: absolute;"></attribute:b>',
  317. '<container:p>' +
  318. '<attribute:i view-priority="1">' +
  319. '<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">t</attribute:b>' +
  320. '[<attribute:b view-priority="1" style="color:red;top:10px">es</attribute:b>]' +
  321. '<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">t</attribute:b>' +
  322. '</attribute:i>' +
  323. '</container:p>'
  324. );
  325. } );
  326. it( 'should be merged after being partially unwrapped', () => {
  327. testUnwrap(
  328. '<container:p>' +
  329. '<attribute:b view-priority="1" baz="qux">xyz</attribute:b>' +
  330. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  331. '</container:p>',
  332. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  333. '<container:p>' +
  334. '<attribute:b view-priority="1" baz="qux">xyz{foo</attribute:b>]' +
  335. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  336. '</container:p>'
  337. );
  338. } );
  339. it( 'should unwrap single node in document fragment', () => {
  340. testUnwrap(
  341. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  342. '<attribute:b view-priority="1"></attribute:b>',
  343. '<container:p>[foobar]</container:p>'
  344. );
  345. } );
  346. it( 'should unwrap EmptyElement', () => {
  347. testUnwrap(
  348. '<container:p>[<attribute:b><empty:img></empty:img></attribute:b>]</container:p>',
  349. '<attribute:b></attribute:b>',
  350. '<container:p>[<empty:img></empty:img>]</container:p>'
  351. );
  352. } );
  353. it( 'should throw if range is inside EmptyElement', () => {
  354. const empty = new EmptyElement( document, 'img' );
  355. const attribute = new AttributeElement( document, 'b' );
  356. const container = new ContainerElement( document, 'p', null, [ empty, attribute ] );
  357. const range = Range._createFromParentsAndOffsets( empty, 0, container, 2 );
  358. expectToThrowCKEditorError( () => {
  359. writer.unwrap( range, attribute );
  360. }, 'view-writer-cannot-break-empty-element', document );
  361. } );
  362. it( 'should unwrap UIElement', () => {
  363. testUnwrap(
  364. '<container:p>[<attribute:b><ui:span></ui:span></attribute:b>]</container:p>',
  365. '<attribute:b></attribute:b>',
  366. '<container:p>[<ui:span></ui:span>]</container:p>'
  367. );
  368. } );
  369. it( 'should throw if range is placed inside UIElement', () => {
  370. const uiElement = new UIElement( document, 'span' );
  371. const attribute = new AttributeElement( document, 'b' );
  372. const container = new ContainerElement( document, 'p', null, [ uiElement, attribute ] );
  373. const range = Range._createFromParentsAndOffsets( uiElement, 0, container, 2 );
  374. expectToThrowCKEditorError( () => {
  375. writer.unwrap( range, attribute );
  376. }, 'view-writer-cannot-break-ui-element', document );
  377. } );
  378. it( 'should unwrap if both elements have same id', () => {
  379. const unwrapper = writer.createAttributeElement( 'span', null, { id: 'foo' } );
  380. const attribute = writer.createAttributeElement( 'span', null, { id: 'foo' } );
  381. const container = writer.createContainerElement( 'div' );
  382. writer.insert( writer.createPositionAt( container, 0 ), attribute );
  383. writer.unwrap( Range._createOn( attribute ), unwrapper );
  384. expect( stringify( container, null, { showType: false, showPriority: false } ) ).to.equal( '<div></div>' );
  385. } );
  386. it( 'should always unwrap whole element if both elements have same id', () => {
  387. const unwrapper = writer.createAttributeElement( 'b', null, { id: 'foo' } );
  388. const attribute = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'foo' } );
  389. const container = writer.createContainerElement( 'div' );
  390. writer.insert( writer.createPositionAt( container, 0 ), attribute );
  391. writer.unwrap( writer.createRangeOn( attribute ), unwrapper );
  392. expect( stringify( container, null, { showType: false, showPriority: false } ) ).to.equal( '<div></div>' );
  393. } );
  394. // Below are tests for elements with different ids.
  395. // Only partial unwrapping is tested because elements with different ids are never similar.
  396. // This means that unwrapping of whole element is not possible in this case.
  397. it( 'should not unwrap matching attributes if the element to unwrap has id', () => {
  398. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' } );
  399. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' }, { id: 'id' } );
  400. const container = writer.createContainerElement( 'div' );
  401. writer.insert( writer.createPositionAt( container, 0 ), attribute );
  402. writer.unwrap( writer.createRangeOn( attribute ), unwrapper );
  403. const view = stringify( container, null, { showType: false, showPriority: false } );
  404. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  405. } );
  406. it( 'should not unwrap matching attributes if the unwrapping element has id', () => {
  407. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'id' } );
  408. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' } );
  409. const container = writer.createContainerElement( 'div' );
  410. writer.insert( writer.createPositionAt( container, 0 ), attribute );
  411. writer.unwrap( writer.createRangeOn( attribute ), unwrapper );
  412. const view = stringify( container, null, { showType: false, showPriority: false } );
  413. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  414. } );
  415. it( 'should not unwrap matching attributes if the elements have different id', () => {
  416. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'a' } );
  417. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' }, { id: 'b' } );
  418. const container = writer.createContainerElement( 'div' );
  419. writer.insert( writer.createPositionAt( container, 0 ), attribute );
  420. writer.unwrap( writer.createRangeOn( attribute ), unwrapper );
  421. const view = stringify( container, null, { showType: false, showPriority: false } );
  422. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  423. } );
  424. } );
  425. } );