8
0

wrap.js 19 KB

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