8
0

view.js 9.2 KB

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