unwrap.js 12 KB

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