unwrap.js 19 KB

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