8
0

view.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* global document, HTMLElement */
  6. import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
  7. import View from '../src/view';
  8. import Template from '../src/template';
  9. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  10. import Collection from '@ckeditor/ckeditor5-utils/src/collection';
  11. import ViewCollection from '../src/viewcollection';
  12. let TestView, view, childA, childB;
  13. testUtils.createSinonSandbox();
  14. describe( 'View', () => {
  15. describe( 'constructor()', () => {
  16. beforeEach( () => {
  17. setTestViewClass();
  18. setTestViewInstance();
  19. } );
  20. it( 'defines basic view properties', () => {
  21. view = new View();
  22. expect( view.t ).to.be.undefined;
  23. expect( view.locale ).to.be.undefined;
  24. expect( view.isRendered ).to.be.false;
  25. expect( view.template ).to.be.undefined;
  26. expect( view._viewCollections ).to.be.instanceOf( Collection );
  27. expect( view._unboundChildren ).to.be.instanceOf( ViewCollection );
  28. } );
  29. it( 'defines the locale property and the "t" function', () => {
  30. const locale = { t() {} };
  31. view = new View( locale );
  32. expect( view.locale ).to.equal( locale );
  33. expect( view.t ).to.equal( locale.t );
  34. } );
  35. describe( '_viewCollections', () => {
  36. it( 'manages #locale property', () => {
  37. const locale = {
  38. t() {}
  39. };
  40. const view = new View( locale );
  41. const collection = new ViewCollection();
  42. expect( view.locale ).to.equal( locale );
  43. expect( collection.locale ).to.be.undefined;
  44. view._viewCollections.add( collection );
  45. expect( collection.locale ).to.equal( view.locale );
  46. } );
  47. } );
  48. } );
  49. describe( 'createCollection()', () => {
  50. beforeEach( () => {
  51. setTestViewClass();
  52. setTestViewInstance();
  53. } );
  54. it( 'returns an instance of view collection', () => {
  55. expect( view.createCollection() ).to.be.instanceOf( ViewCollection );
  56. } );
  57. it( 'adds a new collection to the #_viewCollections', () => {
  58. expect( view._viewCollections ).to.have.length( 1 );
  59. const collection = view.createCollection();
  60. expect( view._viewCollections ).to.have.length( 2 );
  61. expect( view._viewCollections.get( 1 ) ).to.equal( collection );
  62. } );
  63. } );
  64. describe( 'registerChildren()', () => {
  65. beforeEach( () => {
  66. setTestViewClass();
  67. setTestViewInstance();
  68. } );
  69. it( 'should add a single view to #_unboundChildren', () => {
  70. expect( view._unboundChildren ).to.have.length( 0 );
  71. const child = new View();
  72. view.registerChildren( child );
  73. expect( view._unboundChildren ).to.have.length( 1 );
  74. expect( view._unboundChildren.get( 0 ) ).to.equal( child );
  75. } );
  76. it( 'should support iterables', () => {
  77. expect( view._unboundChildren ).to.have.length( 0 );
  78. view.registerChildren( [ new View(), new View(), new View() ] );
  79. expect( view._unboundChildren ).to.have.length( 3 );
  80. } );
  81. } );
  82. describe( 'deregisterChildren()', () => {
  83. beforeEach( () => {
  84. setTestViewClass();
  85. setTestViewInstance();
  86. } );
  87. it( 'should remove a single view from #_unboundChildren', () => {
  88. const child1 = new View();
  89. const child2 = new View();
  90. view.registerChildren( child1 );
  91. view.registerChildren( child2 );
  92. expect( view._unboundChildren ).to.have.length( 2 );
  93. view.deregisterChildren( child2 );
  94. expect( view._unboundChildren ).to.have.length( 1 );
  95. expect( view._unboundChildren.get( 0 ) ).to.equal( child1 );
  96. } );
  97. it( 'should support iterables', () => {
  98. const child1 = new View();
  99. const child2 = new View();
  100. const child3 = new View();
  101. view.registerChildren( [ child1, child2, child3 ] );
  102. expect( view._unboundChildren ).to.have.length( 3 );
  103. view.deregisterChildren( [ child2, child3 ] );
  104. expect( view._unboundChildren ).to.have.length( 1 );
  105. expect( view._unboundChildren.get( 0 ) ).to.equal( child1 );
  106. } );
  107. } );
  108. describe( 'render()', () => {
  109. it( 'should throw if already rendered', () => {
  110. const view = new View();
  111. view.render();
  112. try {
  113. view.render();
  114. throw new Error( 'This should not be executed.' );
  115. } catch ( err ) {
  116. expect( err ).to.be.instanceof( CKEditorError );
  117. expect( err.message ).to.match( /^ui-view-render-already-rendered:/ );
  118. }
  119. } );
  120. it( 'should set view#isRendered', () => {
  121. const view = new View();
  122. view.template = new Template( {
  123. tag: 'div'
  124. } );
  125. expect( view.isRendered ).to.be.false;
  126. view.render();
  127. expect( view.isRendered ).to.be.true;
  128. } );
  129. } );
  130. describe( 'bind', () => {
  131. beforeEach( () => {
  132. setTestViewClass();
  133. setTestViewInstance();
  134. } );
  135. it( 'returns a shorthand for Template binding', () => {
  136. expect( view.bindTemplate.to ).to.be.a( 'function' );
  137. expect( view.bindTemplate.if ).to.be.a( 'function' );
  138. const binding = view.bindTemplate.to( 'a' );
  139. expect( binding.observable ).to.equal( view );
  140. expect( binding.emitter ).to.equal( view );
  141. } );
  142. } );
  143. describe( 'element', () => {
  144. beforeEach( createViewInstanceWithTemplate );
  145. it( 'invokes out of #template', () => {
  146. setTestViewInstance();
  147. expect( view.element ).to.be.an.instanceof( HTMLElement );
  148. expect( view.element.nodeName ).to.equal( 'A' );
  149. } );
  150. it( 'can be explicitly declared', () => {
  151. class CustomView extends View {
  152. constructor() {
  153. super();
  154. this.element = document.createElement( 'span' );
  155. }
  156. }
  157. view = new CustomView();
  158. expect( view.element ).to.be.an.instanceof( HTMLElement );
  159. } );
  160. it( 'is null when there is no template', () => {
  161. expect( new View().element ).to.be.null;
  162. } );
  163. it( 'registers child views found in the template', () => {
  164. const view = new View();
  165. const viewA = new View();
  166. const viewB = new View();
  167. const viewC = new View();
  168. viewA.template = new Template( { tag: 'a' } );
  169. viewB.template = new Template( { tag: 'b' } );
  170. viewC.template = new Template( { tag: 'c' } );
  171. view.template = new Template( {
  172. tag: 'div',
  173. children: [
  174. viewA,
  175. viewB,
  176. {
  177. tag: 'p',
  178. children: [
  179. viewC
  180. ]
  181. },
  182. {
  183. text: 'foo'
  184. }
  185. ]
  186. } );
  187. expect( view._unboundChildren ).to.have.length( 0 );
  188. view.render();
  189. expect( view._unboundChildren ).to.have.length( 3 );
  190. expect( view._unboundChildren.get( 0 ) ).to.equal( viewA );
  191. expect( view._unboundChildren.get( 1 ) ).to.equal( viewB );
  192. expect( view._unboundChildren.get( 2 ) ).to.equal( viewC );
  193. } );
  194. } );
  195. describe( 'destroy()', () => {
  196. beforeEach( createViewWithChildren );
  197. it( 'can be called multiple times', () => {
  198. expect( () => {
  199. view.destroy();
  200. } ).to.not.throw();
  201. } );
  202. it( 'should not touch the basic properties', () => {
  203. view.destroy();
  204. expect( view.element ).to.be.an.instanceof( HTMLElement );
  205. expect( view.template ).to.be.an.instanceof( Template );
  206. expect( view.locale ).to.be.an( 'object' );
  207. expect( view.locale.t ).to.be.a( 'function' );
  208. expect( view._viewCollections ).to.be.instanceOf( Collection );
  209. expect( view._unboundChildren ).to.be.instanceOf( ViewCollection );
  210. } );
  211. it( 'should not clear the #_unboundChildren', () => {
  212. const cached = view._unboundChildren;
  213. view.registerChildren( [ new View(), new View() ] );
  214. expect( cached ).to.have.length( 4 );
  215. view.destroy();
  216. expect( cached ).to.have.length( 4 );
  217. } );
  218. it( 'should not clear the #_viewCollections', () => {
  219. const cached = view._viewCollections;
  220. expect( cached ).to.have.length( 1 );
  221. view.destroy();
  222. expect( cached ).to.have.length( 1 );
  223. } );
  224. it( 'leaves the #element in DOM', () => {
  225. const elRef = view.element;
  226. const parentEl = document.createElement( 'div' );
  227. parentEl.appendChild( view.element );
  228. view.destroy();
  229. expect( elRef.parentNode ).to.equal( parentEl );
  230. } );
  231. it( 'calls destroy() on all view#_viewCollections', () => {
  232. const collectionA = view.createCollection();
  233. const collectionB = view.createCollection();
  234. const spyA = testUtils.sinon.spy( collectionA, 'destroy' );
  235. const spyB = testUtils.sinon.spy( collectionB, 'destroy' );
  236. view.destroy();
  237. sinon.assert.calledOnce( spyA );
  238. sinon.assert.calledOnce( spyB );
  239. sinon.assert.callOrder( spyA, spyB );
  240. } );
  241. it( 'destroy a template–less view', () => {
  242. view = new View();
  243. expect( () => {
  244. view.destroy();
  245. } ).to.not.throw();
  246. } );
  247. } );
  248. } );
  249. function createViewInstanceWithTemplate() {
  250. setTestViewClass( { tag: 'a' } );
  251. setTestViewInstance();
  252. }
  253. function setTestViewClass( templateDef ) {
  254. TestView = class V extends View {
  255. constructor() {
  256. super();
  257. this.locale = { t() {} };
  258. if ( templateDef ) {
  259. this.template = new Template( templateDef );
  260. }
  261. }
  262. };
  263. }
  264. function setTestViewInstance() {
  265. view = new TestView();
  266. if ( view.template ) {
  267. view.render();
  268. document.body.appendChild( view.element );
  269. }
  270. }
  271. function createViewWithChildren() {
  272. class ChildView extends View {
  273. constructor() {
  274. super();
  275. this.template = new Template( {
  276. tag: 'span'
  277. } );
  278. }
  279. }
  280. childA = new ChildView();
  281. childB = new ChildView();
  282. setTestViewClass( {
  283. tag: 'p',
  284. children: [ childA, childB ]
  285. } );
  286. setTestViewInstance();
  287. }