document.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Document from '../../../src/model/document';
  6. import Schema from '../../../src/model/schema';
  7. import RootElement from '../../../src/model/rootelement';
  8. import Batch from '../../../src/model/batch';
  9. import Delta from '../../../src/model/delta/delta';
  10. import Range from '../../../src/model/range';
  11. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  12. import count from '@ckeditor/ckeditor5-utils/src/count';
  13. import { jsonParseStringify } from '../../../tests/model/_utils/utils';
  14. import { setData, getData } from '../../../src/dev-utils/model';
  15. describe( 'Document', () => {
  16. let doc;
  17. beforeEach( () => {
  18. doc = new Document();
  19. } );
  20. describe( 'constructor()', () => {
  21. it( 'should create Document with no data, empty graveyard and selection set to default range', () => {
  22. expect( doc ).to.have.property( '_roots' ).that.is.instanceof( Map );
  23. expect( doc._roots.size ).to.equal( 1 );
  24. expect( doc.graveyard ).to.be.instanceof( RootElement );
  25. expect( doc.graveyard.maxOffset ).to.equal( 0 );
  26. expect( count( doc.selection.getRanges() ) ).to.equal( 1 );
  27. expect( doc.schema ).to.be.instanceof( Schema );
  28. } );
  29. } );
  30. describe( 'getRootNames()', () => {
  31. it( 'should return empty iterator if no roots exist', () => {
  32. expect( count( doc.getRootNames() ) ).to.equal( 0 );
  33. } );
  34. it( 'should return an iterator of all roots without the graveyard', () => {
  35. doc.createRoot( '$root', 'a' );
  36. doc.createRoot( '$root', 'b' );
  37. expect( Array.from( doc.getRootNames() ) ).to.deep.equal( [ 'a', 'b' ] );
  38. } );
  39. } );
  40. describe( 'createRoot', () => {
  41. it( 'should create a new RootElement with default element and root names, add it to roots map and return it', () => {
  42. let root = doc.createRoot();
  43. expect( doc._roots.size ).to.equal( 2 );
  44. expect( root ).to.be.instanceof( RootElement );
  45. expect( root.maxOffset ).to.equal( 0 );
  46. expect( root ).to.have.property( 'name', '$root' );
  47. expect( root ).to.have.property( 'rootName', 'main' );
  48. } );
  49. it( 'should create a new RootElement with custom element and root names, add it to roots map and return it', () => {
  50. let root = doc.createRoot( 'customElementName', 'customRootName' );
  51. expect( doc._roots.size ).to.equal( 2 );
  52. expect( root ).to.be.instanceof( RootElement );
  53. expect( root.maxOffset ).to.equal( 0 );
  54. expect( root ).to.have.property( 'name', 'customElementName' );
  55. expect( root ).to.have.property( 'rootName', 'customRootName' );
  56. } );
  57. it( 'should throw an error when trying to create a second root with the same name', () => {
  58. doc.createRoot( '$root', 'rootName' );
  59. expect(
  60. () => {
  61. doc.createRoot( '$root', 'rootName' );
  62. }
  63. ).to.throw( CKEditorError, /model-document-createRoot-name-exists/ );
  64. } );
  65. } );
  66. describe( 'getRoot', () => {
  67. it( 'should return a RootElement previously created with given name', () => {
  68. let newRoot = doc.createRoot();
  69. let getRoot = doc.getRoot();
  70. expect( getRoot ).to.equal( newRoot );
  71. } );
  72. it( 'should throw an error when trying to get non-existent root', () => {
  73. expect(
  74. () => {
  75. doc.getRoot( 'root' );
  76. }
  77. ).to.throw( CKEditorError, /model-document-getRoot-root-not-exist/ );
  78. } );
  79. } );
  80. describe( 'hasRoot', () => {
  81. it( 'should return true when Document has RootElement with given name', () => {
  82. doc.createRoot();
  83. expect( doc.hasRoot( 'main' ) ).to.be.true;
  84. } );
  85. it( 'should return false when Document does not have RootElement with given name', () => {
  86. expect( doc.hasRoot( 'noroot' ) ).to.be.false;
  87. } );
  88. } );
  89. describe( 'applyOperation', () => {
  90. it( 'should increase document version, execute operation and fire event with proper data', () => {
  91. const changeCallback = sinon.spy();
  92. const type = 't';
  93. const data = { data: 'x' };
  94. const batch = new Batch();
  95. const delta = new Delta();
  96. let operation = {
  97. type: type,
  98. baseVersion: 0,
  99. _execute: sinon.stub().returns( data )
  100. };
  101. delta.addOperation( operation );
  102. batch.addDelta( delta );
  103. doc.on( 'change', changeCallback );
  104. doc.applyOperation( operation );
  105. expect( doc.version ).to.equal( 1 );
  106. sinon.assert.calledOnce( operation._execute );
  107. sinon.assert.calledOnce( changeCallback );
  108. expect( changeCallback.args[ 0 ][ 1 ] ).to.equal( type );
  109. expect( changeCallback.args[ 0 ][ 2 ] ).to.equal( data );
  110. expect( changeCallback.args[ 0 ][ 3 ] ).to.equal( batch );
  111. } );
  112. it( 'should throw an error on the operation base version and the document version is different', () => {
  113. let operation = {
  114. baseVersion: 1
  115. };
  116. expect(
  117. () => {
  118. doc.applyOperation( operation );
  119. }
  120. ).to.throw( CKEditorError, /model-document-applyOperation-wrong-version/ );
  121. } );
  122. } );
  123. describe( 'batch', () => {
  124. it( 'should create a new batch with the document property', () => {
  125. const batch = doc.batch();
  126. expect( batch ).to.be.instanceof( Batch );
  127. expect( batch ).to.have.property( 'document' ).that.equals( doc );
  128. } );
  129. it( 'should set given batch type', () => {
  130. const batch = doc.batch( 'ignore' );
  131. expect( batch ).to.have.property( 'type' ).that.equals( 'ignore' );
  132. } );
  133. } );
  134. describe( 'enqueue', () => {
  135. it( 'should be executed immediately and fire changesDone event', () => {
  136. let order = [];
  137. doc.on( 'changesDone', () => order.push( 'done' ) );
  138. doc.enqueueChanges( () => order.push( 'enqueue1' ) );
  139. expect( order ).to.have.length( 2 );
  140. expect( order[ 0 ] ).to.equal( 'enqueue1' );
  141. expect( order[ 1 ] ).to.equal( 'done' );
  142. } );
  143. it( 'should fire done every time queue is empty', () => {
  144. let order = [];
  145. doc.on( 'changesDone', () => order.push( 'done' ) );
  146. doc.enqueueChanges( () => order.push( 'enqueue1' ) );
  147. doc.enqueueChanges( () => order.push( 'enqueue2' ) );
  148. expect( order ).to.have.length( 4 );
  149. expect( order[ 0 ] ).to.equal( 'enqueue1' );
  150. expect( order[ 1 ] ).to.equal( 'done' );
  151. expect( order[ 2 ] ).to.equal( 'enqueue2' );
  152. expect( order[ 3 ] ).to.equal( 'done' );
  153. } );
  154. it( 'should put callbacks in the proper order', () => {
  155. let order = [];
  156. doc.on( 'changesDone', () => order.push( 'done' ) );
  157. doc.enqueueChanges( () => {
  158. order.push( 'enqueue1 start' );
  159. doc.enqueueChanges( () => {
  160. order.push( 'enqueue2 start' );
  161. doc.enqueueChanges( () => order.push( 'enqueue4' ) );
  162. order.push( 'enqueue2 end' );
  163. } );
  164. doc.enqueueChanges( () => order.push( 'enqueue3' ) );
  165. order.push( 'enqueue1 end' );
  166. } );
  167. expect( order ).to.have.length( 7 );
  168. expect( order[ 0 ] ).to.equal( 'enqueue1 start' );
  169. expect( order[ 1 ] ).to.equal( 'enqueue1 end' );
  170. expect( order[ 2 ] ).to.equal( 'enqueue2 start' );
  171. expect( order[ 3 ] ).to.equal( 'enqueue2 end' );
  172. expect( order[ 4 ] ).to.equal( 'enqueue3' );
  173. expect( order[ 5 ] ).to.equal( 'enqueue4' );
  174. expect( order[ 6 ] ).to.equal( 'done' );
  175. } );
  176. } );
  177. describe( 'selection', () => {
  178. it( 'should get updated attributes whenever attribute operation is applied', () => {
  179. sinon.spy( doc.selection, '_updateAttributes' );
  180. doc.fire( 'change', 'addAttribute' );
  181. expect( doc.selection._updateAttributes.called ).to.be.true;
  182. } );
  183. it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
  184. const root = doc.createRoot();
  185. root.appendChildren( '\uD83D\uDCA9' );
  186. expect( () => {
  187. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 0, root, 1 ) ] );
  188. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  189. expect( () => {
  190. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 2 ) ] );
  191. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  192. } );
  193. it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
  194. const root = doc.createRoot();
  195. root.appendChildren( 'foo̻̐ͩbar' );
  196. expect( () => {
  197. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 3, root, 9 ) ] );
  198. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  199. expect( () => {
  200. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 4, root, 9 ) ] );
  201. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  202. expect( () => {
  203. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 5, root, 9 ) ] );
  204. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  205. expect( () => {
  206. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 3 ) ] );
  207. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  208. expect( () => {
  209. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 4 ) ] );
  210. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  211. expect( () => {
  212. doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 5 ) ] );
  213. } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
  214. } );
  215. } );
  216. describe( 'getNearestSelectionRange', () => {
  217. let root;
  218. let selection;
  219. beforeEach( () => {
  220. doc.schema.registerItem( 'paragraph', '$block' );
  221. doc.schema.registerItem( 'emptyBlock' );
  222. doc.schema.allow( { name: 'emptyBlock', inside: '$root' } );
  223. doc.schema.registerItem( 'widget', '$block' );
  224. doc.schema.allow( { name: 'widget', inside: '$root' } );
  225. doc.schema.objects.add( 'widget' );
  226. root = doc.createRoot();
  227. selection = doc.selection;
  228. } );
  229. test(
  230. 'should return collapsed range if text node can be placed at that position - both',
  231. '<paragraph>[]</paragraph>',
  232. 'both',
  233. '<paragraph>[]</paragraph>'
  234. );
  235. test(
  236. 'should return collapsed range if text node can be placed at that position - forward',
  237. '<paragraph>[]</paragraph>',
  238. 'forward',
  239. '<paragraph>[]</paragraph>'
  240. );
  241. test(
  242. 'should return collapsed range if text node can be placed at that position - backward',
  243. '<paragraph>[]</paragraph>',
  244. 'backward',
  245. '<paragraph>[]</paragraph>'
  246. );
  247. test( 'should return null in empty document - both', '', 'both', null );
  248. test( 'should return null in empty document - backward', '', 'backward', null );
  249. test( 'should return null in empty document - forward', '', 'forward', null );
  250. test(
  251. 'should find range before when searching both ways',
  252. '<paragraph></paragraph>[]<paragraph></paragraph>',
  253. 'both',
  254. '<paragraph>[]</paragraph><paragraph></paragraph>'
  255. );
  256. test(
  257. 'should find range before when searching backward',
  258. '<paragraph></paragraph>[]<paragraph></paragraph>',
  259. 'backward',
  260. '<paragraph>[]</paragraph><paragraph></paragraph>'
  261. );
  262. test(
  263. 'should find range after when searching forward',
  264. '<paragraph></paragraph>[]<paragraph></paragraph>',
  265. 'forward',
  266. '<paragraph></paragraph><paragraph>[]</paragraph>'
  267. );
  268. test(
  269. 'should find range after when searching both ways when it is closer',
  270. '<paragraph></paragraph><emptyBlock></emptyBlock>[]<paragraph></paragraph>',
  271. 'both',
  272. '<paragraph></paragraph><emptyBlock></emptyBlock><paragraph>[]</paragraph>'
  273. );
  274. test(
  275. 'should find range before when searching both ways when it is closer',
  276. '<paragraph></paragraph><emptyBlock></emptyBlock>[]<emptyBlock></emptyBlock><emptyBlock></emptyBlock><paragraph></paragraph>',
  277. 'both',
  278. '<paragraph>[]</paragraph><emptyBlock></emptyBlock><emptyBlock></emptyBlock><emptyBlock></emptyBlock><paragraph></paragraph>'
  279. );
  280. test(
  281. 'should return null if there is no valid range',
  282. '[]<emptyBlock></emptyBlock>',
  283. 'both',
  284. null
  285. );
  286. test(
  287. 'should return null if there is no valid range in given direction - backward',
  288. '[]<paragraph></paragraph>',
  289. 'backward',
  290. null
  291. );
  292. test(
  293. 'should return null if there is no valid range in given direction - forward',
  294. '<paragraph></paragraph>[]',
  295. 'forward',
  296. null
  297. );
  298. test(
  299. 'should select nearest object - both',
  300. '<widget></widget>[]<widget></widget>',
  301. 'both',
  302. '[<widget></widget>]<widget></widget>'
  303. );
  304. test(
  305. 'should select nearest object - forward',
  306. '<paragraph></paragraph>[]<widget></widget>',
  307. 'forward',
  308. '<paragraph></paragraph>[<widget></widget>]'
  309. );
  310. test(
  311. 'should select nearest object - forward',
  312. '<paragraph></paragraph>[]<widget></widget>',
  313. 'forward',
  314. '<paragraph></paragraph>[<widget></widget>]'
  315. );
  316. test(
  317. 'should select nearest object - backward',
  318. '<widget></widget>[]<paragraph></paragraph>',
  319. 'backward',
  320. '[<widget></widget>]<paragraph></paragraph>'
  321. );
  322. test(
  323. 'should move forward when placed at root start',
  324. '[]<paragraph></paragraph><paragraph></paragraph>',
  325. 'both',
  326. '<paragraph>[]</paragraph><paragraph></paragraph>'
  327. );
  328. test(
  329. 'should move backward when placed at root end',
  330. '<paragraph></paragraph><paragraph></paragraph>[]',
  331. 'both',
  332. '<paragraph></paragraph><paragraph>[]</paragraph>'
  333. );
  334. function test( testName, data, direction, expected ) {
  335. it( testName, () => {
  336. setData( doc, data );
  337. const range = doc.getNearestSelectionRange( selection.anchor, direction );
  338. if ( expected === null ) {
  339. expect( range ).to.be.null;
  340. } else {
  341. selection.setRanges( [ range ] );
  342. expect( getData( doc ) ).to.equal( expected );
  343. }
  344. } );
  345. }
  346. } );
  347. describe( '_getDefaultRoot', () => {
  348. it( 'should return graveyard root if there are no other roots in the document', () => {
  349. expect( doc._getDefaultRoot() ).to.equal( doc.graveyard );
  350. } );
  351. it( 'should return the first root added to the document', () => {
  352. let rootA = doc.createRoot( '$root', 'rootA' );
  353. doc.createRoot( '$root', 'rootB' );
  354. doc.createRoot( '$root', 'rootC' );
  355. expect( doc._getDefaultRoot() ).to.equal( rootA );
  356. } );
  357. } );
  358. it( 'should be correctly converted to json', () => {
  359. expect( jsonParseStringify( doc ).selection ).to.equal( '[engine.model.LiveSelection]' );
  360. } );
  361. } );