8
0

unwrap.js 19 KB

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