view.js 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  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.ready ).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( 'addChildren()', () => {
  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 = {};
  72. view.addChildren( 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.addChildren( [ {}, {}, {} ] );
  79. expect( view._unboundChildren ).to.have.length( 3 );
  80. } );
  81. } );
  82. describe( 'removeChildren()', () => {
  83. beforeEach( () => {
  84. setTestViewClass();
  85. setTestViewInstance();
  86. } );
  87. it( 'should remove a single view from #_unboundChildren', () => {
  88. const child1 = {};
  89. const child2 = {};
  90. view.addChildren( child1 );
  91. view.addChildren( child2 );
  92. expect( view._unboundChildren ).to.have.length( 2 );
  93. view.removeChildren( 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 = {};
  99. const child2 = {};
  100. const child3 = {};
  101. view.addChildren( [ child1, child2, child3 ] );
  102. expect( view._unboundChildren ).to.have.length( 3 );
  103. view.removeChildren( [ child2, child3 ] );
  104. expect( view._unboundChildren ).to.have.length( 1 );
  105. expect( view._unboundChildren.get( 0 ) ).to.equal( child1 );
  106. } );
  107. } );
  108. describe( 'init()', () => {
  109. beforeEach( createViewWithChildren );
  110. it( 'should throw if already initialized', () => {
  111. view.init();
  112. try {
  113. view.init();
  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-init-re/ );
  118. }
  119. } );
  120. it( 'should set view#ready', () => {
  121. expect( view.ready ).to.be.false;
  122. view.init();
  123. expect( view.ready ).to.be.true;
  124. } );
  125. it( 'calls init() on all view#_viewCollections', () => {
  126. const collectionA = view.createCollection();
  127. const collectionB = view.createCollection();
  128. const spyA = testUtils.sinon.spy( collectionA, 'init' );
  129. const spyB = testUtils.sinon.spy( collectionB, 'init' );
  130. view.init();
  131. sinon.assert.calledOnce( spyA );
  132. sinon.assert.calledOnce( spyB );
  133. sinon.assert.callOrder( spyA, spyB );
  134. } );
  135. } );
  136. describe( 'bind', () => {
  137. beforeEach( () => {
  138. setTestViewClass();
  139. setTestViewInstance();
  140. } );
  141. it( 'returns a shorthand for Template binding', () => {
  142. expect( view.bindTemplate.to ).to.be.a( 'function' );
  143. expect( view.bindTemplate.if ).to.be.a( 'function' );
  144. const binding = view.bindTemplate.to( 'a' );
  145. expect( binding.observable ).to.equal( view );
  146. expect( binding.emitter ).to.equal( view );
  147. } );
  148. } );
  149. describe( 'element', () => {
  150. beforeEach( createViewInstanceWithTemplate );
  151. it( 'invokes out of #template', () => {
  152. setTestViewInstance();
  153. expect( view.element ).to.be.an.instanceof( HTMLElement );
  154. expect( view.element.nodeName ).to.equal( 'A' );
  155. } );
  156. it( 'can be explicitly declared', () => {
  157. class CustomView extends View {
  158. constructor() {
  159. super();
  160. this.element = document.createElement( 'span' );
  161. }
  162. }
  163. view = new CustomView();
  164. expect( view.element ).to.be.an.instanceof( HTMLElement );
  165. } );
  166. it( 'is null when there is no template', () => {
  167. expect( new View().element ).to.be.null;
  168. } );
  169. it( 'registers child views found in the template', () => {
  170. const view = new View();
  171. const viewA = new View();
  172. const viewB = new View();
  173. const viewC = new View();
  174. viewA.template = new Template( { tag: 'a' } );
  175. viewB.template = new Template( { tag: 'b' } );
  176. viewC.template = new Template( { tag: 'c' } );
  177. view.template = new Template( {
  178. tag: 'div',
  179. children: [
  180. viewA,
  181. viewB,
  182. {
  183. tag: 'p',
  184. children: [
  185. viewC
  186. ]
  187. },
  188. {
  189. text: 'foo'
  190. }
  191. ]
  192. } );
  193. expect( view._unboundChildren ).to.have.length( 0 );
  194. // Render the view.
  195. view.element;
  196. expect( view._unboundChildren ).to.have.length( 3 );
  197. expect( view._unboundChildren.get( 0 ) ).to.equal( viewA );
  198. expect( view._unboundChildren.get( 1 ) ).to.equal( viewB );
  199. expect( view._unboundChildren.get( 2 ) ).to.equal( viewC );
  200. } );
  201. } );
  202. describe( 'destroy()', () => {
  203. beforeEach( createViewWithChildren );
  204. it( 'can be called multiple times', () => {
  205. expect( () => {
  206. view.destroy();
  207. } ).to.not.throw();
  208. } );
  209. it( 'should not touch the basic properties', () => {
  210. view.destroy();
  211. expect( view.element ).to.be.an.instanceof( HTMLElement );
  212. expect( view.template ).to.be.an.instanceof( Template );
  213. expect( view.locale ).to.be.an( 'object' );
  214. expect( view.locale.t ).to.be.a( 'function' );
  215. expect( view._viewCollections ).to.be.instanceOf( Collection );
  216. expect( view._unboundChildren ).to.be.instanceOf( ViewCollection );
  217. } );
  218. it( 'should not clear the #_unboundChildren', () => {
  219. const cached = view._unboundChildren;
  220. view.addChildren( [ new View(), new View() ] );
  221. expect( cached ).to.have.length( 4 );
  222. view.destroy();
  223. expect( cached ).to.have.length( 4 );
  224. } );
  225. it( 'should not clear the #_viewCollections', () => {
  226. const cached = view._viewCollections;
  227. expect( cached ).to.have.length( 1 );
  228. view.destroy();
  229. expect( cached ).to.have.length( 1 );
  230. } );
  231. it( 'leaves the #element in DOM', () => {
  232. const elRef = view.element;
  233. const parentEl = document.createElement( 'div' );
  234. parentEl.appendChild( view.element );
  235. view.destroy();
  236. expect( elRef.parentNode ).to.equal( parentEl );
  237. } );
  238. it( 'calls destroy() on all view#_viewCollections', () => {
  239. const collectionA = view.createCollection();
  240. const collectionB = view.createCollection();
  241. const spyA = testUtils.sinon.spy( collectionA, 'destroy' );
  242. const spyB = testUtils.sinon.spy( collectionB, 'destroy' );
  243. view.destroy();
  244. sinon.assert.calledOnce( spyA );
  245. sinon.assert.calledOnce( spyB );
  246. sinon.assert.callOrder( spyA, spyB );
  247. } );
  248. it( 'destroy a template–less view', () => {
  249. view = new View();
  250. expect( () => {
  251. view.destroy();
  252. } ).to.not.throw();
  253. } );
  254. } );
  255. } );
  256. function createViewInstanceWithTemplate() {
  257. setTestViewClass( { tag: 'a' } );
  258. setTestViewInstance();
  259. }
  260. function setTestViewClass( templateDef ) {
  261. TestView = class V extends View {
  262. constructor() {
  263. super();
  264. this.locale = { t() {} };
  265. if ( templateDef ) {
  266. this.template = new Template( templateDef );
  267. }
  268. }
  269. };
  270. }
  271. function setTestViewInstance() {
  272. view = new TestView();
  273. if ( view.template ) {
  274. document.body.appendChild( view.element );
  275. }
  276. }
  277. function createViewWithChildren() {
  278. class ChildView extends View {
  279. constructor() {
  280. super();
  281. this.template = new Template( {
  282. tag: 'span'
  283. } );
  284. }
  285. }
  286. childA = new ChildView();
  287. childB = new ChildView();
  288. setTestViewClass( {
  289. tag: 'p',
  290. children: [ childA, childB ]
  291. } );
  292. setTestViewInstance();
  293. }