binding.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import ViewElement from '../../../src/view/element';
  7. import ViewSelection from '../../../src/view/selection';
  8. import DomConverter from '../../../src/view/domconverter';
  9. import ViewDocumentFragment from '../../../src/view/documentfragment';
  10. import { INLINE_FILLER } from '../../../src/view/filler';
  11. import { parse } from '../../../src/dev-utils/view';
  12. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  13. describe( 'DomConverter', () => {
  14. let converter;
  15. before( () => {
  16. converter = new DomConverter();
  17. } );
  18. describe( 'bindElements()', () => {
  19. it( 'should bind elements', () => {
  20. const domElement = document.createElement( 'p' );
  21. const viewElement = new ViewElement( 'p' );
  22. converter.bindElements( domElement, viewElement );
  23. expect( converter.mapDomToView( domElement ) ).to.equal( viewElement );
  24. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  25. } );
  26. } );
  27. describe( 'bindDocumentFragments()', () => {
  28. it( 'should bind document fragments', () => {
  29. const domFragment = document.createDocumentFragment();
  30. const viewFragment = new ViewDocumentFragment();
  31. converter.bindDocumentFragments( domFragment, viewFragment );
  32. expect( converter.mapDomToView( domFragment ) ).to.equal( viewFragment );
  33. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  34. } );
  35. } );
  36. describe( 'mapDomToView()', () => {
  37. it( 'should return corresponding view element if element is passed', () => {
  38. const domElement = document.createElement( 'p' );
  39. const viewElement = new ViewElement( 'p' );
  40. converter.bindElements( domElement, viewElement );
  41. expect( converter.mapDomToView( domElement ) ).to.equal( viewElement );
  42. } );
  43. it( 'should return corresponding view document fragment', () => {
  44. const domFragment = document.createDocumentFragment();
  45. const viewFragment = converter.domToView( domFragment );
  46. converter.bindElements( domFragment, viewFragment );
  47. expect( converter.mapDomToView( domFragment ) ).to.equal( viewFragment );
  48. } );
  49. it( 'should return undefined if falsy value was passed', () => {
  50. expect( converter.mapDomToView( null ) ).to.be.undefined;
  51. expect( converter.mapDomToView( undefined ) ).to.be.undefined;
  52. } );
  53. } );
  54. describe( 'findCorrespondingViewText()', () => {
  55. it( 'should return corresponding view text based on sibling', () => {
  56. const domImg = document.createElement( 'img' );
  57. const domText = document.createTextNode( 'foo' );
  58. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  59. const viewImg = new ViewElement( 'img' );
  60. converter.bindElements( domImg, viewImg );
  61. const viewP = converter.domToView( domP );
  62. const viewText = viewP.getChild( 1 );
  63. expect( converter.findCorrespondingViewText( domText ) ).to.equal( viewText );
  64. } );
  65. it( 'should return corresponding view text based on parent', () => {
  66. const domText = document.createTextNode( 'foo' );
  67. const domP = createElement( document, 'p', null, domText );
  68. const viewP = converter.domToView( domP );
  69. const viewText = viewP.getChild( 0 );
  70. converter.bindElements( domP, viewP );
  71. expect( converter.findCorrespondingViewText( domText ) ).to.equal( viewText );
  72. } );
  73. it( 'should return null if sibling is not bound', () => {
  74. const domImg = document.createElement( 'img' );
  75. const domText = document.createTextNode( 'foo' );
  76. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  77. const viewP = converter.domToView( domP );
  78. converter.bindElements( domP, viewP );
  79. expect( converter.findCorrespondingViewText( domText ) ).to.be.null;
  80. } );
  81. it( 'should return null if sibling is not element', () => {
  82. const domTextFoo = document.createTextNode( 'foo' );
  83. const domTextBar = document.createTextNode( 'bar' );
  84. const domP = createElement( document, 'p', null, [ domTextFoo, domTextBar ] );
  85. const viewP = converter.domToView( domP );
  86. converter.bindElements( domP, viewP );
  87. expect( converter.findCorrespondingViewText( domTextBar ) ).to.be.null;
  88. } );
  89. it( 'should return null if parent is not bound', () => {
  90. const domText = document.createTextNode( 'foo' );
  91. createElement( document, 'p', null, domText );
  92. expect( converter.findCorrespondingViewText( domText ) ).to.be.null;
  93. } );
  94. it( 'should return null for inline filler', () => {
  95. const domFiller = document.createTextNode( INLINE_FILLER );
  96. const domP = createElement( document, 'p', null, domFiller );
  97. const viewP = converter.domToView( domP );
  98. converter.bindElements( domP, viewP );
  99. expect( converter.findCorrespondingViewText( domFiller ) ).to.be.null;
  100. } );
  101. it( 'should return null if there is no text node sibling in view', () => {
  102. const domB = document.createElement( 'b' );
  103. const domI = document.createElement( 'i' );
  104. const domText = document.createTextNode( 'x' );
  105. const domP = createElement( document, 'p', null, [ domB, domText, domI ] );
  106. const viewP = parse( '<p><b></b><i></i></p>' );
  107. const viewB = viewP.getChild( 0 );
  108. const viewI = viewP.getChild( 1 );
  109. converter.bindElements( domP, viewP );
  110. converter.bindElements( domI, viewI );
  111. converter.bindElements( domB, viewB );
  112. expect( converter.findCorrespondingViewText( domText ) ).to.be.null;
  113. } );
  114. it( 'should return null if there is no child text node in view', () => {
  115. const domText = document.createTextNode( 'x' );
  116. const domP = createElement( document, 'p', null, domText );
  117. const viewP = parse( '<p></p>' );
  118. converter.bindElements( domP, viewP );
  119. expect( converter.findCorrespondingViewText( domText ) ).to.be.null;
  120. } );
  121. } );
  122. describe( 'mapViewToDom()', () => {
  123. it( 'should return corresponding DOM element if element was passed', () => {
  124. const domElement = document.createElement( 'p' );
  125. const viewElement = new ViewElement( 'p' );
  126. converter.bindElements( domElement, viewElement );
  127. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  128. } );
  129. it( 'should return corresponding DOM document fragment', () => {
  130. const domFragment = document.createDocumentFragment();
  131. const viewFragment = new ViewDocumentFragment();
  132. converter.bindElements( domFragment, viewFragment );
  133. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  134. } );
  135. it( 'should return undefined if wrong parameter is passed', () => {
  136. expect( converter.mapViewToDom( null ) ).to.be.undefined;
  137. } );
  138. } );
  139. describe( 'findCorrespondingDomText()', () => {
  140. it( 'should return corresponding DOM text based on sibling', () => {
  141. const domImg = document.createElement( 'img' );
  142. const domText = document.createTextNode( 'foo' );
  143. const domP = document.createElement( 'p' );
  144. domP.appendChild( domImg );
  145. domP.appendChild( domText );
  146. const viewImg = new ViewElement( 'img' );
  147. converter.bindElements( domImg, viewImg );
  148. const viewP = converter.domToView( domP );
  149. const viewText = viewP.getChild( 1 );
  150. expect( converter.findCorrespondingDomText( viewText ) ).to.equal( domText );
  151. } );
  152. it( 'should return corresponding DOM text based on parent', () => {
  153. const domText = document.createTextNode( 'foo' );
  154. const domP = document.createElement( 'p' );
  155. domP.appendChild( domText );
  156. const viewP = converter.domToView( domP );
  157. const viewText = viewP.getChild( 0 );
  158. converter.bindElements( domP, viewP );
  159. expect( converter.findCorrespondingDomText( viewText ) ).to.equal( domText );
  160. } );
  161. it( 'should return null if sibling is not bound', () => {
  162. const domImg = document.createElement( 'img' );
  163. const domText = document.createTextNode( 'foo' );
  164. const domP = document.createElement( 'p' );
  165. domP.appendChild( domImg );
  166. domP.appendChild( domText );
  167. const viewP = converter.domToView( domP );
  168. const viewText = viewP.getChild( 1 );
  169. converter.bindElements( domP, viewP );
  170. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  171. } );
  172. it( 'should return null if parent is not bound', () => {
  173. const domText = document.createTextNode( 'foo' );
  174. const domP = document.createElement( 'p' );
  175. domP.appendChild( domText );
  176. const viewP = converter.domToView( domP );
  177. const viewText = viewP.getChild( 0 );
  178. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  179. } );
  180. it( 'should return null if there is no previous sibling and parent', () => {
  181. const domText = document.createTextNode( 'foo' );
  182. const viewText = converter.domToView( domText );
  183. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  184. } );
  185. } );
  186. describe( 'bindFakeSelection', () => {
  187. let domEl, selection, viewElement;
  188. beforeEach( () => {
  189. viewElement = new ViewElement();
  190. domEl = document.createElement( 'div' );
  191. selection = new ViewSelection( viewElement, 'in' );
  192. converter.bindFakeSelection( domEl, selection );
  193. } );
  194. it( 'should bind DOM element to selection', () => {
  195. const bindSelection = converter.fakeSelectionToView( domEl );
  196. expect( bindSelection ).to.not.be.undefined;
  197. expect( bindSelection.isEqual( selection ) ).to.be.true;
  198. } );
  199. it( 'should keep a copy of selection', () => {
  200. const selectionCopy = new ViewSelection( selection );
  201. selection._setTo( new ViewElement(), 'in', { backward: true } );
  202. const bindSelection = converter.fakeSelectionToView( domEl );
  203. expect( bindSelection ).to.not.equal( selection );
  204. expect( bindSelection.isEqual( selection ) ).to.be.false;
  205. expect( bindSelection.isEqual( selectionCopy ) ).to.be.true;
  206. } );
  207. } );
  208. describe( 'unbindDomElement', () => {
  209. it( 'should unbind elements', () => {
  210. const domElement = document.createElement( 'p' );
  211. const viewElement = new ViewElement( 'p' );
  212. converter.bindElements( domElement, viewElement );
  213. expect( converter.mapDomToView( domElement ) ).to.equal( viewElement );
  214. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  215. converter.unbindDomElement( domElement );
  216. expect( converter.mapDomToView( domElement ) ).to.be.undefined;
  217. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  218. } );
  219. it( 'should unbind element\'s child nodes', () => {
  220. const domElement = document.createElement( 'p' );
  221. const domChild = document.createElement( 'span' );
  222. domElement.appendChild( domChild );
  223. const viewElement = new ViewElement( 'p' );
  224. const viewChild = new ViewElement( 'span' );
  225. converter.bindElements( domElement, viewElement );
  226. converter.bindElements( domChild, viewChild );
  227. expect( converter.mapDomToView( domChild ) ).to.equal( viewChild );
  228. expect( converter.mapViewToDom( viewChild ) ).to.equal( domChild );
  229. converter.unbindDomElement( domElement );
  230. expect( converter.mapDomToView( domChild ) ).to.be.undefined;
  231. expect( converter.mapViewToDom( viewChild ) ).to.be.undefined;
  232. } );
  233. it( 'should do nothing if there are no elements bind', () => {
  234. const domElement = document.createElement( 'p' );
  235. const viewElement = new ViewElement( 'p' );
  236. expect( converter.mapDomToView( domElement ) ).to.be.undefined;
  237. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  238. converter.unbindDomElement( domElement );
  239. expect( converter.mapDomToView( domElement ) ).to.be.undefined;
  240. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  241. } );
  242. } );
  243. } );