model.js 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  6. import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
  7. describe( 'Model', () => {
  8. let model;
  9. let changes = '';
  10. beforeEach( () => {
  11. model = new Model();
  12. changes = '';
  13. } );
  14. describe( 'change & enqueueChange', () => {
  15. it( 'should execute changes immediately', () => {
  16. model.change( () => {
  17. changes += 'A';
  18. } );
  19. expect( changes ).to.equal( 'A' );
  20. } );
  21. it( 'should pass returned value', () => {
  22. const ret = model.change( () => {
  23. changes += 'A';
  24. return 'B';
  25. } );
  26. changes += ret;
  27. expect( changes ).to.equal( 'AB' );
  28. } );
  29. it( 'should not mixed the order when nested change is called', () => {
  30. const ret = model.change( () => {
  31. changes += 'A';
  32. nested();
  33. return 'D';
  34. } );
  35. changes += ret;
  36. expect( changes ).to.equal( 'ABCD' );
  37. function nested() {
  38. const ret = model.change( () => {
  39. changes += 'B';
  40. return 'C';
  41. } );
  42. changes += ret;
  43. }
  44. } );
  45. it( 'should execute enqueueChanges immediately if its the first block', () => {
  46. model.enqueueChange( () => {
  47. changes += 'A';
  48. nested();
  49. } );
  50. expect( changes ).to.equal( 'ABC' );
  51. function nested() {
  52. const ret = model.change( () => {
  53. changes += 'B';
  54. return 'C';
  55. } );
  56. changes += ret;
  57. }
  58. } );
  59. it( 'should be possible to enqueueChanges immediately if its the first block', () => {
  60. model.enqueueChange( () => {
  61. changes += 'A';
  62. nested();
  63. } );
  64. expect( changes ).to.equal( 'AB' );
  65. function nested() {
  66. model.change( () => {
  67. changes += 'B';
  68. } );
  69. }
  70. } );
  71. it( 'should be possible to nest change in enqueueChanges', () => {
  72. model.enqueueChange( () => {
  73. changes += 'A';
  74. nested();
  75. changes += 'D';
  76. } );
  77. expect( changes ).to.equal( 'ABCD' );
  78. function nested() {
  79. const ret = model.change( () => {
  80. changes += 'B';
  81. return 'C';
  82. } );
  83. changes += ret;
  84. }
  85. } );
  86. it( 'should be possible to nest enqueueChanges in enqueueChanges', () => {
  87. model.enqueueChange( () => {
  88. changes += 'A';
  89. nestedEnqueue();
  90. changes += 'B';
  91. } );
  92. expect( changes ).to.equal( 'ABC' );
  93. function nestedEnqueue() {
  94. model.enqueueChange( () => {
  95. changes += 'C';
  96. } );
  97. }
  98. } );
  99. it( 'should be possible to nest enqueueChanges in changes', () => {
  100. const ret = model.change( () => {
  101. changes += 'A';
  102. nestedEnqueue();
  103. changes += 'B';
  104. return 'D';
  105. } );
  106. changes += ret;
  107. expect( changes ).to.equal( 'ABCD' );
  108. function nestedEnqueue() {
  109. model.enqueueChange( () => {
  110. changes += 'C';
  111. } );
  112. }
  113. } );
  114. it( 'should be possible to nest enqueueChanges in enqueueChanges event', () => {
  115. model.once( 'change', () => {
  116. model.enqueueChange( () => {
  117. changes += 'C';
  118. } );
  119. changes += 'B';
  120. } );
  121. model.on( 'changesDone', () => {
  122. changes += 'D';
  123. } );
  124. model.enqueueChange( () => {
  125. changes += 'A';
  126. } );
  127. expect( changes ).to.equal( 'ABCD' );
  128. } );
  129. it( 'should be possible to nest enqueueChanges in changes event', () => {
  130. model.once( 'change', () => {
  131. model.enqueueChange( () => {
  132. changes += 'C';
  133. } );
  134. changes += 'B';
  135. } );
  136. model.on( 'changesDone', () => {
  137. changes += 'D';
  138. } );
  139. model.change( () => {
  140. changes += 'A';
  141. } );
  142. expect( changes ).to.equal( 'ABCD' );
  143. } );
  144. it( 'should be possible to nest changes in enqueueChanges event', () => {
  145. model.once( 'change', () => {
  146. model.change( () => {
  147. changes += 'B';
  148. } );
  149. changes += 'C';
  150. } );
  151. model.on( 'changesDone', () => {
  152. changes += 'D';
  153. } );
  154. model.enqueueChange( () => {
  155. changes += 'A';
  156. } );
  157. expect( changes ).to.equal( 'ABCD' );
  158. } );
  159. it( 'should be possible to nest changes in changes event', () => {
  160. model.once( 'change', () => {
  161. model.change( () => {
  162. changes += 'B';
  163. } );
  164. changes += 'C';
  165. } );
  166. model.on( 'changesDone', () => {
  167. changes += 'D';
  168. } );
  169. model.change( () => {
  170. changes += 'A';
  171. } );
  172. expect( changes ).to.equal( 'ABCD' );
  173. } );
  174. it( 'should let mix blocks', () => {
  175. model.once( 'change', () => {
  176. model.change( () => {
  177. changes += 'B';
  178. nestedEnqueue();
  179. } );
  180. model.change( () => {
  181. changes += 'C';
  182. } );
  183. changes += 'D';
  184. } );
  185. model.on( 'changesDone', () => {
  186. changes += 'F';
  187. } );
  188. model.change( () => {
  189. changes += 'A';
  190. } );
  191. expect( changes ).to.equal( 'ABCDEF' );
  192. function nestedEnqueue() {
  193. model.enqueueChange( () => {
  194. changes += 'E';
  195. } );
  196. }
  197. } );
  198. it( 'should use the same writer in all change blocks (change & change)', () => {
  199. model.change( outerWriter => {
  200. model.change( innerWriter => {
  201. expect( innerWriter ).to.equal( outerWriter );
  202. } );
  203. } );
  204. } );
  205. it( 'should create new writer in enqueue block', () => {
  206. model.change( outerWriter => {
  207. model.enqueueChange( innerWriter => {
  208. expect( innerWriter ).to.not.equal( outerWriter );
  209. expect( innerWriter.batch ).to.not.equal( outerWriter.batch );
  210. } );
  211. } );
  212. } );
  213. it( 'should let you pass batch', () => {
  214. let outerBatch;
  215. model.change( outerWriter => {
  216. outerBatch = outerWriter.batch;
  217. model.enqueueChange( outerBatch, innerWriter => {
  218. expect( innerWriter.batch ).to.equal( outerBatch );
  219. } );
  220. } );
  221. } );
  222. it( 'should let you create transparent batch', () => {
  223. model.enqueueChange( 'transparent', writer => {
  224. expect( writer.batch.type ).to.equal( 'transparent' );
  225. } );
  226. } );
  227. } );
  228. describe( 'destroy()', () => {
  229. it( 'should destroy document', () => {
  230. sinon.spy( model.document, 'destroy' );
  231. model.destroy();
  232. sinon.assert.calledOnce( model.document.destroy );
  233. } );
  234. it( 'should stop listening', () => {
  235. const emitter = Object.create( EmitterMixin );
  236. const spy = sinon.spy();
  237. model.listenTo( emitter, 'event', spy );
  238. model.destroy();
  239. emitter.fire( 'event' );
  240. sinon.assert.notCalled( spy );
  241. } );
  242. } );
  243. } );