unwrap.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Writer from '../../../src/view/writer';
  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( 'Writer', () => {
  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 Writer( 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 merge unwrapped nodes #1', () => {
  128. test(
  129. '<container:p>foo[<attribute:b view-priority="1">bar</attribute:b>]baz</container:p>',
  130. '<attribute:b view-priority="1"></attribute:b>',
  131. '<container:p>foo{bar}baz</container:p>'
  132. );
  133. } );
  134. it( 'should merge unwrapped nodes #2', () => {
  135. const input = '<container:p>' +
  136. 'foo' +
  137. '<attribute:u view-priority="1">bar</attribute:u>' +
  138. '[' +
  139. '<attribute:b view-priority="1">' +
  140. '<attribute:u view-priority="1">bazqux</attribute:u>' +
  141. '</attribute:b>' +
  142. ']' +
  143. '</container:p>';
  144. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  145. const result = '<container:p>foo<attribute:u view-priority="1">bar{bazqux</attribute:u>]</container:p>';
  146. test( input, attribute, result );
  147. } );
  148. it( 'should merge unwrapped nodes #3', () => {
  149. const input = '<container:p>' +
  150. 'foo' +
  151. '<attribute:u view-priority="1">bar</attribute:u>' +
  152. '[' +
  153. '<attribute:b view-priority="1">' +
  154. '<attribute:u view-priority="1">baz}qux</attribute:u>' +
  155. '</attribute:b>' +
  156. '</container:p>';
  157. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  158. const result = '<container:p>' +
  159. 'foo' +
  160. '<attribute:u view-priority="1">bar{baz</attribute:u>]' +
  161. '<attribute:b view-priority="1">' +
  162. '<attribute:u view-priority="1">qux</attribute:u>' +
  163. '</attribute:b>' +
  164. '</container:p>';
  165. test( input, attribute, result );
  166. } );
  167. it( 'should merge unwrapped nodes #4', () => {
  168. const input = '<container:p>' +
  169. 'foo' +
  170. '<attribute:u view-priority="1">bar</attribute:u>' +
  171. '[' +
  172. '<attribute:b view-priority="1">' +
  173. '<attribute:u view-priority="1">baz</attribute:u>' +
  174. '</attribute:b>' +
  175. ']' +
  176. '<attribute:u view-priority="1">qux</attribute:u>' +
  177. '</container:p>';
  178. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  179. const result = '<container:p>' +
  180. 'foo' +
  181. '<attribute:u view-priority="1">bar{baz}qux</attribute:u>' +
  182. '</container:p>';
  183. test( input, attribute, result );
  184. } );
  185. it( 'should merge unwrapped nodes #5', () => {
  186. const input = '<container:p>' +
  187. '[' +
  188. '<attribute:b view-priority="1"><attribute:u view-priority="1">foo</attribute:u></attribute:b>' +
  189. '<attribute:b view-priority="1"><attribute:u view-priority="1">bar</attribute:u></attribute:b>' +
  190. '<attribute:b view-priority="1"><attribute:u view-priority="1">baz</attribute:u></attribute:b>' +
  191. ']' +
  192. '</container:p>';
  193. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  194. const result = '<container:p>[<attribute:u view-priority="1">foobarbaz</attribute:u>]</container:p>';
  195. test( input, attribute, result );
  196. } );
  197. it( 'should unwrap mixed ranges #1', () => {
  198. const input = '<container:p>' +
  199. '[' +
  200. '<attribute:u view-priority="1">' +
  201. '<attribute:b view-priority="1">foo]</attribute:b>' +
  202. '</attribute:u>' +
  203. '</container:p>';
  204. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  205. const result = '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>';
  206. test( input, attribute, result );
  207. } );
  208. it( 'should unwrap mixed ranges #2', () => {
  209. test(
  210. '<container:p>' +
  211. '[<attribute:u view-priority="1"><attribute:b view-priority="1">foo}</attribute:b></attribute:u>' +
  212. '</container:p>',
  213. '<attribute:b view-priority="1"></attribute:b>',
  214. '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>'
  215. );
  216. } );
  217. it( 'should unwrap single element by removing matching attributes', () => {
  218. test(
  219. '<container:p>[<attribute:b view-priority="1" foo="bar" baz="qux">test</attribute:b>]</container:p>',
  220. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  221. '<container:p>[<attribute:b view-priority="1" foo="bar">test</attribute:b>]</container:p>'
  222. );
  223. } );
  224. it( 'should not unwrap single element when attributes are different', () => {
  225. test(
  226. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>',
  227. '<attribute:b view-priority="1" baz="qux" test="true"></attribute:b>',
  228. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>'
  229. );
  230. } );
  231. it( 'should unwrap single element by removing matching classes', () => {
  232. test(
  233. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  234. '<attribute:b view-priority="1" class="baz foo"></attribute:b>',
  235. '<container:p>[<attribute:b view-priority="1" class="bar">test</attribute:b>]</container:p>'
  236. );
  237. } );
  238. it( 'should not unwrap single element when classes are different', () => {
  239. test(
  240. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  241. '<attribute:b view-priority="1" class="baz foo qux"></attribute:b>',
  242. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>'
  243. );
  244. } );
  245. it( 'should unwrap single element by removing matching styles', () => {
  246. test(
  247. '<container:p>' +
  248. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px;">test</attribute:b>]' +
  249. '</container:p>',
  250. '<attribute:b view-priority="1" style="position: absolute;"></attribute:b>',
  251. '<container:p>[<attribute:b view-priority="1" style="color:red;top:10px">test</attribute:b>]</container:p>'
  252. );
  253. } );
  254. it( 'should not unwrap single element when styles are different', () => {
  255. test(
  256. '<container:p>' +
  257. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  258. '</container:p>',
  259. '<attribute:b view-priority="1" style="position: relative;"></attribute:b>',
  260. '<container:p>' +
  261. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  262. '</container:p>'
  263. );
  264. } );
  265. it( 'should partially unwrap part of a node', () => {
  266. test(
  267. '<container:p>' +
  268. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  269. '</container:p>',
  270. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  271. '<container:p>' +
  272. '[<attribute:b view-priority="1" baz="qux">foo</attribute:b>]' +
  273. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  274. '</container:p>'
  275. );
  276. } );
  277. it( 'should be merged after being partially unwrapped', () => {
  278. test(
  279. '<container:p>' +
  280. '<attribute:b view-priority="1" baz="qux">xyz</attribute:b>' +
  281. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  282. '</container:p>',
  283. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  284. '<container:p>' +
  285. '<attribute:b view-priority="1" baz="qux">xyz{foo</attribute:b>]' +
  286. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  287. '</container:p>'
  288. );
  289. } );
  290. it( 'should unwrap single node in document fragment', () => {
  291. test(
  292. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  293. '<attribute:b view-priority="1"></attribute:b>',
  294. '<container:p>[foobar]</container:p>'
  295. );
  296. } );
  297. it( 'should unwrap EmptyElement', () => {
  298. test(
  299. '<container:p>[<attribute:b><empty:img></empty:img></attribute:b>]</container:p>',
  300. '<attribute:b></attribute:b>',
  301. '<container:p>[<empty:img></empty:img>]</container:p>'
  302. );
  303. } );
  304. it( 'should throw if range is inside EmptyElement', () => {
  305. const empty = new EmptyElement( 'img' );
  306. const attribute = new AttributeElement( 'b' );
  307. const container = new ContainerElement( 'p', null, [ empty, attribute ] );
  308. const range = Range.createFromParentsAndOffsets( empty, 0, container, 2 );
  309. expect( () => {
  310. writer.unwrap( range, attribute );
  311. } ).to.throw( CKEditorError, 'view-writer-cannot-break-empty-element' );
  312. } );
  313. it( 'should unwrap UIElement', () => {
  314. test(
  315. '<container:p>[<attribute:b><ui:span></ui:span></attribute:b>]</container:p>',
  316. '<attribute:b></attribute:b>',
  317. '<container:p>[<ui:span></ui:span>]</container:p>'
  318. );
  319. } );
  320. it( 'should throw if range is placed inside UIElement', () => {
  321. const uiElement = new UIElement( 'span' );
  322. const attribute = new AttributeElement( 'b' );
  323. const container = new ContainerElement( 'p', null, [ uiElement, attribute ] );
  324. const range = Range.createFromParentsAndOffsets( uiElement, 0, container, 2 );
  325. expect( () => {
  326. writer.unwrap( range, attribute );
  327. } ).to.throw( CKEditorError, 'view-writer-cannot-break-ui-element' );
  328. } );
  329. it( 'should unwrap if both elements have same id', () => {
  330. const unwrapper = writer.createAttributeElement( 'span', null, { id: 'foo' } );
  331. const attribute = writer.createAttributeElement( 'span', null, { id: 'foo' } );
  332. const container = writer.createContainerElement( 'div' );
  333. writer.insert( Position.createAt( container, 0 ), attribute );
  334. writer.unwrap( Range.createOn( attribute ), unwrapper );
  335. expect( stringify( container, null, { showType: false, showPriority: false } ) ).to.equal( '<div></div>' );
  336. } );
  337. it( 'should always unwrap whole element if both elements have same id', () => {
  338. const unwrapper = writer.createAttributeElement( 'b', null, { id: 'foo' } );
  339. const attribute = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'foo' } );
  340. const container = writer.createContainerElement( 'div' );
  341. writer.insert( Position.createAt( container, 0 ), attribute );
  342. writer.unwrap( Range.createOn( attribute ), unwrapper );
  343. expect( stringify( container, null, { showType: false, showPriority: false } ) ).to.equal( '<div></div>' );
  344. } );
  345. // Below are tests for elements with different ids.
  346. // Only partial unwrapping is tested because elements with different ids are never similar.
  347. // This means that unwrapping of whole element is not possible in this case.
  348. it( 'should not unwrap matching attributes if the element to unwrap has id', () => {
  349. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' } );
  350. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' }, { id: 'id' } );
  351. const container = writer.createContainerElement( 'div' );
  352. writer.insert( Position.createAt( container, 0 ), attribute );
  353. writer.unwrap( Range.createOn( attribute ), unwrapper );
  354. const view = stringify( container, null, { showType: false, showPriority: false } );
  355. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  356. } );
  357. it( 'should not unwrap matching attributes if the unwrapping element has id', () => {
  358. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'id' } );
  359. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' } );
  360. const container = writer.createContainerElement( 'div' );
  361. writer.insert( Position.createAt( container, 0 ), attribute );
  362. writer.unwrap( Range.createOn( attribute ), unwrapper );
  363. const view = stringify( container, null, { showType: false, showPriority: false } );
  364. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  365. } );
  366. it( 'should not unwrap matching attributes if the elements have different id', () => {
  367. const unwrapper = writer.createAttributeElement( 'span', { foo: 'foo' }, { id: 'a' } );
  368. const attribute = writer.createAttributeElement( 'span', { foo: 'foo', bar: 'bar' }, { id: 'b' } );
  369. const container = writer.createContainerElement( 'div' );
  370. writer.insert( Position.createAt( container, 0 ), attribute );
  371. writer.unwrap( Range.createOn( attribute ), unwrapper );
  372. const view = stringify( container, null, { showType: false, showPriority: false } );
  373. expect( view ).to.equal( '<div><span bar="bar" foo="foo"></span></div>' );
  374. } );
  375. } );
  376. } );