unwrap.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. /**
  2. * @license Copyright (c) 2003-2017, 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. describe( 'Writer', () => {
  17. describe( 'unwrap()', () => {
  18. let writer;
  19. // Executes test using `parse` and `stringify` utils functions.
  20. //
  21. // @param {String} input
  22. // @param {String} unwrapAttribute
  23. // @param {String} expected
  24. function test( input, unwrapAttribute, expected ) {
  25. const { view, selection } = parse( input );
  26. const newRange = writer.unwrap( selection.getFirstRange(), parse( unwrapAttribute ) );
  27. expect( stringify( view.root, newRange, { showType: true, showPriority: true } ) ).to.equal( expected );
  28. }
  29. before( () => {
  30. writer = new Writer();
  31. } );
  32. it( 'should do nothing on collapsed ranges', () => {
  33. test(
  34. '<container:p>f{}oo</container:p>',
  35. '<attribute:b view-priority="10"></attribute:b>',
  36. '<container:p>f{}oo</container:p>'
  37. );
  38. } );
  39. it( 'should do nothing on single text node', () => {
  40. test(
  41. '<container:p>[foobar]</container:p>',
  42. '<attribute:b view-priority="1"></attribute:b>',
  43. '<container:p>[foobar]</container:p>'
  44. );
  45. } );
  46. it( 'should throw error when element is not instance of AttributeElement', () => {
  47. const container = new ContainerElement( 'p', null, new AttributeElement( 'b', null, new Text( 'foo' ) ) );
  48. const range = new Range(
  49. new Position( container, 0 ),
  50. new Position( container, 1 )
  51. );
  52. const b = new Element( 'b' );
  53. expect( () => {
  54. writer.unwrap( range, b );
  55. } ).to.throw( CKEditorError, 'view-writer-unwrap-invalid-attribute' );
  56. } );
  57. it( 'should throw error when range placed in two containers', () => {
  58. const container1 = new ContainerElement( 'p' );
  59. const container2 = new ContainerElement( 'p' );
  60. const range = new Range(
  61. new Position( container1, 0 ),
  62. new Position( container2, 1 )
  63. );
  64. const b = new AttributeElement( 'b' );
  65. expect( () => {
  66. writer.unwrap( range, b );
  67. } ).to.throw( CKEditorError, 'view-writer-invalid-range-container' );
  68. } );
  69. it( 'should throw when range has no parent container', () => {
  70. const el = new AttributeElement( 'b' );
  71. const b = new AttributeElement( 'b' );
  72. expect( () => {
  73. writer.unwrap( Range.createFromParentsAndOffsets( el, 0, el, 0 ), b );
  74. } ).to.throw( CKEditorError, 'view-writer-invalid-range-container' );
  75. } );
  76. it( 'should unwrap single node', () => {
  77. test(
  78. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  79. '<attribute:b view-priority="1"></attribute:b>',
  80. '<container:p>[foobar]</container:p>'
  81. );
  82. } );
  83. it( 'should not unwrap attributes with different priorities #1', () => {
  84. test(
  85. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  86. '<attribute:b view-priority="2"></attribute:b>',
  87. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>'
  88. );
  89. } );
  90. it( 'should not unwrap attributes with different priorities #2', () => {
  91. test(
  92. '<container:p>' +
  93. '[' +
  94. '<attribute:b view-priority="2">foo</attribute:b>' +
  95. '<attribute:b view-priority="1">bar</attribute:b>' +
  96. '<attribute:b view-priority="2">baz</attribute:b>' +
  97. ']' +
  98. '</container:p>',
  99. '<attribute:b view-priority="2"></attribute:b>',
  100. '<container:p>[foo<attribute:b view-priority="1">bar</attribute:b>baz]</container:p>'
  101. );
  102. } );
  103. it( 'should unwrap part of the node', () => {
  104. test(
  105. '<container:p>[baz<attribute:b view-priority="1">foo}bar</attribute:b></container:p>',
  106. '<attribute:b view-priority="1"></attribute:b>',
  107. '<container:p>[bazfoo]<attribute:b view-priority="1">bar</attribute:b></container:p>'
  108. );
  109. } );
  110. it( 'should support unicode', () => {
  111. test(
  112. '<container:p>[நிலை<attribute:b view-priority="1">க்}கு</attribute:b></container:p>',
  113. '<attribute:b view-priority="1"></attribute:b>',
  114. '<container:p>[நிலைக்]<attribute:b view-priority="1">கு</attribute:b></container:p>'
  115. );
  116. } );
  117. it( 'should unwrap nested attributes', () => {
  118. test(
  119. '<container:p>' +
  120. '[<attribute:u view-priority="1"><attribute:b view-priority="1">foobar</attribute:b></attribute:u>]' +
  121. '</container:p>',
  122. '<attribute:b view-priority="1"></attribute:b>',
  123. '<container:p>[<attribute:u view-priority="1">foobar</attribute:u>]</container:p>'
  124. );
  125. } );
  126. it( 'should merge unwrapped nodes #1', () => {
  127. test(
  128. '<container:p>foo[<attribute:b view-priority="1">bar</attribute:b>]baz</container:p>',
  129. '<attribute:b view-priority="1"></attribute:b>',
  130. '<container:p>foo{bar}baz</container:p>'
  131. );
  132. } );
  133. it( 'should merge unwrapped nodes #2', () => {
  134. const input = '<container:p>' +
  135. 'foo' +
  136. '<attribute:u view-priority="1">bar</attribute:u>' +
  137. '[' +
  138. '<attribute:b view-priority="1">' +
  139. '<attribute:u view-priority="1">bazqux</attribute:u>' +
  140. '</attribute:b>' +
  141. ']' +
  142. '</container:p>';
  143. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  144. const result = '<container:p>foo<attribute:u view-priority="1">bar{bazqux</attribute:u>]</container:p>';
  145. test( input, attribute, result );
  146. } );
  147. it( 'should merge unwrapped nodes #3', () => {
  148. const input = '<container:p>' +
  149. 'foo' +
  150. '<attribute:u view-priority="1">bar</attribute:u>' +
  151. '[' +
  152. '<attribute:b view-priority="1">' +
  153. '<attribute:u view-priority="1">baz}qux</attribute:u>' +
  154. '</attribute:b>' +
  155. '</container:p>';
  156. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  157. const result = '<container:p>' +
  158. 'foo' +
  159. '<attribute:u view-priority="1">bar{baz</attribute:u>]' +
  160. '<attribute:b view-priority="1">' +
  161. '<attribute:u view-priority="1">qux</attribute:u>' +
  162. '</attribute:b>' +
  163. '</container:p>';
  164. test( input, attribute, result );
  165. } );
  166. it( 'should merge unwrapped nodes #4', () => {
  167. const input = '<container:p>' +
  168. 'foo' +
  169. '<attribute:u view-priority="1">bar</attribute:u>' +
  170. '[' +
  171. '<attribute:b view-priority="1">' +
  172. '<attribute:u view-priority="1">baz</attribute:u>' +
  173. '</attribute:b>' +
  174. ']' +
  175. '<attribute:u view-priority="1">qux</attribute:u>' +
  176. '</container:p>';
  177. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  178. const result = '<container:p>' +
  179. 'foo' +
  180. '<attribute:u view-priority="1">bar{baz}qux</attribute:u>' +
  181. '</container:p>';
  182. test( input, attribute, result );
  183. } );
  184. it( 'should merge unwrapped nodes #5', () => {
  185. const input = '<container:p>' +
  186. '[' +
  187. '<attribute:b view-priority="1"><attribute:u view-priority="1">foo</attribute:u></attribute:b>' +
  188. '<attribute:b view-priority="1"><attribute:u view-priority="1">bar</attribute:u></attribute:b>' +
  189. '<attribute:b view-priority="1"><attribute:u view-priority="1">baz</attribute:u></attribute:b>' +
  190. ']' +
  191. '</container:p>';
  192. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  193. const result = '<container:p>[<attribute:u view-priority="1">foobarbaz</attribute:u>]</container:p>';
  194. test( input, attribute, result );
  195. } );
  196. it( 'should unwrap mixed ranges #1', () => {
  197. const input = '<container:p>' +
  198. '[' +
  199. '<attribute:u view-priority="1">' +
  200. '<attribute:b view-priority="1">foo]</attribute:b>' +
  201. '</attribute:u>' +
  202. '</container:p>';
  203. const attribute = '<attribute:b view-priority="1"></attribute:b>';
  204. const result = '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>';
  205. test( input, attribute, result );
  206. } );
  207. it( 'should unwrap mixed ranges #2', () => {
  208. test(
  209. '<container:p>' +
  210. '[<attribute:u view-priority="1"><attribute:b view-priority="1">foo}</attribute:b></attribute:u>' +
  211. '</container:p>',
  212. '<attribute:b view-priority="1"></attribute:b>',
  213. '<container:p>[<attribute:u view-priority="1">foo</attribute:u>]</container:p>'
  214. );
  215. } );
  216. it( 'should unwrap single element by removing matching attributes', () => {
  217. test(
  218. '<container:p>[<attribute:b view-priority="1" foo="bar" baz="qux">test</attribute:b>]</container:p>',
  219. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  220. '<container:p>[<attribute:b view-priority="1" foo="bar">test</attribute:b>]</container:p>'
  221. );
  222. } );
  223. it( 'should not unwrap single element when attributes are different', () => {
  224. test(
  225. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>',
  226. '<attribute:b view-priority="1" baz="qux" test="true"></attribute:b>',
  227. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar">test</attribute:b>]</container:p>'
  228. );
  229. } );
  230. it( 'should unwrap single element by removing matching classes', () => {
  231. test(
  232. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  233. '<attribute:b view-priority="1" class="baz foo"></attribute:b>',
  234. '<container:p>[<attribute:b view-priority="1" class="bar">test</attribute:b>]</container:p>'
  235. );
  236. } );
  237. it( 'should not unwrap single element when classes are different', () => {
  238. test(
  239. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>',
  240. '<attribute:b view-priority="1" class="baz foo qux"></attribute:b>',
  241. '<container:p>[<attribute:b view-priority="1" class="bar baz foo">test</attribute:b>]</container:p>'
  242. );
  243. } );
  244. it( 'should unwrap single element by removing matching styles', () => {
  245. test(
  246. '<container:p>' +
  247. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px;">test</attribute:b>]' +
  248. '</container:p>',
  249. '<attribute:b view-priority="1" style="position: absolute;"></attribute:b>',
  250. '<container:p>[<attribute:b view-priority="1" style="color:red;top:10px">test</attribute:b>]</container:p>'
  251. );
  252. } );
  253. it( 'should not unwrap single element when styles are different', () => {
  254. test(
  255. '<container:p>' +
  256. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  257. '</container:p>',
  258. '<attribute:b view-priority="1" style="position: relative;"></attribute:b>',
  259. '<container:p>' +
  260. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:10px">test</attribute:b>]' +
  261. '</container:p>'
  262. );
  263. } );
  264. it( 'should partially unwrap part of a node', () => {
  265. test(
  266. '<container:p>' +
  267. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  268. '</container:p>',
  269. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  270. '<container:p>' +
  271. '[<attribute:b view-priority="1" baz="qux">foo</attribute:b>]' +
  272. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  273. '</container:p>'
  274. );
  275. } );
  276. it( 'should be merged after being partially unwrapped', () => {
  277. test(
  278. '<container:p>' +
  279. '<attribute:b view-priority="1" baz="qux">xyz</attribute:b>' +
  280. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo}bar</attribute:b>' +
  281. '</container:p>',
  282. '<attribute:b view-priority="1" foo="bar"></attribute:b>',
  283. '<container:p>' +
  284. '<attribute:b view-priority="1" baz="qux">xyz{foo</attribute:b>]' +
  285. '<attribute:b view-priority="1" baz="qux" foo="bar">bar</attribute:b>' +
  286. '</container:p>'
  287. );
  288. } );
  289. it( 'should unwrap single node in document fragment', () => {
  290. test(
  291. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>',
  292. '<attribute:b view-priority="1"></attribute:b>',
  293. '<container:p>[foobar]</container:p>'
  294. );
  295. } );
  296. it( 'should unwrap EmptyElement', () => {
  297. test(
  298. '<container:p>[<attribute:b><empty:img></empty:img></attribute:b>]</container:p>',
  299. '<attribute:b></attribute:b>',
  300. '<container:p>[<empty:img></empty:img>]</container:p>'
  301. );
  302. } );
  303. it( 'should throw if range is inside EmptyElement', () => {
  304. const empty = new EmptyElement( 'img' );
  305. const attribute = new AttributeElement( 'b' );
  306. const container = new ContainerElement( 'p', null, [ empty, attribute ] );
  307. const range = Range.createFromParentsAndOffsets( empty, 0, container, 2 );
  308. expect( () => {
  309. writer.unwrap( range, attribute );
  310. } ).to.throw( CKEditorError, 'view-writer-cannot-break-empty-element' );
  311. } );
  312. it( 'should unwrap UIElement', () => {
  313. test(
  314. '<container:p>[<attribute:b><ui:span></ui:span></attribute:b>]</container:p>',
  315. '<attribute:b></attribute:b>',
  316. '<container:p>[<ui:span></ui:span>]</container:p>'
  317. );
  318. } );
  319. it( 'should throw if range is placed inside UIElement', () => {
  320. const uiElement = new UIElement( 'span' );
  321. const attribute = new AttributeElement( 'b' );
  322. const container = new ContainerElement( 'p', null, [ uiElement, attribute ] );
  323. const range = Range.createFromParentsAndOffsets( uiElement, 0, container, 2 );
  324. expect( () => {
  325. writer.unwrap( range, attribute );
  326. } ).to.throw( CKEditorError, 'view-writer-cannot-break-ui-element' );
  327. } );
  328. } );
  329. } );