wrap.js 19 KB

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