wrap.js 11 KB

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