mapper.js 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Mapper from '../../src/conversion/mapper';
  6. import ModelElement from '../../src/model/element';
  7. import ModelRootElement from '../../src/model/rootelement';
  8. import ModelText from '../../src/model/text';
  9. import ModelPosition from '../../src/model/position';
  10. import ModelRange from '../../src/model/range';
  11. import ViewElement from '../../src/view/element';
  12. import ViewUIElement from '../../src/view/uielement';
  13. import ViewText from '../../src/view/text';
  14. import ViewPosition from '../../src/view/position';
  15. import ViewRange from '../../src/view/range';
  16. describe( 'Mapper', () => {
  17. describe( 'clearBindings', () => {
  18. it( 'should remove all mapping', () => {
  19. const viewA = new ViewElement( 'a' );
  20. const viewB = new ViewElement( 'b' );
  21. const viewC = new ViewElement( 'c' );
  22. const modelA = new ModelElement( 'a' );
  23. const modelB = new ModelElement( 'b' );
  24. const modelC = new ModelElement( 'c' );
  25. const mapper = new Mapper();
  26. mapper.bindElements( modelA, viewA );
  27. mapper.bindElements( modelB, viewB );
  28. mapper.bindElements( modelC, viewC );
  29. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  30. expect( mapper.toModelElement( viewB ) ).to.equal( modelB );
  31. expect( mapper.toModelElement( viewC ) ).to.equal( modelC );
  32. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  33. expect( mapper.toViewElement( modelB ) ).to.equal( viewB );
  34. expect( mapper.toViewElement( modelC ) ).to.equal( viewC );
  35. mapper.clearBindings();
  36. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  37. expect( mapper.toModelElement( viewB ) ).to.be.undefined;
  38. expect( mapper.toModelElement( viewC ) ).to.be.undefined;
  39. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  40. expect( mapper.toViewElement( modelB ) ).to.be.undefined;
  41. expect( mapper.toViewElement( modelC ) ).to.be.undefined;
  42. } );
  43. } );
  44. describe( 'unbindModelElement', () => {
  45. it( 'should remove binding between given model element and view element that it was bound to', () => {
  46. const viewA = new ViewElement( 'a' );
  47. const modelA = new ModelElement( 'a' );
  48. const mapper = new Mapper();
  49. mapper.bindElements( modelA, viewA );
  50. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  51. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  52. mapper.unbindModelElement( modelA );
  53. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  54. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  55. } );
  56. it( 'should not remove binding between view and model element if view element got rebound', () => {
  57. const viewA = new ViewElement( 'a' );
  58. const modelA = new ModelElement( 'a' );
  59. const modelB = new ModelElement( 'b' );
  60. const mapper = new Mapper();
  61. mapper.bindElements( modelA, viewA );
  62. mapper.bindElements( modelB, viewA );
  63. // `modelA` is still bound to `viewA` even though `viewA` got rebound.
  64. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  65. mapper.unbindModelElement( modelA );
  66. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  67. expect( mapper.toModelElement( viewA ) ).to.equal( modelB );
  68. } );
  69. } );
  70. describe( 'unbindViewElement', () => {
  71. it( 'should remove binding between given view element and model element that it was bound to', () => {
  72. const viewA = new ViewElement( 'a' );
  73. const modelA = new ModelElement( 'a' );
  74. const mapper = new Mapper();
  75. mapper.bindElements( modelA, viewA );
  76. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  77. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  78. mapper.unbindViewElement( viewA );
  79. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  80. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  81. } );
  82. it( 'should not remove binding between model and view element if model element got rebound', () => {
  83. const viewA = new ViewElement( 'a' );
  84. const viewB = new ViewElement( 'b' );
  85. const modelA = new ModelElement( 'a' );
  86. const mapper = new Mapper();
  87. mapper.bindElements( modelA, viewA );
  88. mapper.bindElements( modelA, viewB );
  89. // `viewA` is still bound to `modelA`, even though `modelA` got rebound.
  90. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  91. mapper.unbindViewElement( viewA );
  92. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  93. expect( mapper.toViewElement( modelA ) ).to.equal( viewB );
  94. } );
  95. } );
  96. describe( 'Standard mapping', () => {
  97. let modelDiv, modelP, modelImg,
  98. viewDiv, viewP, viewB, viewI, viewU, viewSup, viewImg,
  99. viewTextB, viewTextO, viewTextM, viewTextX, viewTextY, viewTextZZ, viewTextFOO, viewTextBAR,
  100. mapper;
  101. beforeEach( () => {
  102. // Tree Model:
  103. //
  104. // <div> ---> modelDiv
  105. // ├─ x
  106. // ├─ <p> ---> modelP
  107. // │ ├─ y
  108. // │ ├─ f {b,i}
  109. // │ ├─ o {b,i}
  110. // │ ├─ o {b,i}
  111. // │ ├─ b
  112. // │ ├─ a
  113. // │ ├─ r
  114. // │ ├─ <img> ---> modelImg
  115. // │ ├─ b {u}
  116. // │ ├─ o {u,sup}
  117. // │ └─ m {u}
  118. // ├─ z
  119. // └─ z
  120. //
  121. // Tree View:
  122. //
  123. // <div> ---> viewDiv
  124. // ├─ x ---> viewTextX
  125. // ├─ <p> ---> viewP
  126. // │ ├─ y ---> viewTextY
  127. // │ ├─ <b> ---> viewB
  128. // │ │ └─ <i> ---> viewI
  129. // │ │ └─ foo ---> viewTextFOO
  130. // │ ├─ bar ---> viewTextBAR
  131. // │ ├─ <img> ---> viewImg
  132. // │ └─ <u> ---> viewU
  133. // │ ├─ b ---> viewTextB
  134. // │ ├─ <sup> ---> viewSup
  135. // │ │ └─ o ---> viewTextO
  136. // │ └─ m ---> viewTextM
  137. // └─ zz ---> viewTextZZ
  138. modelImg = new ModelElement( 'img' );
  139. modelP = new ModelElement( 'p', {}, [
  140. new ModelText( 'y' ),
  141. new ModelText( 'foo', { b: true, i: true } ),
  142. new ModelText( 'bar' ),
  143. modelImg,
  144. new ModelText( 'b', { u: true } ),
  145. new ModelText( 'o', { u: true, sup: true } ),
  146. new ModelText( 'm', { u: true } )
  147. ] );
  148. modelDiv = new ModelRootElement();
  149. modelDiv._appendChild( [
  150. new ModelText( 'x' ),
  151. modelP,
  152. new ModelText( 'zz' )
  153. ] );
  154. viewTextB = new ViewText( 'b' );
  155. viewTextO = new ViewText( 'o' );
  156. viewTextM = new ViewText( 'm' );
  157. viewTextX = new ViewText( 'x' );
  158. viewTextY = new ViewText( 'y' );
  159. viewTextZZ = new ViewText( 'zz' );
  160. viewTextFOO = new ViewText( 'foo' );
  161. viewTextBAR = new ViewText( 'bar' );
  162. viewImg = new ViewElement( 'img' );
  163. viewSup = new ViewElement( 'sup', {}, [ viewTextO ] );
  164. viewU = new ViewElement( 'u', {}, [ viewTextB, viewSup, viewTextM ] );
  165. viewI = new ViewElement( 'i', {}, [ viewTextFOO ] );
  166. viewB = new ViewElement( 'b', {}, [ viewI ] );
  167. viewP = new ViewElement( 'p', {}, [ viewTextY, viewB, viewTextBAR, viewImg, viewU ] );
  168. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewP, viewTextZZ ] );
  169. mapper = new Mapper();
  170. mapper.bindElements( modelP, viewP );
  171. mapper.bindElements( modelDiv, viewDiv );
  172. mapper.bindElements( modelImg, viewImg );
  173. } );
  174. describe( 'toModelElement', () => {
  175. it( 'should return corresponding model element', () => {
  176. expect( mapper.toModelElement( viewP ) ).to.equal( modelP );
  177. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  178. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  179. } );
  180. } );
  181. describe( 'toViewElement', () => {
  182. it( 'should return corresponding view element', () => {
  183. expect( mapper.toViewElement( modelP ) ).to.equal( viewP );
  184. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  185. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  186. } );
  187. } );
  188. describe( 'toModelPosition', () => {
  189. it( 'should fire viewToModelPosition event and return value calculated in callback to that event', () => {
  190. const viewPosition = new ViewPosition( viewDiv, 0 );
  191. const stub = {};
  192. mapper.on( 'viewToModelPosition', ( evt, data ) => {
  193. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  194. data.modelPosition = stub;
  195. // Do not stop the event. Test whether default algorithm was not called if data.modelPosition is already set.
  196. } );
  197. const result = mapper.toModelPosition( viewPosition );
  198. expect( result ).to.equal( stub );
  199. } );
  200. it( 'should be possible to add custom position mapping callback after default callback', () => {
  201. const viewPosition = new ViewPosition( viewDiv, 0 );
  202. // Model position to which default algorithm should map `viewPosition`.
  203. // This mapping is tested in a test below.
  204. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  205. const stub = {};
  206. mapper.on( 'viewToModelPosition', ( evt, data ) => {
  207. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  208. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  209. data.modelPosition = stub;
  210. }, { priority: 'low' } );
  211. const result = mapper.toModelPosition( viewPosition );
  212. expect( result ).to.equal( stub );
  213. } );
  214. // Default algorithm tests.
  215. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  216. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  217. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  218. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  219. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  220. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  221. it( 'should transform viewP 0', () => createToModelTest( viewP, 0, modelP, 0 ) );
  222. it( 'should transform viewP 1', () => createToModelTest( viewP, 1, modelP, 1 ) );
  223. it( 'should transform viewP 2', () => createToModelTest( viewP, 2, modelP, 4 ) );
  224. it( 'should transform viewP 3', () => createToModelTest( viewP, 3, modelP, 7 ) );
  225. it( 'should transform viewP 4', () => createToModelTest( viewP, 4, modelP, 8 ) );
  226. it( 'should transform viewP 5', () => createToModelTest( viewP, 5, modelP, 11 ) );
  227. it( 'should transform viewTextY 0', () => createToModelTest( viewTextY, 0, modelP, 0 ) );
  228. it( 'should transform viewTextY 1', () => createToModelTest( viewTextY, 1, modelP, 1 ) );
  229. it( 'should transform viewB 0', () => createToModelTest( viewB, 0, modelP, 1 ) );
  230. it( 'should transform viewB 1', () => createToModelTest( viewB, 1, modelP, 4 ) );
  231. it( 'should transform viewI 0', () => createToModelTest( viewI, 0, modelP, 1 ) );
  232. it( 'should transform viewI 1', () => createToModelTest( viewI, 1, modelP, 4 ) );
  233. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelP, 1 ) );
  234. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelP, 2 ) );
  235. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelP, 3 ) );
  236. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelP, 4 ) );
  237. it( 'should transform viewTextBAR 0', () => createToModelTest( viewTextBAR, 0, modelP, 4 ) );
  238. it( 'should transform viewTextBAR 1', () => createToModelTest( viewTextBAR, 1, modelP, 5 ) );
  239. it( 'should transform viewTextBAR 2', () => createToModelTest( viewTextBAR, 2, modelP, 6 ) );
  240. it( 'should transform viewTextBAR 3', () => createToModelTest( viewTextBAR, 3, modelP, 7 ) );
  241. it( 'should transform viewU 0', () => createToModelTest( viewU, 0, modelP, 8 ) );
  242. it( 'should transform viewU 1', () => createToModelTest( viewU, 1, modelP, 9 ) );
  243. it( 'should transform viewU 2', () => createToModelTest( viewU, 2, modelP, 10 ) );
  244. it( 'should transform viewU 3', () => createToModelTest( viewU, 3, modelP, 11 ) );
  245. it( 'should transform viewTextB 0', () => createToModelTest( viewTextB, 0, modelP, 8 ) );
  246. it( 'should transform viewTextB 1', () => createToModelTest( viewTextB, 1, modelP, 9 ) );
  247. it( 'should transform viewSup 0', () => createToModelTest( viewSup, 0, modelP, 9 ) );
  248. it( 'should transform viewSup 1', () => createToModelTest( viewSup, 1, modelP, 10 ) );
  249. it( 'should transform viewTextO 0', () => createToModelTest( viewTextO, 0, modelP, 9 ) );
  250. it( 'should transform viewTextO 1', () => createToModelTest( viewTextO, 1, modelP, 10 ) );
  251. it( 'should transform viewTextM 0', () => createToModelTest( viewTextM, 0, modelP, 10 ) );
  252. it( 'should transform viewTextM 1', () => createToModelTest( viewTextM, 1, modelP, 11 ) );
  253. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  254. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  255. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  256. } );
  257. describe( 'toViewPosition', () => {
  258. it( 'should fire modelToViewPosition event and return value calculated in callback to that event', () => {
  259. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  260. const stub = {};
  261. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  262. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  263. data.viewPosition = stub;
  264. // Do not stop the event. Test whether default algorithm was not called if data.viewPosition is already set.
  265. } );
  266. const result = mapper.toViewPosition( modelPosition );
  267. expect( result ).to.equal( stub );
  268. } );
  269. it( 'should be possible to add custom position mapping callback after default callback', () => {
  270. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  271. // View position to which default algorithm should map `viewPosition`.
  272. // This mapping is tested in a test below.
  273. const viewPosition = new ViewPosition( viewTextX, 0 );
  274. const stub = {};
  275. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  276. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  277. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  278. data.viewPosition = stub;
  279. }, { priority: 'low' } );
  280. const result = mapper.toViewPosition( modelPosition );
  281. expect( result ).to.equal( stub );
  282. } );
  283. // Default algorithm tests.
  284. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  285. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  286. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  287. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  288. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  289. it( 'should transform modelP 0', () => createToViewTest( modelP, 0, viewTextY, 0 ) );
  290. it( 'should transform modelP 1', () => createToViewTest( modelP, 1, viewTextY, 1 ) );
  291. it( 'should transform modelP 2', () => createToViewTest( modelP, 2, viewTextFOO, 1 ) );
  292. it( 'should transform modelP 3', () => createToViewTest( modelP, 3, viewTextFOO, 2 ) );
  293. it( 'should transform modelP 4', () => createToViewTest( modelP, 4, viewTextBAR, 0 ) );
  294. it( 'should transform modelP 5', () => createToViewTest( modelP, 5, viewTextBAR, 1 ) );
  295. it( 'should transform modelP 6', () => createToViewTest( modelP, 6, viewTextBAR, 2 ) );
  296. it( 'should transform modelP 7', () => createToViewTest( modelP, 7, viewTextBAR, 3 ) );
  297. it( 'should transform modelP 8', () => createToViewTest( modelP, 8, viewP, 4 ) );
  298. it( 'should transform modelP 9', () => createToViewTest( modelP, 9, viewTextB, 1 ) );
  299. it( 'should transform modelP 10', () => createToViewTest( modelP, 10, viewTextM, 0 ) );
  300. it( 'should transform modelP 11', () => createToViewTest( modelP, 11, viewP, 5 ) );
  301. } );
  302. describe( 'toModelRange', () => {
  303. it( 'should transform range', () => {
  304. const viewRange = ViewRange._createFromParentsAndOffsets( viewDiv, 0, viewTextFOO, 2 );
  305. const modelRange = mapper.toModelRange( viewRange );
  306. expect( modelRange.start.parent ).to.equal( modelDiv );
  307. expect( modelRange.start.offset ).to.equal( 0 );
  308. expect( modelRange.end.parent ).to.equal( modelP );
  309. expect( modelRange.end.offset ).to.equal( 3 );
  310. } );
  311. } );
  312. describe( 'toViewRange', () => {
  313. it( 'should transform range', () => {
  314. const modelRange = new ModelRange( ModelPosition._createAt( modelDiv, 0 ), ModelPosition._createAt( modelP, 3 ) );
  315. const viewRange = mapper.toViewRange( modelRange );
  316. expect( viewRange.start.parent ).to.equal( viewTextX );
  317. expect( viewRange.start.offset ).to.equal( 0 );
  318. expect( viewRange.end.parent ).to.equal( viewTextFOO );
  319. expect( viewRange.end.offset ).to.equal( 2 );
  320. } );
  321. } );
  322. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  323. const modelPosition = ModelPosition._createAt( modelElement, modelOffset );
  324. const viewPosition = mapper.toViewPosition( modelPosition );
  325. expect( viewPosition.parent ).to.equal( viewElement );
  326. expect( viewPosition.offset ).to.equal( viewOffset );
  327. }
  328. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  329. const viewPosition = new ViewPosition( viewElement, viewOffset );
  330. const modelPosition = mapper.toModelPosition( viewPosition );
  331. expect( modelPosition.parent ).to.equal( modelElement );
  332. expect( modelPosition.offset ).to.equal( modelOffset );
  333. }
  334. } );
  335. describe( 'Widget mapping', () => {
  336. let modelDiv, modelWidget, modelImg, modelCaption,
  337. viewDiv, viewWidget, viewMask, viewWrapper, viewImg, viewCaption,
  338. viewTextX, viewTextFOO, viewTextZZ, viewTextLABEL,
  339. mapper;
  340. before( () => {
  341. // Tree Model:
  342. //
  343. // <div> ---> modelDiv
  344. // ├─ x
  345. // ├─ <widget> ---> modelWidget
  346. // │ ├─ <img> ---> modelImg
  347. // │ └─ <caption> ---> modelCaption
  348. // │ ├─ f
  349. // │ ├─ o
  350. // │ └─ o
  351. // ├─ z
  352. // └─ z
  353. //
  354. // Tree View:
  355. //
  356. // <div> ---> viewDiv
  357. // ├─ x ---> viewTextX
  358. // ├─ <widget> ---> viewWidget
  359. // │ ├─ <mask> ---> viewMask
  360. // │ │ └─ label ---> viewTextLABEL
  361. // │ └─ <wrapper> ---> viewWrapper
  362. // │ ├─ <img> ---> viewImg
  363. // │ └─ <caption> ---> viewCaption
  364. // │ └─ foo ---> viewTextFOO
  365. // └─ zz ---> viewTextZZ
  366. modelImg = new ModelElement( 'img' );
  367. modelCaption = new ModelElement( 'caption', {}, new ModelText( 'foo' ) );
  368. modelWidget = new ModelElement( 'widget', {}, [ modelImg, modelCaption ] );
  369. modelDiv = new ModelRootElement();
  370. modelDiv._appendChild( [ new ModelText( 'x' ), modelWidget, new ModelText( 'zz' ) ] );
  371. viewTextX = new ViewText( 'y' );
  372. viewTextZZ = new ViewText( 'zz' );
  373. viewTextFOO = new ViewText( 'foo' );
  374. viewTextLABEL = new ViewText( 'label' );
  375. viewImg = new ViewElement( 'img' );
  376. viewMask = new ViewElement( 'mask', {}, [ viewTextLABEL ] );
  377. viewCaption = new ViewElement( 'caption', {}, [ viewTextFOO ] );
  378. viewWrapper = new ViewElement( 'wrapper', {}, [ viewImg, viewCaption ] );
  379. viewWidget = new ViewElement( 'widget', [ viewMask, viewWrapper ] );
  380. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewWidget, viewTextZZ ] );
  381. mapper = new Mapper();
  382. mapper.bindElements( modelDiv, viewDiv );
  383. mapper.bindElements( modelWidget, viewWidget );
  384. mapper.bindElements( modelImg, viewImg );
  385. mapper.bindElements( modelCaption, viewCaption );
  386. } );
  387. describe( 'toModelElement', () => {
  388. it( 'should return corresponding model element', () => {
  389. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  390. expect( mapper.toModelElement( viewWidget ) ).to.equal( modelWidget );
  391. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  392. expect( mapper.toModelElement( viewCaption ) ).to.equal( modelCaption );
  393. } );
  394. } );
  395. describe( 'toViewElement', () => {
  396. it( 'should return corresponding view element', () => {
  397. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  398. expect( mapper.toViewElement( modelWidget ) ).to.equal( viewWidget );
  399. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  400. expect( mapper.toViewElement( modelCaption ) ).to.equal( viewCaption );
  401. } );
  402. } );
  403. describe( 'toModelPosition', () => {
  404. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  405. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  406. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  407. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  408. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  409. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  410. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  411. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  412. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  413. it( 'should transform viewImg 0', () => createToModelTest( viewImg, 0, modelImg, 0 ) );
  414. it( 'should transform viewCaption 0', () => createToModelTest( viewCaption, 0, modelCaption, 0 ) );
  415. it( 'should transform viewCaption 1', () => createToModelTest( viewCaption, 1, modelCaption, 3 ) );
  416. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelCaption, 0 ) );
  417. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelCaption, 1 ) );
  418. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelCaption, 2 ) );
  419. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelCaption, 3 ) );
  420. } );
  421. describe( 'toViewPosition', () => {
  422. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  423. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  424. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  425. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  426. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  427. it( 'should transform modelImg 0', () => createToViewTest( modelImg, 0, viewImg, 0 ) );
  428. it( 'should transform modelCaption 0', () => createToViewTest( modelCaption, 0, viewTextFOO, 0 ) );
  429. it( 'should transform modelCaption 1', () => createToViewTest( modelCaption, 1, viewTextFOO, 1 ) );
  430. it( 'should transform modelCaption 2', () => createToViewTest( modelCaption, 2, viewTextFOO, 2 ) );
  431. it( 'should transform modelCaption 3', () => createToViewTest( modelCaption, 3, viewTextFOO, 3 ) );
  432. } );
  433. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  434. const modelPosition = ModelPosition._createAt( modelElement, modelOffset );
  435. const viewPosition = mapper.toViewPosition( modelPosition );
  436. expect( viewPosition.parent ).to.equal( viewElement );
  437. expect( viewPosition.offset ).to.equal( viewOffset );
  438. }
  439. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  440. const viewPosition = new ViewPosition( viewElement, viewOffset );
  441. const modelPosition = mapper.toModelPosition( viewPosition );
  442. expect( modelPosition.parent ).to.equal( modelElement );
  443. expect( modelPosition.offset ).to.equal( modelOffset );
  444. }
  445. } );
  446. describe( 'List mapping (test registerViewToModelLength)', () => {
  447. let mapper, modelRoot, viewRoot,
  448. modelListItem1, modelListItem2,
  449. modelListItem11, modelListItem12,
  450. viewList, viewListNested,
  451. viewListItem1, viewListItem2,
  452. viewListItem11, viewListItem12;
  453. before( () => {
  454. modelListItem1 = new ModelElement( 'listItem', null, new ModelText( 'aaa' ) );
  455. modelListItem11 = new ModelElement( 'listItem', null, new ModelText( 'bbb' ) );
  456. modelListItem12 = new ModelElement( 'listItem', null, new ModelText( 'ccc' ) );
  457. modelListItem2 = new ModelElement( 'listItem', null, new ModelText( 'xxx' ) );
  458. modelRoot = new ModelRootElement( 'root', null, [ modelListItem1, modelListItem11, modelListItem12, modelListItem2 ] );
  459. viewListItem11 = new ViewElement( 'li', null, new ViewText( 'bbb' ) );
  460. viewListItem12 = new ViewElement( 'li', null, new ViewText( 'ccc' ) );
  461. viewListNested = new ViewElement( 'ul', null, [ viewListItem11, viewListItem12 ] );
  462. viewListItem1 = new ViewElement( 'li', null, [ new ViewText( 'aaa' ), viewListNested ] );
  463. viewListItem2 = new ViewElement( 'li', null, new ViewText( 'ddd' ) );
  464. viewList = new ViewElement( 'ul', null, [ viewListItem1, viewListItem2 ] );
  465. viewRoot = new ViewElement( 'div', null, viewList );
  466. mapper = new Mapper();
  467. mapper.bindElements( modelRoot, viewRoot );
  468. mapper.bindElements( modelListItem1, viewListItem1 );
  469. mapper.bindElements( modelListItem11, viewListItem11 );
  470. mapper.bindElements( modelListItem12, viewListItem12 );
  471. mapper.bindElements( modelListItem2, viewListItem2 );
  472. function getViewListItemLength( element ) {
  473. let length = 1;
  474. for ( const child of element.getChildren() ) {
  475. if ( child.name == 'ul' || child.name == 'ol' ) {
  476. for ( const item of child.getChildren() ) {
  477. length += getViewListItemLength( item );
  478. }
  479. }
  480. }
  481. return length;
  482. }
  483. mapper.registerViewToModelLength( 'li', getViewListItemLength );
  484. } );
  485. describe( 'toModelPosition', () => {
  486. it( 'should transform viewRoot 0', () => createToModelTest( viewRoot, 0, modelRoot, 0 ) );
  487. it( 'should transform viewRoot 1', () => createToModelTest( viewRoot, 1, modelRoot, 4 ) );
  488. it( 'should transform viewList 0', () => createToModelTest( viewList, 0, modelRoot, 0 ) );
  489. it( 'should transform viewList 1', () => createToModelTest( viewList, 1, modelRoot, 3 ) );
  490. it( 'should transform viewList 2', () => createToModelTest( viewList, 2, modelRoot, 4 ) );
  491. } );
  492. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  493. const viewPosition = new ViewPosition( viewElement, viewOffset );
  494. const modelPosition = mapper.toModelPosition( viewPosition );
  495. expect( modelPosition.parent ).to.equal( modelElement );
  496. expect( modelPosition.offset ).to.equal( modelOffset );
  497. }
  498. } );
  499. describe( 'Markers mapping', () => {
  500. let mapper;
  501. beforeEach( () => {
  502. mapper = new Mapper();
  503. } );
  504. it( 'should bind element to a marker name', () => {
  505. const view = new ViewElement( 'a' );
  506. mapper.bindElementToMarker( view, 'marker' );
  507. const elements = mapper.markerNameToElements( 'marker' );
  508. expect( elements ).to.be.instanceof( Set );
  509. expect( elements.size ).to.equal( 1 );
  510. expect( elements.has( view ) ).to.be.true;
  511. } );
  512. it( 'should bind multiple elements to a marker name', () => {
  513. const viewA = new ViewElement( 'a' );
  514. const viewB = new ViewElement( 'b' );
  515. const viewC = new ViewElement( 'c' );
  516. mapper.bindElementToMarker( viewA, 'marker' );
  517. mapper.bindElementToMarker( viewB, 'marker' );
  518. mapper.bindElementToMarker( viewC, 'marker' );
  519. const elements = Array.from( mapper.markerNameToElements( 'marker' ) );
  520. expect( elements ).to.deep.equal( [ viewA, viewB, viewC ] );
  521. } );
  522. it( 'should unbind all elements from a marker name', () => {
  523. const viewA = new ViewElement( 'a' );
  524. const viewB = new ViewElement( 'b' );
  525. const viewC = new ViewElement( 'c' );
  526. mapper.bindElementToMarker( viewA, 'marker' );
  527. mapper.bindElementToMarker( viewB, 'marker' );
  528. mapper.bindElementToMarker( viewC, 'marker' );
  529. mapper.unbindElementsFromMarkerName( 'marker' );
  530. const elements = mapper.markerNameToElements( 'marker' );
  531. expect( elements ).to.be.null;
  532. } );
  533. } );
  534. it( 'should pass isPhantom flag to model-to-view position mapping callback', () => {
  535. const mapper = new Mapper();
  536. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  537. expect( data.isPhantom ).to.be.true;
  538. evt.stop();
  539. } );
  540. mapper.toViewPosition( {}, { isPhantom: true } );
  541. } );
  542. describe( 'getModelLength', () => {
  543. let mapper;
  544. beforeEach( () => {
  545. mapper = new Mapper();
  546. } );
  547. it( 'should return length according to callback added by registerViewToModelLength', () => {
  548. const viewElement = new ViewElement( 'span' );
  549. mapper.registerViewToModelLength( 'span', () => 4 );
  550. expect( mapper.getModelLength( viewElement ) ).to.equal( 4 );
  551. } );
  552. it( 'should return 1 for mapped elements', () => {
  553. const viewElement = new ViewElement( 'span' );
  554. const modelElement = new ModelElement( 'span' );
  555. mapper.bindElements( modelElement, viewElement );
  556. expect( mapper.getModelLength( viewElement ) ).to.equal( 1 );
  557. } );
  558. it( 'should return 0 for ui elements', () => {
  559. const viewUiElement = new ViewUIElement( 'span' );
  560. expect( mapper.getModelLength( viewUiElement ) ).to.equal( 0 );
  561. } );
  562. it( 'should return length of data for text nodes', () => {
  563. const viewText = new ViewText( 'foo' );
  564. expect( mapper.getModelLength( viewText ) ).to.equal( 3 );
  565. } );
  566. it( 'should return sum of length of children for unmapped element', () => {
  567. const modelP = new ModelElement( 'p' );
  568. const viewP = new ViewElement( 'p' );
  569. const viewUi = new ViewUIElement( 'span' );
  570. const viewFoo = new ViewText( 'foo' );
  571. const viewCallback = new ViewElement( 'xxx' );
  572. const viewDiv = new ViewElement( 'div', null, [ viewP, viewUi, viewFoo, viewCallback ] );
  573. mapper.bindElements( modelP, viewP );
  574. mapper.registerViewToModelLength( 'xxx', () => 2 );
  575. expect( mapper.getModelLength( viewDiv ) ).to.equal( 6 );
  576. } );
  577. } );
  578. describe( 'findMappedViewAncestor()', () => {
  579. it( 'should return for given view position the closest ancestor which is mapped to a model element', () => {
  580. const mapper = new Mapper();
  581. const modelP = new ModelElement( 'p' );
  582. const modelDiv = new ModelElement( 'div' );
  583. const viewText = new ViewText( 'foo' );
  584. const viewSpan = new ViewElement( 'span', null, viewText );
  585. const viewP = new ViewElement( 'p', null, viewSpan );
  586. const viewDiv = new ViewElement( 'div', null, viewP );
  587. mapper.bindElements( modelP, viewP );
  588. mapper.bindElements( modelDiv, viewDiv );
  589. // <div><p><span>f{}oo</span></p></div>
  590. const viewPosition = new ViewPosition( viewText, 1 );
  591. const viewMappedAncestor = mapper.findMappedViewAncestor( viewPosition );
  592. expect( viewMappedAncestor ).to.equal( viewP );
  593. } );
  594. } );
  595. } );