binding.js 11 KB

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