wrap.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import { wrap } from '../../../src/view/writer';
  6. import Document from '../../../src/view/document';
  7. import DocumentFragment from '../../../src/view/documentfragment';
  8. import Element from '../../../src/view/element';
  9. import ContainerElement from '../../../src/view/containerelement';
  10. import AttributeElement from '../../../src/view/attributeelement';
  11. import EmptyElement from '../../../src/view/emptyelement';
  12. import UIElement from '../../../src/view/uielement';
  13. import Position from '../../../src/view/position';
  14. import Range from '../../../src/view/range';
  15. import Text from '../../../src/view/text';
  16. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  17. import { stringify, parse } from '../../../src/dev-utils/view';
  18. import createViewRoot from '../_utils/createroot';
  19. describe( 'writer', () => {
  20. describe( 'wrap', () => {
  21. describe( 'non-collapsed range', () => {
  22. /**
  23. * Executes test using `parse` and `stringify` utils functions.
  24. *
  25. * @param {String} input
  26. * @param {String} wrapAttribute
  27. * @param {String} expected
  28. */
  29. function test( input, wrapAttribute, expected ) {
  30. const { view, selection } = parse( input );
  31. const newRange = wrap( selection.getFirstRange(), parse( wrapAttribute ) );
  32. expect( stringify( view.root, newRange, { showType: true, showPriority: true } ) ).to.equal( expected );
  33. }
  34. it( 'wraps single text node', () => {
  35. test(
  36. '<container:p>[foobar]</container:p>',
  37. '<attribute:b view-priority="1"></attribute:b>',
  38. '<container:p>[<attribute:b view-priority="1">foobar</attribute:b>]</container:p>'
  39. );
  40. } );
  41. it( 'wraps single text node in document fragment', () => {
  42. test(
  43. '{foobar}',
  44. '<attribute:b view-priority="1"></attribute:b>',
  45. '[<attribute:b view-priority="1">foobar</attribute:b>]'
  46. );
  47. } );
  48. it( 'should throw error when element is not instance of AttributeElement', () => {
  49. const container = new ContainerElement( 'p', null, new Text( 'foo' ) );
  50. const range = new Range(
  51. new Position( container, 0 ),
  52. new Position( container, 1 )
  53. );
  54. const b = new Element( 'b' );
  55. expect( () => {
  56. wrap( range, b );
  57. } ).to.throw( CKEditorError, 'view-writer-wrap-invalid-attribute' );
  58. } );
  59. it( 'should throw error when range placed in two containers', () => {
  60. const container1 = new ContainerElement( 'p' );
  61. const container2 = new ContainerElement( 'p' );
  62. const range = new Range(
  63. new Position( container1, 0 ),
  64. new Position( container2, 1 )
  65. );
  66. const b = new AttributeElement( 'b' );
  67. expect( () => {
  68. wrap( range, b );
  69. } ).to.throw( CKEditorError, 'view-writer-invalid-range-container' );
  70. } );
  71. it( 'should throw when range has no parent container', () => {
  72. const el = new AttributeElement( 'b' );
  73. const b = new AttributeElement( 'b' );
  74. expect( () => {
  75. wrap( Range.createFromParentsAndOffsets( el, 0, el, 0 ), b );
  76. } ).to.throw( CKEditorError, 'view-writer-invalid-range-container' );
  77. } );
  78. it( 'wraps part of a single text node #1', () => {
  79. test(
  80. '<container:p>[foo}bar</container:p>',
  81. '<attribute:b view-priority="1"></attribute:b>',
  82. '<container:p>[<attribute:b view-priority="1">foo</attribute:b>]bar</container:p>'
  83. );
  84. } );
  85. it( 'wraps part of a single text node #2', () => {
  86. test(
  87. '<container:p>{foo}bar</container:p>',
  88. '<attribute:b view-priority="1"></attribute:b>',
  89. '<container:p>[<attribute:b view-priority="1">foo</attribute:b>]bar</container:p>'
  90. );
  91. } );
  92. it( 'should support unicode', () => {
  93. test(
  94. '<container:p>நி{லை}க்கு</container:p>',
  95. '<attribute:b view-priority="1"></attribute:b>',
  96. '<container:p>நி[<attribute:b view-priority="1">லை</attribute:b>]க்கு</container:p>'
  97. );
  98. } );
  99. it( 'wraps part of a single text node #3', () => {
  100. test(
  101. '<container:p>foo{bar}</container:p>',
  102. '<attribute:b view-priority="1"></attribute:b>',
  103. '<container:p>foo[<attribute:b view-priority="1">bar</attribute:b>]</container:p>'
  104. );
  105. } );
  106. it( 'should not wrap inside nested containers', () => {
  107. test(
  108. '<container:div>[foobar<container:p>baz</container:p>]</container:div>',
  109. '<attribute:b view-priority="1"></attribute:b>',
  110. '<container:div>[<attribute:b view-priority="1">foobar</attribute:b><container:p>baz</container:p>]</container:div>'
  111. );
  112. } );
  113. it( 'wraps according to priorities', () => {
  114. test(
  115. '<container:p>[<attribute:u view-priority="1">foobar</attribute:u>]</container:p>',
  116. '<attribute:b view-priority="2"></attribute:b>',
  117. '<container:p>' +
  118. '[<attribute:u view-priority="1"><attribute:b view-priority="2">foobar</attribute:b></attribute:u>]' +
  119. '</container:p>'
  120. );
  121. } );
  122. it( 'merges wrapped nodes #1', () => {
  123. test(
  124. '<container:p>' +
  125. '[<attribute:b view-priority="1">foo</attribute:b>bar<attribute:b view-priority="1">baz</attribute:b>]' +
  126. '</container:p>',
  127. '<attribute:b view-priority="1"></attribute:b>',
  128. '<container:p>[<attribute:b view-priority="1">foobarbaz</attribute:b>]</container:p>'
  129. );
  130. } );
  131. it( 'merges wrapped nodes #2', () => {
  132. test(
  133. '<container:p><attribute:b view-priority="1">foo</attribute:b>[bar}baz</container:p>',
  134. '<attribute:b view-priority="1"></attribute:b>',
  135. '<container:p><attribute:b view-priority="1">foo{bar</attribute:b>]baz</container:p>'
  136. );
  137. } );
  138. it( 'merges wrapped nodes #3', () => {
  139. test(
  140. '<container:p><attribute:b view-priority="1">foobar</attribute:b>[baz]</container:p>',
  141. '<attribute:b view-priority="1"></attribute:b>',
  142. '<container:p><attribute:b view-priority="1">foobar{baz</attribute:b>]</container:p>'
  143. );
  144. } );
  145. it( 'merges wrapped nodes #4', () => {
  146. test(
  147. '<container:p>[foo<attribute:i view-priority="1">bar</attribute:i>]baz</container:p>',
  148. '<attribute:b view-priority="1"></attribute:b>',
  149. '<container:p>' +
  150. '[<attribute:b view-priority="1">foo<attribute:i view-priority="1">bar</attribute:i></attribute:b>]baz' +
  151. '</container:p>'
  152. );
  153. } );
  154. it( 'merges wrapped nodes #5', () => {
  155. test(
  156. '<container:p>[foo<attribute:i view-priority="1">bar</attribute:i>baz]</container:p>',
  157. '<attribute:b view-priority="2"></attribute:b>',
  158. '<container:p>' +
  159. '[' +
  160. '<attribute:b view-priority="2">foo</attribute:b>' +
  161. '<attribute:i view-priority="1">' +
  162. '<attribute:b view-priority="2">bar</attribute:b>' +
  163. '</attribute:i>' +
  164. '<attribute:b view-priority="2">baz</attribute:b>' +
  165. ']' +
  166. '</container:p>'
  167. );
  168. } );
  169. it( 'merges wrapped nodes #6', () => {
  170. test(
  171. '<container:div>f{o<attribute:strong>ob</attribute:strong>a}r</container:div>',
  172. '<attribute:span view-priority="1"></attribute:span>',
  173. '<container:div>f[' +
  174. '<attribute:span view-priority="1">o' +
  175. '<attribute:strong view-priority="10">ob</attribute:strong>' +
  176. 'a</attribute:span>' +
  177. ']r</container:div>'
  178. );
  179. } );
  180. it( 'should wrap single element by merging attributes', () => {
  181. test(
  182. '<container:p>[<attribute:b view-priority="1" foo="bar" one="two"></attribute:b>]</container:p>',
  183. '<attribute:b view-priority="1" baz="qux" one="two"></attribute:b>',
  184. '<container:p>[<attribute:b view-priority="1" baz="qux" foo="bar" one="two"></attribute:b>]</container:p>'
  185. );
  186. } );
  187. it( 'should not merge attributes when they differ', () => {
  188. test(
  189. '<container:p>[<attribute:b view-priority="1" foo="bar">text</attribute:b>]</container:p>',
  190. '<attribute:b view-priority="1" foo="baz"></attribute:b>',
  191. '<container:p>' +
  192. '[<attribute:b view-priority="1" foo="bar">' +
  193. '<attribute:b view-priority="1" foo="baz">text</attribute:b>' +
  194. '</attribute:b>]' +
  195. '</container:p>'
  196. );
  197. } );
  198. it( 'should wrap single element by merging classes', () => {
  199. test(
  200. '<container:p>[<attribute:b view-priority="1" class="foo bar baz"></attribute:b>]</container:p>',
  201. '<attribute:b view-priority="1" class="foo bar qux jax"></attribute:b>',
  202. '<container:p>[<attribute:b view-priority="1" class="bar baz foo jax qux"></attribute:b>]</container:p>'
  203. );
  204. } );
  205. it( 'should wrap single element by merging styles', () => {
  206. test(
  207. '<container:p>' +
  208. '[<attribute:b view-priority="1" style="color:red; position: absolute"></attribute:b>]' +
  209. '</container:p>',
  210. '<attribute:b view-priority="1" style="color:red; top: 20px"></attribute:b>',
  211. '<container:p>' +
  212. '[<attribute:b view-priority="1" style="color:red;position:absolute;top:20px"></attribute:b>]' +
  213. '</container:p>'
  214. );
  215. } );
  216. it( 'should not merge styles when they differ', () => {
  217. test(
  218. '<container:p>[<attribute:b view-priority="1" style="color:red"></attribute:b>]</container:p>',
  219. '<attribute:b view-priority="1" style="color:black"></attribute:b>',
  220. '<container:p>' +
  221. '[' +
  222. '<attribute:b view-priority="1" style="color:black">' +
  223. '<attribute:b view-priority="1" style="color:red"></attribute:b>' +
  224. '</attribute:b>' +
  225. ']' +
  226. '</container:p>'
  227. );
  228. } );
  229. it( 'should not merge single elements when they have different priority', () => {
  230. test(
  231. '<container:p>[<attribute:b view-priority="2" style="color:red"></attribute:b>]</container:p>',
  232. '<attribute:b view-priority="1" style="color:red"></attribute:b>',
  233. '<container:p>' +
  234. '[' +
  235. '<attribute:b view-priority="1" style="color:red">' +
  236. '<attribute:b view-priority="2" style="color:red"></attribute:b>' +
  237. '</attribute:b>' +
  238. ']' +
  239. '</container:p>'
  240. );
  241. } );
  242. it( 'should be merged with outside element when wrapping all children', () => {
  243. test(
  244. '<container:p>' +
  245. '<attribute:b view-priority="1" foo="bar">[foobar<attribute:i view-priority="1">baz</attribute:i>]</attribute:b>' +
  246. '</container:p>',
  247. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  248. '<container:p>' +
  249. '[' +
  250. '<attribute:b view-priority="1" baz="qux" foo="bar">' +
  251. 'foobar' +
  252. '<attribute:i view-priority="1">baz</attribute:i>' +
  253. '</attribute:b>' +
  254. ']' +
  255. '</container:p>'
  256. );
  257. } );
  258. it( 'should be merged with broken element', () => {
  259. test(
  260. '<container:p>' +
  261. '[<attribute:b view-priority="1" foo="bar">foo}bar</attribute:b>' +
  262. '</container:p>',
  263. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  264. '<container:p>' +
  265. '[<attribute:b view-priority="1" baz="qux" foo="bar">foo</attribute:b>]' +
  266. '<attribute:b view-priority="1" foo="bar">bar</attribute:b>' +
  267. '</container:p>'
  268. );
  269. } );
  270. it( 'should be merged with broken element and merged with siblings', () => {
  271. test(
  272. '<container:p>' +
  273. '<attribute:b view-priority="1" baz="qux" foo="bar">xyz</attribute:b>' +
  274. '[<attribute:b view-priority="1" foo="bar">foo}bar</attribute:b>' +
  275. '</container:p>',
  276. '<attribute:b view-priority="1" baz="qux"></attribute:b>',
  277. '<container:p>' +
  278. '<attribute:b view-priority="1" baz="qux" foo="bar">xyz{foo</attribute:b>]' +
  279. '<attribute:b view-priority="1" foo="bar">bar</attribute:b>' +
  280. '</container:p>'
  281. );
  282. } );
  283. it( 'should wrap EmptyElement', () => {
  284. test(
  285. '<container:p>[<empty:img></empty:img>]</container:p>',
  286. '<attribute:b></attribute:b>',
  287. '<container:p>[<attribute:b view-priority="10"><empty:img></empty:img></attribute:b>]</container:p>'
  288. );
  289. } );
  290. it( 'should throw if range is inside EmptyElement', () => {
  291. const emptyElement = new EmptyElement( 'img' );
  292. const container = new ContainerElement( 'p', null, emptyElement );
  293. const range = Range.createFromParentsAndOffsets( emptyElement, 0, container, 1 );
  294. expect( () => {
  295. wrap( range, new AttributeElement( 'b' ) );
  296. } ).to.throw( CKEditorError, 'view-writer-cannot-break-empty-element' );
  297. } );
  298. it( 'should wrap UIElement', () => {
  299. test(
  300. '<container:p>[<ui:span></ui:span>]</container:p>',
  301. '<attribute:b></attribute:b>',
  302. '<container:p>[<attribute:b view-priority="10"><ui:span></ui:span></attribute:b>]</container:p>'
  303. );
  304. } );
  305. it( 'should throw if range is inside UIElement', () => {
  306. const uiElement = new UIElement( 'span' );
  307. const container = new ContainerElement( 'p', null, uiElement );
  308. const range = Range.createFromParentsAndOffsets( uiElement, 0, container, 1 );
  309. expect( () => {
  310. wrap( range, new AttributeElement( 'b' ) );
  311. } ).to.throw( CKEditorError, 'view-writer-cannot-break-ui-element' );
  312. } );
  313. it( 'should keep stable hierarchy when wrapping with attribute with same priority', () => {
  314. test(
  315. '<container:p>[<attribute:span>foo</attribute:span>]</container:p>',
  316. '<attribute:b></attribute:b>',
  317. '<container:p>' +
  318. '[<attribute:b view-priority="10">' +
  319. '<attribute:span view-priority="10">foo</attribute:span>' +
  320. '</attribute:b>]' +
  321. '</container:p>'
  322. );
  323. test(
  324. '<container:p>[<attribute:b>foo</attribute:b>]</container:p>',
  325. '<attribute:span></attribute:span>',
  326. '<container:p>' +
  327. '[<attribute:b view-priority="10">' +
  328. '<attribute:span view-priority="10">foo</attribute:span>' +
  329. '</attribute:b>]' +
  330. '</container:p>'
  331. );
  332. } );
  333. it( 'should keep stable hierarchy when wrapping with attribute with same priority that can\'t be merged', () => {
  334. test(
  335. '<container:p>[<attribute:span name="foo">foo</attribute:span>]</container:p>',
  336. '<attribute:span name="bar"></attribute:span>',
  337. '<container:p>' +
  338. '[<attribute:span view-priority="10" name="bar">' +
  339. '<attribute:span view-priority="10" name="foo">foo</attribute:span>' +
  340. '</attribute:span>]' +
  341. '</container:p>'
  342. );
  343. test(
  344. '<container:p>[<attribute:span name="bar">foo</attribute:span>]</container:p>',
  345. '<attribute:span name="foo"></attribute:span>',
  346. '<container:p>' +
  347. '[<attribute:span view-priority="10" name="bar">' +
  348. '<attribute:span view-priority="10" name="foo">foo</attribute:span>' +
  349. '</attribute:span>]' +
  350. '</container:p>'
  351. );
  352. } );
  353. } );
  354. describe( 'collapsed range', () => {
  355. let viewDocument, viewRoot;
  356. beforeEach( () => {
  357. viewDocument = new Document();
  358. viewRoot = createViewRoot( viewDocument );
  359. } );
  360. afterEach( () => {
  361. viewDocument.destroy();
  362. } );
  363. /**
  364. * Executes test using `parse` and `stringify` utils functions.
  365. *
  366. * @param {String} input
  367. * @param {String} wrapAttribute
  368. * @param {String} expected
  369. */
  370. function test( input, wrapAttribute, expected ) {
  371. const { view, selection } = parse( input, { rootElement: viewRoot } );
  372. viewDocument.selection.setTo( selection );
  373. const newPosition = wrap( selection.getFirstRange(), parse( wrapAttribute ) );
  374. // Moving parsed elements to a document fragment so the view root is not shown in `stringify`.
  375. const viewChildren = new DocumentFragment( view.getChildren() );
  376. expect( stringify( viewChildren, newPosition, { showType: true, showPriority: true } ) ).to.equal( expected );
  377. }
  378. it( 'should throw error when element is not instance of AttributeElement', () => {
  379. const container = new ContainerElement( 'p', null, new Text( 'foo' ) );
  380. const position = new Position( container, 0 );
  381. const b = new Element( 'b' );
  382. expect( () => {
  383. wrap( new Range( position ), b );
  384. } ).to.throw( CKEditorError, 'view-writer-wrap-invalid-attribute' );
  385. } );
  386. it( 'should wrap position at the beginning of text node', () => {
  387. test(
  388. '<container:p>{}foobar</container:p>',
  389. '<attribute:b view-priority="1"></attribute:b>',
  390. '<container:p><attribute:b view-priority="1">[]</attribute:b>foobar</container:p>'
  391. );
  392. } );
  393. it( 'should wrap position inside text node', () => {
  394. test(
  395. '<container:p>foo{}bar</container:p>',
  396. '<attribute:b view-priority="1"></attribute:b>',
  397. '<container:p>foo<attribute:b view-priority="1">[]</attribute:b>bar</container:p>'
  398. );
  399. } );
  400. it( 'should support unicode', () => {
  401. test(
  402. '<container:p>நிலை{}க்கு</container:p>',
  403. '<attribute:b view-priority="1"></attribute:b>',
  404. '<container:p>நிலை<attribute:b view-priority="1">[]</attribute:b>க்கு</container:p>'
  405. );
  406. } );
  407. it( 'should wrap position inside document fragment', () => {
  408. test(
  409. '<attribute:b view-priority="1">foo</attribute:b>[]<attribute:b view-priority="3">bar</attribute:b>',
  410. '<attribute:b view-priority="2"></attribute:b>',
  411. '<attribute:b view-priority="1">foo</attribute:b>' +
  412. '<attribute:b view-priority="2">[]</attribute:b>' +
  413. '<attribute:b view-priority="3">bar</attribute:b>'
  414. );
  415. } );
  416. it( 'should wrap position at the end of text node', () => {
  417. test(
  418. '<container:p>foobar{}</container:p>',
  419. '<attribute:b view-priority="1"></attribute:b>',
  420. '<container:p>foobar<attribute:b view-priority="1">[]</attribute:b></container:p>'
  421. );
  422. } );
  423. it( 'should merge with existing attributes #1', () => {
  424. test(
  425. '<container:p><attribute:b view-priority="1">foo</attribute:b>[]</container:p>',
  426. '<attribute:b view-priority="1"></attribute:b>',
  427. '<container:p><attribute:b view-priority="1">foo{}</attribute:b></container:p>'
  428. );
  429. } );
  430. it( 'should merge with existing attributes #2', () => {
  431. test(
  432. '<container:p>[]<attribute:b view-priority="1">foo</attribute:b></container:p>',
  433. '<attribute:b view-priority="1"></attribute:b>',
  434. '<container:p><attribute:b view-priority="1">{}foo</attribute:b></container:p>'
  435. );
  436. } );
  437. it( 'should wrap when inside nested attributes', () => {
  438. test(
  439. '<container:p><attribute:b view-priority="1">foo{}bar</attribute:b></container:p>',
  440. '<attribute:u view-priority="1"></attribute:u>',
  441. '<container:p>' +
  442. '<attribute:b view-priority="1">' +
  443. 'foo' +
  444. '<attribute:u view-priority="1">[]</attribute:u>' +
  445. 'bar' +
  446. '</attribute:b>' +
  447. '</container:p>'
  448. );
  449. } );
  450. it( 'should merge when wrapping between same attribute', () => {
  451. test(
  452. '<container:p>' +
  453. '<attribute:b view-priority="1">foo</attribute:b>[]<attribute:b view-priority="1">bar</attribute:b>' +
  454. '</container:p>',
  455. '<attribute:b view-priority="1"></attribute:b>',
  456. '<container:p><attribute:b view-priority="1">foo{}bar</attribute:b></container:p>'
  457. );
  458. } );
  459. it( 'should move position to text node if in same attribute', () => {
  460. test(
  461. '<container:p><attribute:b view-priority="1">foobar[]</attribute:b></container:p>',
  462. '<attribute:b view-priority="1"></attribute:b>',
  463. '<container:p><attribute:b view-priority="1">foobar{}</attribute:b></container:p>'
  464. );
  465. } );
  466. } );
  467. } );
  468. } );